A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.
Contents
- id
-
Unique identifier for a
ManagedNotificationEvent
.Type: String
Pattern:
[a-z0-9]{27}
Required: Yes
- messageComponents
-
Describes the components of a notification message.
Type: MessageComponents object
Required: Yes
- notificationType
-
The nature of the event causing this 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
-
Version of the
ManagedNotificationEvent
schema.Type: String
Valid Values:
v1.0
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
- aggregationEventType
-
The notifications aggregation type.
Type: String
Valid Values:
AGGREGATE | CHILD | NONE
Required: No
- aggregationSummary
-
Provides additional information about the aggregation key.
Type: AggregationSummary object
Required: No
- endTime
-
The end time of the notification event.
Type: Timestamp
Required: No
- eventStatus
-
The status of an event.
-
Values:
-
HEALTHY
-
All EventRules are
ACTIVE
and any call can be run.
-
-
UNHEALTHY
-
Some EventRules are
ACTIVE
and some areINACTIVE
. Any call can be run.
-
-
Type: String
Valid Values:
HEALTHY | UNHEALTHY
Required: No
-
- organizationalUnitId
-
The Organizational Unit Id that an AWS account belongs to.
Type: String
Pattern:
Root|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}
Required: No
- sourceEventDetailUrl
-
URL defined by Source Service to be used by notification consumers to get additional information about event.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Pattern:
(https?)://.*
Required: No
- sourceEventDetailUrlDisplayText
-
Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.
Type: String
Required: No
- startTime
-
The earliest time of events to return from this call.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: