The Alarm Models API from Amazon IoT Events — 3 operation(s) for alarm models.
openapi: 3.0.0
info:
version: '2018-07-27'
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
version: 1.0.0
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:
ResourceInUseException: {}
DeleteAlarmModelResponse:
type: object
properties: {}
IotTopicPublishAction:
type: object
required:
- mqttTopic
properties:
mqttTopic:
allOf:
- $ref: '#/components/schemas/MQTTTopic'
- description: The MQTT topic of the message. You can use a string expression that includes variables (<code>$variable.<variable-name></code>) and input values (<code>$input.<input-name>.<path-to-datum></code>) as the topic string.
payload:
allOf:
- $ref: '#/components/schemas/Payload'
- description: You can configure the action payload when you publish a message to an AWS IoT Core topic.
description: Information required to publish the MQTT message through the AWS IoT message broker.
RecipientDetail:
type: object
properties:
ssoIdentity:
allOf:
- $ref: '#/components/schemas/SSOIdentity'
- description: The AWS Single Sign-On (AWS SSO) authentication information.
description: The information that identifies the recipient.
InternalFailureException: {}
AssetPropertyStringValue:
type: string
IdentityStoreId:
type: string
InitializationConfiguration:
type: object
required:
- disabledOnInitialization
properties:
disabledOnInitialization:
allOf:
- $ref: '#/components/schemas/DisabledOnInitialization'
- description: The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>FALSE</code>, all alarm instances created based on the alarm model are activated. The default value is <code>TRUE</code>.
description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
Threshold:
type: string
minLength: 1
maxLength: 512
AlarmAction:
type: object
properties:
sns:
$ref: '#/components/schemas/SNSTopicPublishAction'
iotTopicPublish:
$ref: '#/components/schemas/IotTopicPublishAction'
lambda:
$ref: '#/components/schemas/LambdaAction'
iotEvents:
$ref: '#/components/schemas/IotEventsAction'
sqs:
$ref: '#/components/schemas/SqsAction'
firehose:
$ref: '#/components/schemas/FirehoseAction'
dynamoDB:
$ref: '#/components/schemas/DynamoDBAction'
dynamoDBv2:
$ref: '#/components/schemas/DynamoDBv2Action'
iotSiteWise:
$ref: '#/components/schemas/IotSiteWiseAction'
description: Specifies one of the following actions to receive notifications when the alarm state changes.
NotificationAction:
type: object
required:
- action
properties:
action:
allOf:
- $ref: '#/components/schemas/NotificationTargetActions'
- 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>.
smsConfigurations:
allOf:
- $ref: '#/components/schemas/SMSConfigurations'
- description: Contains the configuration information of SMS notifications.
emailConfigurations:
allOf:
- $ref: '#/components/schemas/EmailConfigurations'
- description: Contains the configuration information of email notifications.
description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
SqsAction:
type: object
required:
- queueUrl
properties:
queueUrl:
allOf:
- $ref: '#/components/schemas/QueueUrl'
- description: The URL of the SQS queue where the data is written.
useBase64:
allOf:
- $ref: '#/components/schemas/UseBase64'
- description: Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
payload:
allOf:
- $ref: '#/components/schemas/Payload'
- description: You can configure the action payload when you send a message to an Amazon SQS queue.
description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
SMSSenderId:
type: string
LimitExceededException: {}
PayloadType:
type: string
enum:
- STRING
- JSON
AssetPropertyVariant:
type: object
properties:
stringValue:
allOf:
- $ref: '#/components/schemas/AssetPropertyStringValue'
- description: The asset property value is a string. You must use an expression, and the evaluated result should be a string.
integerValue:
allOf:
- $ref: '#/components/schemas/AssetPropertyIntegerValue'
- description: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
doubleValue:
allOf:
- $ref: '#/components/schemas/AssetPropertyDoubleValue'
- description: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
booleanValue:
allOf:
- $ref: '#/components/schemas/AssetPropertyBooleanValue'
- description: The asset property value is a Boolean value that must be <code>'TRUE'</code> or <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a Boolean value.
description: <p>A structure that contains an asset property value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyVariant</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>integerValue</code> parameter can be <code>'100'</code>.</p> </li> <li> <p>For references, you must specify either variables or parameters. For example, the value for the <code>booleanValue</code> parameter can be <code>$variable.offline</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>doubleValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
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> </importan
# --- 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