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
The details of the user.
Contents
Note
In the following list, the required parameters are described first.
- apiAccess
-
Indicates whether the user can use the
GetProgrammaticAccessCredentialsAPI 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 | DISABLEDRequired: No
-
- apiAccessPrincipalArn
-
The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentialsAPI 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
- createTime
-
The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
Type: Long
Required: No
- emailAddress
-
The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 320.
Pattern:
[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}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
- lastDisabledTime
-
Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
Type: Long
Required: No
- lastEnabledTime
-
Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
Type: Long
Required: No
- lastLoginTime
-
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
Type: Long
Required: No
- lastModifiedTime
-
Describes the last time the user was updated. The value is determined as epoch time in milliseconds.
Type: Long
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
- status
-
The current status of the user.
-
CREATING– The user creation is in progress. -
ENABLED– The user is created and is currently active. -
DISABLED– The user is currently inactive.
Type: String
Valid Values:
CREATING | ENABLED | DISABLEDRequired: No
-
- type
-
Indicates 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_USERRequired: No
-
- userId
-
The unique identifier for the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
.*\S.*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
