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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.getUser

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::User

    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(user_arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(user_arn: 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-native:connect:getUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    UserArn string
    The Amazon Resource Name (ARN) for the user.
    UserArn string
    The Amazon Resource Name (ARN) for the user.
    userArn String
    The Amazon Resource Name (ARN) for the user.
    userArn string
    The Amazon Resource Name (ARN) for the user.
    user_arn str
    The Amazon Resource Name (ARN) for the user.
    userArn String
    The Amazon Resource Name (ARN) for the user.

    getUser Result

    The following output properties are available:

    DirectoryUserId string
    The identifier of the user account in the directory used for identity management.
    HierarchyGroupArn string
    The identifier of the hierarchy group for the user.
    IdentityInfo Pulumi.AwsNative.Connect.Outputs.UserIdentityInfo
    The information about the identity of the user.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    PhoneConfig Pulumi.AwsNative.Connect.Outputs.UserPhoneConfig
    The phone settings for the user.
    RoutingProfileArn string
    The identifier of the routing profile for the user.
    SecurityProfileArns List<string>
    One or more security profile arns for the user
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags.
    UserArn string
    The Amazon Resource Name (ARN) for the user.
    UserProficiencies List<Pulumi.AwsNative.Connect.Outputs.UserProficiency>
    One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
    Username string
    The user name for the account.
    DirectoryUserId string
    The identifier of the user account in the directory used for identity management.
    HierarchyGroupArn string
    The identifier of the hierarchy group for the user.
    IdentityInfo UserIdentityInfo
    The information about the identity of the user.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    PhoneConfig UserPhoneConfig
    The phone settings for the user.
    RoutingProfileArn string
    The identifier of the routing profile for the user.
    SecurityProfileArns []string
    One or more security profile arns for the user
    Tags Tag
    One or more tags.
    UserArn string
    The Amazon Resource Name (ARN) for the user.
    UserProficiencies []UserProficiency
    One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
    Username string
    The user name for the account.
    directoryUserId String
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupArn String
    The identifier of the hierarchy group for the user.
    identityInfo UserIdentityInfo
    The information about the identity of the user.
    instanceArn String
    The identifier of the Amazon Connect instance.
    phoneConfig UserPhoneConfig
    The phone settings for the user.
    routingProfileArn String
    The identifier of the routing profile for the user.
    securityProfileArns List<String>
    One or more security profile arns for the user
    tags List<Tag>
    One or more tags.
    userArn String
    The Amazon Resource Name (ARN) for the user.
    userProficiencies List<UserProficiency>
    One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
    username String
    The user name for the account.
    directoryUserId string
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupArn string
    The identifier of the hierarchy group for the user.
    identityInfo UserIdentityInfo
    The information about the identity of the user.
    instanceArn string
    The identifier of the Amazon Connect instance.
    phoneConfig UserPhoneConfig
    The phone settings for the user.
    routingProfileArn string
    The identifier of the routing profile for the user.
    securityProfileArns string[]
    One or more security profile arns for the user
    tags Tag[]
    One or more tags.
    userArn string
    The Amazon Resource Name (ARN) for the user.
    userProficiencies UserProficiency[]
    One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
    username string
    The user name for the account.
    directory_user_id str
    The identifier of the user account in the directory used for identity management.
    hierarchy_group_arn str
    The identifier of the hierarchy group for the user.
    identity_info UserIdentityInfo
    The information about the identity of the user.
    instance_arn str
    The identifier of the Amazon Connect instance.
    phone_config UserPhoneConfig
    The phone settings for the user.
    routing_profile_arn str
    The identifier of the routing profile for the user.
    security_profile_arns Sequence[str]
    One or more security profile arns for the user
    tags Sequence[root_Tag]
    One or more tags.
    user_arn str
    The Amazon Resource Name (ARN) for the user.
    user_proficiencies Sequence[UserProficiency]
    One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
    username str
    The user name for the account.
    directoryUserId String
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupArn String
    The identifier of the hierarchy group for the user.
    identityInfo Property Map
    The information about the identity of the user.
    instanceArn String
    The identifier of the Amazon Connect instance.
    phoneConfig Property Map
    The phone settings for the user.
    routingProfileArn String
    The identifier of the routing profile for the user.
    securityProfileArns List<String>
    One or more security profile arns for the user
    tags List<Property Map>
    One or more tags.
    userArn String
    The Amazon Resource Name (ARN) for the user.
    userProficiencies List<Property Map>
    One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
    username String
    The user name for the account.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    UserIdentityInfo

    Email string
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    FirstName string
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    LastName string
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    Mobile string
    The user's mobile number.
    SecondaryEmail string

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    Email string
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    FirstName string
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    LastName string
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    Mobile string
    The user's mobile number.
    SecondaryEmail string

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email String
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    firstName String
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    lastName String
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile String
    The user's mobile number.
    secondaryEmail String

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email string
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    firstName string
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    lastName string
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile string
    The user's mobile number.
    secondaryEmail string

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email str
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    first_name str
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    last_name str
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile str
    The user's mobile number.
    secondary_email str

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email String
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    firstName String
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    lastName String
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile String
    The user's mobile number.
    secondaryEmail String

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    UserPhoneConfig

    PhoneType Pulumi.AwsNative.Connect.UserPhoneType
    The phone type.
    AfterContactWorkTimeLimit int

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    AutoAccept bool
    The Auto accept setting.
    DeskPhoneNumber string
    The phone number for the user's desk phone.
    PhoneType UserPhoneType
    The phone type.
    AfterContactWorkTimeLimit int

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    AutoAccept bool
    The Auto accept setting.
    DeskPhoneNumber string
    The phone number for the user's desk phone.
    phoneType UserPhoneType
    The phone type.
    afterContactWorkTimeLimit Integer

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    autoAccept Boolean
    The Auto accept setting.
    deskPhoneNumber String
    The phone number for the user's desk phone.
    phoneType UserPhoneType
    The phone type.
    afterContactWorkTimeLimit number

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    autoAccept boolean
    The Auto accept setting.
    deskPhoneNumber string
    The phone number for the user's desk phone.
    phone_type UserPhoneType
    The phone type.
    after_contact_work_time_limit int

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    auto_accept bool
    The Auto accept setting.
    desk_phone_number str
    The phone number for the user's desk phone.
    phoneType "SOFT_PHONE" | "DESK_PHONE"
    The phone type.
    afterContactWorkTimeLimit Number

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    autoAccept Boolean
    The Auto accept setting.
    deskPhoneNumber String
    The phone number for the user's desk phone.

    UserPhoneType

    UserProficiency

    AttributeName string
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    AttributeValue string
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    Level double
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    AttributeName string
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    AttributeValue string
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    Level float64
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attributeName String
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attributeValue String
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level Double
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attributeName string
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attributeValue string
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level number
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attribute_name str
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attribute_value str
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level float
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attributeName String
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attributeValue String
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level Number
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native