Retrieves runtime information about a detector model analysis.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
Retrieves one or more analysis results of the detector model.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
$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.
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 literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'.
For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the doubleValue parameter uses a substitution template.
'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'
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.
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.
VariableName:
type: string
pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
minLength: 1
maxLength: 128
FirehoseSeparator:
type: string
pattern: ([\n\t])|(\r\n)|(,)
AssetId:
type: string
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.
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
MQTTTopic:
type: string
minLength: 1
maxLength: 128
DynamoKeyField:
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.
AnalysisResults:
type: array
items:
$ref: '#/components/schemas/AnalysisResult'
UseBase64:
type: boolean
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
For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.
For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the propertyAlias parameter uses a substitution template.
'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
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.
AssetPropertyTimeInSeconds: type: string 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. 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 fromtimeInSeconds. 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 literal values, the expressions must contain single quotes. For example, the value for the timeInSeconds parameter can be '1586400675'.
For references, you must specify either variables or input values. For example, the value for the offsetInNanos parameter can be $variable.time.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the timeInSeconds parameter uses a substitution template.
'${$input.TemperatureInput.sensorData.timestamp / 1000}'
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 literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be ''GreenhouseTemperatureTable''.
For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the contentExpression parameter in Payload uses a substitution template.
''{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}''
For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the tableName parameter uses a string concatenation.
''GreenhouseTemperatureTable '' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
The value for the type parameter in Payload must be JSON.
$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.
The status of the analysis activity. The status can be one of the following values:
RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.
COMPLETE - AWS IoT Events finished analyzing your detector model.
FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.
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.
ResourceNotFoundException: {}
AssetPropertyDoubleValue:
type: string
StartDetectorModelAnalysisResponse:
type: object
properties:
analysisId:
allOf:
- $ref: '#/components/schemas/AnalysisId'
- description: The ID that you can use to retrieve the analysis result.
AnalysisId:
type: string
AnalysisType:
type: string
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 literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD'.
For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality.
For more information, see Expressions in the AWS IoT Events Developer Guide.
AssetPropertyId: type: string AnalysisResult: type: object properties: type: allOf: - $ref: '#/components/schemas/AnalysisType' - description:The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.
structure - The detector model must follow a structure that AWS IoT Events supports.
expression-syntax - Your expression must follow the required syntax.
data-type - Data types referenced in the detector model must be compatible.
referenced-data - You must define the data referenced in your detector model before you can use the data.
referenced-resource - Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
level: allOf: - $ref: '#/components/schemas/AnalysisResultLevel' - description:The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.
WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
condition is TRUE.
description: When entering this state, perform these actions if the condition is TRUE.
AnalysisResultLocation:
type: object
properties:
path:
allOf:
- $ref: '#/components/schemas/AnalysisResultLocationPath'
- description: A JsonPath expression that identifies the error field in your detector model.
description: Contains information that you can use to locate the field in your detector model that the analysis result references.
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:
'STRING' - The hash key is a string.
'NUMBER' - The hash key is a number.
If you don't specify hashKeyType, the default value is 'STRING'.
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:
'STRING' - The range key is a string.
'NUMBER' - The range key is number.
If you don't specify rangeKeyField, the default value is 'STRING'.
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:
''INSERT'' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
''UPDATE'' - Update an existing item of the DynamoDB table with new data. This item''s partition key must match the specified hash key. If you specified a range key, the range key must match the item''s sort key.
''DELETE'' - Delete an existing item of the DynamoDB table. This item''s partition key must match the specified hash key. If you specified a range key, the range key must match the item''s sort key.
If you don''t specify this parameter, AWS IoT Events triggers the ''INSERT'' operation.
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 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 literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.
For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the hashKeyValue parameter uses a substitution template.
'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'
For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the tableName parameter uses a string concatenation.
'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
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.
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.
GetDetectorModelAnalysisResultsResponse:
type: object
properties:
analysisResults:
allOf:
- $ref: '#/components/schemas/AnalysisResults'
- description: Contains information about one or more analysis results.
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.
DeliveryStreamName:
type: string
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