Class: Aws::Notifications::Types::ManagedNotificationEvent

Inherits:

Struct

• Object
• Struct
• Aws::Notifications::Types::ManagedNotificationEvent

Defined in:

gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb

Overview

A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation_event_type ⇒ String

  The notifications aggregation type.

• #aggregation_summary ⇒ Types::AggregationSummary

  Provides additional information about the aggregation key.

• #attachments ⇒ Array<Types::NotificationEventAttachment>

  A list of files attached to the notification event.

• #end_time ⇒ Time

  The end time of the notification event.

• #event_status ⇒ String

  The status of an event.

• #id ⇒ String

  Unique identifier for a ManagedNotificationEvent.

• #message_components ⇒ Types::MessageComponents

  Describes the components of a notification message.

• #notification_type ⇒ String

  The nature of the event causing this notification.

• #organizational_unit_id ⇒ String

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

• #schema_version ⇒ String

  Version of the ManagedNotificationEvent schema.

• #source_event_detail_url ⇒ String

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

• #source_event_detail_url_display_text ⇒ String

  Text that needs to be hyperlinked with the sourceEventDetailUrl.

• #start_time ⇒ Time

  The earliest time of events to return from this call.

• #text_parts ⇒ Hash<String,Types::TextPartValue>

  A list of text values.

Instance Attribute Details

#aggregation_event_type ⇒ String

The notifications aggregation type.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_summary ⇒ Types::AggregationSummary

Provides additional information about the aggregation key.

Returns:

• (Types::AggregationSummary)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#attachments ⇒ Array<Types::NotificationEventAttachment>

A list of files attached to the notification event.

Returns:

• (Array<Types::NotificationEventAttachment>)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time of the notification event.

Returns:

• (Time)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#event_status ⇒ String

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.

    ^

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

Unique identifier for a ManagedNotificationEvent.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#message_components ⇒ Types::MessageComponents

Describes the components of a notification message.

Returns:

• (Types::MessageComponents)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#notification_type ⇒ String

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.

    ^

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#schema_version ⇒ String

Version of the ManagedNotificationEvent schema.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#source_event_detail_url ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#source_event_detail_url_display_text ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The earliest time of events to return from this call.

Returns:

• (Time)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end

#text_parts ⇒ Hash<String,Types::TextPartValue>

A list of text values.

Returns:

• (Hash<String,Types::TextPartValue>)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2225

class ManagedNotificationEvent < Struct.new(
  :schema_version,
  :id,
  :message_components,
  :source_event_detail_url,
  :source_event_detail_url_display_text,
  :notification_type,
  :event_status,
  :aggregation_event_type,
  :aggregation_summary,
  :start_time,
  :end_time,
  :text_parts,
  :organizational_unit_id,
  :attachments)
  SENSITIVE = []
  include Aws::Structure
end