Module Awso_iotevents_asyncSource

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

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.

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.

Information needed to clear the timer.

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

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

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

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.

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.

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.

Information required to publish the Amazon SNS message.

Information needed to set the timer.

Information about the variable and its new value.

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

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

An action to be performed when the condition is TRUE.

The information that identifies the recipient.

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

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

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.

Contains the configuration information of email notifications.

Contains the configuration information of SMS notifications.

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.

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

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

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 that defines a state of a detector.

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

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

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

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

Specifies whether to get notified for alarm state changes.

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

A rule that compares an input property value to a threshold value with a comparison operator.

Metadata that can be used to manage the resource.

Information about the input.

Contains information about the routed resource.

The identifier of the input routed to AWS IoT Events.

The identifer of the input routed from AWS IoT SiteWise.

Information about the detector model.

Information about the detector model version.

Contains a summary of an alarm model.

Contains a summary of an alarm model version.

Contains the result of the analysis.

Information about the configuration of an input.

The definition of the input.

Information about how the detector model is configured.

Information that defines how a detector operates.

An internal failure occurred.

The request was invalid.

The resource is in use.

The resource was not found.

The service is currently unavailable.

The request could not be completed due to throttling.

Contains the configuration information of alarm state changes.

Contains information about one or more alarm actions.

Contains information about one or more notification actions.

Defines when your alarm is invoked.

A limit was exceeded.

The values of the AWS IoT Events logging options.

The identifer of the input.

The requested operation is not supported.

Information about the input.

Information about the detector model.

The resource already exists.

Updates an input.

Updates an input.

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

Removes the given tags (metadata) from the resource.

Removes the given tags (metadata) from the resource.

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

Sets or updates the AWS IoT Events logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

Lists the tags (metadata) you have assigned to the resource.

Lists the tags (metadata) you have assigned to the resource.

Lists the inputs you have created.

Lists the inputs you have created.

Lists one or more input routings.

Lists one or more input routings.

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

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.

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.

Retrieves the current settings of the AWS IoT Events logging options.

Retrieves the current settings of the AWS IoT Events logging options.

Describes an input.

Describes an input.

Describes a detector model. If the version parameter is not specified, information about the latest version is returned.

Describes a detector model. If the version parameter is not specified, information about the latest version is returned.

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 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 information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

Deletes an input.

Deletes an input.

Deletes a detector model. Any active instances of the detector model are also deleted.

Deletes a detector model. Any active instances of the detector model are also deleted.

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

Creates an input.

Creates an input.

Creates a detector model.

Creates a detector model.

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.