Amazon Connect Service

2020/11/17 - Amazon Connect Service - 4 new api methods

Changes  This release adds support for user hierarchy group and user hierarchy structure. For details, see the Release Notes in the Amazon Connect Administrator Guide.

UpdateUserHierarchyStructure (new) Link ¶

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

See also: AWS API Documentation

Request Syntax

client.update_user_hierarchy_structure(
    HierarchyStructure={
        'LevelOne': {
            'Name': 'string'
        },
        'LevelTwo': {
            'Name': 'string'
        },
        'LevelThree': {
            'Name': 'string'
        },
        'LevelFour': {
            'Name': 'string'
        },
        'LevelFive': {
            'Name': 'string'
        }
    },
    InstanceId='string'
)
type HierarchyStructure

dict

param HierarchyStructure

[REQUIRED]

The hierarchy levels to update.

  • LevelOne (dict) --

    The update for level one.

    • Name (string) -- [REQUIRED]

      The name of the user hierarchy level. Must not be more than 50 characters.

  • LevelTwo (dict) --

    The update for level two.

    • Name (string) -- [REQUIRED]

      The name of the user hierarchy level. Must not be more than 50 characters.

  • LevelThree (dict) --

    The update for level three.

    • Name (string) -- [REQUIRED]

      The name of the user hierarchy level. Must not be more than 50 characters.

  • LevelFour (dict) --

    The update for level four.

    • Name (string) -- [REQUIRED]

      The name of the user hierarchy level. Must not be more than 50 characters.

  • LevelFive (dict) --

    The update for level five.

    • Name (string) -- [REQUIRED]

      The name of the user hierarchy level. Must not be more than 50 characters.

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

returns

None

DeleteUserHierarchyGroup (new) Link ¶

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

See also: AWS API Documentation

Request Syntax

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

returns

None

UpdateUserHierarchyGroupName (new) Link ¶

Updates the name of the user hierarchy group.

See also: AWS API Documentation

Request Syntax

client.update_user_hierarchy_group_name(
    Name='string',
    HierarchyGroupId='string',
    InstanceId='string'
)
type Name

string

param Name

[REQUIRED]

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

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.

returns

None

CreateUserHierarchyGroup (new) Link ¶

Creates a new user hierarchy group.

See also: AWS API Documentation

Request Syntax

client.create_user_hierarchy_group(
    Name='string',
    ParentGroupId='string',
    InstanceId='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.

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.