NotificationEvent

A NotificationEvent is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.

id

The unique identifier for a NotificationEvent.

Type: String

Pattern: [a-z0-9]{27}

Required: Yes

media

A list of media elements.

Type: Array of MediaElement objects

Required: Yes

messageComponents

Describes the components of a notification message.

Type: MessageComponents object

Required: Yes

notificationType

The type of event causing the notification.

Values:
- ALERT
  - A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
- WARNING
  - A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
- ANNOUNCEMENT
  - A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
- INFORMATIONAL
  - A notification about informational messages. For example, recommendations, service announcements, or reminders.

Type: String

Valid Values: ALERT | WARNING | ANNOUNCEMENT | INFORMATIONAL

Required: Yes

schemaVersion

The schema version of the Notification Event.

Type: String

Valid Values: v1.0

Required: Yes

sourceEventMetadata

The source event metadata.

Type: SourceEventMetadata object

Required: Yes

textParts

A list of text values.

Type: String to TextPartValue object map

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

Key Pattern: [A-Za-z0-9_]+

Required: Yes

aggregateNotificationEventArn

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

Type: String

Pattern: arn:[-.a-z0-9]{1,63}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27}

Required: No

aggregationEventType

The aggregation type of the NotificationConfiguration.

Values:
- AGGREGATE
  - The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
- CHILD
  - Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
- NONE
  - The notification isn't aggregated.

Type: String

Valid Values: AGGREGATE | CHILD | NONE

Required: No

aggregationSummary

Provides additional information about how multiple notifications are grouped.

Type: AggregationSummary object

Required: No

endTime

The end time of the event.

Type: Timestamp

Required: No

eventStatus

The assessed nature of the event.

Values:
- HEALTHY
  - All EventRules are ACTIVE and any call can be run.
- UNHEALTHY
  - Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

Type: String

Valid Values: HEALTHY | UNHEALTHY

Required: No

organizationalUnitId

The unique identifier of the organizational unit associated with the notification event.

Type: String

Pattern: (Root|r-[0-9a-z]{4,32}|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})

Required: No

sourceEventDetailUrl

The source event URL.

Type: String

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

Pattern: (https?)://.*

Required: No

sourceEventDetailUrlDisplayText

The detailed URL for the source event.

Type: String

Required: No

startTime

The notification event start time.

Type: Timestamp

Required: No

NotificationEvent

Contents

See Also