Search User Hierarchy Groups

connect_search_user_hierarchy_groups

R Documentation

Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering

Description

Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.

The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

Usage

connect_search_user_hierarchy_groups(InstanceId, NextToken, MaxResults,
  SearchFilter, SearchCriteria)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instanceId in the 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.

SearchFilter

Filters to be applied to search results.

SearchCriteria

The search criteria to be used to return UserHierarchyGroups.

Value

A list with the following syntax:

list(
  UserHierarchyGroups = list(
    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"
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax

svc$search_user_hierarchy_groups(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchFilter = list(
    AttributeFilter = list(
      OrConditions = list(
        list(
          TagConditions = list(
            list(
              TagKey = "string",
              TagValue = "string"
            )
          )
        )
      ),
      AndCondition = list(
        TagConditions = list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  ),
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    )
  )
)