notifications

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

Overview

Name	notifications
Type	Resource
Id	aws.connect.notifications

Fields

The following fields are returned by SELECT queries:

describe_notification

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the notification.
content	object	The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.
created_at	string (date-time)	The timestamp when the notification was created.
expires_at	string (date-time)	The timestamp when the notification expires and is no longer displayed to users.
id	string	The unique identifier for a notification.
last_modified_region	string	The AWS Region where the notification was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when the notification was last modified.
priority	string	The priority level of the notification. Valid values are URGENT, HIGH, and LOW. (URGENT, HIGH, LOW)
recipients	array	A list of recipient Amazon Resource Names (ARNs). Maximum of 200 recipients.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_notifications

Name	Datatype	Description
next_token	string	The token for the next set of results. If present, there are more results available.
notification_summary_list	array	A list of notification summaries.

search_notifications

Name	Datatype	Description
approximate_total_count	integer (int64)	The approximate total number of notifications matching the search criteria.
next_token	string	The token for the next set of results. If present, there are more results available.
notifications	array	A list of notifications matching the search criteria.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_notification	select	instance_id, notification_id, region		Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
list_notifications	select	instance_id, region	nextToken, maxResults	Retrieves a paginated list of all notifications in the Amazon Connect instance.
search_notifications	select	region		Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.
create_notification	insert	instance_id, region, Recipients, Content		Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.
update_notification_content	update	instance_id, notification_id, region, Content		Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.
delete_notification	delete	instance_id, notification_id, region		Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.

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
instance_id	string	The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
notification_id	string	The unique identifier for the notification to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page. Valid range is 1-100.
nextToken	string	The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

SELECT examples

describe_notification

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

SELECT
arn,
content,
created_at,
expires_at,
id,
last_modified_region,
last_modified_time,
priority,
recipients,
tags
FROM aws.connect.notifications
WHERE instance_id = '{{ instance_id }}' -- required
AND notification_id = '{{ notification_id }}' -- required
AND region = '{{ region }}' -- required
;

list_notifications

Retrieves a paginated list of all notifications in the Amazon Connect instance.

SELECT
next_token,
notification_summary_list
FROM aws.connect.notifications
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_notifications

Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.

SELECT
approximate_total_count,
next_token,
notifications
FROM aws.connect.notifications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_notification

Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.

INSERT INTO aws.connect.notifications (
ExpiresAt,
Recipients,
Priority,
Content,
Tags,
PredefinedNotificationId,
ClientToken,
instance_id,
region
)
SELECT 
'{{ ExpiresAt }}',
'{{ Recipients }}' /* required */,
'{{ Priority }}',
'{{ Content }}' /* required */,
'{{ Tags }}',
'{{ PredefinedNotificationId }}',
'{{ ClientToken }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
notification_arn,
notification_id
;

Manifest

# Description fields are for documentation purposes
- name: notifications
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the notifications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notifications resource.
  - name: ExpiresAt
    value: "{{ ExpiresAt }}"
  - name: Recipients
    value:
      - "{{ Recipients }}"
    description: |
      A list of recipient Amazon Resource Names (ARNs). Maximum of 200 recipients.
  - name: Priority
    value: "{{ Priority }}"
    description: |
      The priority level that can be set when creating a customer notification. Valid values are HIGH and LOW. URGENT priority is reserved for system-generated notifications.
    valid_values: ['HIGH', 'LOW']
  - name: Content
    value: "{{ Content }}"
    description: |
      A map of localized notification content where keys are locale codes and values are the notification text in that locale. Each localized string can be 0-500 characters.
  - name: Tags
    value: "{{ Tags }}"
  - name: PredefinedNotificationId
    value: "{{ PredefinedNotificationId }}"
    description: |
      The unique identifier for a notification.
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_notification_content

Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.

UPDATE aws.connect.notifications
SET 
Content = '{{ Content }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND notification_id = '{{ notification_id }}' --required
AND region = '{{ region }}' --required
AND Content = '{{ Content }}' --required;

DELETE examples

delete_notification

Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.

DELETE FROM aws.connect.notifications
WHERE instance_id = '{{ instance_id }}' --required
AND notification_id = '{{ notification_id }}' --required
AND region = '{{ region }}' --required
;