ListGroups
Lists all user groups in Amazon QuickSight.
Request Syntax
GET /accounts/AwsAccountId
/namespaces/Namespace
/groups?max-results=MaxResults
&next-token=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID for the AWS account that the group 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}$
Required: Yes
- MaxResults
-
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
- Namespace
-
The namespace that you want a list of groups from.
Length Constraints: Maximum length of 64.
Pattern:
^[a-zA-Z0-9._-]*$
Required: Yes
- NextToken
-
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
{
"GroupList": [
{
"Arn": "string",
"Description": "string",
"GroupName": "string",
"PrincipalId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 credentials.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 401
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextToken
value isn't valid.- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 400
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 400
- PreconditionNotMetException
-
One or more preconditions aren't met.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
The resource type for this request.
HTTP Status Code: 404
- ResourceUnavailableException
-
This resource is currently unavailable.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
The resource type for this request.
HTTP Status Code: 503
- ThrottlingException
-
Access is throttled.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: