Connect / Client / delete_user_hierarchy_group

delete_user_hierarchy_group#

Connect.Client.delete_user_hierarchy_group(**kwargs)#

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

response = client.delete_user_hierarchy_group(
    HierarchyGroupId='string',
    InstanceId='string'
)
Parameters:
  • HierarchyGroupId (string) –

    [REQUIRED]

    The identifier of the hierarchy group.

  • 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