SearchUserHierarchyGroups
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
Important
The UserHierarchyGroup with "LevelId": "0" is the foundation for building
levels on top of an instance. It is not user-definable, nor is it visible in the UI.
Request Syntax
POST /search-user-hierarchy-groups HTTP/1.1
Content-type: application/json
{
"InstanceId": "string",
"MaxResults": number,
"NextToken": "string",
"SearchCriteria": {
"AndConditions": [
"UserHierarchyGroupSearchCriteria"
],
"OrConditions": [
"UserHierarchyGroupSearchCriteria"
],
"StringCondition": {
"ComparisonType": "string",
"FieldName": "string",
"Value": "string"
}
},
"SearchFilter": {
"AttributeFilter": {
"AndCondition": {
"TagConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
]
},
"OrConditions": [
{
"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 instanceId in the ARN of the instance.
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 100.
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 UserHierarchyGroups.
Type: UserHierarchyGroupSearchCriteria object
Required: No
- SearchFilter
-
Filters to be applied to search results.
Type: UserHierarchyGroupSearchFilter object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApproximateTotalCount": number,
"NextToken": "string",
"UserHierarchyGroups": [
{
"Arn": "string",
"HierarchyPath": {
"LevelFive": {
"Arn": "string",
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Name": "string"
},
"LevelFour": {
"Arn": "string",
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Name": "string"
},
"LevelOne": {
"Arn": "string",
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Name": "string"
},
"LevelThree": {
"Arn": "string",
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Name": "string"
},
"LevelTwo": {
"Arn": "string",
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Name": "string"
}
},
"Id": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"LevelId": "string",
"Name": "string",
"Tags": {
"string" : "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 userHierarchyGroups which 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.
- UserHierarchyGroups
-
Information about the userHierarchyGroups.
Type: Array of HierarchyGroup 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
