Amazon Connect Service
API Reference (API Version 2017-08-08)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeUserHierarchyGroup

Describes the specified hierarchy group.

Request Syntax

GET /user-hierarchy-groups/InstanceId/HierarchyGroupId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

HierarchyGroupId

The identifier of the hierarchy group.

InstanceId

The identifier of the Amazon Connect instance.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "HierarchyGroup": { "Arn": "string", "HierarchyPath": { "LevelFive": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelFour": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelOne": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelThree": { "Arn": "string", "Id": "string", "Name": "string" }, "LevelTwo": { "Arn": "string", "Id": "string", "Name": "string" } }, "Id": "string", "LevelId": "string", "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.

HierarchyGroup

Information about the hierarchy group.

Type: HierarchyGroup object

Errors

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

InternalServiceException

Request processing failed due to 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: