View a markdown version of this page

AlertCondition - Amazon CloudWatch Omni

AlertCondition

The condition that determines when the alert fires.

On UpdateAlert a supplied condition is replaced whole, not merged: an omitted warningThreshold or criticalThreshold removes that tier, and an omitted thresholdField clears it. A condition must keep at least one tier. thresholdMode and comparator are optional at the Smithy level (so a single-tier condition is expressible) but are required whenever a threshold is present; enforced by the service-side validator.

Contents

comparator

The comparison operator applied to the threshold.

Type: String

Valid Values: GT | LT | GTE | LTE

Required: No

criticalThreshold

The value at which the alert enters the CRITICAL state.

Type: Double

Required: No

thresholdField

The field the threshold is evaluated against.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

thresholdMode

How the threshold is applied to query results.

Type: String

Valid Values: COUNT_OF_RESULTS | FIELD_VALUE

Required: No

warningThreshold

The value at which the alert enters the WARNING state.

Type: Double

Required: No

See Also

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