:doc:`Connect <../../connect>` / Client / list_user_notifications

***********************
list_user_notifications
***********************



.. py:method:: Connect.Client.list_user_notifications(**kwargs)

  

  Retrieves a paginated list of notifications for a specific user, including the notification status for that user.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserNotifications>`_  


  **Request Syntax**
  ::

    response = client.list_user_notifications(
        InstanceId='string',
        NextToken='string',
        MaxResults=123,
        UserId='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per page. Valid range is 1-1000.

    

  
  :type UserId: string
  :param UserId: **[REQUIRED]** 

    The identifier of the user.

    

  
  
  :rtype: dict
  :returns: 
    
    **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.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  