Amazon FinSpace Dataset Browser will be discontinued on November 29,
2024
. Starting November 29, 2023
, FinSpace will no longer accept the creation of new Dataset Browser
environments. Customers using Amazon FinSpace with Managed Kdb Insights
ListUsersByPermissionGroup
Lists details of all the users in a specific permission group.
Request Syntax
GET /permission-group/permissionGroupId
/users?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results per page.
Valid Range: Minimum value of 1. Maximum value of 100.
Required: Yes
- nextToken
-
A token that indicates where a results page should begin.
- permissionGroupId
-
The unique identifier for the permission group.
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
.*\S.*
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"users": [
{
"apiAccess": "string",
"apiAccessPrincipalArn": "string",
"emailAddress": "string",
"firstName": "string",
"lastName": "string",
"membershipStatus": "string",
"status": "string",
"type": "string",
"userId": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
A token that indicates where a results page should begin.
Type: String
- users
-
Lists details of all users in a specific permission group.
Type: Array of UserByPermissionGroup objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: