pulumi-aws-kotlin/com.pulumi.aws.connect.kotlin/ConnectFunctions/getUserHierarchyGroup

getUserHierarchyGroup

suspend fun getUserHierarchyGroup(argument: GetUserHierarchyGroupPlainArgs): GetUserHierarchyGroupResult

Provides details about a specific Amazon Connect User Hierarchy Group.

Example Usage

By name

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.connect.getUserHierarchyGroup({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "Example",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.connect.get_user_hierarchy_group(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="Example")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Connect.GetUserHierarchyGroup.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "Example",
    });
});
Content copied to clipboard
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.LookupUserHierarchyGroup(ctx, &connect.LookupUserHierarchyGroupArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			Name:       pulumi.StringRef("Example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.GetUserHierarchyGroupArgs;
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 example = ConnectFunctions.getUserHierarchyGroup(GetUserHierarchyGroupArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("Example")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:connect:getUserHierarchyGroup
      arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        name: Example
Content copied to clipboard

By hierarchy_group_id

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.connect.getUserHierarchyGroup({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    hierarchyGroupId: "cccccccc-bbbb-cccc-dddd-111111111111",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.connect.get_user_hierarchy_group(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    hierarchy_group_id="cccccccc-bbbb-cccc-dddd-111111111111")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Connect.GetUserHierarchyGroup.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        HierarchyGroupId = "cccccccc-bbbb-cccc-dddd-111111111111",
    });
});
Content copied to clipboard
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.LookupUserHierarchyGroup(ctx, &connect.LookupUserHierarchyGroupArgs{
			InstanceId:       "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			HierarchyGroupId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.GetUserHierarchyGroupArgs;
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 example = ConnectFunctions.getUserHierarchyGroup(GetUserHierarchyGroupArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .hierarchyGroupId("cccccccc-bbbb-cccc-dddd-111111111111")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:connect:getUserHierarchyGroup
      arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        hierarchyGroupId: cccccccc-bbbb-cccc-dddd-111111111111
Content copied to clipboard

Return

A collection of values returned by getUserHierarchyGroup.

Parameters

argument

A collection of arguments for invoking getUserHierarchyGroup.

suspend fun getUserHierarchyGroup(hierarchyGroupId: String? = null, instanceId: String, name: String? = null, tags: Map<String, String>? = null): GetUserHierarchyGroupResult

Return

A collection of values returned by getUserHierarchyGroup.

Parameters

hierarchyGroupId

Returns information on a specific hierarchy group by hierarchy group id

instanceId

Reference to the hosting Amazon Connect Instance

name

Returns information on a specific hierarchy group by name

tags

Map of tags to assign to the hierarchy group.

See also

.

suspend fun getUserHierarchyGroup(argument: suspend GetUserHierarchyGroupPlainArgsBuilder.() -> Unit): GetUserHierarchyGroupResult

Return

A collection of values returned by getUserHierarchyGroup.

Parameters

argument

Builder for com.pulumi.aws.connect.kotlin.inputs.GetUserHierarchyGroupPlainArgs.

See also

.