Amazon Connect Service

{'Tags': {'string': 'string'}}

Creates a new user hierarchy group.

See also: AWS API Documentation

Request Syntax

client.create_user_hierarchy_group(
    Name='string',
    ParentGroupId='string',
    InstanceId='string',
    Tags={
        'string': 'string'
    }
)

type Name

string

param Name

[REQUIRED]

The name of the user hierarchy group. Must not be more than 100 characters.

type ParentGroupId

string

param ParentGroupId

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Tags

dict

param Tags

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

• (string) --

  • (string) --

rtype

dict

returns

Response Syntax

{
    'HierarchyGroupId': 'string',
    'HierarchyGroupArn': 'string'
}

Response Structure

• (dict) --

  • HierarchyGroupId (string) --

    The identifier of the hierarchy group.

  • HierarchyGroupArn (string) --

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

{'HierarchyGroup': {'Tags': {'string': 'string'}}}

Describes the specified hierarchy group.

See also: AWS API Documentation

Request Syntax

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

type HierarchyGroupId

string

param HierarchyGroupId

[REQUIRED]

The identifier of the hierarchy group.

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

rtype

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.

      • (string) --

        • (string) --