Connect / Client / update_user_notification_status

update_user_notification_status

Connect.Client.update_user_notification_status(**kwargs)

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

response = client.update_user_notification_status(
    InstanceId='string',
    NotificationId='string',
    UserId='string',
    Status='READ'|'UNREAD'|'HIDDEN',
    LastModifiedTime=datetime(2015, 1, 1),
    LastModifiedRegion='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • NotificationId (string) –

    [REQUIRED]

    The unique identifier for the notification.

  • UserId (string) –

    [REQUIRED]

    The identifier of the user whose notification status is being updated.

  • Status (string) –

    [REQUIRED]

    The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.

  • LastModifiedTime (datetime) – The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.

  • LastModifiedRegion (string) – The AWS Region where the notification status was last modified. Used for cross-region replication.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The response from updating a user’s notification status.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.InvalidParameterException