Describe User

quicksight_describe_user

R Documentation

Returns information about a user, given the user name

Description

Returns information about a user, given the user name.

Usage

quicksight_describe_user(UserName, AwsAccountId, Namespace)

Arguments

UserName	[required] The name of the user that you want to describe.
AwsAccountId	[required] The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
Namespace	[required] The namespace. Currently, you should set this to default.

Value

A list with the following syntax:

list(
  User = list(
    Arn = "string",
    UserName = "string",
    Email = "string",
    Role = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|"ADMIN_PRO"|"AUTHOR_PRO"|"READER_PRO",
    IdentityType = "IAM"|"QUICKSIGHT"|"IAM_IDENTITY_CENTER",
    Active = TRUE|FALSE,
    PrincipalId = "string",
    CustomPermissionsName = "string",
    ExternalLoginFederationProviderType = "string",
    ExternalLoginFederationProviderUrl = "string",
    ExternalLoginId = "string"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

svc$describe_user(
  UserName = "string",
  AwsAccountId = "string",
  Namespace = "string"
)