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 version 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 ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) 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 condition is TRUE, perform the specified actions. onEnter: allOf: - $ref: '#/components/schemas/OnEnterLifecycle' - description: When entering this state, perform these actions if the condition is TRUE. onExit: allOf: - $ref: '#/components/schemas/OnExitLifecycle' - description: When exiting this state, perform these actions if the specified condition is TRUE. 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 null 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 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value. description:

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 parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.

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 actions 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 actions to be performed when the condition 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 an Amazon SQS queue. firehose: allOf: - $ref: '#/components/schemas/FirehoseAction' - description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. dynamoDB: allOf: - $ref: '#/components/schemas/DynamoDBAction' - description: Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide. dynamoDBv2: allOf: - $ref: '#/components/schemas/DynamoDBv2Action' - description: Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide. iotSiteWise: allOf: - $ref: '#/components/schemas/IotSiteWiseAction' - description: Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise . description: An action to be performed when the condition is TRUE. DynamoTableName: type: string DetectorModelVersionSummary: type: object properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelVersion: allOf: - $ref: '#/components/schemas/DetectorModelVersion' - description: The ID of the detector model version. detectorModelArn: allOf: - $ref: '#/components/schemas/DetectorModelArn' - description: The ARN of the detector model version. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants the detector model permission to perform its tasks. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model version was created. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time the detector model version was updated. status: allOf: - $ref: '#/components/schemas/DetectorModelVersionStatus' - description: The status of the detector model version. evaluationMethod: allOf: - $ref: '#/components/schemas/EvaluationMethod' - description: 'Information about the order in which events are evaluated and how actions are executed. ' description: Information about the detector model version. MQTTTopic: type: string minLength: 1 maxLength: 128 DynamoKeyField: type: string ListDetectorModelVersionsResponse: type: object properties: detectorModelVersionSummaries: allOf: - $ref: '#/components/schemas/DetectorModelVersionSummaries' - description: Summary information about the detector model versions. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token that you can use to return the next set of results, or null if there are no more results. AttributeJsonPath: type: string pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$ minLength: 1 maxLength: 128 TagKey: type: string minLength: 1 maxLength: 128 DetectorModelArn: type: string SetVariableAction: type: object required: - variableName - value properties: variableName: allOf: - $ref: '#/components/schemas/VariableName' - description: The name of the variable. value: allOf: - $ref: '#/components/schemas/VariableValue' - description: The new value of the variable. description: Information about the variable and its new value. TransitionEvent: type: object required: - eventName - condition - nextState properties: eventName: allOf: - $ref: '#/components/schemas/EventName' - description: The name of the transition event. condition: allOf: - $ref: '#/components/schemas/Condition' - description: Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered. actions: allOf: - $ref: '#/components/schemas/Actions' - description: The actions to be performed. nextState: allOf: - $ref: '#/components/schemas/StateName' - description: The next state to enter. description: Specifies the actions performed and the next state entered when a condition evaluates to TRUE. UseBase64: type: boolean DetectorModelConfiguration: type: object properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelVersion: allOf: - $ref: '#/components/schemas/DetectorModelVersion' - description: The version of the detector model. detectorModelDescription: allOf: - $ref: '#/components/schemas/DetectorModelDescription' - description: A brief description of the detector model. detectorModelArn: allOf: - $ref: '#/components/schemas/DetectorModelArn' - description: The ARN of the detector model. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model was created. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model was last updated. status: allOf: - $ref: '#/components/schemas/DetectorModelVersionStatus' - description: The status of the detector model. key: allOf: - $ref: '#/components/schemas/AttributeJsonPath' - description:

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

evaluationMethod: allOf: - $ref: '#/components/schemas/EvaluationMethod' - description: 'Information about the order in which events are evaluated and how actions are executed. ' description: Information about how the detector model is configured. IotSiteWiseAction: type: object properties: entryId: allOf: - $ref: '#/components/schemas/AssetPropertyEntryId' - description: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. assetId: allOf: - $ref: '#/components/schemas/AssetId' - description: The ID of the asset that has the specified property. propertyId: allOf: - $ref: '#/components/schemas/AssetPropertyId' - description: The ID of the asset property. propertyAlias: allOf: - $ref: '#/components/schemas/AssetPropertyAlias' - description: The alias of the asset property. propertyValue: allOf: - $ref: '#/components/schemas/AssetPropertyValue' - description: 'The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. ' description:

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 expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

ResetTimerAction: type: object required: - timerName properties: timerName: allOf: - $ref: '#/components/schemas/TimerName' - description: The name of the timer to reset. description: Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer. AssetPropertyTimeInSeconds: type: string CreateDetectorModelResponse: type: object properties: detectorModelConfiguration: allOf: - $ref: '#/components/schemas/DetectorModelConfiguration' - description: Information about how the detector model is configured. VariableValue: type: string minLength: 1 maxLength: 1024 Condition: type: string maxLength: 512 ThrottlingException: {} NextToken: type: string TimerName: type: string minLength: 1 maxLength: 128 AssetPropertyTimestamp: type: object required: - timeInSeconds properties: timeInSeconds: allOf: - $ref: '#/components/schemas/AssetPropertyTimeInSeconds' - description: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. offsetInNanos: allOf: - $ref: '#/components/schemas/AssetPropertyOffsetInNanos' - description: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. description:

A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

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: '

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 payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

' Seconds: type: integer minimum: 1 maximum: 31622400 Timestamp: type: string format: date-time DynamoKeyValue: type: string InputName: type: string pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ minLength: 1 maxLength: 128 AmazonResourceName: type: string minLength: 1 maxLength: 2048 SetTimerAction: type: object required: - timerName properties: timerName: allOf: - $ref: '#/components/schemas/TimerName' - description: The name of the timer. seconds: allOf: - $ref: '#/components/schemas/Seconds' - deprecated: true description: The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression. durationExpression: allOf: - $ref: '#/components/schemas/VariableValue' - description: 'The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. ' description: Information needed to set the timer. InvalidRequestException: {} Payload: type: object required: - contentExpression - type properties: contentExpression: allOf: - $ref: '#/components/schemas/ContentExpression' - description: The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB. type: allOf: - $ref: '#/components/schemas/PayloadType' - description: The value of the payload type can be either STRING or JSON. description:

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 attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Events: type: array items: $ref: '#/components/schemas/Event' ClearTimerAction: type: object required: - timerName properties: timerName: allOf: - $ref: '#/components/schemas/TimerName' - description: The name of the timer to clear. description: Information needed to clear the timer. DetectorModelDefinition: type: object required: - states - initialStateName 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). description: Information that defines how a detector operates. ResourceAlreadyExistsException: {} QueueUrl: type: string DetectorModelVersion: type: string minLength: 1 maxLength: 128 TransitionEvents: type: array items: $ref: '#/components/schemas/TransitionEvent' OnExitLifecycle: type: object properties: events: allOf: - $ref: '#/components/schemas/Events' - description: Specifies the actions that are performed when the state is exited and the condition is TRUE. description: When exiting this state, perform these actions if the specified condition is TRUE. DetectorModelVersionSummaries: type: array items: $ref: '#/components/schemas/DetectorModelVersionSummary' ResourceNotFoundException: {} AssetPropertyDoubleValue: type: string EvaluationMethod: type: string enum: - BATCH - SERIAL AssetPropertyOffsetInNanos: type: string AssetPropertyValue: type: object properties: value: allOf: - $ref: '#/components/schemas/AssetPropertyVariant' - description: The value to send to an asset property. timestamp: allOf: - $ref: '#/components/schemas/AssetPropertyTimestamp' - description: The timestamp associated with the asset property value. The default is the current event time. quality: allOf: - $ref: '#/components/schemas/AssetPropertyQuality' - description: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'. description:

A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

AssetPropertyId: type: string DetectorModelName: type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 maxLength: 128 DetectorModel: type: object properties: detectorModelDefinition: allOf: - $ref: '#/components/schemas/DetectorModelDefinition' - description: Information that defines how a detector operates. detectorModelConfiguration: allOf: - $ref: '#/components/schemas/DetectorModelConfiguration' - description: Information about how the detector is configured. description: Information about the detector model. OnEnterLifecycle: type: object properties: events: allOf: - $ref: '#/components/schemas/Events' - description: Specifies the actions that are performed when the state is entered and the condition is TRUE. description: When entering this state, perform these actions if the condition is TRUE. TagValue: type: string minLength: 0 maxLength: 256 Actions: type: array items: $ref: '#/components/schemas/Action' DynamoDBAction: type: object required: - hashKeyField - hashKeyValue - tableName properties: hashKeyType: allOf: - $ref: '#/components/schemas/DynamoKeyType' - description:

The data type for the hash key (also called the partition key). You can specify the following values:

If you don't specify hashKeyType, the default value is 'STRING'.

hashKeyField: allOf: - $ref: '#/components/schemas/DynamoKeyField' - description: The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table. hashKeyValue: allOf: - $ref: '#/components/schemas/DynamoKeyValue' - description: The value of the hash key (also called the partition key). rangeKeyType: allOf: - $ref: '#/components/schemas/DynamoKeyType' - description:

The data type for the range key (also called the sort key), You can specify the following values:

If you don't specify rangeKeyField, the default value is 'STRING'.

rangeKeyField: allOf: - $ref: '#/components/schemas/DynamoKeyField' - description: 'The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table. ' rangeKeyValue: allOf: - $ref: '#/components/schemas/DynamoKeyValue' - description: The value of the range key (also called the sort key). operation: allOf: - $ref: '#/components/schemas/DynamoOperation' - description: '

The type of operation to perform. You can specify the following values:

If you don''t specify this parameter, AWS IoT Events triggers the ''INSERT'' operation.

' payloadField: allOf: - $ref: '#/components/schemas/DynamoKeyField' - description:

The name of the DynamoDB column that receives the action payload.

If you don't specify this parameter, the name of the DynamoDB column is payload.

tableName: allOf: - $ref: '#/components/schemas/DynamoTableName' - description: 'The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table. ' payload: $ref: '#/components/schemas/Payload' description:

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 instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.

AssetPropertyAlias: type: string DetectorModelSummary: type: object properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelDescription: allOf: - $ref: '#/components/schemas/DetectorModelDescription' - description: A brief description of the detector model. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model was created. description: Information about the detector model. ContentExpression: type: string minLength: 1 DynamoKeyType: type: string AssetPropertyBooleanValue: type: string States: type: array items: $ref: '#/components/schemas/State' minItems: 1 DetectorModelVersionStatus: type: string enum: - ACTIVE - ACTIVATING - INACTIVE - DEPRECATED - DRAFT - PAUSED - FAILED DescribeDetectorModelResponse: type: object properties: detectorModel: allOf: - $ref: '#/components/schemas/DetectorModel' - description: Information about the detector model. 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. DetectorModelDescription: type: string maxLength: 128 OnInputLifecycle: type: object properties: events: allOf: - $ref: '#/components/schemas/Events' - description: Specifies the actions performed when the condition evaluates to TRUE. transitionEvents: allOf: - $ref: '#/components/schemas/TransitionEvents' - description: Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE. description: Specifies the actions performed when the condition evaluates to TRUE. DeliveryStreamName: type: string DeleteDetectorModelResponse: type: object properties: {} parameters: X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/iotevents/ x-hasEquivalentPaths: true