Crate rusoto_iotevents

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

Action

An action to be performed when the condition is TRUE.

AssetPropertyTimestamp

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

For parameters that are string data type, you can specify the following options:

• Use a string. For example, the timeInSeconds value can be '1586400675'.

• Use an expression. For example, the timeInSeconds value can be '${$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.

For parameters that are string data type, you can specify the following options:

• Use a string. For example, the quality value can be 'GOOD'.

• Use an expression. For example, the quality value 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 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.

For parameters that are string data type, you can specify the following options:

• Use a string. For example, the doubleValue value can be '47.9'.

• Use an expression. For example, the doubleValue value can be $input.TemperatureInput.sensorData.temperature.

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

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.

CreateDetectorModelRequest

CreateDetectorModelResponse

CreateInputRequest

CreateInputResponse

DeleteDetectorModelRequest

DeleteDetectorModelResponse

DeleteInputRequest

DeleteInputResponse

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

The tableName and hashKeyField values must match the table name and the partition key of the DynamoDB table.

If the DynamoDB table also has a sort key, you must specify rangeKeyField. The rangeKeyField value must match the sort key.

The hashKeyValue and rangeKeyValue use substitution templates. These templates provide data at runtime. The syntax is ${sql-expression}.

You can use expressions for parameters that are string data type. 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 payloadField is <payload-field>_raw.

DynamoDBv2Action

Defines an action to write to the Amazon 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 also customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

The type value for Payload must be JSON.

You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide.

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.

Input

Information about the input.

InputConfiguration

Information about the configuration of an input.

InputDefinition

The definition 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.

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 specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For parameters that are string data type, you can specify the following options:

• Use a string. For example, the propertyAlias value can be '/company/windfarm/3/turbine/7/temperature'.

• Use an expression. For example, the propertyAlias value can be 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature'.

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

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.

ListDetectorModelVersionsRequest

ListDetectorModelVersionsResponse

ListDetectorModelsRequest

ListDetectorModelsResponse

ListInputsRequest

ListInputsResponse

ListTagsForResourceRequest

ListTagsForResourceResponse

LoggingOptions

The values of the AWS IoT Events logging options.

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

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.

SNSTopicPublishAction

Information required to publish the Amazon SNS message.

SetTimerAction

Information needed to set the timer.

SetVariableAction

Information about the variable and its new value.

SqsAction

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

State

Information that defines a state of a detector.

Tag

Metadata that can be used to manage the resource.

TagResourceRequest

TagResourceResponse

TransitionEvent

Specifies the actions performed and the next state entered when a condition evaluates to TRUE.

UntagResourceRequest

UntagResourceResponse

UpdateDetectorModelRequest

UpdateDetectorModelResponse

UpdateInputRequest

UpdateInputResponse

Enums

CreateDetectorModelError

Errors returned by CreateDetectorModel

CreateInputError

Errors returned by CreateInput

DeleteDetectorModelError

Errors returned by DeleteDetectorModel

DeleteInputError

Errors returned by DeleteInput

DescribeDetectorModelError

Errors returned by DescribeDetectorModel

DescribeInputError

Errors returned by DescribeInput

DescribeLoggingOptionsError

Errors returned by DescribeLoggingOptions

ListDetectorModelVersionsError

Errors returned by ListDetectorModelVersions

ListDetectorModelsError

Errors returned by ListDetectorModels

ListInputsError

Errors returned by ListInputs

ListTagsForResourceError

Errors returned by ListTagsForResource

PutLoggingOptionsError

Errors returned by PutLoggingOptions

TagResourceError

Errors returned by TagResource

UntagResourceError

Errors returned by UntagResource

UpdateDetectorModelError

Errors returned by UpdateDetectorModel

UpdateInputError

Errors returned by UpdateInput

Traits

IotEvents

Trait representing the capabilities of the AWS IoT Events API. AWS IoT Events clients implement this trait.