Alarms - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Alarms

Contains the configuration information of an alarm created in an Amazon 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 Amazon IoT SiteWise Application Guide.

Contents

alarmRoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: Yes

notificationLambdaArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: