describe_user_hierarchy_structure

describe_user_hierarchy_structure(**kwargs)

Describes the hierarchy structure of the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.describe_user_hierarchy_structure(
    InstanceId='string'
)

Parameters

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

{
    'HierarchyStructure': {
        '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'
        }
    }
}

Response Structure

• (dict) --
  • HierarchyStructure (dict) --

    Information about the hierarchy structure.

    • LevelOne (dict) --

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

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

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

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

      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.

Exceptions

• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException