Connect / Client / create_user_hierarchy_group

create_user_hierarchy_group#

Connect.Client.create_user_hierarchy_group(**kwargs)#

Creates a new user hierarchy group.

See also: AWS API Documentation

Request Syntax

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

  • Name (string) –

    [REQUIRED]

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

  • ParentGroupId (string) – The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

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

  • Tags (dict) –

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

    • (string) –

      • (string) –

Return type:

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.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.DuplicateResourceException

  • Connect.Client.exceptions.LimitExceededException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException