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

SearchUsers

Searches users in an Amazon Connect instance, with optional filtering.

Note

AfterContactWorkTimeLimit is returned in milliseconds.

Request Syntax


POST /search-users HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "UserSearchCriteria"
      ],
      "HierarchyGroupCondition": { 
         "HierarchyGroupMatchType": "string",
         "Value": "string"
      },
      "ListCondition": { 
         "Conditions": [ 
            { 
               "NumberCondition": { 
                  "ComparisonType": "string",
                  "FieldName": "string",
                  "MaxValue": number,
                  "MinValue": number
               },
               "StringCondition": { 
                  "ComparisonType": "string",
                  "FieldName": "string",
                  "Value": "string"
               }
            }
         ],
         "TargetListType": "string"
      },
      "OrConditions": [ 
         "UserSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      },
      "UserAttributeFilter": { 
         "AndCondition": { 
            "HierarchyGroupCondition": { 
               "HierarchyGroupMatchType": "string",
               "Value": "string"
            },
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "HierarchyGroupCondition": { 
            "HierarchyGroupMatchType": "string",
            "Value": "string"
         },
         "OrConditions": [ 
            { 
               "HierarchyGroupCondition": { 
                  "HierarchyGroupMatchType": "string",
                  "Value": "string"
               },
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

InstanceId

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

Note

InstanceID is a required field. The "Required: No" below is incorrect.

Type: String

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

Required: Yes

MaxResults

The maximum number of results to return per page.

Type: Integer

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

Required: No

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.

Type: String

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

Required: No

SearchCriteria

The search criteria to be used to return users.

Note

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Type: UserSearchCriteria object

Required: No

SearchFilter

Filters to be applied to search results.

Type: UserSearchFilter object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Users": [ 
      { 
         "Arn": "string",
         "DirectoryUserId": "string",
         "HierarchyGroupId": "string",
         "Id": "string",
         "IdentityInfo": { 
            "FirstName": "string",
            "LastName": "string"
         },
         "PhoneConfig": { 
            "AfterContactWorkTimeLimit": number,
            "AutoAccept": boolean,
            "DeskPhoneNumber": "string",
            "PhoneType": "string"
         },
         "RoutingProfileId": "string",
         "SecurityProfileIds": [ "string" ],
         "Tags": { 
            "string" : "string" 
         },
         "Username": "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.

ApproximateTotalCount

The total number of users who matched your search query.

Type: Long

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

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

Users

Information about the users.

Type: Array of UserSearchSummary objects

Errors

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

InternalServiceException

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

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429