connect_describe_user_hierarchy_group: Describes the specified hierarchy group

Description Usage Arguments Value Request syntax

View source: R/connect_operations.R

Description

Describes the specified hierarchy group.

Usage

1
connect_describe_user_hierarchy_group(HierarchyGroupId, InstanceId)

Arguments

HierarchyGroupId

[required] The identifier of the hierarchy group.

InstanceId

[required] The identifier of the Amazon Connect instance.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
list(
  HierarchyGroup = list(
    Id = "string",
    Arn = "string",
    Name = "string",
    LevelId = "string",
    HierarchyPath = list(
      LevelOne = list(
        Id = "string",
        Arn = "string",
        Name = "string"
      ),
      LevelTwo = list(
        Id = "string",
        Arn = "string",
        Name = "string"
      ),
      LevelThree = list(
        Id = "string",
        Arn = "string",
        Name = "string"
      ),
      LevelFour = list(
        Id = "string",
        Arn = "string",
        Name = "string"
      ),
      LevelFive = list(
        Id = "string",
        Arn = "string",
        Name = "string"
      )
    )
  )
)

Request syntax

1
2
3
4
svc$describe_user_hierarchy_group(
  HierarchyGroupId = "string",
  InstanceId = "string"
)

paws.customer.engagement documentation built on Aug. 23, 2021, 9:22 a.m.