NotificationEventSummary - AWS User Notifications
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

NotificationEventSummary

Describes a short summary and metadata for a NotificationEvent.

Contents

eventStatus

Provides additional information about the current status of the NotificationEvent.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE.

Type: String

Valid Values: HEALTHY | UNHEALTHY

Required: Yes

messageComponents

The message components of a notification event.

Type: MessageComponentsSummary 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: SourceEventMetadataSummary object

Required: Yes

See Also

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