iotevents-2018-07-27
library
Classes
-
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.
-
AssetPropertyValue
-
A structure that contains value information. For more information, see AssetPropertyValue
in the AWS IoT SiteWise API Reference.
-
AssetPropertyVariant
-
A structure that contains an asset property value. For more information, see
Variant
in the AWS IoT SiteWise API Reference.
For parameters that are string data type, you can specify the following
options:
-
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.
-
AwsClientCredentials
-
AWS credentials.
-
ClearTimerAction
-
Information needed to clear the timer.
-
CreateDetectorModelResponse
-
-
CreateInputResponse
-
-
DeleteDetectorModelResponse
-
-
DeleteInputResponse
-
-
DescribeDetectorModelResponse
-
-
DescribeInputResponse
-
-
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.
-
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.
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.
-
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.
-
IotEventsAction
-
Sends an AWS IoT Events input, passing in information about the detector
model instance and the event that triggered the action.
-
IotSiteWiseAction
-
Sends information about the detector model instance and the event that
triggered the action to a specified asset property in AWS IoT SiteWise.
For parameters that are string data type, you can specify the following
options:
-
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.
-
ListDetectorModelsResponse
-
-
ListDetectorModelVersionsResponse
-
-
ListInputsResponse
-
-
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.
-
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.
-
SetTimerAction
-
Information needed to set the timer.
-
SetVariableAction
-
Information about the variable and its new value.
-
SNSTopicPublishAction
-
Information required to publish the Amazon SNS message.
-
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.
-
TagResourceResponse
-
-
TransitionEvent
-
Specifies the actions performed and the next state entered when a
condition
evaluates to TRUE.
-
UntagResourceResponse
-
-
UpdateDetectorModelResponse
-
-
UpdateInputResponse
-