2026/02/13 - Amazon Connect Service - 8 new api methods
Changes API release for headerr notifications in the admin website. APIs allow customers to publish brief messages (including URLs) to a specified audience, and a new header icon will indicate when unread messages are available.
Creates a new notification to be delivered to specified recipients. Notifications can include localized content with embedded links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.
See also: AWS API Documentation
Request Syntax
client.create_notification(
InstanceId='string',
ExpiresAt=datetime(2015, 1, 1),
Recipients=[
'string',
],
Priority='HIGH'|'LOW',
Content={
'string': 'string'
},
Tags={
'string': 'string'
},
PredefinedNotificationId='string',
ClientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
datetime
The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.
list
[REQUIRED]
A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.
(string) --
string
The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.
dict
[REQUIRED]
The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports markdown formatting and embedded links. Maximum 250 characters per locale.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 characters.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
string
The unique identifier for a notification.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Response Syntax
{
'NotificationId': 'string',
'NotificationArn': 'string'
}
Response Structure
(dict) --
NotificationId (string) --
The unique identifier assigned to the created notification.
NotificationArn (string) --
The Amazon Resource Name (ARN) of the created notification.
Retrieves a paginated list of notifications for a specific user, including the notification status for that user.
See also: AWS API Documentation
Request Syntax
client.list_user_notifications(
InstanceId='string',
NextToken='string',
MaxResults=123,
UserId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.
integer
The maximum number of results to return per page. Valid range is 1-1000.
string
[REQUIRED]
The identifier of the user.
dict
Response Syntax
{
'UserNotifications': [
{
'NotificationId': 'string',
'NotificationStatus': 'READ'|'UNREAD'|'HIDDEN',
'InstanceId': 'string',
'RecipientId': 'string',
'Content': {
'string': 'string'
},
'Priority': 'URGENT'|'HIGH'|'LOW',
'Source': 'CUSTOMER'|'RULES'|'SYSTEM',
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserNotifications (list) --
A list of notifications sent to the specified user.
(dict) --
Summary information about a notification for a specific user, including the user's read status.
NotificationId (string) --
The unique identifier for the notification.
NotificationStatus (string) --
The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.
InstanceId (string) --
The identifier of the Amazon Connect instance.
RecipientId (string) --
The identifier of the recipient user.
Content (dict) --
The localized content of the notification.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 characters.
Priority (string) --
The priority level of the notification.
Source (string) --
The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.
CreatedAt (datetime) --
The timestamp when the notification was created.
ExpiresAt (datetime) --
The timestamp when the notification expires.
NextToken (string) --
The token for the next set of results. If present, there are more results available.
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.
See also: AWS API Documentation
Request Syntax
client.search_notifications(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.
integer
The maximum number of results to return per page. Valid range is 1-100.
dict
Filters to apply to the search results, such as tag-based filters.
AttributeFilter (dict) --
Attribute-based filters to apply to the search results.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.
OrConditions (list) --
A list of conditions to be met, where at least one condition must be satisfied.
(dict) --
The search criteria to be used to return notifications.
AndConditions (list) --
A list of conditions that must all be satisfied.
(dict) --
The search criteria to be used to return notifications.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'Notifications': [
{
'Id': 'string',
'Arn': 'string',
'InstanceId': 'string',
'Content': {
'string': 'string'
},
'Priority': 'URGENT'|'HIGH'|'LOW',
'Recipients': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Notifications (list) --
A list of notifications matching the search criteria.
(dict) --
Summary information about a notification returned from a search operation.
Id (string) --
The unique identifier for the notification.
Arn (string) --
The Amazon Resource Name (ARN) of the notification.
InstanceId (string) --
The identifier of the Amazon Connect instance.
Content (dict) --
The localized content of the notification.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 characters.
Priority (string) --
The priority level of the notification.
Recipients (list) --
A list of recipient Amazon Resource Names (ARNs).
(string) --
CreatedAt (datetime) --
The timestamp when the notification was created.
ExpiresAt (datetime) --
The timestamp when the notification expires.
LastModifiedRegion (string) --
The AWS Region where the notification was last modified.
LastModifiedTime (datetime) --
The timestamp when the notification was last modified.
Tags (dict) --
The tags associated with the notification.
(string) --
(string) --
NextToken (string) --
The token for the next set of results. If present, there are more results available.
ApproximateTotalCount (integer) --
The approximate total number of notifications matching the search criteria.
Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
See also: AWS API Documentation
Request Syntax
client.describe_notification(
InstanceId='string',
NotificationId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the notification.
dict
Response Syntax
{
'Notification': {
'Content': {
'string': 'string'
},
'Id': 'string',
'Arn': 'string',
'Priority': 'URGENT'|'HIGH'|'LOW',
'Recipients': [
'string',
],
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Notification (dict) --
The complete notification information including content, priority, recipients, and metadata.
Content (dict) --
The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 characters.
Id (string) --
The unique identifier for the notification.
Arn (string) --
The Amazon Resource Name (ARN) of the notification.
Priority (string) --
The priority level of the notification. Valid values are URGENT, HIGH, and LOW.
Recipients (list) --
A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.
(string) --
LastModifiedTime (datetime) --
The timestamp when the notification was last modified.
CreatedAt (datetime) --
The timestamp when the notification was created.
ExpiresAt (datetime) --
The timestamp when the notification expires and is no longer displayed to users.
LastModifiedRegion (string) --
The AWS Region where the notification was last modified.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.
See also: AWS API Documentation
Request Syntax
client.delete_notification(
InstanceId='string',
NotificationId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the notification to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
The response from deleting a notification.
Retrieves a paginated list of all notifications in the Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_notifications(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.
integer
The maximum number of results to return per page. Valid range is 1-100.
dict
Response Syntax
{
'NextToken': 'string',
'NotificationSummaryList': [
{
'Content': {
'string': 'string'
},
'Id': 'string',
'Arn': 'string',
'Priority': 'URGENT'|'HIGH'|'LOW',
'Recipients': [
'string',
],
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token for the next set of results. If present, there are more results available.
NotificationSummaryList (list) --
A list of notification summaries.
(dict) --
Contains information about a notification, including its content, priority, recipients, and metadata.
Content (dict) --
The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 characters.
Id (string) --
The unique identifier for the notification.
Arn (string) --
The Amazon Resource Name (ARN) of the notification.
Priority (string) --
The priority level of the notification. Valid values are URGENT, HIGH, and LOW.
Recipients (list) --
A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.
(string) --
LastModifiedTime (datetime) --
The timestamp when the notification was last modified.
CreatedAt (datetime) --
The timestamp when the notification was created.
ExpiresAt (datetime) --
The timestamp when the notification expires and is no longer displayed to users.
LastModifiedRegion (string) --
The AWS Region where the notification was last modified.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.
See also: AWS API Documentation
Request Syntax
client.update_notification_content(
InstanceId='string',
NotificationId='string',
Content={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the notification to update.
dict
[REQUIRED]
The updated localized content of the notification. A map of locale codes and values. Maximum 500 characters per locale.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 characters.
dict
Response Syntax
{}
Response Structure
(dict) --
The response from updating notification content.
Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.
See also: AWS API Documentation
Request Syntax
client.update_user_notification_status(
InstanceId='string',
NotificationId='string',
UserId='string',
Status='READ'|'UNREAD'|'HIDDEN',
LastModifiedTime=datetime(2015, 1, 1),
LastModifiedRegion='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the notification.
string
[REQUIRED]
The identifier of the user whose notification status is being updated.
string
[REQUIRED]
The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.
datetime
The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.
string
The AWS Region where the notification status was last modified. Used for cross-region replication.
dict
Response Syntax
{}
Response Structure
(dict) --
The response from updating a user's notification status.