Describes the hierarchy structure of the specified Amazon Connect instance.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-user-hierarchy-structure
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--instance-id
(string)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To display the details for a hierarchy structure
The following describe-user-hierarchy-structure
example displays the details for the hierarchy structure for the specified Amazon Connect instance.
aws connect describe-user-hierarchy-group \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Output:
{
"HierarchyStructure": {
"LevelOne": {
"Id": "12345678-1111-2222-800e-aaabbb555gg",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/1",
"Name": "Corporation"
},
"LevelTwo": {
"Id": "87654321-2222-3333-ac99-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/2",
"Name": "Services Division"
},
"LevelThree": {
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/3",
"Name": "EU Site"
}
}
}
For more information, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
HierarchyStructure -> (structure)
Information about the hierarchy structure.
LevelOne -> (structure)
Information about level one.
Id -> (string)
The identifier of the hierarchy level.
Arn -> (string)
The Amazon Resource Name (ARN) of the hierarchy level.
Name -> (string)
The name of the hierarchy level.
LevelTwo -> (structure)
Information about level two.
Id -> (string)
The identifier of the hierarchy level.
Arn -> (string)
The Amazon Resource Name (ARN) of the hierarchy level.
Name -> (string)
The name of the hierarchy level.
LevelThree -> (structure)
Information about level three.
Id -> (string)
The identifier of the hierarchy level.
Arn -> (string)
The Amazon Resource Name (ARN) of the hierarchy level.
Name -> (string)
The name of the hierarchy level.
LevelFour -> (structure)
Information about level four.
Id -> (string)
The identifier of the hierarchy level.
Arn -> (string)
The Amazon Resource Name (ARN) of the hierarchy level.
Name -> (string)
The name of the hierarchy level.
LevelFive -> (structure)
Information about level five.
Id -> (string)
The identifier of the hierarchy level.
Arn -> (string)
The Amazon Resource Name (ARN) of the hierarchy level.
Name -> (string)
The name of the hierarchy level.