Class: Aws::Notifications::Types::NotificationEvent

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_notification_event_arn ⇒ String

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.

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#aggregation_event_type ⇒ String

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.

      ^

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#aggregation_summary ⇒ Types::AggregationSummary

Provides additional information about how multiple notifications are grouped.

Returns:



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#end_time ⇒ Time

The end time of the event.

Returns:

  • (Time) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#event_status ⇒ String

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.

      ^

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#id ⇒ String

The unique identifier for a NotificationEvent.

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#media ⇒ Array<Types::MediaElement>

A list of media elements.

Returns:



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#message_components ⇒ Types::MessageComponents

Describes the components of a notification message.

Returns:



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#notification_type ⇒ String

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.

      ^

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#organizational_unit_id ⇒ String

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

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#schema_version ⇒ String

The schema version of the Notification Event.

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#source_event_detail_url ⇒ String

The source event URL.

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#source_event_detail_url_display_text ⇒ String

The detailed URL for the source event.

Returns:

  • (String) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#source_event_metadata ⇒ Types::SourceEventMetadata

The source event metadata.

Returns:



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

#start_time ⇒ Time

The notification event start time.

Returns:

  • (Time) 


2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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

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

A list of text values.

Returns:



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2759

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