Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. connect
  5. getUser

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.connect.getUser

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides details about a specific Amazon Connect User.

    Example Usage

    By name

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

const example = aws.connect.getUser({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "Example",
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.get_user(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="Example")

    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.LookupUser(ctx, &connect.LookupUserArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			Name:       pulumi.StringRef("Example"),
		}, 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 example = Aws.Connect.GetUser.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "Example",
    });

});

    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.GetUserArgs;
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.getUser(GetUserArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("Example")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:connect:getUser
      Arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        name: Example

    By user_id

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

const example = aws.connect.getUser({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    userId: "cccccccc-bbbb-cccc-dddd-111111111111",
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.get_user(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    user_id="cccccccc-bbbb-cccc-dddd-111111111111")

    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.LookupUser(ctx, &connect.LookupUserArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			UserId:     pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
		}, 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 example = Aws.Connect.GetUser.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        UserId = "cccccccc-bbbb-cccc-dddd-111111111111",
    });

});

    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.GetUserArgs;
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.getUser(GetUserArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .userId("cccccccc-bbbb-cccc-dddd-111111111111")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:connect:getUser
      Arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        userId: cccccccc-bbbb-cccc-dddd-111111111111

    Using getUser

    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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
    def get_user(instance_id: Optional[str] = None,
             name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             user_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(instance_id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             user_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

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

    public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    InstanceId string
    Reference to the hosting Amazon Connect Instance
    Name string
    Returns information on a specific User by name
    Tags Dictionary<string, string>
    A map of tags to assign to the User.
    UserId string
    Returns information on a specific User by User id
    InstanceId string
    Reference to the hosting Amazon Connect Instance
    Name string
    Returns information on a specific User by name
    Tags map[string]string
    A map of tags to assign to the User.
    UserId string
    Returns information on a specific User by User id
    instanceId String
    Reference to the hosting Amazon Connect Instance
    name String
    Returns information on a specific User by name
    tags Map<String,String>
    A map of tags to assign to the User.
    userId String
    Returns information on a specific User by User id
    instanceId string
    Reference to the hosting Amazon Connect Instance
    name string
    Returns information on a specific User by name
    tags {[key: string]: string}
    A map of tags to assign to the User.
    userId string
    Returns information on a specific User by User id
    instance_id str
    Reference to the hosting Amazon Connect Instance
    name str
    Returns information on a specific User by name
    tags Mapping[str, str]
    A map of tags to assign to the User.
    user_id str
    Returns information on a specific User by User id
    instanceId String
    Reference to the hosting Amazon Connect Instance
    name String
    Returns information on a specific User by name
    tags Map<String>
    A map of tags to assign to the User.
    userId String
    Returns information on a specific User by User id

    getUser Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the User.
    DirectoryUserId string
    The identifier of the user account in the directory used for identity management.
    HierarchyGroupId string
    The identifier of the hierarchy group for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityInfos List<GetUserIdentityInfo>
    A block that contains information about the identity of the user. Documented below.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Name string
    PhoneConfigs List<GetUserPhoneConfig>
    A block that contains information about the phone settings for the user. Documented below.
    RoutingProfileId string
    The identifier of the routing profile for the user.
    SecurityProfileIds List<string>
    A list of identifiers for the security profiles for the user.
    Tags Dictionary<string, string>
    A map of tags to assign to the User.
    UserId string
    Arn string
    The Amazon Resource Name (ARN) of the User.
    DirectoryUserId string
    The identifier of the user account in the directory used for identity management.
    HierarchyGroupId string
    The identifier of the hierarchy group for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityInfos []GetUserIdentityInfo
    A block that contains information about the identity of the user. Documented below.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Name string
    PhoneConfigs []GetUserPhoneConfig
    A block that contains information about the phone settings for the user. Documented below.
    RoutingProfileId string
    The identifier of the routing profile for the user.
    SecurityProfileIds []string
    A list of identifiers for the security profiles for the user.
    Tags map[string]string
    A map of tags to assign to the User.
    UserId string
    arn String
    The Amazon Resource Name (ARN) of the User.
    directoryUserId String
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupId String
    The identifier of the hierarchy group for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    identityInfos List<GetUserIdentityInfo>
    A block that contains information about the identity of the user. Documented below.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    name String
    phoneConfigs List<GetUserPhoneConfig>
    A block that contains information about the phone settings for the user. Documented below.
    routingProfileId String
    The identifier of the routing profile for the user.
    securityProfileIds List<String>
    A list of identifiers for the security profiles for the user.
    tags Map<String,String>
    A map of tags to assign to the User.
    userId String
    arn string
    The Amazon Resource Name (ARN) of the User.
    directoryUserId string
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupId string
    The identifier of the hierarchy group for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    identityInfos GetUserIdentityInfo[]
    A block that contains information about the identity of the user. Documented below.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    name string
    phoneConfigs GetUserPhoneConfig[]
    A block that contains information about the phone settings for the user. Documented below.
    routingProfileId string
    The identifier of the routing profile for the user.
    securityProfileIds string[]
    A list of identifiers for the security profiles for the user.
    tags {[key: string]: string}
    A map of tags to assign to the User.
    userId string
    arn str
    The Amazon Resource Name (ARN) of the User.
    directory_user_id str
    The identifier of the user account in the directory used for identity management.
    hierarchy_group_id str
    The identifier of the hierarchy group for the user.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_infos Sequence[GetUserIdentityInfo]
    A block that contains information about the identity of the user. Documented below.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    name str
    phone_configs Sequence[GetUserPhoneConfig]
    A block that contains information about the phone settings for the user. Documented below.
    routing_profile_id str
    The identifier of the routing profile for the user.
    security_profile_ids Sequence[str]
    A list of identifiers for the security profiles for the user.
    tags Mapping[str, str]
    A map of tags to assign to the User.
    user_id str
    arn String
    The Amazon Resource Name (ARN) of the User.
    directoryUserId String
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupId String
    The identifier of the hierarchy group for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    identityInfos List<Property Map>
    A block that contains information about the identity of the user. Documented below.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    name String
    phoneConfigs List<Property Map>
    A block that contains information about the phone settings for the user. Documented below.
    routingProfileId String
    The identifier of the routing profile for the user.
    securityProfileIds List<String>
    A list of identifiers for the security profiles for the user.
    tags Map<String>
    A map of tags to assign to the User.
    userId String

    Supporting Types

    GetUserIdentityInfo

    Email string
    The email address.
    FirstName string
    The first name.
    LastName string
    The last name.
    Email string
    The email address.
    FirstName string
    The first name.
    LastName string
    The last name.
    email String
    The email address.
    firstName String
    The first name.
    lastName String
    The last name.
    email string
    The email address.
    firstName string
    The first name.
    lastName string
    The last name.
    email str
    The email address.
    first_name str
    The first name.
    last_name str
    The last name.
    email String
    The email address.
    firstName String
    The first name.
    lastName String
    The last name.

    GetUserPhoneConfig

    AfterContactWorkTimeLimit int
    The After Call Work (ACW) timeout setting, in seconds.
    AutoAccept bool
    When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
    DeskPhoneNumber string
    The phone number for the user's desk phone.
    PhoneType string
    The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
    AfterContactWorkTimeLimit int
    The After Call Work (ACW) timeout setting, in seconds.
    AutoAccept bool
    When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
    DeskPhoneNumber string
    The phone number for the user's desk phone.
    PhoneType string
    The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
    afterContactWorkTimeLimit Integer
    The After Call Work (ACW) timeout setting, in seconds.
    autoAccept Boolean
    When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
    deskPhoneNumber String
    The phone number for the user's desk phone.
    phoneType String
    The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
    afterContactWorkTimeLimit number
    The After Call Work (ACW) timeout setting, in seconds.
    autoAccept boolean
    When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
    deskPhoneNumber string
    The phone number for the user's desk phone.
    phoneType string
    The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
    after_contact_work_time_limit int
    The After Call Work (ACW) timeout setting, in seconds.
    auto_accept bool
    When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
    desk_phone_number str
    The phone number for the user's desk phone.
    phone_type str
    The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
    afterContactWorkTimeLimit Number
    The After Call Work (ACW) timeout setting, in seconds.
    autoAccept Boolean
    When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
    deskPhoneNumber String
    The phone number for the user's desk phone.
    phoneType String
    The phone type. Valid values are DESK_PHONE and SOFT_PHONE.

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws