Get Current User Data
connect_get_current_user_data | R Documentation |
Gets the real-time active user data from the specified Amazon Connect instance¶
Description¶
Gets the real-time active user data from the specified Amazon Connect instance.
Usage¶
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.
Filters
[required] The filters to apply to returned user data. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
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.
Value¶
A list with the following syntax:
list(
NextToken = "string",
UserDataList = list(
list(
User = list(
Id = "string",
Arn = "string"
),
RoutingProfile = list(
Id = "string",
Arn = "string"
),
HierarchyPath = list(
LevelOne = list(
Id = "string",
Arn = "string"
),
LevelTwo = list(
Id = "string",
Arn = "string"
),
LevelThree = list(
Id = "string",
Arn = "string"
),
LevelFour = list(
Id = "string",
Arn = "string"
),
LevelFive = list(
Id = "string",
Arn = "string"
)
),
Status = list(
StatusStartTimestamp = as.POSIXct(
"2015-01-01"
),
StatusArn = "string",
StatusName = "string"
),
AvailableSlotsByChannel = list(
123
),
MaxSlotsByChannel = list(
123
),
ActiveSlotsByChannel = list(
123
),
Contacts = list(
list(
ContactId = "string",
Channel = "VOICE"|"CHAT"|"TASK",
InitiationMethod = "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND",
AgentContactState = "INCOMING"|"PENDING"|"CONNECTING"|"CONNECTED"|"CONNECTED_ONHOLD"|"MISSED"|"ERROR"|"ENDED"|"REJECTED",
StateStartTimestamp = as.POSIXct(
"2015-01-01"
),
ConnectedToAgentTimestamp = as.POSIXct(
"2015-01-01"
),
Queue = list(
Id = "string",
Arn = "string"
)
)
),
NextStatus = "string"
)
),
ApproximateTotalCount = 123
)
Request syntax¶
svc$get_current_user_data(
InstanceId = "string",
Filters = list(
Queues = list(
"string"
),
ContactFilter = list(
ContactStates = list(
"INCOMING"|"PENDING"|"CONNECTING"|"CONNECTED"|"CONNECTED_ONHOLD"|"MISSED"|"ERROR"|"ENDED"|"REJECTED"
)
),
RoutingProfiles = list(
"string"
),
Agents = list(
"string"
),
UserHierarchyGroups = list(
"string"
)
),
NextToken = "string",
MaxResults = 123
)