Alert

Full alert entity, returned by both CreateAlert and GetAlert. A create and a read of the same alert describe it identically except for state, which only the read paths populate. UpdateAlert returns an empty response.

accountId

The AWS account ID that owns the alert.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: Yes

alertArn

The Amazon Resource Name (ARN) of the alert.

Type: String

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

Pattern: arn:.+

Required: Yes

createdAt

The timestamp when the alert was created.

Type: Timestamp

Required: Yes

name

The name of the alert.

Type: String

Required: Yes

rule

The rule that defines how the alert is evaluated.

Type: Rule object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

updatedAt

The timestamp when the alert was last updated.

Type: Timestamp

Required: Yes

alertId

The stable alert identifier (see AlertId), minted on create and immutable across updates. Use it (not name) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

Type: String

Length Constraints: Fixed length of 32.

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

Required: No

description

An optional description of the alert.

Type: String

Required: No

notificationRules

The notification rules for the alert.

Type: Array of NotificationRule objects

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

Required: No

notificationStatus

Whether notifications are enabled.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

profileId

The ID of the access profile associated with the alert.

Type: String

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

Pattern: [a-zA-Z0-9_-]+

Required: No

spaceId

The ID of the space the alert belongs to.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

state

Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required.

Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it.

contributorSummary is nested inside this member, so it too is absent on CreateAlert.

Type: AlertStateInfo object

Required: No

Alert

Contents

See Also