List User Hierarchy Groups

connect_list_user_hierarchy_groups

R Documentation

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)

Arguments¶

InstanceId: [required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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 maximum number of results to return per page. The default MaxResult size is 100.

Value¶

A list with the following syntax:

list(
  UserHierarchyGroupSummaryList = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

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