Integer statusCode
The returned status code of the response.
String accessKeyId
The unique identifier for the security credentials.
String secretAccessKey
The secret access key that can be used to sign requests.
String sessionToken
The token that users must pass to use the credentials.
Long expiration
The Epoch time when the current credentials expire.
String errorMessage
The text of the error message.
String errorCategory
The category of the error.
VALIDATION – The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase
quotas.
ACCESS_DENIED – Missing required permission to perform this request.
RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
THROTTLING – The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
CANCELLED – Cancelled.
USER_RECOVERABLE – A user recoverable error has occurred.
String changesetId
The unique identifier for a Changeset.
String changesetArn
The ARN identifier of the Changeset.
String datasetId
The unique identifier for the FinSpace Dataset in which the Changeset is created.
String changeType
Type that indicates how a Changeset is applied to a Dataset.
REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
Map<K,V> sourceParams
Options that define the location of the data being ingested.
Map<K,V> formatParams
Options that define the structure of the source file(s).
Long createTime
The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
String status
Status of the Changeset ingestion.
PENDING – Changeset is pending creation.
FAILED – Changeset creation has failed.
SUCCESS – Changeset creation has succeeded.
RUNNING – Changeset creation is running.
STOP_REQUESTED – User requested Changeset creation to stop.
ChangesetErrorInfo errorInfo
The structure with error messages.
Long activeUntilTimestamp
Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
Long activeFromTimestamp
Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
String updatesChangesetId
The unique identifier of the Changeset that is updated.
String updatedByChangesetId
The unique identifier of the updated Changeset.
String dataType
Data type of a column.
STRING – A String data type.
CHAR – A char data type.
INTEGER – An integer data type.
TINYINT – A tinyint data type.
SMALLINT – A smallint data type.
BIGINT – A bigint data type.
FLOAT – A float data type.
DOUBLE – A double data type.
DATE – A date data type.
DATETIME – A datetime data type.
BOOLEAN – A boolean data type.
BINARY – A binary data type.
String columnName
The name of a column.
String columnDescription
Description for a column.
String reason
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String datasetId
The unique identifier for the FinSpace Dataset where the Changeset will be created.
String changeType
The option to indicate how a Changeset will be applied to a Dataset.
REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.
APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.
MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
Map<K,V> sourceParams
Options that define the location of the data being ingested (s3SourcePath) and the source of the
changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.
Map<K,V> formatParams
Options that define the structure of the source file(s) including the format type (formatType),
header row (withHeader), data separation character (separator) and the type of
compression (compression).
formatType is a required attribute and can have the following values:
PARQUET – Parquet source file format.
CSV – CSV source file format.
JSON – JSON source file format.
XML – XML source file format.
Here is an example of how you could specify the formatParams:
"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }
Note that if you only provide formatType as CSV, the rest of the attributes will
automatically default to CSV values as following:
{ "withHeader": "true", "separator": "," }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String datasetTitle
Display title for a FinSpace Dataset.
String kind
The format in which Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
String datasetDescription
Description of a Dataset.
DatasetOwnerInfo ownerInfo
Contact information for a Dataset owner.
PermissionGroupParams permissionGroupParams
Permission group parameters for Dataset permissions.
String alias
The unique resource identifier for a Dataset.
SchemaUnion schemaDefinition
Definition for a schema on a tabular Dataset.
String datasetId
The unique identifier for the created Dataset.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String datasetId
The unique Dataset identifier that is used to create a Dataview.
Boolean autoUpdate
Flag to indicate Dataview should be updated automatically.
List<E> sortColumns
Columns to be used for sorting the data.
List<E> partitionColumns
Ordered set of column names used to partition data.
Long asOfTimestamp
Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
DataViewDestinationTypeParams destinationTypeParams
Options that define the destination type for the Dataview.
String name
The name of the permission group.
String description
A brief description for the permission group.
List<E> applicationPermissions
The option to indicate FinSpace application permissions that are granted to a specific group.
When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
users to grant themselves or others access to any functionality in their FinSpace environment's application. It
should only be granted to trusted users.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
permission that allows users to grant themselves or others access to any functionality in the application. It
should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String permissionGroupId
The unique identifier for the permission group.
String emailAddress
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
String type
The option to indicate the type of user. Use one of the following options to specify this parameter:
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.
String firstName
The first name of the user that you want to register.
String lastName
The last name of the user that you want to register.
String 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.
String 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.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String userId
The unique identifier for the user.
String datasetId
An identifier for a Dataset.
String datasetArn
The ARN identifier of the Dataset.
String datasetTitle
Display title for a Dataset.
String kind
The format in which Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
String datasetDescription
Description for a Dataset.
DatasetOwnerInfo ownerInfo
Contact information for a Dataset owner.
Long createTime
The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
Long lastModifiedTime
The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
SchemaUnion schemaDefinition
Definition for a schema on a tabular Dataset.
String alias
The unique resource identifier for a Dataset.
String destinationType
Destination type for a Dataview.
GLUE_TABLE – Glue table destination type.
S3 – S3 destination type.
String s3DestinationExportFileFormat
Dataview export file format.
PARQUET – Parquet export file format.
DELIMITED_TEXT – Delimited text export file format.
Map<K,V> s3DestinationExportFileFormatOptions
Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }
String errorMessage
The text of the error message.
String errorCategory
The category of the error.
VALIDATION – The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase
quotas.
ACCESS_DENIED – Missing required permission to perform this request.
RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
THROTTLING – The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
CANCELLED – Cancelled.
USER_RECOVERABLE – A user recoverable error has occurred.
String dataViewId
The unique identifier for the Dataview.
String dataViewArn
The ARN identifier of the Dataview.
String datasetId
Th unique identifier for the Dataview Dataset.
Long asOfTimestamp
Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
List<E> partitionColumns
Ordered set of column names used to partition data.
List<E> sortColumns
Columns to be used for sorting the data.
String status
The status of a Dataview creation.
RUNNING – Dataview creation is running.
STARTING – Dataview creation is starting.
FAILED – Dataview creation has failed.
CANCELLED – Dataview creation has been cancelled.
TIMEOUT – Dataview creation has timed out.
SUCCESS – Dataview creation has succeeded.
PENDING – Dataview creation is pending.
FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.
DataViewErrorInfo errorInfo
The structure with error messages.
DataViewDestinationTypeParams destinationTypeProperties
Information about the Dataview destination.
Boolean autoUpdate
The flag to indicate Dataview should be updated automatically.
Long createTime
The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
Long lastModifiedTime
The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
String datasetId
The unique identifier for the deleted Dataset.
String permissionGroupId
The unique identifier for the deleted permission group.
String userId
The unique identifier for the disabled user account.
Integer statusCode
The returned status code of the response.
String userId
The unique identifier for the enabled user account.
String changesetId
The unique identifier for a Changeset.
String changesetArn
The ARN identifier of the Changeset.
String datasetId
The unique identifier for the FinSpace Dataset where the Changeset is created.
String changeType
Type that indicates how a Changeset is applied to a Dataset.
REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
Map<K,V> sourceParams
Options that define the location of the data being ingested.
Map<K,V> formatParams
Structure of the source file(s).
Long createTime
The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
String status
The status of Changeset creation operation.
ChangesetErrorInfo errorInfo
The structure with error messages.
Long activeUntilTimestamp
Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
Long activeFromTimestamp
Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
String updatesChangesetId
The unique identifier of the Changeset that is being updated.
String updatedByChangesetId
The unique identifier of the updated Changeset.
String datasetId
The unique identifier for a Dataset.
String datasetId
The unique identifier for a Dataset.
String datasetArn
The ARN identifier of the Dataset.
String datasetTitle
Display title for a Dataset.
String kind
The format in which Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
String datasetDescription
A description of the Dataset.
Long createTime
The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
Long lastModifiedTime
The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
SchemaUnion schemaDefinition
Definition for a schema on a tabular Dataset.
String alias
The unique resource identifier for a Dataset.
String status
Status of the Dataset creation.
PENDING – Dataset is pending creation.
FAILED – Dataset creation has failed.
SUCCESS – Dataset creation has succeeded.
RUNNING – Dataset creation is running.
Boolean autoUpdate
Flag to indicate Dataview should be updated automatically.
List<E> partitionColumns
Ordered set of column names used to partition data.
String datasetId
The unique identifier for the Dataset used in the Dataview.
Long asOfTimestamp
Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
DataViewErrorInfo errorInfo
Information about an error that occurred for the Dataview.
Long lastModifiedTime
The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
Long createTime
The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
List<E> sortColumns
Columns to be used for sorting the data.
String dataViewId
The unique identifier for the Dataview.
String dataViewArn
The ARN identifier of the Dataview.
DataViewDestinationTypeParams destinationTypeParams
Options that define the destination type for the Dataview.
String status
The status of a Dataview creation.
RUNNING – Dataview creation is running.
STARTING – Dataview creation is starting.
FAILED – Dataview creation has failed.
CANCELLED – Dataview creation has been cancelled.
TIMEOUT – Dataview creation has timed out.
SUCCESS – Dataview creation has succeeded.
PENDING – Dataview creation is pending.
FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.
AwsCredentials credentials
The credentials required to access the external Dataview from the S3 location.
S3Location s3Location
The location where the external Dataview is stored.
String permissionGroupId
The unique identifier for the permission group.
PermissionGroup permissionGroup
Credentials credentials
Returns the programmatic credentials.
Long durationInMinutes
Returns the duration in which the credentials will remain valid.
String userId
The unique identifier of the user to get data for.
String userId
The unique identifier for the user account that is retrieved.
String status
The current status of the user account.
CREATING – The user account creation is in progress.
ENABLED – The user account is created and is currently active.
DISABLED – The user account is currently inactive.
String firstName
The first name of the user.
String lastName
The last name of the user.
String emailAddress
The email address that is associated with the user.
String 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.
String apiAccess
Indicates 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.
String 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.
Long createTime
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
Long lastEnabledTime
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
Long lastDisabledTime
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
Long lastModifiedTime
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
Long lastLoginTime
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
String locationType
Specify the type of the working location.
SAGEMAKER – Use the Amazon S3 location as a temporary location to store data content when working
with FinSpace Notebooks that run on SageMaker studio.
INGESTION – Use the Amazon S3 location as a staging location to copy your data content and then use
the location with the Changeset creation operation.
String permissionGroupId
The unique identifier for the permission group.
String name
The name of the permission group.
String description
A brief description for the permission group.
List<E> applicationPermissions
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
users to grant themselves or others access to any functionality in their FinSpace environment's application. It
should only be granted to trusted users.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
permission that allows users to grant themselves or others access to any functionality in the application. It
should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
Long createTime
The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
Long lastModifiedTime
Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
String membershipStatus
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
ADDITION_SUCCESS – The user account is successfully added to the permission group.
REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
String permissionGroupId
The unique identifier for the permission group.
String name
The name of the permission group.
String membershipStatus
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
ADDITION_SUCCESS – The user account is successfully added to the permission group.
REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
String reason
String permission
Permission for a resource.
SchemaDefinition tabularSchemaConfig
The configuration for a schema on a tabular Dataset.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String datasetId
The unique identifier for the FinSpace Dataset in which the Changeset is created.
String changesetId
The unique identifier for the Changeset to update.
Map<K,V> sourceParams
Options that define the location of the data being ingested (s3SourcePath) and the source of the
changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.
Map<K,V> formatParams
Options that define the structure of the source file(s) including the format type (formatType),
header row (withHeader), data separation character (separator) and the type of
compression (compression).
formatType is a required attribute and can have the following values:
PARQUET – Parquet source file format.
CSV – CSV source file format.
JSON – JSON source file format.
XML – XML source file format.
Here is an example of how you could specify the formatParams:
"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }
Note that if you only provide formatType as CSV, the rest of the attributes will
automatically default to CSV values as following:
{ "withHeader": "true", "separator": "," }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String datasetId
The unique identifier for the Dataset to update.
String datasetTitle
A display title for the Dataset.
String kind
The format in which the Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
String datasetDescription
A description for the Dataset.
String alias
The unique resource identifier for a Dataset.
SchemaUnion schemaDefinition
Definition for a schema on a tabular Dataset.
String datasetId
The unique identifier for updated Dataset.
String permissionGroupId
The unique identifier for the permission group to update.
String name
The name of the permission group.
String description
A brief description for the permission group.
List<E> applicationPermissions
The permissions that are granted to a specific group for accessing the FinSpace application.
When assigning application permissions, be aware that the permission ManageUsersAndGroups allows
users to grant themselves or others access to any functionality in their FinSpace environment's application. It
should only be granted to trusted users.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged
permission that allows users to grant themselves or others access to any functionality in the application. It
should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String permissionGroupId
The unique identifier for the updated permission group.
String userId
The unique identifier for the user account to update.
String 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.
String firstName
The first name of the user.
String lastName
The last name of the user.
String 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.
String 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.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String userId
The unique identifier of the updated user account.
String userId
The unique identifier for the user.
String status
The current status of the user account.
CREATING – The user account creation is in progress.
ENABLED – The user account is created and is currently active.
DISABLED – The user account is currently inactive.
String firstName
The first name of the user.
String lastName
The last name of the user.
String 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.
String 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.
String apiAccess
Indicates 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.
String 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.
Long createTime
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
Long lastEnabledTime
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
Long lastDisabledTime
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
Long lastModifiedTime
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
Long lastLoginTime
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
String userId
The unique identifier for the user.
String status
The current status of the user account.
CREATING – The user account creation is in progress.
ENABLED – The user account is created and is currently active.
DISABLED – The user account is currently inactive.
String firstName
The first name of the user.
String lastName
The last name of the user.
String emailAddress
The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.
String 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.
String apiAccess
Indicates whether the user can access FinSpace API operations.
ENABLED – The user has permissions to use the API operations.
DISABLED – The user does not have permissions to use any API operations.
String apiAccessPrincipalArn
The IAM ARN identifier that is attached to FinSpace API calls.
String membershipStatus
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
ADDITION_SUCCESS – The user account is successfully added to the permission group.
REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
String reason
Copyright © 2023. All rights reserved.