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

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .

The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight list-users --aws-account-id=111122223333 --namespace=default

Request Syntax

GET /accounts/AwsAccountId/namespaces/Namespace/users?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.


The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$


The maximum number of results to return from this request.

Valid Range: Minimum value of 1. Maximum value of 100.


The namespace. Currently, you should set this to default.

Pattern: default


A pagination token that can be used in a subsequent request.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 Status Content-type: application/json { "NextToken": "string", "RequestId": "string", "UserList": [ { "Active": boolean, "Arn": "string", "Email": "string", "IdentityType": "string", "PrincipalId": "string", "Role": "string", "UserName": "string" } ] }

Response Elements

If the action is successful, the service sends back the following HTTP response.


The http status of the request.

The following data is returned in JSON format by the service.


A pagination token that can be used in a subsequent request.

Type: String


The AWS request ID for this operation.

Type: String


The list of users.

Type: Array of User objects


For information about the errors that are common to all actions, see Common Client Errors.


You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

HTTP Status Code: 401


An internal failure occurred.

HTTP Status Code: 500


The NextToken value isn't valid.

HTTP Status Code: 400


One or more parameters don't have a valid value.

HTTP Status Code: 400


One or more resources can't be found.

HTTP Status Code: 404


This resource is currently unavailable.

HTTP Status Code: 503


Access is throttled.

HTTP Status Code: 429


aws quicksight list-users --aws-account-id=111122223333 --namespace=default
{ "Status": 200, "RequestId": "fd45ab56-ec31-4940-8865-78be764d341e", "UserList": [ { "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/Pat", "Email": "", "Name": "Pat", "Role": "READER" }, { "Role": "ADMIN", "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/catmi", "Name": "catmi", "Email": "" }, { "Role": "AUTHOR", "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/Charlie", "Name": "Charlie", "Email": "" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: