Search Users
connect_search_users | R Documentation |
Searches users in an Amazon Connect instance, with optional filtering¶
Description¶
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
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.
InstanceID is a required field. The "Required: No" below is incorrect.
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.
SearchFilter
Filters to be applied to search results.
SearchCriteria
Value¶
A list with the following syntax:
list(
Users = list(
list(
Arn = "string",
DirectoryUserId = "string",
HierarchyGroupId = "string",
Id = "string",
IdentityInfo = list(
FirstName = "string",
LastName = "string"
),
PhoneConfig = list(
PhoneType = "SOFT_PHONE"|"DESK_PHONE",
AutoAccept = TRUE|FALSE,
AfterContactWorkTimeLimit = 123,
DeskPhoneNumber = "string"
),
RoutingProfileId = "string",
SecurityProfileIds = list(
"string"
),
Tags = list(
"string"
),
Username = "string"
)
),
NextToken = "string",
ApproximateTotalCount = 123
)
Request syntax¶
svc$search_users(
InstanceId = "string",
NextToken = "string",
MaxResults = 123,
SearchFilter = list(
TagFilter = list(
OrConditions = list(
list(
list(
TagKey = "string",
TagValue = "string"
)
)
),
AndConditions = list(
list(
TagKey = "string",
TagValue = "string"
)
),
TagCondition = list(
TagKey = "string",
TagValue = "string"
)
),
UserAttributeFilter = list(
OrConditions = list(
list(
TagConditions = list(
list(
TagKey = "string",
TagValue = "string"
)
),
HierarchyGroupCondition = list(
Value = "string",
HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
)
)
),
AndCondition = list(
TagConditions = list(
list(
TagKey = "string",
TagValue = "string"
)
),
HierarchyGroupCondition = list(
Value = "string",
HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
)
),
TagCondition = list(
TagKey = "string",
TagValue = "string"
),
HierarchyGroupCondition = list(
Value = "string",
HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
)
)
),
SearchCriteria = list(
OrConditions = list(
list()
),
AndConditions = list(
list()
),
StringCondition = list(
FieldName = "string",
Value = "string",
ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
),
ListCondition = list(
TargetListType = "PROFICIENCIES",
Conditions = list(
list(
StringCondition = list(
FieldName = "string",
Value = "string",
ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
),
NumberCondition = list(
FieldName = "string",
MinValue = 123,
MaxValue = 123,
ComparisonType = "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
)
)
)
),
HierarchyGroupCondition = list(
Value = "string",
HierarchyGroupMatchType = "EXACT"|"WITH_CHILD_GROUPS"
)
)
)