managed_notification_events
Creates, updates, deletes, gets or lists a managed_notification_events resource.
Overview
| Name | managed_notification_events |
| Type | Resource |
| Id | aws.notifications.managed_notification_events |
Fields
The following fields are returned by SELECT queries:
- get_managed_notification_event
- list_managed_notification_events
| Name | Datatype | Description |
|---|---|---|
arn | string | The ARN of the resource. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}/event/[a-z0-9]{27}</code>) |
content | object | The content of the ManagedNotificationEvent. |
creation_time | string (date-time) | The creation time of the ManagedNotificationEvent. |
managed_notification_configuration_arn | string | The ARN of the ManagedNotificationConfiguration. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}</code>) |
| Name | Datatype | Description |
|---|---|---|
aggregated_notification_regions | array | The list of the regions where the aggregated notifications in this NotificationEvent originated. |
aggregation_event_type | string | The notifications 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 ManagedNotificationEvent. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}/event/[a-z0-9]{27}</code>) |
creation_time | string (date-time) | The creation time of the ManagedNotificationEvent. |
managed_notification_configuration_arn | string | The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}</code>) |
notification_event | object | A short summary of a ManagedNotificationEvent. This is only used when listing managed notification events. |
organizational_unit_id | string | The Organizational Unit Id that an Amazon Web Services account belongs to. (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 that related to the ManagedNotificationEvent. (pattern: <code>\d{12}</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_managed_notification_event | select | arn, region | locale | Returns a specified ManagedNotificationEvent. |
list_managed_notification_events | select | region | startTime, endTime, locale, source, maxResults, nextToken, organizationalUnitId, relatedAccount | Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first). |
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 ManagedNotificationEvent to return. |
region | string | AWS region (default: us-east-1) |
endTime | string (date-time) | Latest time of events to return from this call. |
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 ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding. |
organizationalUnitId | string | The Organizational Unit Id that an Amazon Web Services account belongs to. |
relatedAccount | string | The Amazon Web Services account ID associated with the Managed Notification Events. |
source | string | The Amazon Web Services service the event originates from. For example aws.cloudwatch. |
startTime | string (date-time) | The earliest time of events to return from this call. |
SELECT examples
- get_managed_notification_event
- list_managed_notification_events
Returns a specified ManagedNotificationEvent.
SELECT
arn,
content,
creation_time,
managed_notification_configuration_arn
FROM aws.notifications.managed_notification_events
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
AND locale = '{{ locale }}'
;
Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).
SELECT
aggregated_notification_regions,
aggregation_event_type,
aggregation_summary,
arn,
creation_time,
managed_notification_configuration_arn,
notification_event,
organizational_unit_id,
related_account
FROM aws.notifications.managed_notification_events
WHERE region = '{{ region }}' -- required
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND locale = '{{ locale }}'
AND source = '{{ source }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND organizationalUnitId = '{{ organizationalUnitId }}'
AND relatedAccount = '{{ relatedAccount }}'
;