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

DescribeUserHierarchyGroup

Describes the specified hierarchy group.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

HierarchyGroupId

The identifier of the hierarchy group.

Required: Yes

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

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",
            "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.

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 because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429