connect_describe_user: Describes the specified user account

Description Usage Arguments Value Request syntax

View source: R/connect_operations.R

Description

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Usage

1
connect_describe_user(UserId, InstanceId)

Arguments

UserId

[required] The identifier of the user account.

InstanceId

[required] The identifier of the Amazon Connect instance.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
list(
  User = list(
    Id = "string",
    Arn = "string",
    Username = "string",
    IdentityInfo = list(
      FirstName = "string",
      LastName = "string",
      Email = "string"
    ),
    PhoneConfig = list(
      PhoneType = "SOFT_PHONE"|"DESK_PHONE",
      AutoAccept = TRUE|FALSE,
      AfterContactWorkTimeLimit = 123,
      DeskPhoneNumber = "string"
    ),
    DirectoryUserId = "string",
    SecurityProfileIds = list(
      "string"
    ),
    RoutingProfileId = "string",
    HierarchyGroupId = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax

1
2
3
4
svc$describe_user(
  UserId = "string",
  InstanceId = "string"
)

paws.customer.engagement documentation built on Aug. 23, 2021, 9:22 a.m.