Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. getUserHierarchyStructure
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws

aws.connect.getUserHierarchyStructure

Explore with Pulumi AI

aws logo
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws

    Provides details about a specific Amazon Connect User Hierarchy Structure

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.connect.getUserHierarchyStructure({
    instanceId: testAwsConnectInstance.id,
});

    import pulumi
import pulumi_aws as aws

test = aws.connect.get_user_hierarchy_structure(instance_id=test_aws_connect_instance["id"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.LookupUserHierarchyStructure(ctx, &connect.LookupUserHierarchyStructureArgs{
			InstanceId: testAwsConnectInstance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Connect.GetUserHierarchyStructure.Invoke(new()
    {
        InstanceId = testAwsConnectInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.ConnectFunctions;
import com.pulumi.aws.connect.inputs.GetUserHierarchyStructureArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = ConnectFunctions.getUserHierarchyStructure(GetUserHierarchyStructureArgs.builder()
            .instanceId(testAwsConnectInstance.id())
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: aws:connect:getUserHierarchyStructure
      arguments:
        instanceId: ${testAwsConnectInstance.id}

    Using getUserHierarchyStructure

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserHierarchyStructure(args: GetUserHierarchyStructureArgs, opts?: InvokeOptions): Promise<GetUserHierarchyStructureResult>
function getUserHierarchyStructureOutput(args: GetUserHierarchyStructureOutputArgs, opts?: InvokeOptions): Output<GetUserHierarchyStructureResult>
    def get_user_hierarchy_structure(instance_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetUserHierarchyStructureResult
def get_user_hierarchy_structure_output(instance_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetUserHierarchyStructureResult]
    func LookupUserHierarchyStructure(ctx *Context, args *LookupUserHierarchyStructureArgs, opts ...InvokeOption) (*LookupUserHierarchyStructureResult, error)
func LookupUserHierarchyStructureOutput(ctx *Context, args *LookupUserHierarchyStructureOutputArgs, opts ...InvokeOption) LookupUserHierarchyStructureResultOutput

    > Note: This function is named LookupUserHierarchyStructure in the Go SDK.

    public static class GetUserHierarchyStructure 
{
    public static Task<GetUserHierarchyStructureResult> InvokeAsync(GetUserHierarchyStructureArgs args, InvokeOptions? opts = null)
    public static Output<GetUserHierarchyStructureResult> Invoke(GetUserHierarchyStructureInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserHierarchyStructureResult> getUserHierarchyStructure(GetUserHierarchyStructureArgs args, InvokeOptions options)
public static Output<GetUserHierarchyStructureResult> getUserHierarchyStructure(GetUserHierarchyStructureArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:connect/getUserHierarchyStructure:getUserHierarchyStructure
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Reference to the hosting Amazon Connect Instance
    InstanceId string
    Reference to the hosting Amazon Connect Instance
    instanceId String
    Reference to the hosting Amazon Connect Instance
    instanceId string
    Reference to the hosting Amazon Connect Instance
    instance_id str
    Reference to the hosting Amazon Connect Instance
    instanceId String
    Reference to the hosting Amazon Connect Instance

    getUserHierarchyStructure Result

    The following output properties are available:

    HierarchyStructures List<GetUserHierarchyStructureHierarchyStructure>
    Block that defines the hierarchy structure's levels. The hierarchy_structure block is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    HierarchyStructures []GetUserHierarchyStructureHierarchyStructure
    Block that defines the hierarchy structure's levels. The hierarchy_structure block is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    hierarchyStructures List<GetUserHierarchyStructureHierarchyStructure>
    Block that defines the hierarchy structure's levels. The hierarchy_structure block is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    hierarchyStructures GetUserHierarchyStructureHierarchyStructure[]
    Block that defines the hierarchy structure's levels. The hierarchy_structure block is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    hierarchy_structures Sequence[GetUserHierarchyStructureHierarchyStructure]
    Block that defines the hierarchy structure's levels. The hierarchy_structure block is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    hierarchyStructures List<Property Map>
    Block that defines the hierarchy structure's levels. The hierarchy_structure block is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String

    Supporting Types

    GetUserHierarchyStructureHierarchyStructure

    levelFives List<Property Map>
    Details of level five. See below.
    levelFours List<Property Map>
    Details of level four. See below.
    levelOnes List<Property Map>
    Details of level one. See below.
    levelThrees List<Property Map>
    Details of level three. See below.
    levelTwos List<Property Map>
    Details of level two. See below.

    GetUserHierarchyStructureHierarchyStructureLevelFife

    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn string
    ARN of the hierarchy level.
    id string
    The identifier of the hierarchy level.
    name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn str
    ARN of the hierarchy level.
    id str
    The identifier of the hierarchy level.
    name str
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.

    GetUserHierarchyStructureHierarchyStructureLevelFour

    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn string
    ARN of the hierarchy level.
    id string
    The identifier of the hierarchy level.
    name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn str
    ARN of the hierarchy level.
    id str
    The identifier of the hierarchy level.
    name str
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.

    GetUserHierarchyStructureHierarchyStructureLevelOne

    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn string
    ARN of the hierarchy level.
    id string
    The identifier of the hierarchy level.
    name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn str
    ARN of the hierarchy level.
    id str
    The identifier of the hierarchy level.
    name str
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.

    GetUserHierarchyStructureHierarchyStructureLevelThree

    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn string
    ARN of the hierarchy level.
    id string
    The identifier of the hierarchy level.
    name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn str
    ARN of the hierarchy level.
    id str
    The identifier of the hierarchy level.
    name str
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.

    GetUserHierarchyStructureHierarchyStructureLevelTwo

    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    Arn string
    ARN of the hierarchy level.
    Id string
    The identifier of the hierarchy level.
    Name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn string
    ARN of the hierarchy level.
    id string
    The identifier of the hierarchy level.
    name string
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn str
    ARN of the hierarchy level.
    id str
    The identifier of the hierarchy level.
    name str
    Name of the user hierarchy level. Must not be more than 50 characters.
    arn String
    ARN of the hierarchy level.
    id String
    The identifier of the hierarchy level.
    name String
    Name of the user hierarchy level. Must not be more than 50 characters.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
    pulumi/pulumi-aws