Skip to content

Describe User Hierarchy Structure

connect_describe_user_hierarchy_structure R Documentation

Describes the hierarchy structure of the specified Amazon Connect instance

Description

Describes the hierarchy structure of the specified Amazon Connect instance.

Usage

connect_describe_user_hierarchy_structure(InstanceId)

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.

Value

A list with the following syntax:

list(
  HierarchyStructure = 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"
    )
  )
)

Request syntax

svc$describe_user_hierarchy_structure(
  InstanceId = "string"
)