Connect / Client / describe_user_hierarchy_group

describe_user_hierarchy_group

Connect.Client.describe_user_hierarchy_group(**kwargs)

Describes the specified hierarchy group.

See also: AWS API Documentation

Request Syntax

response = client.describe_user_hierarchy_group(
    HierarchyGroupId='string',
    InstanceId='string'
)

Parameters:

• HierarchyGroupId (string) –

  [REQUIRED]

  The identifier of the hierarchy group.

• InstanceId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'HierarchyGroup': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'LevelId': 'string',
        'HierarchyPath': {
            'LevelOne': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelTwo': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelThree': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelFour': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelFive': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • HierarchyGroup (dict) –

    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 (dict) –

      Information about the levels in the hierarchy group.

      • LevelOne (dict) –

        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 (dict) –

        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 (dict) –

        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 (dict) –

        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 (dict) –

        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 (dict) –

      The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

      • (string) –

        • (string) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException