Specifies whether to get notified for alarm state changes.
* @public */ export interface AcknowledgeFlow { /** *The value must be TRUE or FALSE. If TRUE, you
* receive a notification when the alarm state changes. You must choose to acknowledge the
* notification before the alarm state can return to NORMAL. If FALSE,
* you won't receive notifications. The alarm automatically changes to the NORMAL
* state when the input property value returns to the specified range.
Information needed to clear the timer.
* @public */ export interface ClearTimerAction { /** *The name of the timer to clear.
* @public */ timerName: string | undefined; } /** *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.
The content of the payload. You can use a string expression that includes quoted strings
* ('), variables ($variable.),
* input values ($input.), string
* concatenations, and quoted strings that contain $\{\} as the content. The
* recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or
* JSON.
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
*
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 name of the hash key (also called the partition key). The hashKeyField
* value must match the partition key of the target DynamoDB table.
The value of the hash key (also called the partition key).
* @public */ hashKeyValue: string | undefined; /** *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 name of the range key (also called the sort key). The rangeKeyField value
* must match the sort key of the target DynamoDB table.
The value of the range key (also called the sort key).
* @public */ rangeKeyValue?: string | undefined; /** *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 column that receives the action payload.
*If you don't specify this parameter, the name of the DynamoDB column is
* payload.
The name of the DynamoDB table. The tableName value must match the table name of
* the target DynamoDB table.
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.
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.
The name of the DynamoDB table.
* @public */ tableName: string | undefined; /** *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.
Sends information about the detector model instance and the event that triggered the * action to an Amazon Kinesis Data Firehose delivery stream.
* @public */ export interface FirehoseAction { /** *The name of the Kinesis Data Firehose delivery stream where the data is written.
* @public */ deliveryStreamName: string | undefined; /** *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).
* @public */ separator?: string | undefined; /** *You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery * stream.
* @public */ payload?: Payload | undefined; } /** *Sends an AWS IoT Events input, passing in information about the detector model instance and the * event that triggered the action.
* @public */ export interface IotEventsAction { /** *The name of the AWS IoT Events input where the data is sent.
* @public */ inputName: string | undefined; /** *You can configure the action payload when you send a message to an AWS IoT Events input.
* @public */ payload?: Payload | undefined; } /** *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.
* @public */ export interface AssetPropertyTimestamp { /** *The timestamp, in seconds, in the Unix epoch format. The valid range is between * 1-31556889864403199.
* @public */ timeInSeconds: string | undefined; /** *The nanosecond offset converted from timeInSeconds. The valid range is
* between 0-999999999.
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.
The asset property value is a string. You must use an expression, and the evaluated result * should be a string.
* @public */ stringValue?: string | undefined; /** *The asset property value is an integer. You must use an expression, and the evaluated * result should be an integer.
* @public */ integerValue?: string | undefined; /** *The asset property value is a double. You must use an expression, and the evaluated result * should be a double.
* @public */ doubleValue?: string | undefined; /** *The asset property value is a Boolean value that must be 'TRUE' or
* 'FALSE'. You must use an expression, and the evaluated result should be a
* Boolean value.
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.
* @public */ export interface AssetPropertyValue { /** *The value to send to an asset property.
* @public */ value?: AssetPropertyVariant | undefined; /** *The timestamp associated with the asset property value. The default is the current event * time.
* @public */ timestamp?: AssetPropertyTimestamp | undefined; /** *The quality of the asset property value. The value must be 'GOOD',
* 'BAD', or 'UNCERTAIN'.
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.
* @public */ export interface IotSiteWiseAction { /** *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.
* @public */ entryId?: string | undefined; /** *The ID of the asset that has the specified property.
* @public */ assetId?: string | undefined; /** *The ID of the asset property.
* @public */ propertyId?: string | undefined; /** *The alias of the asset property.
* @public */ propertyAlias?: string | undefined; /** *The value to send to the asset property. This value contains timestamp, quality, and value * (TQV) information.
* @public */ propertyValue?: AssetPropertyValue | undefined; } /** *Information required to publish the MQTT message through the AWS IoT message broker.
* @public */ export interface IotTopicPublishAction { /** *The MQTT topic of the message. You can use a string expression that includes variables
* ($variable.) and input values
* ($input.) as the topic string.
You can configure the action payload when you publish a message to an AWS IoT Core * topic.
* @public */ payload?: Payload | undefined; } /** *Calls a Lambda function, passing in information about the detector model instance and the * event that triggered the action.
* @public */ export interface LambdaAction { /** *The ARN of the Lambda function that is executed.
* @public */ functionArn: string | undefined; /** *You can configure the action payload when you send a message to a Lambda function.
* @public */ payload?: Payload | undefined; } /** *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.
* @public */ export interface ResetTimerAction { /** *The name of the timer to reset.
* @public */ timerName: string | undefined; } /** *Information needed to set the timer.
* @public */ export interface SetTimerAction { /** *The name of the timer.
* @public */ timerName: string | undefined; /** *The number of seconds until the timer expires. The minimum value is 60 seconds to ensure * accuracy. The maximum value is 31622400 seconds.
* * @deprecated seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression. * @public */ seconds?: number | undefined; /** *The duration of the timer, in seconds. You can use a string expression that includes
* numbers, variables ($variable.), and input values
* ($input.) 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.
Information about the variable and its new value.
* @public */ export interface SetVariableAction { /** *The name of the variable.
* @public */ variableName: string | undefined; /** *The new value of the variable.
* @public */ value: string | undefined; } /** *Information required to publish the Amazon SNS message.
* @public */ export interface SNSTopicPublishAction { /** *The ARN of the Amazon SNS target where the message is sent.
* @public */ targetArn: string | undefined; /** *You can configure the action payload when you send a message as an Amazon SNS push * notification.
* @public */ payload?: Payload | undefined; } /** *Sends information about the detector model instance and the event that triggered the * action to an Amazon SQS queue.
* @public */ export interface SqsAction { /** *The URL of the SQS queue where the data is written.
* @public */ queueUrl: string | undefined; /** *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.
* @public */ useBase64?: boolean | undefined; /** *You can configure the action payload when you send a message to an Amazon SQS * queue.
* @public */ payload?: Payload | undefined; } /** *An action to be performed when the condition is TRUE.
Sets a variable to a specified value.
* @public */ setVariable?: SetVariableAction | undefined; /** *Sends an Amazon SNS message.
* @public */ sns?: SNSTopicPublishAction | undefined; /** *Publishes an MQTT message with the given topic to the AWS IoT message broker.
* @public */ iotTopicPublish?: IotTopicPublishAction | undefined; /** *Information needed to set the timer.
* @public */ setTimer?: SetTimerAction | undefined; /** *Information needed to clear the timer.
* @public */ clearTimer?: ClearTimerAction | undefined; /** *Information needed to reset the timer.
* @public */ resetTimer?: ResetTimerAction | undefined; /** *Calls a Lambda function, passing in information about the detector model instance and the * event that triggered the action.
* @public */ lambda?: LambdaAction | undefined; /** *Sends AWS IoT Events input, which passes information about the detector model instance and the * event that triggered the action.
* @public */ iotEvents?: IotEventsAction | undefined; /** *Sends information about the detector model instance and the event that triggered the * action to an Amazon SQS queue.
* @public */ sqs?: SqsAction | undefined; /** *Sends information about the detector model instance and the event that triggered the * action to an Amazon Kinesis Data Firehose delivery stream.
* @public */ firehose?: FirehoseAction | undefined; /** *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 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.
* @public */ dynamoDB?: DynamoDBAction | undefined; /** *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 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.
* @public */ dynamoDBv2?: DynamoDBv2Action | undefined; /** *Sends information about the detector model instance and the event that triggered the * action to an asset property in AWS IoT SiteWise .
* @public */ iotSiteWise?: IotSiteWiseAction | undefined; } /** *Specifies one of the following actions to receive notifications when the alarm state * changes.
* @public */ export interface AlarmAction { /** *Information required to publish the Amazon SNS message.
* @public */ sns?: SNSTopicPublishAction | undefined; /** *Information required to publish the MQTT message through the AWS IoT message broker.
* @public */ iotTopicPublish?: IotTopicPublishAction | undefined; /** *Calls a Lambda function, passing in information about the detector model instance and the * event that triggered the action.
* @public */ lambda?: LambdaAction | undefined; /** *Sends an AWS IoT Events input, passing in information about the detector model instance and the * event that triggered the action.
* @public */ iotEvents?: IotEventsAction | undefined; /** *Sends information about the detector model instance and the event that triggered the * action to an Amazon SQS queue.
* @public */ sqs?: SqsAction | undefined; /** *Sends information about the detector model instance and the event that triggered the * action to an Amazon Kinesis Data Firehose delivery stream.
* @public */ firehose?: FirehoseAction | undefined; /** *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
*
Defines an action to write to the Amazon DynamoDB table that you created. The default action * payload contains all the information about the detector model instance and the event that * triggered the action. You can customize the payload. A separate column of * the DynamoDB table receives one attribute-value pair in the payload that you specify.
*You must use expressions for all parameters in DynamoDBv2Action. The expressions
* accept literals, operators, functions, references, and substitution templates.
* Examples *
*For literal values, the expressions must contain single quotes. For example, the value
* for the tableName parameter can be
* 'GreenhouseTemperatureTable'.
For references, you must specify either variables or input values. For example, the
* value for the tableName parameter can be
* $variable.ddbtableName.
For a substitution template, you must use $\{\}, and the template must be
* in single quotes. A substitution template can also contain a combination of literals,
* operators, functions, references, and substitution templates.
In the following example, the value for the contentExpression parameter
* in Payload uses a substitution template.
* '\{\"sensorID\": \"$\{$input.GreenhouseInput.sensor_id\}\", \"temperature\":
* \"$\{$input.GreenhouseInput.temperature * 9 / 5 + 32\}\"\}'
*
For a string concatenation, you must use +. A string concatenation can
* also contain a combination of literals, operators, functions, references, and substitution
* templates.
In the following example, the value for the tableName parameter uses a
* string concatenation.
* 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
*
For more information, * see Expressions * in the AWS IoT Events Developer Guide.
*The value for the type parameter in Payload must be
* JSON.
Sends information about the detector model instance and the event that triggered the * action to 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.
* @public */ iotSiteWise?: IotSiteWiseAction | undefined; } /** *Specifies the default alarm state. * The configuration applies to all alarms that were created based on this alarm model.
* @public */ export interface InitializationConfiguration { /** *The value must be TRUE or FALSE. If FALSE, all
* alarm instances created based on the alarm model are activated. The default value is
* TRUE.
Contains the configuration information of alarm state changes.
* @public */ export interface AlarmCapabilities { /** *Specifies the default alarm state. * The configuration applies to all alarms that were created based on this alarm model.
* @public */ initializationConfiguration?: InitializationConfiguration | undefined; /** *Specifies whether to get notified for alarm state changes.
* @public */ acknowledgeFlow?: AcknowledgeFlow | undefined; } /** *Contains information about one or more alarm actions.
* @public */ export interface AlarmEventActions { /** *Specifies one or more supported actions to receive notifications when the alarm state * changes.
* @public */ alarmActions?: AlarmAction[] | undefined; } /** *Contains a summary of an alarm model.
* @public */ export interface AlarmModelSummary { /** *The time the alarm model was created, in the Unix epoch format.
* @public */ creationTime?: Date | undefined; /** *The description of the alarm model.
* @public */ alarmModelDescription?: string | undefined; /** *The name of the alarm model.
* @public */ alarmModelName?: string | undefined; } /** *Contains a summary of an alarm model version.
* @public */ export interface AlarmModelVersionSummary { /** *The name of the alarm model.
* @public */ alarmModelName?: string | undefined; /** *The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ alarmModelArn?: string | undefined; /** *The version of the alarm model.
* @public */ alarmModelVersion?: string | undefined; /** *The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ roleArn?: string | undefined; /** *The time the alarm model was created, in the Unix epoch format.
* @public */ creationTime?: Date | undefined; /** *The time the alarm model was last updated, in the Unix epoch format.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the alarm model. The status can be one of the following values:
*
* ACTIVE - The alarm model is active and it's ready to evaluate data.
* ACTIVATING - AWS IoT Events is activating your alarm model.
* Activating an alarm model can take up to a few minutes.
* INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data.
* Check your alarm model information and update the alarm model.
* FAILED - You couldn't create or update the alarm model. Check your alarm model information
* and try again.
* Contains information about the status of the alarm model version. *
* @public */ statusMessage?: string | undefined; } /** *Specifies an AWS Lambda function to manage alarm notifications. * You can create one or use the AWS Lambda function provided by AWS IoT Events.
* @public */ export interface NotificationTargetActions { /** *Calls a Lambda function, passing in information about the detector model instance and the * event that triggered the action.
* @public */ lambdaAction?: LambdaAction | undefined; } /** *Contains the subject and message of an email.
* @public */ export interface EmailContent { /** *The subject of the email.
* @public */ subject?: string | undefined; /** *The message that you want to send. The message can be up to 200 characters.
* @public */ additionalMessage?: string | undefined; } /** *Contains information about your identity source in AWS Single Sign-On. For more information, see * the AWS Single Sign-On * User Guide.
* @public */ export interface SSOIdentity { /** *The ID of the AWS SSO identity store.
* @public */ identityStoreId: string | undefined; /** *The user ID.
* @public */ userId?: string | undefined; } /** *The information that identifies the recipient.
* @public */ export interface RecipientDetail { /** *The AWS Single Sign-On (AWS SSO) authentication information.
* @public */ ssoIdentity?: SSOIdentity | undefined; } /** *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.
*Specifies one or more recipients who receive the email.
* @public */ to?: RecipientDetail[] | undefined; } /** *Contains the configuration information of email notifications.
* @public */ export interface EmailConfiguration { /** *The email address that sends emails.
*If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify * the email address that sends emails in Amazon SES.
*Contains the subject and message of an email.
* @public */ content?: EmailContent | undefined; /** *Contains the information of one or more recipients who receive the emails.
*You must add the users that receive emails to your AWS SSO store.
*Contains the configuration information of SMS notifications.
* @public */ export interface SMSConfiguration { /** *The sender ID.
* @public */ senderId?: string | undefined; /** *The message that you want to send. The message can be up to 200 characters.
* @public */ additionalMessage?: string | undefined; /** *Specifies one or more recipients who receive the message.
*You must add the users that receive SMS messages to your AWS SSO store.
*Contains the notification settings of an alarm model. * The settings apply to all alarms that were created based on this alarm model.
* @public */ export interface NotificationAction { /** *Specifies an AWS Lambda function to manage alarm notifications. * You can create one or use the AWS Lambda function provided by AWS IoT Events.
* @public */ action: NotificationTargetActions | undefined; /** *Contains the configuration information of SMS notifications.
* @public */ smsConfigurations?: SMSConfiguration[] | undefined; /** *Contains the configuration information of email notifications.
* @public */ emailConfigurations?: EmailConfiguration[] | undefined; } /** *Contains information about one or more notification actions.
* @public */ export interface AlarmNotification { /** *Contains the notification settings of an alarm model. * The settings apply to all alarms that were created based on this alarm model.
* @public */ notificationActions?: NotificationAction[] | undefined; } /** *A rule that compares an input property value to a threshold value with a comparison operator.
* @public */ export interface SimpleRule { /** *The value on the left side of the comparison operator. You can specify an AWS IoT Events input * attribute as an input property.
* @public */ inputProperty: string | undefined; /** *The comparison operator.
* @public */ comparisonOperator: ComparisonOperator | undefined; /** *The value on the right side of the comparison operator. You can enter a number or specify * an AWS IoT Events input attribute.
* @public */ threshold: string | undefined; } /** *Defines when your alarm is invoked.
* @public */ export interface AlarmRule { /** *A rule that compares an input property value to a threshold value with a comparison operator.
* @public */ simpleRule?: SimpleRule | undefined; } /** *Contains information that you can use to locate the field in your detector model that the * analysis result references.
* @public */ export interface AnalysisResultLocation { /** *A JsonPath expression that * identifies the error field in your detector model.
* @public */ path?: string | undefined; } /** *Contains the result of the analysis.
* @public */ export interface AnalysisResult { /** *The type of the analysis result. Analyses fall into the following types based on the * validators used to generate the analysis result:
*
* supported-actions - You must specify AWS IoT Events supported actions that work
* with other AWS services in a supported AWS Region.
* service-limits - Resources or API operations can't exceed service
* quotas (also known as limits). Update your detector model or request a quota
* increase.
* structure - The detector model must follow a structure that AWS IoT Events
* supports.
* expression-syntax - Your expression must follow the required
* syntax.
* data-type - Data types referenced in the detector model must be
* compatible.
* referenced-data - You must define the data referenced in your detector
* model before you can use the data.
* referenced-resource - Resources that the detector model uses must be
* available.
For more information, see Running detector model * analyses in the AWS IoT Events Developer Guide.
* @public */ type?: string | undefined; /** *The severity level of the analysis result. Based on the severity level, analysis results * fall into three general categories:
*
* INFO - An information result tells you about a significant field in your
* detector model. This type of result usually doesn't require immediate action.
* WARNING - 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.
* ERROR - 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.
Contains additional information about the analysis result.
* @public */ message?: string | undefined; /** *Contains one or more locations that you can use to locate the fields in your detector * model that the analysis result references.
* @public */ locations?: AnalysisResultLocation[] | undefined; } /** *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:
Metadata that can be used to manage the resource.
* @public */ export interface Tag { /** *The tag's key.
* @public */ key: string | undefined; /** *The tag's value.
* @public */ value: string | undefined; } /** * @public */ export interface CreateAlarmModelRequest { /** *A unique name that helps you identify the alarm model. You can't change this name after * you create the alarm model.
* @public */ alarmModelName: string | undefined; /** *A description that tells you what the alarm model detects.
* @public */ alarmModelDescription?: string | undefined; /** *The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ roleArn: string | undefined; /** *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 Tagging your AWS IoT Events * resources in the AWS IoT Events Developer Guide.
*You can create up to 50 tags for one alarm model.
* @public */ tags?: Tag[] | undefined; /** *An input attribute used as a key to create an alarm. * AWS IoT Events routes inputs * associated with this key to the alarm.
* @public */ key?: string | undefined; /** *A non-negative integer that reflects the severity level of the alarm.
* @public */ severity?: number | undefined; /** *Defines when your alarm is invoked.
* @public */ alarmRule: AlarmRule | undefined; /** *Contains information about one or more notification actions.
* @public */ alarmNotification?: AlarmNotification | undefined; /** *Contains information about one or more alarm actions.
* @public */ alarmEventActions?: AlarmEventActions | undefined; /** *Contains the configuration information of alarm state changes.
* @public */ alarmCapabilities?: AlarmCapabilities | undefined; } /** * @public */ export interface CreateAlarmModelResponse { /** *The time the alarm model was created, in the Unix epoch format.
* @public */ creationTime?: Date | undefined; /** *The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ alarmModelArn?: string | undefined; /** *The version of the alarm model.
* @public */ alarmModelVersion?: string | undefined; /** *The time the alarm model was last updated, in the Unix epoch format.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the alarm model. The status can be one of the following values:
*
* ACTIVE - The alarm model is active and it's ready to evaluate data.
* ACTIVATING - AWS IoT Events is activating your alarm model.
* Activating an alarm model can take up to a few minutes.
* INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data.
* Check your alarm model information and update the alarm model.
* FAILED - You couldn't create or update the alarm model. Check your alarm model information
* and try again.
Specifies the actions to be performed when the condition
* evaluates to TRUE.
The name of the event.
* @public */ eventName: string | undefined; /** *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).
The actions to be performed.
* @public */ actions?: Action[] | undefined; } /** *When entering this state, perform these actions if the condition
* is TRUE.
Specifies the actions that are performed when the state is entered and the
* condition is TRUE.
When exiting this state, perform these actions if the specified
* condition is TRUE.
Specifies the actions that are performed when the state is exited and the
* condition is TRUE.
Specifies the actions performed and the next state entered when a condition
* evaluates to TRUE.
The name of the transition event.
* @public */ eventName: string | undefined; /** *Required. A Boolean expression that when TRUE causes the actions to be performed and the
* nextState to be entered.
The actions to be performed.
* @public */ actions?: Action[] | undefined; /** *The next state to enter.
* @public */ nextState: string | undefined; } /** *Specifies the actions performed when the condition evaluates to TRUE.
Specifies the actions performed when the condition evaluates to TRUE.
Specifies the actions performed, and the next state entered, when a condition
* evaluates to TRUE.
Information that defines a state of a detector.
* @public */ export interface State { /** *The name of the state.
* @public */ stateName: string | undefined; /** *When an input is received and the condition is TRUE, perform the specified
* actions.
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.
Information that defines how a detector operates.
* @public */ export interface DetectorModelDefinition { /** *Information about the states of the detector.
* @public */ states: State[] | undefined; /** *The state that is entered at the creation of each detector (instance).
* @public */ initialStateName: string | undefined; } /** * @public */ export interface CreateDetectorModelRequest { /** *The name of the detector model.
* @public */ detectorModelName: string | undefined; /** *Information that defines how the detectors operate.
* @public */ detectorModelDefinition: DetectorModelDefinition | undefined; /** *A brief description of the detector model.
* @public */ detectorModelDescription?: string | undefined; /** *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.
* @public */ key?: string | undefined; /** *The ARN of the role that grants permission to AWS IoT Events to perform its operations.
* @public */ roleArn: string | undefined; /** *Metadata that can be used to manage the detector model.
* @public */ tags?: Tag[] | undefined; /** *Information about the order in which events are evaluated and how actions are executed. *
* @public */ evaluationMethod?: EvaluationMethod | undefined; } /** *Information about how the detector model is configured.
* @public */ export interface DetectorModelConfiguration { /** *The name of the detector model.
* @public */ detectorModelName?: string | undefined; /** *The version of the detector model.
* @public */ detectorModelVersion?: string | undefined; /** *A brief description of the detector model.
* @public */ detectorModelDescription?: string | undefined; /** *The ARN of the detector model.
* @public */ detectorModelArn?: string | undefined; /** *The ARN of the role that grants permission to AWS IoT Events to perform its operations.
* @public */ roleArn?: string | undefined; /** *The time the detector model was created.
* @public */ creationTime?: Date | undefined; /** *The time the detector model was last updated.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the detector model.
* @public */ status?: DetectorModelVersionStatus | undefined; /** *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.
* @public */ key?: string | undefined; /** *Information about the order in which events are evaluated and how actions are executed. *
* @public */ evaluationMethod?: EvaluationMethod | undefined; } /** * @public */ export interface CreateDetectorModelResponse { /** *Information about how the detector model is configured.
* @public */ detectorModelConfiguration?: DetectorModelConfiguration | undefined; } /** *The definition of the input.
* @public */ export interface InputDefinition { /** *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.
The name you want to give to the input.
* @public */ inputName: string | undefined; /** *A brief description of the input.
* @public */ inputDescription?: string | undefined; /** *The definition of the input.
* @public */ inputDefinition: InputDefinition | undefined; /** *Metadata that can be used to manage the input.
* @public */ tags?: Tag[] | undefined; } /** *Information about the configuration of an input.
* @public */ export interface InputConfiguration { /** *The name of the input.
* @public */ inputName: string | undefined; /** *A brief description of the input.
* @public */ inputDescription?: string | undefined; /** *The ARN of the input.
* @public */ inputArn: string | undefined; /** *The time the input was created.
* @public */ creationTime: Date | undefined; /** *The last time the input was updated.
* @public */ lastUpdateTime: Date | undefined; /** *The status of the input.
* @public */ status: InputStatus | undefined; } /** * @public */ export interface CreateInputResponse { /** *Information about the configuration of the input.
* @public */ inputConfiguration?: InputConfiguration | undefined; } /** * @public */ export interface DeleteAlarmModelRequest { /** *The name of the alarm model.
* @public */ alarmModelName: string | undefined; } /** * @public */ export interface DeleteAlarmModelResponse { } /** * @public */ export interface DeleteDetectorModelRequest { /** *The name of the detector model to be deleted.
* @public */ detectorModelName: string | undefined; } /** * @public */ export interface DeleteDetectorModelResponse { } /** * @public */ export interface DeleteInputRequest { /** *The name of the input to delete.
* @public */ inputName: string | undefined; } /** * @public */ export interface DeleteInputResponse { } /** * @public */ export interface DescribeAlarmModelRequest { /** *The name of the alarm model.
* @public */ alarmModelName: string | undefined; /** *The version of the alarm model.
* @public */ alarmModelVersion?: string | undefined; } /** * @public */ export interface DescribeAlarmModelResponse { /** *The time the alarm model was created, in the Unix epoch format.
* @public */ creationTime?: Date | undefined; /** *The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ alarmModelArn?: string | undefined; /** *The version of the alarm model.
* @public */ alarmModelVersion?: string | undefined; /** *The time the alarm model was last updated, in the Unix epoch format.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the alarm model. The status can be one of the following values:
*
* ACTIVE - The alarm model is active and it's ready to evaluate data.
* ACTIVATING - AWS IoT Events is activating your alarm model.
* Activating an alarm model can take up to a few minutes.
* INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data.
* Check your alarm model information and update the alarm model.
* FAILED - You couldn't create or update the alarm model. Check your alarm model information
* and try again.
* Contains information about the status of the alarm model. *
* @public */ statusMessage?: string | undefined; /** *The name of the alarm model.
* @public */ alarmModelName?: string | undefined; /** *The description of the alarm model.
* @public */ alarmModelDescription?: string | undefined; /** *The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ roleArn?: string | undefined; /** *An input attribute used as a key to create an alarm. * AWS IoT Events routes inputs * associated with this key to the alarm.
* @public */ key?: string | undefined; /** *A non-negative integer that reflects the severity level of the alarm.
* @public */ severity?: number | undefined; /** *Defines when your alarm is invoked.
* @public */ alarmRule?: AlarmRule | undefined; /** *Contains information about one or more notification actions.
* @public */ alarmNotification?: AlarmNotification | undefined; /** *Contains information about one or more alarm actions.
* @public */ alarmEventActions?: AlarmEventActions | undefined; /** *Contains the configuration information of alarm state changes.
* @public */ alarmCapabilities?: AlarmCapabilities | undefined; } /** * @public */ export interface DescribeDetectorModelRequest { /** *The name of the detector model.
* @public */ detectorModelName: string | undefined; /** *The version of the detector model.
* @public */ detectorModelVersion?: string | undefined; } /** *Information about the detector model.
* @public */ export interface DetectorModel { /** *Information that defines how a detector operates.
* @public */ detectorModelDefinition?: DetectorModelDefinition | undefined; /** *Information about how the detector is configured.
* @public */ detectorModelConfiguration?: DetectorModelConfiguration | undefined; } /** * @public */ export interface DescribeDetectorModelResponse { /** *Information about the detector model.
* @public */ detectorModel?: DetectorModel | undefined; } /** * @public */ export interface DescribeDetectorModelAnalysisRequest { /** *The ID of the analysis result that you want to retrieve.
* @public */ analysisId: string | undefined; } /** * @public */ export interface DescribeDetectorModelAnalysisResponse { /** *The status of the analysis activity. The status can be one of the following values:
*
* RUNNING - AWS IoT Events is analyzing your detector model. This process can take
* several minutes to complete.
* COMPLETE - AWS IoT Events finished analyzing your detector model.
* FAILED - AWS IoT Events couldn't analyze your detector model. Try again
* later.
The name of the input.
* @public */ inputName: string | undefined; } /** *Information about the input.
* @public */ export interface Input { /** *Information about the configuration of an input.
* @public */ inputConfiguration?: InputConfiguration | undefined; /** *The definition of the input.
* @public */ inputDefinition?: InputDefinition | undefined; } /** * @public */ export interface DescribeInputResponse { /** *Information about the input.
* @public */ input?: Input | undefined; } /** * @public */ export interface DescribeLoggingOptionsRequest { } /** *The detector model and the specific detectors (instances) for which the logging level is * given.
* @public */ export interface DetectorDebugOption { /** *The name of the detector model.
* @public */ detectorModelName: string | undefined; /** *The value of the input attribute key used to create the detector (the instance of the * detector model).
* @public */ keyValue?: string | undefined; } /** *The values of the AWS IoT Events logging options.
* @public */ export interface LoggingOptions { /** *The ARN of the role that grants permission to AWS IoT Events to perform logging.
* @public */ roleArn: string | undefined; /** *The logging level.
* @public */ level: LoggingLevel | undefined; /** *If TRUE, logging is enabled for AWS IoT Events.
* @public */ enabled: boolean | undefined; /** *Information that identifies those detector models and their detectors (instances) for * which the logging level is given.
* @public */ detectorDebugOptions?: DetectorDebugOption[] | undefined; } /** * @public */ export interface DescribeLoggingOptionsResponse { /** *The current settings of the AWS IoT Events logging options.
* @public */ loggingOptions?: LoggingOptions | undefined; } /** *Information about the detector model.
* @public */ export interface DetectorModelSummary { /** *The name of the detector model.
* @public */ detectorModelName?: string | undefined; /** *A brief description of the detector model.
* @public */ detectorModelDescription?: string | undefined; /** *The time the detector model was created.
* @public */ creationTime?: Date | undefined; } /** *Information about the detector model version.
* @public */ export interface DetectorModelVersionSummary { /** *The name of the detector model.
* @public */ detectorModelName?: string | undefined; /** *The ID of the detector model version.
* @public */ detectorModelVersion?: string | undefined; /** *The ARN of the detector model version.
* @public */ detectorModelArn?: string | undefined; /** *The ARN of the role that grants the detector model permission to perform its tasks.
* @public */ roleArn?: string | undefined; /** *The time the detector model version was created.
* @public */ creationTime?: Date | undefined; /** *The last time the detector model version was updated.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the detector model version.
* @public */ status?: DetectorModelVersionStatus | undefined; /** *Information about the order in which events are evaluated and how actions are executed. *
* @public */ evaluationMethod?: EvaluationMethod | undefined; } /** * @public */ export interface GetDetectorModelAnalysisResultsRequest { /** *The ID of the analysis result that you want to retrieve.
* @public */ analysisId: string | undefined; /** *The token that you can use to return the next set of results.
* @public */ nextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ maxResults?: number | undefined; } /** * @public */ export interface GetDetectorModelAnalysisResultsResponse { /** *Contains information about one or more analysis results.
* @public */ analysisResults?: AnalysisResult[] | undefined; /** *The token that you can use to return the next set of results,
* or null if there are no more results.
* The identifier of the input routed to AWS IoT Events. *
* @public */ export interface IotEventsInputIdentifier { /** ** The name of the input routed to AWS IoT Events. *
* @public */ inputName: string | undefined; } /** ** The asset model property identifer of the input routed from AWS IoT SiteWise. *
* @public */ export interface IotSiteWiseAssetModelPropertyIdentifier { /** ** The ID of the AWS IoT SiteWise asset model. *
* @public */ assetModelId: string | undefined; /** ** The ID of the AWS IoT SiteWise asset property. *
* @public */ propertyId: string | undefined; } /** ** The identifer of the input routed from AWS IoT SiteWise. *
* @public */ export interface IotSiteWiseInputIdentifier { /** ** The identifier of the AWS IoT SiteWise asset model property. *
* @public */ iotSiteWiseAssetModelPropertyIdentifier?: IotSiteWiseAssetModelPropertyIdentifier | undefined; } /** ** The identifer of the input. *
* @public */ export interface InputIdentifier { /** ** The identifier of the input routed to AWS IoT Events. *
* @public */ iotEventsInputIdentifier?: IotEventsInputIdentifier | undefined; /** ** The identifer of the input routed from AWS IoT SiteWise. *
* @public */ iotSiteWiseInputIdentifier?: IotSiteWiseInputIdentifier | undefined; } /** *Information about the input.
* @public */ export interface InputSummary { /** *The name of the input.
* @public */ inputName?: string | undefined; /** *A brief description of the input.
* @public */ inputDescription?: string | undefined; /** *The ARN of the input.
* @public */ inputArn?: string | undefined; /** *The time the input was created.
* @public */ creationTime?: Date | undefined; /** *The last time the input was updated.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the input.
* @public */ status?: InputStatus | undefined; } /** * @public */ export interface ListAlarmModelsRequest { /** *The token that you can use to return the next set of results.
* @public */ nextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ maxResults?: number | undefined; } /** * @public */ export interface ListAlarmModelsResponse { /** *A list that summarizes each alarm model.
* @public */ alarmModelSummaries?: AlarmModelSummary[] | undefined; /** *The token that you can use to return the next set of results,
* or null if there are no more results.
The name of the alarm model.
* @public */ alarmModelName: string | undefined; /** *The token that you can use to return the next set of results.
* @public */ nextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ maxResults?: number | undefined; } /** * @public */ export interface ListAlarmModelVersionsResponse { /** *A list that summarizes each alarm model version.
* @public */ alarmModelVersionSummaries?: AlarmModelVersionSummary[] | undefined; /** *The token that you can use to return the next set of results,
* or null if there are no more results.
The token that you can use to return the next set of results.
* @public */ nextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ maxResults?: number | undefined; } /** * @public */ export interface ListDetectorModelsResponse { /** *Summary information about the detector models.
* @public */ detectorModelSummaries?: DetectorModelSummary[] | undefined; /** *The token that you can use to return the next set of results,
* or null if there are no more results.
The name of the detector model whose versions are returned.
* @public */ detectorModelName: string | undefined; /** *The token that you can use to return the next set of results.
* @public */ nextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ maxResults?: number | undefined; } /** * @public */ export interface ListDetectorModelVersionsResponse { /** *Summary information about the detector model versions.
* @public */ detectorModelVersionSummaries?: DetectorModelVersionSummary[] | undefined; /** *The token that you can use to return the next set of results,
* or null if there are no more results.
* The identifer of the routed input. *
* @public */ inputIdentifier: InputIdentifier | undefined; /** ** The maximum number of results to be returned per request. *
* @public */ maxResults?: number | undefined; /** ** The token that you can use to return the next set of results. *
* @public */ nextToken?: string | undefined; } /** ** Contains information about the routed resource. *
* @public */ export interface RoutedResource { /** ** The name of the routed resource. *
* @public */ name?: string | undefined; /** ** The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. *
* @public */ arn?: string | undefined; } /** * @public */ export interface ListInputRoutingsResponse { /** ** Summary information about the routed resources. *
* @public */ routedResources?: RoutedResource[] | undefined; /** *
* The token that you can use to return the next set of results,
* or null if there are no more results.
*
The token that you can use to return the next set of results.
* @public */ nextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ maxResults?: number | undefined; } /** * @public */ export interface ListInputsResponse { /** *Summary information about the inputs.
* @public */ inputSummaries?: InputSummary[] | undefined; /** *The token that you can use to return the next set of results,
* or null if there are no more results.
The ARN of the resource.
* @public */ resourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *The list of tags assigned to the resource.
* @public */ tags?: Tag[] | undefined; } /** * @public */ export interface PutLoggingOptionsRequest { /** *The new values of the AWS IoT Events logging options.
* @public */ loggingOptions: LoggingOptions | undefined; } /** * @public */ export interface StartDetectorModelAnalysisRequest { /** *Information that defines how a detector operates.
* @public */ detectorModelDefinition: DetectorModelDefinition | undefined; } /** * @public */ export interface StartDetectorModelAnalysisResponse { /** *The ID that you can use to retrieve the analysis result.
* @public */ analysisId?: string | undefined; } /** * @public */ export interface TagResourceRequest { /** *The ARN of the resource.
* @public */ resourceArn: string | undefined; /** *The new or modified tags for the resource.
* @public */ tags: Tag[] | undefined; } /** * @public */ export interface TagResourceResponse { } /** * @public */ export interface UntagResourceRequest { /** *The ARN of the resource.
* @public */ resourceArn: string | undefined; /** *A list of the keys of the tags to be removed from the resource.
* @public */ tagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { } /** * @public */ export interface UpdateAlarmModelRequest { /** *The name of the alarm model.
* @public */ alarmModelName: string | undefined; /** *The description of the alarm model.
* @public */ alarmModelDescription?: string | undefined; /** *The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ roleArn: string | undefined; /** *A non-negative integer that reflects the severity level of the alarm.
* @public */ severity?: number | undefined; /** *Defines when your alarm is invoked.
* @public */ alarmRule: AlarmRule | undefined; /** *Contains information about one or more notification actions.
* @public */ alarmNotification?: AlarmNotification | undefined; /** *Contains information about one or more alarm actions.
* @public */ alarmEventActions?: AlarmEventActions | undefined; /** *Contains the configuration information of alarm state changes.
* @public */ alarmCapabilities?: AlarmCapabilities | undefined; } /** * @public */ export interface UpdateAlarmModelResponse { /** *The time the alarm model was created, in the Unix epoch format.
* @public */ creationTime?: Date | undefined; /** *The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
* @public */ alarmModelArn?: string | undefined; /** *The version of the alarm model.
* @public */ alarmModelVersion?: string | undefined; /** *The time the alarm model was last updated, in the Unix epoch format.
* @public */ lastUpdateTime?: Date | undefined; /** *The status of the alarm model. The status can be one of the following values:
*
* ACTIVE - The alarm model is active and it's ready to evaluate data.
* ACTIVATING - AWS IoT Events is activating your alarm model.
* Activating an alarm model can take up to a few minutes.
* INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data.
* Check your alarm model information and update the alarm model.
* FAILED - You couldn't create or update the alarm model. Check your alarm model information
* and try again.
The name of the detector model that is updated.
* @public */ detectorModelName: string | undefined; /** *Information that defines how a detector operates.
* @public */ detectorModelDefinition: DetectorModelDefinition | undefined; /** *A brief description of the detector model.
* @public */ detectorModelDescription?: string | undefined; /** *The ARN of the role that grants permission to AWS IoT Events to perform its operations.
* @public */ roleArn: string | undefined; /** *Information about the order in which events are evaluated and how actions are executed. *
* @public */ evaluationMethod?: EvaluationMethod | undefined; } /** * @public */ export interface UpdateDetectorModelResponse { /** *Information about how the detector model is configured.
* @public */ detectorModelConfiguration?: DetectorModelConfiguration | undefined; } /** * @public */ export interface UpdateInputRequest { /** *The name of the input you want to update.
* @public */ inputName: string | undefined; /** *A brief description of the input.
* @public */ inputDescription?: string | undefined; /** *The definition of the input.
* @public */ inputDefinition: InputDefinition | undefined; } /** * @public */ export interface UpdateInputResponse { /** *Information about the configuration of the input.
* @public */ inputConfiguration?: InputConfiguration | undefined; }