notification_events

Creates, updates, deletes, gets or lists a notification_events resource.

Overview

Name	notification_events
Type	Resource
Id	aws.notifications.notification_events

Fields

The following fields are returned by SELECT queries:

get_notification_event

Name	Datatype	Description
arn	string	The ARN of the resource. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27}</code>)
content	object	The content of the NotificationEvent.
creation_time	string (date-time)	The creation time of the NotificationEvent.
notification_configuration_arn	string	The ARN of the NotificationConfiguration. (pattern: <code>arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}</code>)

list_notification_events

Name	Datatype	Description
aggregate_notification_event_arn	string	The ARN of the aggregatedNotificationEventArn to match. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27}</code>)
aggregation_event_type	string	The NotificationConfiguration's aggregation type. 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. (AGGREGATE, CHILD, NONE)
aggregation_summary	object	Provides additional information about the aggregation key.
arn	string	The Amazon Resource Name (ARN) of the resource. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27}</code>)
creation_time	string (date-time)	The creation time of the NotificationEvent.
notification_configuration_arn	string	The ARN of the NotificationConfiguration. (pattern: <code>arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}</code>)
notification_event	object	Refers to a NotificationEventSummary object. Similar in structure to content in the GetNotificationEvent response.
organizational_unit_id	string	The unique identifier of the organizational unit in the notification event overview. (pattern: <code>(Root|r-[0-9a-z]{4,32}|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})</code>)
related_account	string	The account name containing the NotificationHub. (pattern: <code>\d{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notification_event	select	arn, region	locale	Returns a specified NotificationEvent. User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.
list_notification_events	select	region	startTime, endTime, locale, source, includeChildEvents, aggregateNotificationEventArn, maxResults, nextToken, organizationalUnitId	Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first). User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the NotificationEvent to return.
region	string	AWS region (default: us-east-1)
aggregateNotificationEventArn	string	The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.
endTime	string (date-time)	Latest time of events to return from this call.
includeChildEvents	boolean	Include aggregated child events in the result.
locale	string	The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).
maxResults	integer	The maximum number of results to be returned in this call. Defaults to 20.
nextToken	string	The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
organizationalUnitId	string	The unique identifier of the organizational unit used to filter notification events.
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.
startTime	string (date-time)	The earliest time of events to return from this call.

SELECT examples

get_notification_event

Returns a specified NotificationEvent. User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

SELECT
arn,
content,
creation_time,
notification_configuration_arn
FROM aws.notifications.notification_events
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
AND locale = '{{ locale }}'
;

list_notification_events

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first). User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

SELECT
aggregate_notification_event_arn,
aggregation_event_type,
aggregation_summary,
arn,
creation_time,
notification_configuration_arn,
notification_event,
organizational_unit_id,
related_account
FROM aws.notifications.notification_events
WHERE region = '{{ region }}' -- required
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND locale = '{{ locale }}'
AND source = '{{ source }}'
AND includeChildEvents = '{{ includeChildEvents }}'
AND aggregateNotificationEventArn = '{{ aggregateNotificationEventArn }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND organizationalUnitId = '{{ organizationalUnitId }}'
;