DescribeUserHierarchyStructureCommand

Suggest an Edit

Describes the hierarchy structure of the specified Amazon Connect instance.

Example Syntax

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

import { ConnectClient, DescribeUserHierarchyStructureCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeUserHierarchyStructureCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeUserHierarchyStructureRequest
  InstanceId: "STRING_VALUE", // required
};
const command = new DescribeUserHierarchyStructureCommand(input);
const response = await client.send(command);
// { // DescribeUserHierarchyStructureResponse
//   HierarchyStructure: { // HierarchyStructure
//     LevelOne: { // HierarchyLevel
//       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",
//     },
//   },
// };

DescribeUserHierarchyStructureCommand Input

See DescribeUserHierarchyStructureCommandInput for more details

Parameter
Type
Description
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.

DescribeUserHierarchyStructureCommand Output

See DescribeUserHierarchyStructureCommandOutput for details

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

Information about the hierarchy structure.

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.