DescribeUserHierarchyGroupCommand

Suggest an Edit

Describes the specified hierarchy group.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, DescribeUserHierarchyGroupCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeUserHierarchyGroupCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeUserHierarchyGroupRequest
  HierarchyGroupId: "STRING_VALUE", // required
  InstanceId: "STRING_VALUE", // required
};
const command = new DescribeUserHierarchyGroupCommand(input);
const response = await client.send(command);
// { // DescribeUserHierarchyGroupResponse
//   HierarchyGroup: { // HierarchyGroup
//     Id: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     LevelId: "STRING_VALUE",
//     HierarchyPath: { // HierarchyPath
//       LevelOne: { // HierarchyGroupSummary
//         Id: "STRING_VALUE",
//         Arn: "STRING_VALUE",
//         Name: "STRING_VALUE",
//         LastModifiedTime: new Date("TIMESTAMP"),
//         LastModifiedRegion: "STRING_VALUE",
//       },
//       LevelTwo: {
//         Id: "STRING_VALUE",
//         Arn: "STRING_VALUE",
//         Name: "STRING_VALUE",
//         LastModifiedTime: new Date("TIMESTAMP"),
//         LastModifiedRegion: "STRING_VALUE",
//       },
//       LevelThree: {
//         Id: "STRING_VALUE",
//         Arn: "STRING_VALUE",
//         Name: "STRING_VALUE",
//         LastModifiedTime: new Date("TIMESTAMP"),
//         LastModifiedRegion: "STRING_VALUE",
//       },
//       LevelFour: {
//         Id: "STRING_VALUE",
//         Arn: "STRING_VALUE",
//         Name: "STRING_VALUE",
//         LastModifiedTime: new Date("TIMESTAMP"),
//         LastModifiedRegion: "STRING_VALUE",
//       },
//       LevelFive: {
//         Id: "STRING_VALUE",
//         Arn: "STRING_VALUE",
//         Name: "STRING_VALUE",
//         LastModifiedTime: new Date("TIMESTAMP"),
//         LastModifiedRegion: "STRING_VALUE",
//       },
//     },
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     LastModifiedTime: new Date("TIMESTAMP"),
//     LastModifiedRegion: "STRING_VALUE",
//   },
// };

DescribeUserHierarchyGroupCommand Input

See DescribeUserHierarchyGroupCommandInput for more details

Parameter
Type
Description
HierarchyGroupId
Required
string | undefined

The identifier of the hierarchy group.

InstanceId
Required
string | undefined

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

DescribeUserHierarchyGroupCommand Output

See DescribeUserHierarchyGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
HierarchyGroup
HierarchyGroup | undefined

Information about the hierarchy group.

Throws

Name
Fault
Details
InternalServiceException
server

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

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.