List Users

quicksight_list_users

R Documentation

Returns a list of all of the Amazon Quick Sight users belonging to this account

Description

Returns a list of all of the Amazon Quick Sight users belonging to this account.

Usage

quicksight_list_users(AwsAccountId, NextToken, MaxResults, Namespace)

Arguments

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 Quick Sight account.
NextToken	A pagination token that can be used in a subsequent request.
MaxResults	The maximum number of results to return from this request.
Namespace	[required] The namespace. Currently, you should set this to default.

Value

A list with the following syntax:

list(
  UserList = list(
    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"
    )
  ),
  NextToken = "string",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$list_users(
  AwsAccountId = "string",
  NextToken = "string",
  MaxResults = 123,
  Namespace = "string"
)