Module Awso_iotevents.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule AssetPropertyBooleanValue : sig ... end
Sourcemodule AssetPropertyDoubleValue : sig ... end
Sourcemodule AssetPropertyIntegerValue : sig ... end
Sourcemodule AssetPropertyStringValue : sig ... end
Sourcemodule ContentExpression : sig ... end
Sourcemodule PayloadType : sig ... end
Sourcemodule AssetPropertyQuality : sig ... end
Sourcemodule AssetPropertyTimestamp : sig ... end

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.

Sourcemodule AssetPropertyVariant : sig ... end

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.

Sourcemodule TimerName : sig ... end
Sourcemodule DynamoKeyField : sig ... end
Sourcemodule DynamoKeyType : sig ... end
Sourcemodule DynamoKeyValue : sig ... end
Sourcemodule DynamoOperation : sig ... end
Sourcemodule DynamoTableName : sig ... end
Sourcemodule Payload : sig ... end

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.

Sourcemodule DeliveryStreamName : sig ... end
Sourcemodule FirehoseSeparator : sig ... end
Sourcemodule InputName : sig ... end
Sourcemodule AssetId : sig ... end
Sourcemodule AssetPropertyAlias : sig ... end
Sourcemodule AssetPropertyEntryId : sig ... end
Sourcemodule AssetPropertyId : sig ... end
Sourcemodule AssetPropertyValue : sig ... end

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.

Sourcemodule MQTTTopic : sig ... end
Sourcemodule AmazonResourceName : sig ... end
Sourcemodule Seconds : sig ... end
Sourcemodule VariableValue : sig ... end
Sourcemodule VariableName : sig ... end
Sourcemodule QueueUrl : sig ... end
Sourcemodule UseBase64 : sig ... end
Sourcemodule IdentityStoreId : sig ... end
Sourcemodule SSOReferenceId : sig ... end
Sourcemodule ClearTimerAction : sig ... end

Information needed to clear the timer.

Sourcemodule DynamoDBAction : sig ... end

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.

Sourcemodule DynamoDBv2Action : sig ... end

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.

Sourcemodule FirehoseAction : sig ... end

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

Sourcemodule IotEventsAction : sig ... end

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

Sourcemodule IotSiteWiseAction : sig ... end

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.

Sourcemodule IotTopicPublishAction : sig ... end

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

Sourcemodule LambdaAction : sig ... end

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

Sourcemodule ResetTimerAction : sig ... end

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.

Sourcemodule SNSTopicPublishAction : sig ... end

Information required to publish the Amazon SNS message.

Sourcemodule SetTimerAction : sig ... end

Information needed to set the timer.

Sourcemodule SetVariableAction : sig ... end

Information about the variable and its new value.

Sourcemodule SqsAction : sig ... end

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

Sourcemodule SSOIdentity : sig ... end

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

Sourcemodule Action : sig ... end

An action to be performed when the condition is TRUE.

Sourcemodule RecipientDetail : sig ... end

The information that identifies the recipient.

Sourcemodule Actions : sig ... end
Sourcemodule Condition : sig ... end
Sourcemodule EventName : sig ... end
Sourcemodule StateName : sig ... end
Sourcemodule EmailSubject : sig ... end
Sourcemodule RecipientDetails : sig ... end
Sourcemodule Event : sig ... end

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

Sourcemodule TransitionEvent : sig ... end

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

Sourcemodule EmailContent : sig ... end

Contains the subject and message of an email.

Sourcemodule EmailRecipients : sig ... end

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.

Sourcemodule FromEmail : sig ... end
Sourcemodule SMSSenderId : sig ... end
Sourcemodule Events : sig ... end
Sourcemodule TransitionEvents : sig ... end
Sourcemodule EmailConfiguration : sig ... end

Contains the configuration information of email notifications.

Sourcemodule SMSConfiguration : sig ... end

Contains the configuration information of SMS notifications.

Sourcemodule AttributeJsonPath : sig ... end
Sourcemodule OnEnterLifecycle : sig ... end

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

Sourcemodule OnExitLifecycle : sig ... end

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

Sourcemodule OnInputLifecycle : sig ... end

Specifies the actions performed when the condition evaluates to TRUE.

Sourcemodule EmailConfigurations : sig ... end
Sourcemodule NotificationTargetActions : sig ... end

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

Sourcemodule SMSConfigurations : sig ... end
Sourcemodule DetectorModelName : sig ... end
Sourcemodule KeyValue : sig ... end
Sourcemodule AssetModelId : sig ... end
Sourcemodule AnalysisResultLocation : sig ... end

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

Sourcemodule Attribute : sig ... end

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.

Sourcemodule State : sig ... end

Information that defines a state of a detector.

Sourcemodule AcknowledgeFlowEnabled : sig ... end
Sourcemodule DisabledOnInitialization : sig ... end
Sourcemodule AlarmAction : sig ... end

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

Sourcemodule NotificationAction : sig ... end

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

Sourcemodule ComparisonOperator : sig ... end
Sourcemodule InputProperty : sig ... end
Sourcemodule Threshold : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule DetectorDebugOption : sig ... end

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

Sourcemodule InputArn : sig ... end
Sourcemodule InputDescription : sig ... end
Sourcemodule InputStatus : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule ResourceName : sig ... end

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

Sourcemodule DetectorModelDescription : sig ... end
Sourcemodule DetectorModelArn : sig ... end
Sourcemodule DetectorModelVersion : sig ... end
Sourcemodule EvaluationMethod : sig ... end
Sourcemodule AlarmModelDescription : sig ... end
Sourcemodule AlarmModelName : sig ... end
Sourcemodule AlarmModelArn : sig ... end
Sourcemodule AlarmModelVersion : sig ... end
Sourcemodule AlarmModelVersionStatus : sig ... end
Sourcemodule StatusMessage : sig ... end
Sourcemodule AnalysisMessage : sig ... end
Sourcemodule AnalysisResultLevel : sig ... end
Sourcemodule AnalysisResultLocations : sig ... end
Sourcemodule AnalysisType : sig ... end
Sourcemodule Attributes : sig ... end
Sourcemodule States : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule AcknowledgeFlow : sig ... end

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.

Sourcemodule AlarmActions : sig ... end
Sourcemodule NotificationActions : sig ... end
Sourcemodule SimpleRule : sig ... end

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

Sourcemodule Tag : sig ... end

Metadata that can be used to manage the resource.

Sourcemodule DetectorDebugOptions : sig ... end
Sourcemodule LoggingEnabled : sig ... end
Sourcemodule LoggingLevel : sig ... end
Sourcemodule InputSummary : sig ... end

Information about the input.

Sourcemodule RoutedResource : sig ... end

Contains information about the routed resource.

Sourcemodule IotEventsInputIdentifier : sig ... end

The identifier of the input routed to AWS IoT Events.

The identifer of the input routed from AWS IoT SiteWise.

Sourcemodule DetectorModelSummary : sig ... end

Information about the detector model.

Information about the detector model version.

Sourcemodule AlarmModelSummary : sig ... end

Contains a summary of an alarm model.

Sourcemodule AlarmModelVersionSummary : sig ... end

Contains a summary of an alarm model version.

Sourcemodule AnalysisResult : sig ... end

Contains the result of the analysis.

Sourcemodule InputConfiguration : sig ... end

Information about the configuration of an input.

Sourcemodule InputDefinition : sig ... end

The definition of the input.

Information about how the detector model is configured.

Sourcemodule DetectorModelDefinition : sig ... end

Information that defines how a detector operates.

Sourcemodule ResourceArn : sig ... end
Sourcemodule ResourceId : sig ... end
Sourcemodule InternalFailureException : sig ... end

An internal failure occurred.

Sourcemodule InvalidRequestException : sig ... end

The request was invalid.

Sourcemodule ResourceInUseException : sig ... end

The resource is in use.

Sourcemodule ResourceNotFoundException : sig ... end

The resource was not found.

The service is currently unavailable.

Sourcemodule ThrottlingException : sig ... end

The request could not be completed due to throttling.

Sourcemodule AlarmCapabilities : sig ... end

Contains the configuration information of alarm state changes.

Sourcemodule AlarmEventActions : sig ... end

Contains information about one or more alarm actions.

Sourcemodule AlarmNotification : sig ... end

Contains information about one or more notification actions.

Sourcemodule AlarmRule : sig ... end

Defines when your alarm is invoked.

Sourcemodule Severity : sig ... end
Sourcemodule TagKeys : sig ... end
Sourcemodule LimitExceededException : sig ... end

A limit was exceeded.

Sourcemodule Tags : sig ... end
Sourcemodule AnalysisId : sig ... end
Sourcemodule LoggingOptions : sig ... end

The values of the AWS IoT Events logging options.

Sourcemodule InputSummaries : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule RoutedResources : sig ... end
Sourcemodule InputIdentifier : sig ... end

The identifer of the input.

Sourcemodule DetectorModelSummaries : sig ... end
Sourcemodule AlarmModelSummaries : sig ... end
Sourcemodule AnalysisResults : sig ... end
Sourcemodule MaxAnalysisResults : sig ... end

The requested operation is not supported.

Sourcemodule Input : sig ... end

Information about the input.

Sourcemodule DetectorModel : sig ... end

Information about the detector model.

Sourcemodule AnalysisStatus : sig ... end

The resource already exists.

Sourcemodule UpdateInputResponse : sig ... end

Updates an input.

Sourcemodule UpdateInputRequest : sig ... end

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.

Sourcemodule UpdateAlarmModelResponse : sig ... end

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

Sourcemodule UpdateAlarmModelRequest : sig ... end

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

Sourcemodule UntagResourceResponse : sig ... end

Removes the given tags (metadata) from the resource.

Sourcemodule UntagResourceRequest : sig ... end

Removes the given tags (metadata) from the resource.

Sourcemodule TagResourceResponse : sig ... end

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

Sourcemodule TagResourceRequest : sig ... end

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.

Sourcemodule PutLoggingOptionsRequest : sig ... end

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.

Sourcemodule ListInputsResponse : sig ... end

Lists the inputs you have created.

Sourcemodule ListInputsRequest : sig ... end

Lists the inputs you have created.

Sourcemodule ListInputRoutingsResponse : sig ... end

Lists one or more input routings.

Sourcemodule ListInputRoutingsRequest : sig ... end

Lists one or more input routings.

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

Sourcemodule ListDetectorModelsRequest : sig ... end

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.

Sourcemodule ListAlarmModelsResponse : sig ... end

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

Sourcemodule ListAlarmModelsRequest : sig ... end

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.

Sourcemodule DescribeInputResponse : sig ... end

Describes an input.

Sourcemodule DescribeInputRequest : sig ... end

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.

Sourcemodule DescribeAlarmModelRequest : sig ... end

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

Sourcemodule DeleteInputResponse : sig ... end

Deletes an input.

Sourcemodule DeleteInputRequest : sig ... end

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.

Sourcemodule DeleteAlarmModelResponse : sig ... end

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

Sourcemodule DeleteAlarmModelRequest : sig ... end

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

Sourcemodule CreateInputResponse : sig ... end

Creates an input.

Sourcemodule CreateInputRequest : sig ... end

Creates an input.

Creates a detector model.

Creates a detector model.

Sourcemodule CreateAlarmModelResponse : sig ... end

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.

Sourcemodule CreateAlarmModelRequest : sig ... end

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.