Skip to content

List User Notifications

connect_list_user_notifications R Documentation

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

Description

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

Usage

connect_list_user_notifications(InstanceId, NextToken, MaxResults,
  UserId)

Arguments

InstanceId

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

NextToken

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

MaxResults

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

UserId

[required] The identifier of the user.

Value

A list with the following syntax:

list(
  UserNotifications = list(
    list(
      NotificationId = "string",
      NotificationStatus = "READ"|"UNREAD"|"HIDDEN",
      InstanceId = "string",
      RecipientId = "string",
      Content = list(
        "string"
      ),
      Priority = "URGENT"|"HIGH"|"LOW",
      Source = "CUSTOMER"|"RULES"|"SYSTEM",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ExpiresAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_user_notifications(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  UserId = "string"
)