Connect / Client / list_user_hierarchy_groups
list_user_hierarchy_groups#
- Connect.Client.list_user_hierarchy_groups(**kwargs)#
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_user_hierarchy_groups( InstanceId='string', NextToken='string', MaxResults=123 )
- Parameters:
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.
NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return per page. The default MaxResult size is 100.
- Return type:
dict
- Returns:
Response Syntax
{ 'UserHierarchyGroupSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
UserHierarchyGroupSummaryList (list) –
Information about the hierarchy groups.
(dict) –
Contains summary information about a 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.
NextToken (string) –
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException