ListUserHierarchyGroups - Amazon Connect


Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Request Syntax

GET /user-hierarchy-groups-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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

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

Required: Yes


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

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


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.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "UserHierarchyGroupSummaryList": [ { "Arn": "string", "Id": "string", "LastModifiedRegion": "string", "LastModifiedTime": number, "Name": "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.


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

Type: String


Information about the hierarchy groups.

Type: Array of HierarchyGroupSummary objects


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


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

HTTP Status Code: 500


One or more of the specified parameters are not valid.

HTTP Status Code: 400


The request is not valid.

HTTP Status Code: 400


The specified resource was not found.

HTTP Status Code: 404


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: