The Detector Models API from Amazon IoT Events — 3 operation(s) for detector models.
openapi: 3.0.0
info:
version: '2018-07-27'
x-release: v4
title: AWS IoT Events Alarm Models Detector 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: Detector Models
paths:
/detector-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: CreateDetectorModel
description: Creates a detector model.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDetectorModelResponse'
'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:
- detectorModelName
- detectorModelDefinition
- roleArn
properties:
detectorModelName:
description: The name of the detector model.
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 128
detectorModelDefinition:
description: Information that defines how a detector operates.
type: object
properties:
states:
allOf:
- $ref: '#/components/schemas/States'
- description: Information about the states of the detector.
initialStateName:
allOf:
- $ref: '#/components/schemas/StateName'
- description: The state that is entered at the creation of each detector (instance).
detectorModelDescription:
description: A brief description of the detector model.
type: string
maxLength: 128
key:
description: The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
type: string
pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$
minLength: 1
maxLength: 128
roleArn:
description: The ARN of the role that grants permission to AWS IoT Events to perform its operations.
type: string
minLength: 1
maxLength: 2048
tags:
description: Metadata that can be used to manage the detector model.
type: array
items:
$ref: '#/components/schemas/Tag'
evaluationMethod:
description: 'Information about the order in which events are evaluated and how actions are executed. '
type: string
enum:
- BATCH
- SERIAL
summary: Amazon IoT Events Create Detector Model
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector Models
get:
operationId: ListDetectorModels
description: Lists the detector models you have created. Only the metadata associated with each detector model is returned.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDetectorModelsResponse'
'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 Detector Models
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector Models
/detector-models/{detectorModelName}:
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: DeleteDetectorModel
description: Deletes a detector model. Any active instances of the detector model are also deleted.
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDetectorModelResponse'
'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: detectorModelName
in: path
required: true
description: The name of the detector model to be deleted.
schema:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 128
summary: Amazon IoT Events Delete Detector Model
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector Models
get:
operationId: DescribeDetectorModel
description: Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeDetectorModelResponse'
'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: detectorModelName
in: path
required: true
description: The name of the detector model.
schema:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 128
- name: version
in: query
required: false
description: The version of the detector model.
schema:
type: string
minLength: 1
maxLength: 128
summary: Amazon IoT Events Describe Detector Model
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector Models
post:
operationId: UpdateDetectorModel
description: Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDetectorModelResponse'
'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: detectorModelName
in: path
required: true
description: The name of the detector model that is updated.
schema:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- detectorModelDefinition
- roleArn
properties:
detectorModelDefinition:
description: Information that defines how a detector operates.
type: object
properties:
states:
allOf:
- $ref: '#/components/schemas/States'
- description: Information about the states of the detector.
initialStateName:
allOf:
- $ref: '#/components/schemas/StateName'
- description: The state that is entered at the creation of each detector (instance).
detectorModelDescription:
description: A brief description of the detector model.
type: string
maxLength: 128
roleArn:
description: The ARN of the role that grants permission to AWS IoT Events to perform its operations.
type: string
minLength: 1
maxLength: 2048
evaluationMethod:
description: 'Information about the order in which events are evaluated and how actions are executed. '
type: string
enum:
- BATCH
- SERIAL
summary: Amazon IoT Events Update Detector Model
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector Models
/detector-models/{detectorModelName}/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: ListDetectorModelVersions
description: Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDetectorModelVersionsResponse'
'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: detectorModelName
in: path
required: true
description: The name of the detector model whose versions are returned.
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 Detector Model Versions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector Models
components:
schemas:
ResourceInUseException: {}
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.
InternalFailureException: {}
AssetPropertyStringValue:
type: string
EventName:
type: string
maxLength: 128
State:
type: object
required:
- stateName
properties:
stateName:
allOf:
- $ref: '#/components/schemas/StateName'
- description: The name of the state.
onInput:
allOf:
- $ref: '#/components/schemas/OnInputLifecycle'
- description: When an input is received and the <code>condition</code> is TRUE, perform the specified <code>actions</code>.
onEnter:
allOf:
- $ref: '#/components/schemas/OnEnterLifecycle'
- description: When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.
onExit:
allOf:
- $ref: '#/components/schemas/OnExitLifecycle'
- description: When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is <code>TRUE</code>.
description: Information that defines a state of a detector.
StateName:
type: string
minLength: 1
maxLength: 128
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.
ListDetectorModelsResponse:
type: object
properties:
detectorModelSummaries:
allOf:
- $ref: '#/components/schemas/DetectorModelSummaries'
- description: Summary information about the detector models.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can use to return the next set of results, or <code>null</code> if there are no more results.
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>
ServiceUnavailableException: {}
LambdaAction:
type: object
required:
- functionArn
properties:
functionArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the Lambda function that is executed.
payload:
allOf:
- $ref: '#/components/schemas/Payload'
- description: You can configure the action payload when you send a message to a Lambda function.
description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
AssetPropertyIntegerValue:
type: string
DynamoOperation:
type: string
AssetPropertyQuality:
type: string
VariableName:
type: string
pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
minLength: 1
maxLength: 128
Event:
type: object
required:
- eventName
properties:
eventName:
allOf:
- $ref: '#/components/schemas/EventName'
- description: The name of the event.
condition:
allOf:
- $ref: '#/components/schemas/Condition'
- description: Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
actions:
allOf:
- $ref: '#/components/schemas/Actions'
- description: The actions to be performed.
description: Specifies the <code>actions</code> to be performed when the <code>condition</code> evaluates to TRUE.
FirehoseSeparator:
type: string
pattern: ([\n\t])|(\r\n)|(,)
AssetId:
type: string
UpdateDetectorModelResponse:
type: object
properties:
detectorModelConfiguration:
allOf:
- $ref: '#/components/schemas/DetectorModelConfiguration'
- description: Information about how the detector model is configured.
Tag:
type: object
required:
- key
- value
properties:
key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The tag's key.
value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The tag's value.
description: Metadata that can be used to manage the resource.
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.
AssetPropertyEntryId:
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.
DetectorModelSummaries:
type: array
items:
$ref: '#/components/schemas/DetectorModelSummary'
Action:
type: object
properties:
setVariable:
allOf:
- $ref: '#/components/schemas/SetVariableAction'
- description: Sets a variable to a specified value.
sns:
allOf:
- $ref: '#/components/schemas/SNSTopicPublishAction'
- description: Sends an Amazon SNS message.
iotTopicPublish:
allOf:
- $ref: '#/components/schemas/IotTopicPublishAction'
- description: Publishes an MQTT message with the given topic to the AWS IoT message broker.
setTimer:
allOf:
- $ref: '#/components/schemas/SetTimerAction'
- description: Information needed to set the timer.
clearTimer:
allOf:
- $ref: '#/components/schemas/ClearTimerAction'
- description: Information needed to clear the timer.
resetTimer:
allOf:
- $ref: '#/components/schemas/ResetTimerAction'
- description: Information needed to reset the timer.
lambda:
allOf:
- $ref: '#/components/schemas/LambdaAction'
- description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
iotEvents:
allOf:
- $ref: '#/components/schemas/IotEventsAction'
- description: Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
sqs:
allOf:
- $ref: '#/components/schemas/SqsAction'
- description: Sends information about the detector model instance and the event that triggered the action to
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/openapi/amazon-iot-events-detector-models-api-openapi.yml