Class: Aws::Notifications::Types::ListNotificationEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Notifications::Types::ListNotificationEventsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-notifications/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregate_notification_event_arn ⇒ String

  The Amazon Resource Name (ARN) of the ‘aggregatedNotificationEventArn` to match.

• #end_time ⇒ Time

  Latest time of events to return from this call.

• #include_child_events ⇒ Boolean

  Include aggregated child events in the result.

• #locale ⇒ String

  The locale code of the language used for the retrieved ‘NotificationEvent`.

• #max_results ⇒ Integer

  The maximum number of results to be returned in this call.

• #next_token ⇒ String

  The start token for paginated calls.

• #organizational_unit_id ⇒ String

  The unique identifier of the organizational unit used to filter notification events.

• #source ⇒ String

  The matched event source.

• #start_time ⇒ Time

  The earliest time of events to return from this call.

Instance Attribute Details

#aggregate_notification_event_arn ⇒ String

The Amazon Resource Name (ARN) of the ‘aggregatedNotificationEventArn` to match.

Returns:

• (String)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

Latest time of events to return from this call.

Returns:

• (Time)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#include_child_events ⇒ Boolean

Include aggregated child events in the result.

Returns:

• (Boolean)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ String

The locale code of the language used for the retrieved ‘NotificationEvent`. The default locale is English `(en_US)`.

Returns:

• (String)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to be returned in this call. Defaults to 20.

Returns:

• (Integer)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The start token for paginated calls. Retrieved from the response of a previous ‘ListEventRules` call. Next token uses Base64 encoding.

Returns:

• (String)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_id ⇒ String

The unique identifier of the organizational unit used to filter notification events.

Returns:

• (String)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, ‘aws.ec2` and `aws.cloudwatch`. For more information, see [Event delivery from Amazon Web Services services] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level

Returns:

• (String)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The earliest time of events to return from this call.

Returns:

• (Time)

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

class ListNotificationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :locale,
  :source,
  :include_child_events,
  :aggregate_notification_event_arn,
  :max_results,
  :next_token,
  :organizational_unit_id)
  SENSITIVE = []
  include Aws::Structure
end