Crate rusoto_iotevents
source · [−]Expand 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.
If you’re using the service, you’re probably looking for IotEventsClient and IotEvents.
Structs
Specifies whether to get notified for alarm state changes.
An action to be performed when the condition
is TRUE.
Specifies one of the following actions to receive notifications when the alarm state changes.
Contains the configuration information of alarm state changes.
Contains information about one or more alarm actions.
Contains a summary of an alarm model.
Contains a summary of an alarm model version.
Contains information about one or more notification actions.
Defines when your alarm is invoked.
Contains the result of the analysis.
Contains information that you can use to locate the field in your detector model that the analysis result references.
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.
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.
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.
The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage
. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the condition
expressions used by detectors.
Information needed to clear the timer.
The detector model and the specific detectors (instances) for which the logging level is given.
Information about the detector model.
Information about how the detector model is configured.
Information that defines how a detector operates.
Information about the detector model.
Information about the detector model version.
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
.
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 inPayload
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
.
Contains the configuration information of email notifications.
Contains the subject and message of an email.
Contains the information of one or more recipients who receive the emails.
You must add the users that receive emails to your AWS SSO store.
Specifies the actions
to be performed when the condition
evaluates to TRUE.
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
Information about the input.
Information about the configuration of an input.
The definition of the input.
The identifer of the input.
Information about the input.
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
A client for the AWS IoT Events API.
The identifier of the input routed to AWS IoT Events.
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.
The asset model property identifer of the input routed from AWS IoT SiteWise.
The identifer of the input routed from AWS IoT SiteWise.
Information required to publish the MQTT message through the AWS IoT message broker.
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
The values of the AWS IoT Events logging options.
Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
When entering this state, perform these actions
if the condition
is TRUE.
When exiting this state, perform these actions
if the specified condition
is TRUE
.
Specifies the actions performed when the condition
evaluates to TRUE.
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 information that identifies the recipient.
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.
Contains information about the routed resource.
Contains the configuration information of SMS notifications.
Information required to publish the Amazon SNS message.
Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide.
Information needed to set the timer.
Information about the variable and its new value.
A rule that compares an input property value to a threshold value with a comparison operator.
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
Information that defines a state of a detector.
Metadata that can be used to manage the resource.
Specifies the actions performed and the next state entered when a condition
evaluates to TRUE.
Enums
Errors returned by CreateAlarmModel
Errors returned by CreateDetectorModel
Errors returned by CreateInput
Errors returned by DeleteAlarmModel
Errors returned by DeleteDetectorModel
Errors returned by DeleteInput
Errors returned by DescribeAlarmModel
Errors returned by DescribeDetectorModelAnalysis
Errors returned by DescribeDetectorModel
Errors returned by DescribeInput
Errors returned by DescribeLoggingOptions
Errors returned by GetDetectorModelAnalysisResults
Errors returned by ListAlarmModelVersions
Errors returned by ListAlarmModels
Errors returned by ListDetectorModelVersions
Errors returned by ListDetectorModels
Errors returned by ListInputRoutings
Errors returned by ListInputs
Errors returned by ListTagsForResource
Errors returned by PutLoggingOptions
Errors returned by StartDetectorModelAnalysis
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateAlarmModel
Errors returned by UpdateDetectorModel
Errors returned by UpdateInput
Traits
Trait representing the capabilities of the AWS IoT Events API. AWS IoT Events clients implement this trait.