"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html\">Create an alarm model</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.</p>"
"documentation":"<p>Retrieves information about an alarm model. If you don't specify a value for the <code>alarmModelVersion</code> parameter, the latest version is returned.</p>"
"documentation":"<p>Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.</p>"
"documentation":"<p>Retrieves runtime information about a detector model analysis.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>"
"documentation":"<p>Retrieves one or more analysis results of the detector model.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>"
"documentation":"<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>loggingOptions</code> 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 <code>roleArn</code> field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.</p>"
"documentation":"<p>Performs an analysis of your detector model. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html\">Troubleshooting a detector model</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.</p>"
"documentation":"<p>Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.</p>"
"documentation":"<p>The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>TRUE</code>, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to <code>NORMAL</code>. If <code>FALSE</code>, you won't receive notifications. The alarm automatically changes to the <code>NORMAL</code> state when the input property value returns to the specified range.</p>"
}
},
"documentation":"<p>Specifies whether to get notified for alarm state changes.</p>"
"documentation":"<p>Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.</p>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.</p>"
"documentation":"<p>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 customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>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 customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .</p>"
"documentation":"<p>Specifies one of the following actions to receive notifications when the alarm state changes.</p>"
},
"AlarmActions":{
"type":"list",
"member":{"shape":"AlarmAction"}
},
"AlarmCapabilities":{
"type":"structure",
"members":{
"initializationConfiguration":{
"shape":"InitializationConfiguration",
"documentation":"<p>Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.</p>"
},
"acknowledgeFlow":{
"shape":"AcknowledgeFlow",
"documentation":"<p>Specifies whether to get notified for alarm state changes.</p>"
}
},
"documentation":"<p>Contains the configuration information of alarm state changes.</p>"
},
"AlarmEventActions":{
"type":"structure",
"members":{
"alarmActions":{
"shape":"AlarmActions",
"documentation":"<p>Specifies one or more supported actions to receive notifications when the alarm state changes.</p>"
}
},
"documentation":"<p>Contains information about one or more alarm actions.</p>"
},
"AlarmModelArn":{"type":"string"},
"AlarmModelDescription":{
"type":"string",
"max":128
},
"AlarmModelName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9_-]+$"
},
"AlarmModelSummaries":{
"type":"list",
"member":{"shape":"AlarmModelSummary"}
},
"AlarmModelSummary":{
"type":"structure",
"members":{
"creationTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was created, in the Unix epoch format.</p>"
},
"alarmModelDescription":{
"shape":"AlarmModelDescription",
"documentation":"<p>The description of the alarm model.</p>"
},
"alarmModelName":{
"shape":"AlarmModelName",
"documentation":"<p>The name of the alarm model.</p>"
}
},
"documentation":"<p>Contains a summary of an alarm model.</p>"
},
"AlarmModelVersion":{
"type":"string",
"max":128,
"min":1
},
"AlarmModelVersionStatus":{
"type":"string",
"enum":[
"ACTIVE",
"ACTIVATING",
"INACTIVE",
"FAILED"
]
},
"AlarmModelVersionSummaries":{
"type":"list",
"member":{"shape":"AlarmModelVersionSummary"}
},
"AlarmModelVersionSummary":{
"type":"structure",
"members":{
"alarmModelName":{
"shape":"AlarmModelName",
"documentation":"<p>The name of the alarm model.</p>"
},
"alarmModelArn":{
"shape":"AlarmModelArn",
"documentation":"<p>The ARN of the alarm model. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"alarmModelVersion":{
"shape":"AlarmModelVersion",
"documentation":"<p>The version of the alarm model.</p>"
},
"roleArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"creationTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was created, in the Unix epoch format.</p>"
},
"lastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was last updated, in the Unix epoch format.</p>"
},
"status":{
"shape":"AlarmModelVersionStatus",
"documentation":"<p>The status of the alarm model. The status can be one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The alarm model is active and it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVATING</code> - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.</p> </li> <li> <p> <code>INACTIVE</code> - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.</p> </li> <li> <p> <code>FAILED</code> - You couldn't create or update the alarm model. Check your alarm model information and try again.</p> </li> </ul>"
},
"statusMessage":{
"shape":"StatusMessage",
"documentation":"<p> Contains information about the status of the alarm model version. </p>"
}
},
"documentation":"<p>Contains a summary of an alarm model version.</p>"
},
"AlarmNotification":{
"type":"structure",
"members":{
"notificationActions":{
"shape":"NotificationActions",
"documentation":"<p>Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.</p>"
}
},
"documentation":"<p>Contains information about one or more notification actions.</p>"
},
"AlarmRule":{
"type":"structure",
"members":{
"simpleRule":{
"shape":"SimpleRule",
"documentation":"<p>A rule that compares an input property value to a threshold value with a comparison operator.</p>"
}
},
"documentation":"<p>Defines when your alarm is invoked.</p>"
"documentation":"<p>The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:</p> <ul> <li> <p> <code>supported-actions</code> - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.</p> </li> <li> <p> <code>service-limits</code> - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.</p> </li> <li> <p> <code>structure</code> - The detector model must follow a structure that AWS IoT Events supports. </p> </li> <li> <p> <code>expression-syntax</code> - Your expression must follow the required syntax.</p> </li> <li> <p> <code>data-type</code> - Data types referenced in the detector model must be compatible.</p> </li> <li> <p> <code>referenced-data</code> - You must define the data referenced in your detector model before you can use the data.</p> </li> <li> <p> <code>referenced-resource</code> - Resources that the detector model uses must be available.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html\">Running detector model analyses</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:</p> <ul> <li> <p> <code>INFO</code> - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.</p> </li> <li> <p> <code>WARNING</code> - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.</p> </li> <li> <p> <code>ERROR</code> - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.</p> </li> </ul>"
"documentation":"<p>Contains additional information about the analysis result.</p>"
},
"locations":{
"shape":"AnalysisResultLocations",
"documentation":"<p>Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.</p>"
}
},
"documentation":"<p>Contains the result of the analysis.</p>"
},
"AnalysisResultLevel":{
"type":"string",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"AnalysisResultLocation":{
"type":"structure",
"members":{
"path":{
"shape":"AnalysisResultLocationPath",
"documentation":"<p>A <a href=\"https://github.com/json-path/JsonPath\">JsonPath</a> expression that identifies the error field in your detector model.</p>"
}
},
"documentation":"<p>Contains information that you can use to locate the field in your detector model that the analysis result references.</p>"
"documentation":"<p>A structure that contains timestamp information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html\">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyTimestamp</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>timeInSeconds</code> parameter can be <code>'1586400675'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>offsetInNanos</code> parameter can be <code>$variable.time</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>timeInSeconds</code> parameter uses a substitution template.</p> <p> <code>'${$input.TemperatureInput.sensorData.timestamp / 1000}'</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>The quality of the asset property value. The value must be <code>'GOOD'</code>, <code>'BAD'</code>, or <code>'UNCERTAIN'</code>.</p>"
"documentation":"<p>A structure that contains value information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html\">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyValue</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>quality</code> parameter can be <code>'GOOD'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>quality</code> parameter can be <code>$input.TemperatureInput.sensorData.quality</code>.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>The asset property value is a Boolean value that must be <code>'TRUE'</code> or <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a Boolean value.</p>"
"documentation":"<p>A structure that contains an asset property value. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html\">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyVariant</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>integerValue</code> parameter can be <code>'100'</code>.</p> </li> <li> <p>For references, you must specify either variables or parameters. For example, the value for the <code>booleanValue</code> parameter can be <code>$variable.offline</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. </p> <p>In the following example, the value for the <code>doubleValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html\">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>"
"documentation":"<p>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 (<code>BatchPutMessage</code>). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the <code>condition</code> expressions used by detectors. </p> <p>Syntax: <code><field-name>.<field-name>...</code> </p>"
"documentation":"<p>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 <code>BatchPutMessage</code>. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors. </p>"
"documentation":"<p>A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.</p>"
},
"alarmModelDescription":{
"shape":"AlarmModelDescription",
"documentation":"<p>A description that tells you what the alarm model detects.</p>"
},
"roleArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html\">Tagging your AWS IoT Events resources</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You can create up to 50 tags for one alarm model.</p>"
},
"key":{
"shape":"AttributeJsonPath",
"documentation":"<p>An input attribute used as a key to create an alarm. AWS IoT Events routes <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html\">inputs</a> associated with this key to the alarm.</p>"
},
"severity":{
"shape":"Severity",
"documentation":"<p>A non-negative integer that reflects the severity level of the alarm.</p>"
},
"alarmRule":{
"shape":"AlarmRule",
"documentation":"<p>Defines when your alarm is invoked.</p>"
},
"alarmNotification":{
"shape":"AlarmNotification",
"documentation":"<p>Contains information about one or more notification actions.</p>"
},
"alarmEventActions":{
"shape":"AlarmEventActions",
"documentation":"<p>Contains information about one or more alarm actions.</p>"
},
"alarmCapabilities":{
"shape":"AlarmCapabilities",
"documentation":"<p>Contains the configuration information of alarm state changes.</p>"
}
}
},
"CreateAlarmModelResponse":{
"type":"structure",
"members":{
"creationTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was created, in the Unix epoch format.</p>"
},
"alarmModelArn":{
"shape":"AlarmModelArn",
"documentation":"<p>The ARN of the alarm model. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"alarmModelVersion":{
"shape":"AlarmModelVersion",
"documentation":"<p>The version of the alarm model.</p>"
},
"lastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was last updated, in the Unix epoch format.</p>"
},
"status":{
"shape":"AlarmModelVersionStatus",
"documentation":"<p>The status of the alarm model. The status can be one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The alarm model is active and it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVATING</code> - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.</p> </li> <li> <p> <code>INACTIVE</code> - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.</p> </li> <li> <p> <code>FAILED</code> - You couldn't create or update the alarm model. Check your alarm model information and try again.</p> </li> </ul>"
"documentation":"<p>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.</p>"
"documentation":"<p>The name of the alarm model.</p>",
"location":"uri",
"locationName":"alarmModelName"
},
"alarmModelVersion":{
"shape":"AlarmModelVersion",
"documentation":"<p>The version of the alarm model.</p>",
"location":"querystring",
"locationName":"version"
}
}
},
"DescribeAlarmModelResponse":{
"type":"structure",
"members":{
"creationTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was created, in the Unix epoch format.</p>"
},
"alarmModelArn":{
"shape":"AlarmModelArn",
"documentation":"<p>The ARN of the alarm model. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"alarmModelVersion":{
"shape":"AlarmModelVersion",
"documentation":"<p>The version of the alarm model.</p>"
},
"lastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was last updated, in the Unix epoch format.</p>"
},
"status":{
"shape":"AlarmModelVersionStatus",
"documentation":"<p>The status of the alarm model. The status can be one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The alarm model is active and it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVATING</code> - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.</p> </li> <li> <p> <code>INACTIVE</code> - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.</p> </li> <li> <p> <code>FAILED</code> - You couldn't create or update the alarm model. Check your alarm model information and try again.</p> </li> </ul>"
},
"statusMessage":{
"shape":"StatusMessage",
"documentation":"<p> Contains information about the status of the alarm model. </p>"
},
"alarmModelName":{
"shape":"AlarmModelName",
"documentation":"<p>The name of the alarm model.</p>"
},
"alarmModelDescription":{
"shape":"AlarmModelDescription",
"documentation":"<p>The description of the alarm model.</p>"
},
"roleArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"key":{
"shape":"AttributeJsonPath",
"documentation":"<p>An input attribute used as a key to create an alarm. AWS IoT Events routes <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html\">inputs</a> associated with this key to the alarm.</p>"
},
"severity":{
"shape":"Severity",
"documentation":"<p>A non-negative integer that reflects the severity level of the alarm.</p>"
},
"alarmRule":{
"shape":"AlarmRule",
"documentation":"<p>Defines when your alarm is invoked.</p>"
},
"alarmNotification":{
"shape":"AlarmNotification",
"documentation":"<p>Contains information about one or more notification actions.</p>"
},
"alarmEventActions":{
"shape":"AlarmEventActions",
"documentation":"<p>Contains information about one or more alarm actions.</p>"
},
"alarmCapabilities":{
"shape":"AlarmCapabilities",
"documentation":"<p>Contains the configuration information of alarm state changes.</p>"
"documentation":"<p>The status of the analysis activity. The status can be one of the following values:</p> <ul> <li> <p> <code>RUNNING</code> - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.</p> </li> <li> <p> <code>COMPLETE</code> - AWS IoT Events finished analyzing your detector model.</p> </li> <li> <p> <code>FAILED</code> - AWS IoT Events couldn't analyze your detector model. Try again later.</p> </li> </ul>"
"documentation":"<p>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. </p> <p>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.</p>"
"documentation":"<p>The data type for the hash key (also called the partition key). You can specify the following values:</p> <ul> <li> <p> <code>'STRING'</code> - The hash key is a string.</p> </li> <li> <p> <code>'NUMBER'</code> - The hash key is a number.</p> </li> </ul> <p>If you don't specify <code>hashKeyType</code>, the default value is <code>'STRING'</code>.</p>"
"documentation":"<p>The name of the hash key (also called the partition key). The <code>hashKeyField</code> value must match the partition key of the target DynamoDB table.</p>"
"documentation":"<p>The data type for the range key (also called the sort key), You can specify the following values:</p> <ul> <li> <p> <code>'STRING'</code> - The range key is a string.</p> </li> <li> <p> <code>'NUMBER'</code> - The range key is number.</p> </li> </ul> <p>If you don't specify <code>rangeKeyField</code>, the default value is <code>'STRING'</code>.</p>"
"documentation":"<p>The name of the range key (also called the sort key). The <code>rangeKeyField</code> value must match the sort key of the target DynamoDB table. </p>"
"documentation":"<p>The type of operation to perform. You can specify the following values: </p> <ul> <li> <p> <code>'INSERT'</code> - 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.</p> </li> <li> <p> <code>'UPDATE'</code> - 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.</p> </li> <li> <p> <code>'DELETE'</code> - 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.</p> </li> </ul> <p>If you don't specify this parameter, AWS IoT Events triggers the <code>'INSERT'</code> operation.</p>"
"documentation":"<p>The name of the DynamoDB column that receives the action payload.</p> <p>If you don't specify this parameter, the name of the DynamoDB column is <code>payload</code>.</p>"
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.</p> <p>You must use expressions for all parameters in <code>DynamoDBAction</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>hashKeyType</code> parameter can be <code>'STRING'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>hashKeyField</code> parameter can be <code>$input.GreenhouseInput.name</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>hashKeyValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'</code> </p> </li> <li> <p>For a string concatenation, you must use <code>+</code>. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>tableName</code> parameter uses a string concatenation. </p> <p> <code>'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>If the defined payload type is a string, <code>DynamoDBAction</code> 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 <code>payloadField</code> parameter is <code><payload-field>_raw</code>.</p>"
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.</p> <p>You must use expressions for all parameters in <code>DynamoDBv2Action</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>tableName</code> parameter can be <code>'GreenhouseTemperatureTable'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>tableName</code> parameter can be <code>$variable.ddbtableName</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>contentExpression</code> parameter in <code>Payload</code> uses a substitution template. </p> <p> <code>'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'</code> </p> </li> <li> <p>For a string concatenation, you must use <code>+</code>. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>tableName</code> parameter uses a string concatenation. </p> <p> <code>'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>The value for the <code>type</code> parameter in <code>Payload</code> must be <code>JSON</code>.</p>"
"documentation":"<p>The email address that sends emails.</p> <important> <p>If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html\">verify the email address that sends emails in Amazon SES</a>.</p> </important>"
},
"content":{
"shape":"EmailContent",
"documentation":"<p>Contains the subject and message of an email.</p>"
},
"recipients":{
"shape":"EmailRecipients",
"documentation":"<p>Contains the information of one or more recipients who receive the emails.</p> <important> <p>You must <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html\">add the users that receive emails to your AWS SSO store</a>.</p> </important>"
}
},
"documentation":"<p>Contains the configuration information of email notifications.</p>"
},
"EmailConfigurations":{
"type":"list",
"member":{"shape":"EmailConfiguration"},
"min":1
},
"EmailContent":{
"type":"structure",
"members":{
"subject":{
"shape":"EmailSubject",
"documentation":"<p>The subject of the email.</p>"
},
"additionalMessage":{
"shape":"NotificationAdditionalMessage",
"documentation":"<p>The message that you want to send. The message can be up to 200 characters.</p>"
}
},
"documentation":"<p>Contains the subject and message of an email.</p>"
},
"EmailRecipients":{
"type":"structure",
"members":{
"to":{
"shape":"RecipientDetails",
"documentation":"<p>Specifies one or more recipients who receive the email.</p>"
}
},
"documentation":"<p>Contains the information of one or more recipients who receive the emails.</p> <important> <p>You must <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html\">add the users that receive emails to your AWS SSO store</a>.</p> </important>"
"documentation":"<p>Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> 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).</p>"
"documentation":"<p>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).</p>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.</p>"
"documentation":"<p>The value must be <code>TRUE</code> or <code>FALSE</code>. If <code>FALSE</code>, all alarm instances created based on the alarm model are activated. The default value is <code>TRUE</code>.</p>"
}
},
"documentation":"<p>Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.</p>"
"documentation":"<p>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 <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors that monitor this input. </p>"
"documentation":"<p>Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The expressions accept literals, operators, functions, references, and substitutions templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>propertyAlias</code> parameter can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>assetId</code> parameter can be <code>$input.TurbineInput.assetId1</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>propertyAlias</code> parameter uses a substitution template. </p> <p> <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'</code> </p> </li> </ul> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>The MQTT topic of the message. You can use a string expression that includes variables (<code>$variable.<variable-name></code>) and input values (<code>$input.<input-name>.<path-to-datum></code>) as the topic string.</p>"
"documentation":"<p>Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html\">AWS Lambda function provided by AWS IoT Events</a>.</p>"
},
"smsConfigurations":{
"shape":"SMSConfigurations",
"documentation":"<p>Contains the configuration information of SMS notifications.</p>"
},
"emailConfigurations":{
"shape":"EmailConfigurations",
"documentation":"<p>Contains the configuration information of email notifications.</p>"
}
},
"documentation":"<p>Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.</p>"
"documentation":"<p>Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html\">AWS Lambda function provided by AWS IoT Events</a>.</p>"
"documentation":"<p>Specifies the <code>actions</code> that are performed when the state is exited and the <code>condition</code> is <code>TRUE</code>.</p>"
"documentation":"<p>The content of the payload. You can use a string expression that includes quoted strings (<code>'<string>'</code>), variables (<code>$variable.<variable-name></code>), input values (<code>$input.<input-name>.<path-to-datum></code>), string concatenations, and quoted strings that contain <code>${}</code> as the content. The recommended maximum size of a content expression is 1 KB.</p>"
},
"type":{
"shape":"PayloadType",
"documentation":"<p>The value of the payload type can be either <code>STRING</code> or <code>JSON</code>.</p>"
}
},
"documentation":"<p>Information needed to configure the payload.</p> <p>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 <code>contentExpression</code>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p> The name of the routed resource. </p>"
},
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p> The ARN of the routed resource. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>. </p>"
}
},
"documentation":"<p> Contains information about the routed resource. </p>"
},
"RoutedResources":{
"type":"list",
"member":{"shape":"RoutedResource"}
},
"SMSConfiguration":{
"type":"structure",
"required":["recipients"],
"members":{
"senderId":{
"shape":"SMSSenderId",
"documentation":"<p>The sender ID.</p>"
},
"additionalMessage":{
"shape":"NotificationAdditionalMessage",
"documentation":"<p>The message that you want to send. The message can be up to 200 characters.</p>"
},
"recipients":{
"shape":"RecipientDetails",
"documentation":"<p>Specifies one or more recipients who receive the message.</p> <important> <p>You must <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html\">add the users that receive SMS messages to your AWS SSO store</a>.</p> </important>"
}
},
"documentation":"<p>Contains the configuration information of SMS notifications.</p>"
"documentation":"<p>The ID of the AWS SSO identity store.</p>"
},
"userId":{
"shape":"SSOReferenceId",
"documentation":"<p>The user ID.</p>"
}
},
"documentation":"<p>Contains information about your identity source in AWS Single Sign-On. For more information, see the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html\">AWS Single Sign-On User Guide</a>.</p>"
"documentation":"<p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. </p>",
"deprecatedMessage":"seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression."
},
"durationExpression":{
"shape":"VariableValue",
"documentation":"<p>The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (<code>$variable.<variable-name></code>), and input values (<code>$input.<input-name>.<path-to-datum></code>) 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. </p>"
"documentation":"<p>The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.</p>"
},
"comparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"<p>The comparison operator.</p>"
},
"threshold":{
"shape":"Threshold",
"documentation":"<p>The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.</p>"
}
},
"documentation":"<p>A rule that compares an input property value to a threshold value with a comparison operator.</p>"
"documentation":"<p>Required. A Boolean expression that when TRUE causes the actions to be performed and the <code>nextState</code> to be entered.</p>"
"documentation":"<p>The name of the alarm model.</p>",
"location":"uri",
"locationName":"alarmModelName"
},
"alarmModelDescription":{
"shape":"AlarmModelDescription",
"documentation":"<p>The description of the alarm model.</p>"
},
"roleArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"severity":{
"shape":"Severity",
"documentation":"<p>A non-negative integer that reflects the severity level of the alarm.</p>"
},
"alarmRule":{
"shape":"AlarmRule",
"documentation":"<p>Defines when your alarm is invoked.</p>"
},
"alarmNotification":{
"shape":"AlarmNotification",
"documentation":"<p>Contains information about one or more notification actions.</p>"
},
"alarmEventActions":{
"shape":"AlarmEventActions",
"documentation":"<p>Contains information about one or more alarm actions.</p>"
},
"alarmCapabilities":{
"shape":"AlarmCapabilities",
"documentation":"<p>Contains the configuration information of alarm state changes.</p>"
}
}
},
"UpdateAlarmModelResponse":{
"type":"structure",
"members":{
"creationTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was created, in the Unix epoch format.</p>"
},
"alarmModelArn":{
"shape":"AlarmModelArn",
"documentation":"<p>The ARN of the alarm model. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"alarmModelVersion":{
"shape":"AlarmModelVersion",
"documentation":"<p>The version of the alarm model.</p>"
},
"lastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The time the alarm model was last updated, in the Unix epoch format.</p>"
},
"status":{
"shape":"AlarmModelVersionStatus",
"documentation":"<p>The status of the alarm model. The status can be one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The alarm model is active and it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVATING</code> - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.</p> </li> <li> <p> <code>INACTIVE</code> - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.</p> </li> <li> <p> <code>FAILED</code> - You couldn't create or update the alarm model. Check your alarm model information and try again.</p> </li> </ul>"
"documentation":"<p>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.</p>"