Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

describe-user-hierarchy-structure¶

Description¶

Describes the hierarchy structure of the specified Amazon Connect instance.

Synopsis¶

  describe-user-hierarchy-structure
--instance-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--instance-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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

Output¶

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.

LastModifiedTime -> (timestamp)

The timestamp when this resource was last modified.

LastModifiedRegion -> (string)

The Amazon Web Services Region where this resource was last modified.

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.

LastModifiedTime -> (timestamp)

The timestamp when this resource was last modified.

LastModifiedRegion -> (string)

The Amazon Web Services Region where this resource was last modified.

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.

LastModifiedTime -> (timestamp)

The timestamp when this resource was last modified.

LastModifiedRegion -> (string)

The Amazon Web Services Region where this resource was last modified.

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.

LastModifiedTime -> (timestamp)

The timestamp when this resource was last modified.

LastModifiedRegion -> (string)

The Amazon Web Services Region where this resource was last modified.

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.

LastModifiedTime -> (timestamp)

The timestamp when this resource was last modified.

LastModifiedRegion -> (string)

The Amazon Web Services Region where this resource was last modified.

Table Of Contents

Feedback

User Guide