List Users

connect_list_users

R Documentation

Provides summary information about the users for the specified Amazon Connect instance¶

Description¶

Provides summary information about the users for the specified Amazon Connect instance.

Usage¶

connect_list_users(InstanceId, NextToken, MaxResults)

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 in the next request to retrieve the next set of results.

MaxResults

The maximum number of results to return per page. The default MaxResult size is 100.

Value¶

A list with the following syntax:

list(
  UserSummaryList = list(
    list(
      Id = "string",
      Arn = "string",
      Username = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

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