aws_iotevents_alarm_model

account_id

Type: STRING

alarm_capabilities

Type: STRUCT
Provider name: alarmCapabilities
Description: Contains the configuration information of alarm state changes.

• acknowledge_flow
  Type: STRUCT
  Provider name: acknowledgeFlow
  Description: Specifies whether to get notified for alarm state changes.
  
  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: 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.
    
• initialization_configuration
  Type: STRUCT
  Provider name: initializationConfiguration
  Description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
  
  • disabled_on_initialization
    Type: BOOLEAN
    Provider name: disabledOnInitialization
    Description: 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.
    

alarm_event_actions

Type: STRUCT
Provider name: alarmEventActions
Description: Contains information about one or more alarm actions.

• alarm_actions
  Type: UNORDERED_LIST_STRUCT
  Provider name: alarmActions
  Description: Specifies one or more supported actions to receive notifications when the alarm state changes.
  
  • dynamo_d_bv2
    Type: STRUCT
    Provider name: dynamoDBv2
    
    • payload
      Type: STRUCT
      Provider name: payload
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
    • table_name
      Type: STRING
      Provider name: tableName
      Description: The name of the DynamoDB table.
      
  • dynamo_db
    Type: STRUCT
    Provider name: dynamoDB
    
    • hash_key_field
      Type: STRING
      Provider name: hashKeyField
      Description: The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.
      
    • hash_key_type
      Type: STRING
      Provider name: hashKeyType
      Description: 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’.
      
    • hash_key_value
      Type: STRING
      Provider name: hashKeyValue
      Description: The value of the hash key (also called the partition key).
      
    • operation
      Type: STRING
      Provider name: operation
      Description: 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.
      
    • payload
      Type: STRUCT
      Provider name: payload
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
    • payload_field
      Type: STRING
      Provider name: payloadField
      Description: 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.
      
    • range_key_field
      Type: STRING
      Provider name: rangeKeyField
      Description: The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.
      
    • range_key_type
      Type: STRING
      Provider name: rangeKeyType
      Description: 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’.
      
    • range_key_value
      Type: STRING
      Provider name: rangeKeyValue
      Description: The value of the range key (also called the sort key).
      
    • table_name
      Type: STRING
      Provider name: tableName
      Description: The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.
      
  • firehose
    Type: STRUCT
    Provider name: firehose
    
    • delivery_stream_name
      Type: STRING
      Provider name: deliveryStreamName
      Description: The name of the Kinesis Data Firehose delivery stream where the data is written.
      
    • payload
      Type: STRUCT
      Provider name: payload
      Description: You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
    • separator
      Type: STRING
      Provider name: separator
      Description: 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).
      
  • iot_events
    Type: STRUCT
    Provider name: iotEvents
    
    • input_name
      Type: STRING
      Provider name: inputName
      Description: The name of the AWS IoT Events input where the data is sent.
      
    • payload
      Type: STRUCT
      Provider name: payload
      Description: You can configure the action payload when you send a message to an AWS IoT Events input.
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
  • iot_site_wise
    Type: STRUCT
    Provider name: iotSiteWise
    
    • asset_id
      Type: STRING
      Provider name: assetId
      Description: The ID of the asset that has the specified property.
      
    • entry_id
      Type: STRING
      Provider name: entryId
      Description: 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.
      
    • property_alias
      Type: STRING
      Provider name: propertyAlias
      Description: The alias of the asset property.
      
    • property_id
      Type: STRING
      Provider name: propertyId
      Description: The ID of the asset property.
      
    • property_value
      Type: STRUCT
      Provider name: propertyValue
      Description: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
      
      • quality
        Type: STRING
        Provider name: quality
        Description: The quality of the asset property value. The value must be ‘GOOD’, ‘BAD’, or ‘UNCERTAIN’.
        
      • timestamp
        Type: STRUCT
        Provider name: timestamp
        Description: The timestamp associated with the asset property value. The default is the current event time.
        
        • offset_in_nanos
          Type: STRING
          Provider name: offsetInNanos
          Description: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.
          
        • time_in_seconds
          Type: STRING
          Provider name: timeInSeconds
          Description: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
          
      • value
        Type: STRUCT
        Provider name: value
        Description: The value to send to an asset property.
        
        • boolean_value
          Type: STRING
          Provider name: booleanValue
          Description: 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.
          
        • double_value
          Type: STRING
          Provider name: doubleValue
          Description: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
          
        • integer_value
          Type: STRING
          Provider name: integerValue
          Description: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
          
        • string_value
          Type: STRING
          Provider name: stringValue
          Description: The asset property value is a string. You must use an expression, and the evaluated result should be a string.
          
  • iot_topic_publish
    Type: STRUCT
    Provider name: iotTopicPublish
    
    • mqtt_topic
      Type: STRING
      Provider name: mqttTopic
      Description: The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.
      
    • payload
      Type: STRUCT
      Provider name: payload
      Description: You can configure the action payload when you publish a message to an AWS IoT Core topic.
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
  • lambda
    Type: STRUCT
    Provider name: lambda
    
    • function_arn
      Type: STRING
      Provider name: functionArn
      Description: The ARN of the Lambda function that is executed.
      
    • payload
      Type: STRUCT
      Provider name: payload
      Description: You can configure the action payload when you send a message to a Lambda function.
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
  • sns
    Type: STRUCT
    Provider name: sns
    
    • payload
      Type: STRUCT
      Provider name: payload
      Description: You can configure the action payload when you send a message as an Amazon SNS push notification.
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
    • target_arn
      Type: STRING
      Provider name: targetArn
      Description: The ARN of the Amazon SNS target where the message is sent.
      
  • sqs
    Type: STRUCT
    Provider name: sqs
    
    • payload
      Type: STRUCT
      Provider name: payload
      Description: You can configure the action payload when you send a message to an Amazon SQS queue.
      
      • content_expression
        Type: STRING
        Provider name: contentExpression
        Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
        
      • type
        Type: STRING
        Provider name: type
        Description: The value of the payload type can be either STRING or JSON.
        
    • queue_url
      Type: STRING
      Provider name: queueUrl
      Description: The URL of the SQS queue where the data is written.
      
    • use_base64
      Type: BOOLEAN
      Provider name: useBase64
      Description: 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.
      

alarm_model_arn

Type: STRING
Provider name: alarmModelArn
Description: The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

alarm_model_description

Type: STRING
Provider name: alarmModelDescription
Description: The description of the alarm model.

alarm_model_name

Type: STRING
Provider name: alarmModelName
Description: The name of the alarm model.

alarm_model_version

Type: STRING
Provider name: alarmModelVersion
Description: The version of the alarm model.

alarm_notification

Type: STRUCT
Provider name: alarmNotification
Description: Contains information about one or more notification actions.

• notification_actions
  Type: UNORDERED_LIST_STRUCT
  Provider name: notificationActions
  Description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
  
  • action
    Type: STRUCT
    Provider name: action
    Description: Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
    
    • lambda_action
      Type: STRUCT
      Provider name: lambdaAction
      
      • function_arn
        Type: STRING
        Provider name: functionArn
        Description: The ARN of the Lambda function that is executed.
        
      • payload
        Type: STRUCT
        Provider name: payload
        Description: You can configure the action payload when you send a message to a Lambda function.
        
        • content_expression
          Type: STRING
          Provider name: contentExpression
          Description: The content of the payload. You can use a string expression that includes quoted strings (’<string>’), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
          
        • type
          Type: STRING
          Provider name: type
          Description: The value of the payload type can be either STRING or JSON.
          
  • email_configurations
    Type: UNORDERED_LIST_STRUCT
    Provider name: emailConfigurations
    Description: Contains the configuration information of email notifications.
    
    • content
      Type: STRUCT
      Provider name: content
      Description: Contains the subject and message of an email.
      
      • additional_message
        Type: STRING
        Provider name: additionalMessage
        Description: The message that you want to send. The message can be up to 200 characters.
        
      • subject
        Type: STRING
        Provider name: subject
        Description: The subject of the email.
        
    • from
      Type: STRING
      Provider name: from
      Description: 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.
      
    • recipients
      Type: STRUCT
      Provider name: recipients
      Description: 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.
      
      • to
        Type: UNORDERED_LIST_STRUCT
        Provider name: to
        Description: Specifies one or more recipients who receive the email.
        
        • sso_identity
          Type: STRUCT
          Provider name: ssoIdentity
          Description: The AWS Single Sign-On (AWS SSO) authentication information.
          
          • identity_store_id
            Type: STRING
            Provider name: identityStoreId
            Description: The ID of the AWS SSO identity store.
            
          • user_id
            Type: STRING
            Provider name: userId
            Description: The user ID.
            
  • sms_configurations
    Type: UNORDERED_LIST_STRUCT
    Provider name: smsConfigurations
    Description: Contains the configuration information of SMS notifications.
    
    • additional_message
      Type: STRING
      Provider name: additionalMessage
      Description: The message that you want to send. The message can be up to 200 characters.
      
    • recipients
      Type: UNORDERED_LIST_STRUCT
      Provider name: recipients
      Description: Specifies one or more recipients who receive the message. You must add the users that receive SMS messages to your AWS SSO store.
      
      • sso_identity
        Type: STRUCT
        Provider name: ssoIdentity
        Description: The AWS Single Sign-On (AWS SSO) authentication information.
        
        • identity_store_id
          Type: STRING
          Provider name: identityStoreId
          Description: The ID of the AWS SSO identity store.
          
        • user_id
          Type: STRING
          Provider name: userId
          Description: The user ID.
          
    • sender_id
      Type: STRING
      Provider name: senderId
      Description: The sender ID.
      

alarm_rule

Type: STRUCT
Provider name: alarmRule
Description: Defines when your alarm is invoked.

• simple_rule
  Type: STRUCT
  Provider name: simpleRule
  Description: A rule that compares an input property value to a threshold value with a comparison operator.
  
  • comparison_operator
    Type: STRING
    Provider name: comparisonOperator
    Description: The comparison operator.
    
  • input_property
    Type: STRING
    Provider name: inputProperty
    Description: The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
    
  • threshold
    Type: STRING
    Provider name: threshold
    Description: The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
    

creation_time

Type: TIMESTAMP
Provider name: creationTime
Description: The time the alarm model was created, in the Unix epoch format.

key

Type: STRING
Provider name: key
Description: An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

last_update_time

Type: TIMESTAMP
Provider name: lastUpdateTime
Description: The time the alarm model was last updated, in the Unix epoch format.

role_arn

Type: STRING
Provider name: roleArn
Description: 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.

severity

Type: INT32
Provider name: severity
Description: A non-negative integer that reflects the severity level of the alarm.

status

Type: STRING
Provider name: status
Description: 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.

status_message

Type: STRING
Provider name: statusMessage
Description: Contains information about the status of the alarm model.

tags

Type: UNORDERED_LIST_STRING