Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListUserNotifications

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

Request Syntax


GET /users/InstanceId/UserId/notifications?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

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

UserId

The identifier of the user.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "UserNotifications": [ 
      { 
         "Content": { 
            "string" : "string" 
         },
         "CreatedAt": number,
         "ExpiresAt": number,
         "InstanceId": "string",
         "NotificationId": "string",
         "NotificationStatus": "string",
         "Priority": "string",
         "RecipientId": "string",
         "Source": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token for the next set of results. If present, there are more results available.

Type: String

UserNotifications

A list of notifications sent to the specified user.

Type: Array of UserNotificationSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429