Skip to content

ManagedNotificationEvent

Source code in docs_src/capo_notifications/types/managed_notification_event.py
class ManagedNotificationEvent(TypedDict, closed=True):
    schema_version: "capo_notifications.types.schema_version.SchemaVersion"
    """<p>Version of the <code>ManagedNotificationEvent</code> schema.</p>"""
    id: "capo_notifications.types.notification_event_id.NotificationEventId"
    """<p>Unique identifier for a <code>ManagedNotificationEvent</code>.</p>"""
    message_components: "capo_notifications.types.message_components.MessageComponents"
    source_event_detail_url: NotRequired["capo_notifications.types.url.Url"]
    """<p>URL defined by Source Service to be used by notification consumers to get additional information about event.</p>"""
    source_event_detail_url_display_text: NotRequired["str"]
    """<p>Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.</p>"""
    notification_type: "capo_notifications.types.notification_type.NotificationType"
    """<p>The nature of the event causing this notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>"""
    event_status: NotRequired["capo_notifications.types.event_status.EventStatus"]
    """<p>The status of an event.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> </ul> </li> </ul>"""
    aggregation_event_type: NotRequired[
        "capo_notifications.types.aggregation_event_type.AggregationEventType"
    ]
    """<p>The notifications aggregation type.</p>"""
    aggregation_summary: NotRequired[
        "capo_notifications.types.aggregation_summary.AggregationSummary"
    ]
    start_time: NotRequired["datetime.datetime"]
    """<p>The earliest time of events to return from this call.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The end time of the notification event.</p>"""
    text_parts: "capo_notifications.types.text_parts.TextParts"
    """<p>A list of text values.</p>"""
    organizational_unit_id: NotRequired[
        "capo_notifications.types.organizational_unit_id.OrganizationalUnitId"
    ]
    """<p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>"""
    attachments: NotRequired[
        "capo_notifications.types.notification_event_attachment_list.NotificationEventAttachmentList"
    ]
    """<p>A list of files attached to the notification event.</p>"""

aggregation_event_type instance-attribute

aggregation_event_type: NotRequired[AggregationEventType]

The notifications aggregation type.

aggregation_summary instance-attribute

aggregation_summary: NotRequired[AggregationSummary]

attachments instance-attribute

attachments: NotRequired[NotificationEventAttachmentList]

A list of files attached to the notification event.

end_time instance-attribute

end_time: NotRequired[datetime]

The end time of the notification event.

event_status instance-attribute

event_status: NotRequired[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 are INACTIVE. Any call can be run.

id instance-attribute

Unique identifier for a ManagedNotificationEvent.

message_components instance-attribute

message_components: MessageComponents

notification_type instance-attribute

notification_type: 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.

organizational_unit_id instance-attribute

organizational_unit_id: NotRequired[OrganizationalUnitId]

The Organizational Unit Id that an Amazon Web Services account belongs to.

schema_version instance-attribute

schema_version: SchemaVersion

Version of the ManagedNotificationEvent schema.

source_event_detail_url instance-attribute

source_event_detail_url: NotRequired[Url]

URL defined by Source Service to be used by notification consumers to get additional information about event.

source_event_detail_url_display_text instance-attribute

source_event_detail_url_display_text: NotRequired[str]

Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.

start_time instance-attribute

start_time: NotRequired[datetime]

The earliest time of events to return from this call.

text_parts instance-attribute

text_parts: TextParts

A list of text values.