[ aws . connect ]

describe-user-hierarchy-group

Description

Describes the specified hierarchy group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-user-hierarchy-group
--hierarchy-group-id <value>
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--hierarchy-group-id (string)

The identifier of the hierarchy group.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To display the details for a hierarchy group

The following describe-user-hierarchy-group example displays the details for the specified Amazon Connect hierarchy group.

aws connect describe-user-hierarchy-group \
    --hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output:

{
     "HierarchyGroup": {
         "Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
         "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/12345678-1111-2222-800e-a2b3c4d5f6g7",
         "Name": "Example Corporation",
         "LevelId": "1",
         "HierarchyPath": {
             "LevelOne": {
                 "Id": "abcdefgh-3333-4444-8af3-201123456789",
                 "Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/abcdefgh-3333-4444-8af3-201123456789",
                 "Name": "Example Corporation"
             }
         }
     }
 }

For more information, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Output

HierarchyGroup -> (structure)

Information about the hierarchy group.

Id -> (string)

The identifier of the hierarchy group.

Arn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.

Name -> (string)

The name of the hierarchy group.

LevelId -> (string)

The identifier of the level in the hierarchy group.

HierarchyPath -> (structure)

Information about the levels in the hierarchy group.

LevelOne -> (structure)

Information about level one.

Id -> (string)

The identifier of the hierarchy group.

Arn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.

Name -> (string)

The name of the hierarchy group.

LevelTwo -> (structure)

Information about level two.

Id -> (string)

The identifier of the hierarchy group.

Arn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.

Name -> (string)

The name of the hierarchy group.

LevelThree -> (structure)

Information about level three.

Id -> (string)

The identifier of the hierarchy group.

Arn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.

Name -> (string)

The name of the hierarchy group.

LevelFour -> (structure)

Information about level four.

Id -> (string)

The identifier of the hierarchy group.

Arn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.

Name -> (string)

The name of the hierarchy group.

LevelFive -> (structure)

Information about level five.

Id -> (string)

The identifier of the hierarchy group.

Arn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.

Name -> (string)

The name of the hierarchy group.

Tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)