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.
", "operations": { "CreateDetectorModel": "Creates a detector model.
", "CreateInput": "Creates an input.
", "DeleteDetectorModel": "Deletes a detector model. Any active instances of the detector model are also deleted.
", "DeleteInput": "Deletes an input.
", "DescribeDetectorModel": "Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
Describes an input.
", "DescribeLoggingOptions": "Retrieves the current settings of the AWS IoT Events logging options.
", "ListDetectorModelVersions": "Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
", "ListDetectorModels": "Lists the detector models you have created. Only the metadata associated with each detector model is returned.
", "ListInputs": "Lists the inputs you have created.
", "ListTagsForResource": "Lists the tags (metadata) you have assigned to the resource.
", "PutLoggingOptions": "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.
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
", "UntagResource": "Removes the given tags (metadata) from the resource.
", "UpdateDetectorModel": "Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
", "UpdateInput": "Updates an input.
" }, "shapes": { "Action": { "base": "An action to be performed when the condition is TRUE.
The actions to be performed.
", "TransitionEvent$actions": "The actions to be performed.
" } }, "AmazonResourceName": { "base": null, "refs": { "CreateDetectorModelRequest$roleArn": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.
", "DetectorModelConfiguration$roleArn": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.
", "DetectorModelVersionSummary$roleArn": "The ARN of the role that grants the detector model permission to perform its tasks.
", "LambdaAction$functionArn": "The ARN of the Lambda function that is executed.
", "ListTagsForResourceRequest$resourceArn": "The ARN of the resource.
", "LoggingOptions$roleArn": "The ARN of the role that grants permission to AWS IoT Events to perform logging.
", "SNSTopicPublishAction$targetArn": "The ARN of the Amazon SNS target where the message is sent.
", "TagResourceRequest$resourceArn": "The ARN of the resource.
", "UntagResourceRequest$resourceArn": "The ARN of the resource.
", "UpdateDetectorModelRequest$roleArn": "The ARN of the role that grants permission to AWS IoT Events to perform its operations.
" } }, "AssetId": { "base": null, "refs": { "IotSiteWiseAction$assetId": "The ID of the asset that has the specified property. You can specify an expression.
" } }, "AssetPropertyAlias": { "base": null, "refs": { "IotSiteWiseAction$propertyAlias": "The alias of the asset property. You can also specify an expression.
" } }, "AssetPropertyBooleanValue": { "base": null, "refs": { "AssetPropertyVariant$booleanValue": "The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.
The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.
" } }, "AssetPropertyEntryId": { "base": null, "refs": { "IotSiteWiseAction$entryId": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.
" } }, "AssetPropertyId": { "base": null, "refs": { "IotSiteWiseAction$propertyId": "The ID of the asset property. You can specify an expression.
" } }, "AssetPropertyIntegerValue": { "base": null, "refs": { "AssetPropertyVariant$integerValue": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.
" } }, "AssetPropertyOffsetInNanos": { "base": null, "refs": { "AssetPropertyTimestamp$offsetInNanos": "The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.
The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.
The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.
" } }, "AssetPropertyTimeInSeconds": { "base": null, "refs": { "AssetPropertyTimestamp$timeInSeconds": "The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.
" } }, "AssetPropertyTimestamp": { "base": "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.
The timestamp associated with the asset property value. The default is the current event time.
" } }, "AssetPropertyValue": { "base": "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.
The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
" } }, "AssetPropertyVariant": { "base": "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.
The value to send to an asset property.
" } }, "Attribute": { "base": "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.
An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.
Syntax: <field-name>.<field-name>...
The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
", "DetectorModelConfiguration$key": "The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
" } }, "Attributes": { "base": null, "refs": { "InputDefinition$attributes": "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, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.
Information needed to clear the timer.
", "refs": { "Action$clearTimer": "Information needed to clear the timer.
" } }, "Condition": { "base": null, "refs": { "Event$condition": "Optional. The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The name of the Kinesis Data Firehose delivery stream where the data is written.
" } }, "DescribeDetectorModelRequest": { "base": null, "refs": { } }, "DescribeDetectorModelResponse": { "base": null, "refs": { } }, "DescribeInputRequest": { "base": null, "refs": { } }, "DescribeInputResponse": { "base": null, "refs": { } }, "DescribeLoggingOptionsRequest": { "base": null, "refs": { } }, "DescribeLoggingOptionsResponse": { "base": null, "refs": { } }, "DetectorDebugOption": { "base": "The detector model and the specific detectors (instances) for which the logging level is given.
", "refs": { "DetectorDebugOptions$member": null } }, "DetectorDebugOptions": { "base": null, "refs": { "LoggingOptions$detectorDebugOptions": "Information that identifies those detector models and their detectors (instances) for which the logging level is given.
" } }, "DetectorModel": { "base": "Information about the detector model.
", "refs": { "DescribeDetectorModelResponse$detectorModel": "Information about the detector model.
" } }, "DetectorModelArn": { "base": null, "refs": { "DetectorModelConfiguration$detectorModelArn": "The ARN of the detector model.
", "DetectorModelVersionSummary$detectorModelArn": "The ARN of the detector model version.
" } }, "DetectorModelConfiguration": { "base": "Information about how the detector model is configured.
", "refs": { "CreateDetectorModelResponse$detectorModelConfiguration": "Information about how the detector model is configured.
", "DetectorModel$detectorModelConfiguration": "Information about how the detector is configured.
", "UpdateDetectorModelResponse$detectorModelConfiguration": "Information about how the detector model is configured.
" } }, "DetectorModelDefinition": { "base": "Information that defines how a detector operates.
", "refs": { "CreateDetectorModelRequest$detectorModelDefinition": "Information that defines how the detectors operate.
", "DetectorModel$detectorModelDefinition": "Information that defines how a detector operates.
", "UpdateDetectorModelRequest$detectorModelDefinition": "Information that defines how a detector operates.
" } }, "DetectorModelDescription": { "base": null, "refs": { "CreateDetectorModelRequest$detectorModelDescription": "A brief description of the detector model.
", "DetectorModelConfiguration$detectorModelDescription": "A brief description of the detector model.
", "DetectorModelSummary$detectorModelDescription": "A brief description of the detector model.
", "UpdateDetectorModelRequest$detectorModelDescription": "A brief description of the detector model.
" } }, "DetectorModelName": { "base": null, "refs": { "CreateDetectorModelRequest$detectorModelName": "The name of the detector model.
", "DeleteDetectorModelRequest$detectorModelName": "The name of the detector model to be deleted.
", "DescribeDetectorModelRequest$detectorModelName": "The name of the detector model.
", "DetectorDebugOption$detectorModelName": "The name of the detector model.
", "DetectorModelConfiguration$detectorModelName": "The name of the detector model.
", "DetectorModelSummary$detectorModelName": "The name of the detector model.
", "DetectorModelVersionSummary$detectorModelName": "The name of the detector model.
", "ListDetectorModelVersionsRequest$detectorModelName": "The name of the detector model whose versions are returned.
", "UpdateDetectorModelRequest$detectorModelName": "The name of the detector model that is updated.
" } }, "DetectorModelSummaries": { "base": null, "refs": { "ListDetectorModelsResponse$detectorModelSummaries": "Summary information about the detector models.
" } }, "DetectorModelSummary": { "base": "Information about the detector model.
", "refs": { "DetectorModelSummaries$member": null } }, "DetectorModelVersion": { "base": null, "refs": { "DescribeDetectorModelRequest$detectorModelVersion": "The version of the detector model.
", "DetectorModelConfiguration$detectorModelVersion": "The version of the detector model.
", "DetectorModelVersionSummary$detectorModelVersion": "The ID of the detector model version.
" } }, "DetectorModelVersionStatus": { "base": null, "refs": { "DetectorModelConfiguration$status": "The status of the detector model.
", "DetectorModelVersionSummary$status": "The status of the detector model version.
" } }, "DetectorModelVersionSummaries": { "base": null, "refs": { "ListDetectorModelVersionsResponse$detectorModelVersionSummaries": "Summary information about the detector model versions.
" } }, "DetectorModelVersionSummary": { "base": "Information about the detector model version.
", "refs": { "DetectorModelVersionSummaries$member": null } }, "DynamoDBAction": { "base": "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.
Writes to the 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. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
" } }, "DynamoDBv2Action": { "base": "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.
", "refs": { "Action$dynamoDBv2": "Writes to the 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. For more information, see Actions in AWS IoT Events Developer Guide.
" } }, "DynamoKeyField": { "base": null, "refs": { "DynamoDBAction$hashKeyField": "The name of the hash key (also called the partition key).
", "DynamoDBAction$rangeKeyField": "The name of the range key (also called the sort key).
", "DynamoDBAction$payloadField": "The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is payload.
The data type for the hash key (also called the partition key). You can specify the following values:
STRING - The hash key is a string.
NUMBER - The hash key is a number.
If you don't specify hashKeyType, the default value is STRING.
The data type for the range key (also called the sort key), You can specify the following values:
STRING - The range key is a string.
NUMBER - The range key is number.
If you don't specify rangeKeyField, the default value is STRING.
The value of the hash key (also called the partition key).
", "DynamoDBAction$rangeKeyValue": "The value of the range key (also called the sort key).
" } }, "DynamoOperation": { "base": null, "refs": { "DynamoDBAction$operation": "The type of operation to perform. You can specify the following values:
INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
The name of the DynamoDB table.
", "DynamoDBv2Action$tableName": "The name of the DynamoDB table.
" } }, "EvaluationMethod": { "base": null, "refs": { "CreateDetectorModelRequest$evaluationMethod": "Information about the order in which events are evaluated and how actions are executed.
", "DetectorModelConfiguration$evaluationMethod": "Information about the order in which events are evaluated and how actions are executed.
", "DetectorModelVersionSummary$evaluationMethod": "Information about the order in which events are evaluated and how actions are executed.
", "UpdateDetectorModelRequest$evaluationMethod": "Information about the order in which events are evaluated and how actions are executed.
" } }, "Event": { "base": "Specifies the actions to be performed when the condition evaluates to TRUE.
The name of the event.
", "TransitionEvent$eventName": "The name of the transition event.
" } }, "Events": { "base": null, "refs": { "OnEnterLifecycle$events": "Specifies the actions that are performed when the state is entered and the condition is TRUE.
Specifies the actions that are performed when the state is exited and the condition is TRUE.
Specifies the actions performed when the condition evaluates to TRUE.
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
", "refs": { "Action$firehose": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
" } }, "FirehoseSeparator": { "base": null, "refs": { "FirehoseAction$separator": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).
" } }, "Input": { "base": "Information about the input.
", "refs": { "DescribeInputResponse$input": "Information about the input.
" } }, "InputArn": { "base": null, "refs": { "InputConfiguration$inputArn": "The ARN of the input.
", "InputSummary$inputArn": "The ARN of the input.
" } }, "InputConfiguration": { "base": "Information about the configuration of an input.
", "refs": { "CreateInputResponse$inputConfiguration": "Information about the configuration of the input.
", "Input$inputConfiguration": "Information about the configuration of an input.
", "UpdateInputResponse$inputConfiguration": "Information about the configuration of the input.
" } }, "InputDefinition": { "base": "The definition of the input.
", "refs": { "CreateInputRequest$inputDefinition": "The definition of the input.
", "Input$inputDefinition": "The definition of the input.
", "UpdateInputRequest$inputDefinition": "The definition of the input.
" } }, "InputDescription": { "base": null, "refs": { "CreateInputRequest$inputDescription": "A brief description of the input.
", "InputConfiguration$inputDescription": "A brief description of the input.
", "InputSummary$inputDescription": "A brief description of the input.
", "UpdateInputRequest$inputDescription": "A brief description of the input.
" } }, "InputName": { "base": null, "refs": { "CreateInputRequest$inputName": "The name you want to give to the input.
", "DeleteInputRequest$inputName": "The name of the input to delete.
", "DescribeInputRequest$inputName": "The name of the input.
", "InputConfiguration$inputName": "The name of the input.
", "InputSummary$inputName": "The name of the input.
", "IotEventsAction$inputName": "The name of the AWS IoT Events input where the data is sent.
", "UpdateInputRequest$inputName": "The name of the input you want to update.
" } }, "InputStatus": { "base": null, "refs": { "InputConfiguration$status": "The status of the input.
", "InputSummary$status": "The status of the input.
" } }, "InputSummaries": { "base": null, "refs": { "ListInputsResponse$inputSummaries": "Summary information about the inputs.
" } }, "InputSummary": { "base": "Information about the input.
", "refs": { "InputSummaries$member": null } }, "InternalFailureException": { "base": "An internal failure occurred.
", "refs": { } }, "InvalidRequestException": { "base": "The request was invalid.
", "refs": { } }, "IotEventsAction": { "base": "Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
", "refs": { "Action$iotEvents": "Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
" } }, "IotSiteWiseAction": { "base": "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.
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
" } }, "IotTopicPublishAction": { "base": "Information required to publish the MQTT message through the AWS IoT message broker.
", "refs": { "Action$iotTopicPublish": "Publishes an MQTT message with the given topic to the AWS IoT message broker.
" } }, "KeyValue": { "base": null, "refs": { "DetectorDebugOption$keyValue": "The value of the input attribute key used to create the detector (the instance of the detector model).
" } }, "LambdaAction": { "base": "Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
", "refs": { "Action$lambda": "Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
" } }, "LimitExceededException": { "base": "A limit was exceeded.
", "refs": { } }, "ListDetectorModelVersionsRequest": { "base": null, "refs": { } }, "ListDetectorModelVersionsResponse": { "base": null, "refs": { } }, "ListDetectorModelsRequest": { "base": null, "refs": { } }, "ListDetectorModelsResponse": { "base": null, "refs": { } }, "ListInputsRequest": { "base": null, "refs": { } }, "ListInputsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "LoggingEnabled": { "base": null, "refs": { "LoggingOptions$enabled": "If TRUE, logging is enabled for AWS IoT Events.
" } }, "LoggingLevel": { "base": null, "refs": { "LoggingOptions$level": "The logging level.
" } }, "LoggingOptions": { "base": "The values of the AWS IoT Events logging options.
", "refs": { "DescribeLoggingOptionsResponse$loggingOptions": "The current settings of the AWS IoT Events logging options.
", "PutLoggingOptionsRequest$loggingOptions": "The new values of the AWS IoT Events logging options.
" } }, "MQTTTopic": { "base": null, "refs": { "IotTopicPublishAction$mqttTopic": "The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.
The maximum number of results to return at one time.
", "ListDetectorModelsRequest$maxResults": "The maximum number of results to return at one time.
", "ListInputsRequest$maxResults": "The maximum number of results to return at one time.
" } }, "NextToken": { "base": null, "refs": { "ListDetectorModelVersionsRequest$nextToken": "The token for the next set of results.
", "ListDetectorModelVersionsResponse$nextToken": "A token to retrieve the next set of results, or null if there are no additional results.
The token for the next set of results.
", "ListDetectorModelsResponse$nextToken": "A token to retrieve the next set of results, or null if there are no additional results.
The token for the next set of results.
", "ListInputsResponse$nextToken": "A token to retrieve the next set of results, or null if there are no additional results.
When entering this state, perform these actions if the condition is TRUE.
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.
When exiting this state, perform these actions if the specified condition is TRUE.
Specifies the actions performed when the condition evaluates to TRUE.
When an input is received and the condition is TRUE, perform the specified actions.
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.
You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
", "IotEventsAction$payload": "You can configure the action payload when you send a message to an AWS IoT Events input.
", "IotTopicPublishAction$payload": "You can configure the action payload when you publish a message to an AWS IoT Core topic.
", "LambdaAction$payload": "You can configure the action payload when you send a message to a Lambda function.
", "SNSTopicPublishAction$payload": "You can configure the action payload when you send a message as an Amazon SNS push notification.
", "SqsAction$payload": "You can configure the action payload when you send a message to an Amazon SQS queue.
" } }, "PayloadType": { "base": null, "refs": { "Payload$type": "The value of the payload type can be either STRING or JSON.
The URL of the SQS queue where the data is written.
" } }, "ResetTimerAction": { "base": "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.
", "refs": { "Action$resetTimer": "Information needed to reset the timer.
" } }, "ResourceAlreadyExistsException": { "base": "The resource already exists.
", "refs": { } }, "ResourceInUseException": { "base": "The resource is in use.
", "refs": { } }, "ResourceNotFoundException": { "base": "The resource was not found.
", "refs": { } }, "SNSTopicPublishAction": { "base": "Information required to publish the Amazon SNS message.
", "refs": { "Action$sns": "Sends an Amazon SNS message.
" } }, "Seconds": { "base": null, "refs": { "SetTimerAction$seconds": "The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
" } }, "ServiceUnavailableException": { "base": "The service is currently unavailable.
", "refs": { } }, "SetTimerAction": { "base": "Information needed to set the timer.
", "refs": { "Action$setTimer": "Information needed to set the timer.
" } }, "SetVariableAction": { "base": "Information about the variable and its new value.
", "refs": { "Action$setVariable": "Sets a variable to a specified value.
" } }, "SqsAction": { "base": "Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
", "refs": { "Action$sqs": "Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
" } }, "State": { "base": "Information that defines a state of a detector.
", "refs": { "States$member": null } }, "StateName": { "base": null, "refs": { "DetectorModelDefinition$initialStateName": "The state that is entered at the creation of each detector (instance).
", "State$stateName": "The name of the state.
", "TransitionEvent$nextState": "The next state to enter.
" } }, "States": { "base": null, "refs": { "DetectorModelDefinition$states": "Information about the states of the detector.
" } }, "Tag": { "base": "Metadata that can be used to manage the resource.
", "refs": { "Tags$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The tag's key.
", "TagKeys$member": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of the keys of the tags to be removed from the resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The tag's value.
" } }, "Tags": { "base": null, "refs": { "CreateDetectorModelRequest$tags": "Metadata that can be used to manage the detector model.
", "CreateInputRequest$tags": "Metadata that can be used to manage the input.
", "ListTagsForResourceResponse$tags": "The list of tags assigned to the resource.
", "TagResourceRequest$tags": "The new or modified tags for the resource.
" } }, "ThrottlingException": { "base": "The request could not be completed due to throttling.
", "refs": { } }, "TimerName": { "base": null, "refs": { "ClearTimerAction$timerName": "The name of the timer to clear.
", "ResetTimerAction$timerName": "The name of the timer to reset.
", "SetTimerAction$timerName": "The name of the timer.
" } }, "Timestamp": { "base": null, "refs": { "DetectorModelConfiguration$creationTime": "The time the detector model was created.
", "DetectorModelConfiguration$lastUpdateTime": "The time the detector model was last updated.
", "DetectorModelSummary$creationTime": "The time the detector model was created.
", "DetectorModelVersionSummary$creationTime": "The time the detector model version was created.
", "DetectorModelVersionSummary$lastUpdateTime": "The last time the detector model version was updated.
", "InputConfiguration$creationTime": "The time the input was created.
", "InputConfiguration$lastUpdateTime": "The last time the input was updated.
", "InputSummary$creationTime": "The time the input was created.
", "InputSummary$lastUpdateTime": "The last time the input was updated.
" } }, "TransitionEvent": { "base": "Specifies the actions performed and the next state entered when a condition evaluates to TRUE.
Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.
The requested operation is not supported.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateDetectorModelRequest": { "base": null, "refs": { } }, "UpdateDetectorModelResponse": { "base": null, "refs": { } }, "UpdateInputRequest": { "base": null, "refs": { } }, "UpdateInputResponse": { "base": null, "refs": { } }, "UseBase64": { "base": null, "refs": { "SqsAction$useBase64": "Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
" } }, "VariableName": { "base": null, "refs": { "SetVariableAction$variableName": "The name of the variable.
" } }, "VariableValue": { "base": null, "refs": { "SetTimerAction$durationExpression": "The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.
The new value of the variable.
" } }, "errorMessage": { "base": null, "refs": { "InternalFailureException$message": "The message for the exception.
", "InvalidRequestException$message": "The message for the exception.
", "LimitExceededException$message": "The message for the exception.
", "ResourceAlreadyExistsException$message": "The message for the exception.
", "ResourceInUseException$message": "The message for the exception.
", "ResourceNotFoundException$message": "The message for the exception.
", "ServiceUnavailableException$message": "The message for the exception.
", "ThrottlingException$message": "The message for the exception.
", "UnsupportedOperationException$message": "The message for the exception.
" } }, "resourceArn": { "base": null, "refs": { "ResourceAlreadyExistsException$resourceArn": "The ARN of the resource.
" } }, "resourceId": { "base": null, "refs": { "ResourceAlreadyExistsException$resourceId": "The ID of the resource.
" } } } }