Connect / Client / update_user_hierarchy_structure

update_user_hierarchy_structure#

Connect.Client.update_user_hierarchy_structure(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • HierarchyStructure (dict) –

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

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

Returns:

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ResourceInUseException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException