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
UpdateUser
Modifies the details of the specified user. You cannot update the userId
for a user.
Request Syntax
PUT /user/userId
HTTP/1.1
Content-type: application/json
{
"apiAccess": "string
",
"apiAccessPrincipalArn": "string
",
"clientToken": "string
",
"firstName": "string
",
"lastName": "string
",
"type": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- userId
-
The unique identifier for the user that you want to update.
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- apiAccess
-
The option to indicate whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
Type: String
Valid Values:
ENABLED | DISABLED
Required: No
-
- apiAccessPrincipalArn
-
The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.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+=,.@\-_/]+$
Required: No
- clientToken
-
A token that ensures idempotency. This token expires in 10 minutes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: No
- firstName
-
The first name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
.*\S.*
Required: No
- lastName
-
The last name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
.*\S.*
Required: No
- type
-
The option to indicate the type of user.
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
Type: String
Valid Values:
SUPER_USER | APP_USER
Required: No
-
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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.
- userId
-
The unique identifier of the updated user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
.*\S.*
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
- ConflictException
-
The request conflicts with an existing resource.
HTTP Status Code: 409
- 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: