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
Retrieves information about the specified kdb user.
Request Syntax
GET /kx/environments/environmentId/users/userName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- environmentId
-
A unique identifier for the kdb environment.
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$Required: Yes
- userName
-
A unique identifier for the user.
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
^[0-9A-Za-z_-]{1,50}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"environmentId": "string",
"iamRole": "string",
"userArn": "string",
"userName": "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.
- environmentId
-
A unique identifier for the kdb environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$ - iamRole
-
The IAM role ARN that is associated with the user.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - userArn
-
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}/kxUser/[0-9A-Za-z_-]{1,128}$ - userName
-
A unique identifier for the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$
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:
