Crate rusoto_iotevents

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

AcknowledgeFlow

Specifies whether to get notified for alarm state changes.

Action

An action to be performed when the condition is TRUE.

AlarmAction

Specifies one of the following actions to receive notifications when the alarm state changes.

AlarmCapabilities

Contains the configuration information of alarm state changes.

AlarmEventActions

Contains information about one or more alarm actions.

AlarmModelSummary

Contains a summary of an alarm model.

AlarmModelVersionSummary

Contains a summary of an alarm model version.

AlarmNotification

Contains information about one or more notification actions.

AlarmRule

Defines when your alarm is invoked.

AnalysisResult

Contains the result of the analysis.

AnalysisResultLocation

Contains information that you can use to locate the field in your detector model that the analysis result references.

AssetPropertyTimestamp

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.

AssetPropertyValue

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.

AssetPropertyVariant

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.

Attribute

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.

ClearTimerAction

Information needed to clear the timer.

CreateAlarmModelRequest

CreateAlarmModelResponse

CreateDetectorModelRequest

CreateDetectorModelResponse

CreateInputRequest

CreateInputResponse

DeleteAlarmModelRequest

DeleteAlarmModelResponse

DeleteDetectorModelRequest

DeleteDetectorModelResponse

DeleteInputRequest

DeleteInputResponse

DescribeAlarmModelRequest

DescribeAlarmModelResponse

DescribeDetectorModelAnalysisRequest

DescribeDetectorModelAnalysisResponse

DescribeDetectorModelRequest

DescribeDetectorModelResponse

DescribeInputRequest

DescribeInputResponse

DescribeLoggingOptionsRequest

DescribeLoggingOptionsResponse

DetectorDebugOption

The detector model and the specific detectors (instances) for which the logging level is given.

DetectorModel

Information about the detector model.

DetectorModelConfiguration

Information about how the detector model is configured.

DetectorModelDefinition

Information that defines how a detector operates.

DetectorModelSummary

Information about the detector model.

DetectorModelVersionSummary

Information about the detector model version.

DynamoDBAction

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.

DynamoDBv2Action

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.

EmailConfiguration

Contains the configuration information of email notifications.

EmailContent

Contains the subject and message of an email.

EmailRecipients

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.

Event

Specifies the actions to be performed when the condition evaluates to TRUE.

FirehoseAction

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

GetDetectorModelAnalysisResultsRequest

GetDetectorModelAnalysisResultsResponse

InitializationConfiguration

Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

Input

Information about the input.

InputConfiguration

Information about the configuration of an input.

InputDefinition

The definition of the input.

InputIdentifier

The identifer of the input.

InputSummary

Information about the input.

IotEventsAction

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

IotEventsClient

A client for the AWS IoT Events API.

IotEventsInputIdentifier

The identifier of the input routed to AWS IoT Events.

IotSiteWiseAction

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.

IotSiteWiseAssetModelPropertyIdentifier

The asset model property identifer of the input routed from AWS IoT SiteWise.

IotSiteWiseInputIdentifier

The identifer of the input routed from AWS IoT SiteWise.

IotTopicPublishAction

Information required to publish the MQTT message through the AWS IoT message broker.

LambdaAction

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

ListAlarmModelVersionsRequest

ListAlarmModelVersionsResponse

ListAlarmModelsRequest

ListAlarmModelsResponse

ListDetectorModelVersionsRequest

ListDetectorModelVersionsResponse

ListDetectorModelsRequest

ListDetectorModelsResponse

ListInputRoutingsRequest

ListInputRoutingsResponse

ListInputsRequest

ListInputsResponse

ListTagsForResourceRequest

ListTagsForResourceResponse

LoggingOptions

The values of the AWS IoT Events logging options.

NotificationAction

Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.

NotificationTargetActions

Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.

OnEnterLifecycle

When entering this state, perform these actions if the condition is TRUE.

OnExitLifecycle

When exiting this state, perform these actions if the specified condition is TRUE.

OnInputLifecycle

Specifies the actions performed when the condition evaluates to TRUE.

Payload

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.

PutLoggingOptionsRequest

RecipientDetail

The information that identifies the recipient.

ResetTimerAction

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.

RoutedResource

Contains information about the routed resource.

SMSConfiguration

Contains the configuration information of SMS notifications.

SNSTopicPublishAction

Information required to publish the Amazon SNS message.

SSOIdentity

Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide.

SetTimerAction

Information needed to set the timer.

SetVariableAction

Information about the variable and its new value.