AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::Alarms

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass Alarms data as a hash:

{
  alarm_role_arn: "ARN", # required
  notification_lambda_arn: "ARN",
}

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_role_arnString

The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

Returns:

  • (String)


155
156
157
158
159
160
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 155

class Alarms < Struct.new(
  :alarm_role_arn,
  :notification_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notification_lambda_arnString

The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

Returns:

  • (String)


155
156
157
158
159
160
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 155

class Alarms < Struct.new(
  :alarm_role_arn,
  :notification_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end