Amazon IoT Events Alarm Models API

The Alarm Models API from Amazon IoT Events — 3 operation(s) for alarm models.

Operations 6

POST /alarm-models Amazon IoT Events Create Alarm Model #
GET /alarm-models Amazon IoT Events List Alarm Models #
DELETE /alarm-models/{alarmModelName} Amazon IoT Events Delete Alarm Model #
GET /alarm-models/{alarmModelName} Amazon IoT Events Describe Alarm Model #
POST /alarm-models/{alarmModelName} Amazon IoT Events Update Alarm Model #
GET /alarm-models/{alarmModelName}/versions Amazon IoT Events List Alarm Model Versions #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-iot-events-alarm-models-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-iot-events-alarm-models-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: AWS IoT Events Alarm Models API
  description: 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.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: iotevents
  x-aws-signingName: iotevents
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotevents-2018-07-27.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://iotevents.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT Events multi-region endpoint
- url: https://iotevents.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT Events multi-region endpoint
- url: http://iotevents.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT Events endpoint for China (Beijing) and China (Ningxia)
- url: https://iotevents.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT Events endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Alarm Models
paths:
  /alarm-models:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateAlarmModel
      description: 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 <i>AWS IoT Events Developer Guide</i>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAlarmModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '483':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '485':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '486':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - alarmModelName
              - roleArn
              - alarmRule
              properties:
                alarmModelName:
                  description: A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.
                  type: string
                  pattern: ^[a-zA-Z0-9_-]+$
                  minLength: 1
                  maxLength: 128
                alarmModelDescription:
                  description: A description that tells you what the alarm model detects.
                  type: string
                  maxLength: 128
                roleArn:
                  description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.
                  type: string
                  minLength: 1
                  maxLength: 2048
                tags:
                  description: <p>A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html">Tagging your AWS IoT Events resources</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You can create up to 50 tags for one alarm model.</p>
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
                key:
                  description: An input attribute used as a key to create an alarm. AWS IoT Events routes <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html">inputs</a> associated with this key to the alarm.
                  type: string
                  pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$
                  minLength: 1
                  maxLength: 128
                severity:
                  description: A non-negative integer that reflects the severity level of the alarm.
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                alarmRule:
                  description: Defines when your alarm is invoked.
                  type: object
                  properties:
                    simpleRule:
                      allOf:
                      - $ref: '#/components/schemas/SimpleRule'
                      - description: A rule that compares an input property value to a threshold value with a comparison operator.
                alarmNotification:
                  description: Contains information about one or more notification actions.
                  type: object
                  properties:
                    notificationActions:
                      allOf:
                      - $ref: '#/components/schemas/NotificationActions'
                      - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
                alarmEventActions:
                  description: Contains information about one or more alarm actions.
                  type: object
                  properties:
                    alarmActions:
                      allOf:
                      - $ref: '#/components/schemas/AlarmActions'
                      - description: Specifies one or more supported actions to receive notifications when the alarm state changes.
                alarmCapabilities:
                  description: Contains the configuration information of alarm state changes.
                  type: object
                  properties:
                    initializationConfiguration:
                      allOf:
                      - $ref: '#/components/schemas/InitializationConfiguration'
                      - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
                    acknowledgeFlow:
                      allOf:
                      - $ref: '#/components/schemas/AcknowledgeFlow'
                      - description: Specifies whether to get notified for alarm state changes.
      summary: Amazon IoT Events Create Alarm Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Alarm Models
    get:
      operationId: ListAlarmModels
      description: Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAlarmModelsResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '482':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '483':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: nextToken
        in: query
        required: false
        description: The token that you can use to return the next set of results.
        schema:
          type: string
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to be returned per request.
        schema:
          type: integer
          minimum: 1
          maximum: 250
      summary: Amazon IoT Events List Alarm Models
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Alarm Models
  /alarm-models/{alarmModelName}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeleteAlarmModel
      description: Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
      responses:
        '204':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAlarmModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '485':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: alarmModelName
        in: path
        required: true
        description: The name of the alarm model.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      summary: Amazon IoT Events Delete Alarm Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Alarm Models
    get:
      operationId: DescribeAlarmModel
      description: Retrieves information about an alarm model. If you don't specify a value for the <code>alarmModelVersion</code> parameter, the latest version is returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAlarmModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: alarmModelName
        in: path
        required: true
        description: The name of the alarm model.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      - name: version
        in: query
        required: false
        description: The version of the alarm model.
        schema:
          type: string
          minLength: 1
          maxLength: 128
      summary: Amazon IoT Events Describe Alarm Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Alarm Models
    post:
      operationId: UpdateAlarmModel
      description: Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAlarmModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '485':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: alarmModelName
        in: path
        required: true
        description: The name of the alarm model.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - roleArn
              - alarmRule
              properties:
                alarmModelDescription:
                  description: The description of the alarm model.
                  type: string
                  maxLength: 128
                roleArn:
                  description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.
                  type: string
                  minLength: 1
                  maxLength: 2048
                severity:
                  description: A non-negative integer that reflects the severity level of the alarm.
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                alarmRule:
                  description: Defines when your alarm is invoked.
                  type: object
                  properties:
                    simpleRule:
                      allOf:
                      - $ref: '#/components/schemas/SimpleRule'
                      - description: A rule that compares an input property value to a threshold value with a comparison operator.
                alarmNotification:
                  description: Contains information about one or more notification actions.
                  type: object
                  properties:
                    notificationActions:
                      allOf:
                      - $ref: '#/components/schemas/NotificationActions'
                      - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
                alarmEventActions:
                  description: Contains information about one or more alarm actions.
                  type: object
                  properties:
                    alarmActions:
                      allOf:
                      - $ref: '#/components/schemas/AlarmActions'
                      - description: Specifies one or more supported actions to receive notifications when the alarm state changes.
                alarmCapabilities:
                  description: Contains the configuration information of alarm state changes.
                  type: object
                  properties:
                    initializationConfiguration:
                      allOf:
                      - $ref: '#/components/schemas/InitializationConfiguration'
                      - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
                    acknowledgeFlow:
                      allOf:
                      - $ref: '#/components/schemas/AcknowledgeFlow'
                      - description: Specifies whether to get notified for alarm state changes.
      summary: Amazon IoT Events Update Alarm Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Alarm Models
  /alarm-models/{alarmModelName}/versions:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: ListAlarmModelVersions
      description: Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAlarmModelVersionsResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: alarmModelName
        in: path
        required: true
        description: The name of the alarm model.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      - name: nextToken
        in: query
        required: false
        description: The token that you can use to return the next set of results.
        schema:
          type: string
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to be returned per request.
        schema:
          type: integer
          minimum: 1
          maximum: 250
      summary: Amazon IoT Events List Alarm Model Versions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Alarm Models
components:
  schemas:
    DynamoKeyField:
      type: string
    AssetPropertyQuality:
      type: string
    IotEventsAction:
      type: object
      required:
      - inputName
      properties:
        inputName:
          allOf:
          - $ref: '#/components/schemas/InputName'
          - description: The name of the AWS IoT Events input where the data is sent.
        payload:
          allOf:
          - $ref: '#/components/schemas/Payload'
          - description: You can configure the action payload when you send a message to an AWS IoT Events input.
      description: Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
    AlarmEventActions:
      type: object
      properties:
        alarmActions:
          allOf:
          - $ref: '#/components/schemas/AlarmActions'
          - description: Specifies one or more supported actions to receive notifications when the alarm state changes.
      description: Contains information about one or more alarm actions.
    SNSTopicPublishAction:
      type: object
      required:
      - targetArn
      properties:
        targetArn:
          allOf:
          - $ref: '#/components/schemas/AmazonResourceName'
          - description: The ARN of the Amazon SNS target where the message is sent.
        payload:
          allOf:
          - $ref: '#/components/schemas/Payload'
          - description: You can configure the action payload when you send a message as an Amazon SNS push notification.
      description: Information required to publish the Amazon SNS message.
    ContentExpression:
      type: string
      minLength: 1
    AssetPropertyEntryId:
      type: string
    InputProperty:
      type: string
      minLength: 1
      maxLength: 512
    UseBase64:
      type: boolean
    EmailConfiguration:
      type: object
      required:
      - from
      - recipients
      properties:
        from:
          allOf:
          - $ref: '#/components/schemas/FromEmail'
          - description: <p>The email address that sends emails.</p> <important> <p>If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">verify the email address that sends emails in Amazon SES</a>.</p> </important>
        content:
          allOf:
          - $ref: '#/components/schemas/EmailContent'
          - description: Contains the subject and message of an email.
        recipients:
          allOf:
          - $ref: '#/components/schemas/EmailRecipients'
          - description: <p>Contains the information of one or more recipients who receive the emails.</p> <important> <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive emails to your AWS SSO store</a>.</p> </important>
      description: Contains the configuration information of email notifications.
    AcknowledgeFlowEnabled:
      type: boolean
    ComparisonOperator:
      type: string
      enum:
      - GREATER
      - GREATER_OR_EQUAL
      - LESS
      - LESS_OR_EQUAL
      - EQUAL
      - NOT_EQUAL
    InternalFailureException: {}
    AssetPropertyBooleanValue:
      type: string
    AssetPropertyId:
      type: string
    RecipientDetails:
      type: array
      items:
        $ref: '#/components/schemas/RecipientDetail'
      minItems: 1
    ResourceNotFoundException: {}
    FirehoseAction:
      type: object
      required:
      - deliveryStreamName
      properties:
        deliveryStreamName:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamName'
          - description: The name of the Kinesis Data Firehose delivery stream where the data is written.
        separator:
          allOf:
          - $ref: '#/components/schemas/FirehoseSeparator'
          - description: 'A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: ''\n'' (newline), ''\t'' (tab), ''\r\n'' (Windows newline), '','' (comma).'
        payload:
          allOf:
          - $ref: '#/components/schemas/Payload'
          - description: You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
      description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
    SimpleRule:
      type: object
      required:
      - inputProperty
      - comparisonOperator
      - threshold
      properties:
        inputProperty:
          allOf:
          - $ref: '#/components/schemas/InputProperty'
          - description: The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
        comparisonOperator:
          allOf:
          - $ref: '#/components/schemas/ComparisonOperator'
          - description: The comparison operator.
        threshold:
          allOf:
          - $ref: '#/components/schemas/Threshold'
          - description: The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
      description: A rule that compares an input property value to a threshold value with a comparison operator.
    ThrottlingException: {}
    NotificationTargetActions:
      type: object
      properties:
        lambdaAction:
          $ref: '#/components/schemas/LambdaAction'
      description: Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">AWS Lambda function provided by AWS IoT Events</a>.
    EmailSubject:
      type: string
    AlarmModelSummary:
      type: object
      properties:
        creationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time the alarm model was created, in the Unix epoch format.
        alarmModelDescription:
          allOf:
          - $ref: '#/components/schemas/AlarmModelDescription'
          - description: The description of the alarm model.
        alarmModelName:
          allOf:
          - $ref: '#/components/schemas/AlarmModelName'
          - description: The name of the alarm model.
      description: Contains a summary of an alarm model.
    DynamoDBv2Action:
      type: object
      required:
      - tableName
      properties:
        tableName:
          allOf:
          - $ref: '#/components/schemas/DynamoTableName'
          - description: The name of the DynamoDB table.
        payload:
          $ref: '#/components/schemas/Payload'
      description: '<p>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 instance and the event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.</p> <p>You must use expressions for all parameters in <code>DynamoDBv2Action</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>tableName</code> parameter can be <code>''GreenhouseTemperatureTable''</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>tableName</code> parameter can be <code>$variable.ddbtableName</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>contentExpression</code> parameter in <co

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/openapi/amazon-iot-events-alarm-models-api-openapi.yml