Learn R Programming
paws.customer.engagement (version 0.1.12)

connect_list_user_hierarchy_groups: Provides summary information about the hierarchy groups for the specified Amazon Connect instance

Description

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.

Usage

connect_list_user_hierarchy_groups(InstanceId, NextToken, MaxResults)

Value

A list with the following syntax:

list(
  UserHierarchyGroupSummaryList = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string"
    )
  ),
  NextToken = "string"
)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

NextToken

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

The maximimum number of results to return per page.

Request syntax

svc$list_user_hierarchy_groups(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123
)