ListUserGroups

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

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

The response is a one or more group objects.

CLI Sample:

aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

AwsAccountId

The AWS Account ID 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}$

MaxResults

The maximum number of results to return from this request.

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

Namespace

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

Pattern: default

NextToken

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

UserName

The Amazon QuickSight user name that you want to list group memberships for.

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 Status Content-type: application/json { "GroupList": [ { "Arn": "string", "Description": "string", "GroupName": "string" } ], "NextToken": "string", "RequestId": "string" }

Response Elements

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

Status

The HTTP status of the request.

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

GroupList

The list of groups the user is a member of.

Type: Array of Group objects

NextToken

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

Type: String

RequestId

The AWS request ID for this operation.

Type: String

Errors

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

AccessDeniedException

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

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

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429

See Also

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