View a markdown version of this page

AlertFilterCriteria - Amazon CloudWatch Omni

AlertFilterCriteria

Filter criteria for ListAlerts. All members are optional; each omitted member is unconstrained. At most one of names, namePrefix, ids may be provided (mutually exclusive; the service rejects more than one). The remaining members combine with AND.

Contents

ids

Filter to alerts whose AlertId exactly matches any entry (OR semantics). Mutually exclusive with names and namePrefix.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Fixed length of 32.

Pattern: [0-9a-f]{32}

Required: No

namePrefix

Filter to alerts whose name starts with this prefix. Mutually exclusive with names and ids.

Type: String

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

Pattern: [a-zA-Z0-9_.@~()-]+

Required: No

names

Filter to alerts whose name exactly matches any entry (OR semantics). Mutually exclusive with namePrefix and ids.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Pattern: [a-zA-Z0-9_.@~()-]+

Required: No

notificationsEnabled

Filter to alerts by whether notifications are enabled.

Type: Boolean

Required: No

stateValue

Filter to alerts currently in any of these states (OR semantics).

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 4 items.

Valid Values: OK | WARNING | CRITICAL | NODATA

Required: No

See Also

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