Describe User Hierarchy Group

connect_describe_user_hierarchy_group

R Documentation

Describes the specified hierarchy group

Description

Describes the specified hierarchy group.

Usage

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. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Value

A list with the following syntax:

list(
  HierarchyGroup = list(
    Id = "string",
    Arn = "string",
    Name = "string",
    LevelId = "string",
    HierarchyPath = list(
      LevelOne = list(
        Id = "string",
        Arn = "string",
        Name = "string",
        LastModifiedTime = as.POSIXct(
          "2015-01-01"
        ),
        LastModifiedRegion = "string"
      ),
      LevelTwo = list(
        Id = "string",
        Arn = "string",
        Name = "string",
        LastModifiedTime = as.POSIXct(
          "2015-01-01"
        ),
        LastModifiedRegion = "string"
      ),
      LevelThree = list(
        Id = "string",
        Arn = "string",
        Name = "string",
        LastModifiedTime = as.POSIXct(
          "2015-01-01"
        ),
        LastModifiedRegion = "string"
      ),
      LevelFour = list(
        Id = "string",
        Arn = "string",
        Name = "string",
        LastModifiedTime = as.POSIXct(
          "2015-01-01"
        ),
        LastModifiedRegion = "string"
      ),
      LevelFive = list(
        Id = "string",
        Arn = "string",
        Name = "string",
        LastModifiedTime = as.POSIXct(
          "2015-01-01"
        ),
        LastModifiedRegion = "string"
      )
    ),
    Tags = list(
      "string"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string"
  )
)

Request syntax

svc$describe_user_hierarchy_group(
  HierarchyGroupId = "string",
  InstanceId = "string"
)