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

ListUserHierarchyGroups

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.

InstanceId

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

MaxResults

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.

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.

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.

NextToken

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

Type: String

UserHierarchyGroupSummaryList

Information about the hierarchy groups.

Type: Array of HierarchyGroupSummary 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