Table of Contents
A low-level client representing FinSpace Public API (FinSpace Data)
The FinSpace APIs let you take actions inside the FinSpace.
import boto3
client = boto3.client('finspace-data')
These are the available methods:
Check if an operation can be paginated.
Creates a new Changeset in a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = client.create_changeset(
clientToken='string',
datasetId='string',
changeType='REPLACE'|'APPEND'|'MODIFY',
sourceParams={
'string': 'string'
},
formatParams={
'string': 'string'
}
)
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier for the FinSpace Dataset where the Changeset will be created.
[REQUIRED]
The option to indicate how a Changeset will be applied to a Dataset.
[REQUIRED]
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.
[REQUIRED]
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:
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.
dict
Response Syntax
{
'datasetId': 'string',
'changesetId': 'string'
}
Response Structure
(dict) -- The response from a CreateChangeset operation.
datasetId (string) --
The unique identifier for the FinSpace Dataset where the Changeset is created.
changesetId (string) --
The unique identifier of the Changeset that is created.
Exceptions
Creates a Dataview for a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.create_data_view(
clientToken='string',
datasetId='string',
autoUpdate=True|False,
sortColumns=[
'string',
],
partitionColumns=[
'string',
],
asOfTimestamp=123,
destinationTypeParams={
'destinationType': 'string',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': 'string'
}
}
)
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
[REQUIRED]
The unique Dataset identifier that is used to create a Dataview.
Columns to be used for sorting the data.
Ordered set of column names used to partition data.
[REQUIRED]
Options that define the destination type for the Dataview.
Destination type for a Dataview.
Data view export file format.
Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }
dict
Response Syntax
{
'datasetId': 'string',
'dataViewId': 'string'
}
Response Structure
(dict) -- Response for creating a data view.
datasetId (string) --
The unique identifier of the Dataset used for the Dataview.
dataViewId (string) --
The unique identifier for the created Dataview.
Exceptions
Creates a new FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = client.create_dataset(
clientToken='string',
datasetTitle='string',
kind='TABULAR'|'NON_TABULAR',
datasetDescription='string',
ownerInfo={
'name': 'string',
'phoneNumber': 'string',
'email': 'string'
},
permissionGroupParams={
'permissionGroupId': 'string',
'datasetPermissions': [
{
'permission': 'string'
},
]
},
alias='string',
schemaDefinition={
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
}
)
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
[REQUIRED]
Display title for a FinSpace Dataset.
[REQUIRED]
The format in which Dataset data is structured.
Contact information for a Dataset owner.
The name of the Dataset owner.
Phone number for the Dataset owner.
Email address for the Dataset owner.
[REQUIRED]
Permission group parameters for Dataset permissions.
The unique identifier for the PermissionGroup .
List of resource permissions.
Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.
The following is a list of valid dataset permissions that you can apply:
For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
Permission for a resource.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
The name of a column.
Description for a column.
List of column names used for primary key.
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from a CreateDataset operation
datasetId (string) --
The unique identifier for the created Dataset.
Exceptions
Creates a group of permissions for various actions that a user can perform in FinSpace.
See also: AWS API Documentation
Request Syntax
response = client.create_permission_group(
name='string',
description='string',
applicationPermissions=[
'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
],
clientToken='string'
)
[REQUIRED]
The name of the permission group.
[REQUIRED]
The option to indicate FinSpace application permissions that are granted to a specific group.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'permissionGroupId': 'string'
}
Response Structure
(dict) --
permissionGroupId (string) --
The unique identifier for the permission group.
Exceptions
Creates a new user in FinSpace.
See also: AWS API Documentation
Request Syntax
response = client.create_user(
emailAddress='string',
type='SUPER_USER'|'APP_USER',
firstName='string',
lastName='string',
ApiAccess='ENABLED'|'DISABLED',
apiAccessPrincipalArn='string',
clientToken='string'
)
[REQUIRED]
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.
[REQUIRED]
The option to indicate the type of user. Use one of the following options to specify this parameter:
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.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'userId': 'string'
}
Response Structure
(dict) --
userId (string) --
The unique identifier for the user.
Exceptions
Deletes a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = client.delete_dataset(
clientToken='string',
datasetId='string'
)
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier of the Dataset to be deleted.
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from an DeleteDataset operation
datasetId (string) --
The unique identifier for the deleted Dataset.
Exceptions
Deletes a permission group. This action is irreversible.
See also: AWS API Documentation
Request Syntax
response = client.delete_permission_group(
permissionGroupId='string',
clientToken='string'
)
[REQUIRED]
The unique identifier for the permission group that you want to delete.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'permissionGroupId': 'string'
}
Response Structure
(dict) --
permissionGroupId (string) --
The unique identifier for the deleted permission group.
Exceptions
Denies access to the FinSpace web application and API for the specified user.
See also: AWS API Documentation
Request Syntax
response = client.disable_user(
userId='string',
clientToken='string'
)
[REQUIRED]
The unique identifier for the user account that you want to disable.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'userId': 'string'
}
Response Structure
(dict) --
userId (string) --
The unique identifier for the disabled user account.
Exceptions
Allows the specified user to access the FinSpace web application and API.
See also: AWS API Documentation
Request Syntax
response = client.enable_user(
userId='string',
clientToken='string'
)
[REQUIRED]
The unique identifier for the user account that you want to enable.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'userId': 'string'
}
Response Structure
(dict) --
userId (string) --
The unique identifier for the enabled user account.
Exceptions
Get information about a Changeset.
See also: AWS API Documentation
Request Syntax
response = client.get_changeset(
datasetId='string',
changesetId='string'
)
[REQUIRED]
The unique identifier for the FinSpace Dataset where the Changeset is created.
[REQUIRED]
The unique identifier of the Changeset for which to get data.
dict
Response Syntax
{
'changesetId': 'string',
'changesetArn': 'string',
'datasetId': 'string',
'changeType': 'REPLACE'|'APPEND'|'MODIFY',
'sourceParams': {
'string': 'string'
},
'formatParams': {
'string': 'string'
},
'createTime': 123,
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'activeUntilTimestamp': 123,
'activeFromTimestamp': 123,
'updatesChangesetId': 'string',
'updatedByChangesetId': 'string'
}
Response Structure
(dict) -- The response from a describe changeset operation
changesetId (string) --
The unique identifier for a Changeset.
changesetArn (string) --
The ARN identifier of the Changeset.
datasetId (string) --
The unique identifier for the FinSpace Dataset where the Changeset is created.
changeType (string) --
Type that indicates how a Changeset is applied to a Dataset.
sourceParams (dict) --
Options that define the location of the data being ingested.
formatParams (dict) --
Structure of the source file(s).
createTime (integer) --
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.
status (string) --
The status of Changeset creation operation.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
activeUntilTimestamp (integer) --
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.
activeFromTimestamp (integer) --
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.
updatesChangesetId (string) --
The unique identifier of the Changeset that is being updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
Exceptions
Gets information about a Dataview.
See also: AWS API Documentation
Request Syntax
response = client.get_data_view(
dataViewId='string',
datasetId='string'
)
[REQUIRED]
The unique identifier for the Dataview.
[REQUIRED]
The unique identifier for the Dataset used in the Dataview.
dict
Response Syntax
{
'autoUpdate': True|False,
'partitionColumns': [
'string',
],
'datasetId': 'string',
'asOfTimestamp': 123,
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'lastModifiedTime': 123,
'createTime': 123,
'sortColumns': [
'string',
],
'dataViewId': 'string',
'dataViewArn': 'string',
'destinationTypeParams': {
'destinationType': 'string',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': 'string'
}
},
'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED'
}
Response Structure
(dict) -- Response from retrieving a dataview, which includes details on the target database and table name
autoUpdate (boolean) --
Flag to indicate Dataview should be updated automatically.
partitionColumns (list) --
Ordered set of column names used to partition data.
datasetId (string) --
The unique identifier for the Dataset used in the Dataview.
asOfTimestamp (integer) --
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.
errorInfo (dict) --
Information about an error that occurred for the Dataview.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
lastModifiedTime (integer) --
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.
createTime (integer) --
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.
sortColumns (list) --
Columns to be used for sorting the data.
dataViewId (string) --
The unique identifier for the Dataview.
dataViewArn (string) --
The ARN identifier of the Dataview.
destinationTypeParams (dict) --
Options that define the destination type for the Dataview.
destinationType (string) --
Destination type for a Dataview.
s3DestinationExportFileFormat (string) --
Data view export file format.
s3DestinationExportFileFormatOptions (dict) --
Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }
status (string) --
The status of a Dataview creation.
Exceptions
Returns information about a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.get_dataset(
datasetId='string'
)
[REQUIRED]
The unique identifier for a Dataset.
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetTitle': 'string',
'kind': 'TABULAR'|'NON_TABULAR',
'datasetDescription': 'string',
'createTime': 123,
'lastModifiedTime': 123,
'schemaDefinition': {
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
},
'alias': 'string',
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'
}
Response Structure
The unique identifier for a Dataset.
The ARN identifier of the Dataset.
Display title for a Dataset.
The format in which Dataset data is structured.
A description of the Dataset.
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.
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.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
The name of a column.
Description for a column.
List of column names used for primary key.
The unique resource identifier for a Dataset.
Status of the Dataset creation.
Exceptions
Create a paginator for an operation.
Request programmatic credentials to use with FinSpace SDK.
See also: AWS API Documentation
Request Syntax
response = client.get_programmatic_access_credentials(
durationInMinutes=123,
environmentId='string'
)
[REQUIRED]
The FinSpace environment identifier.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'secretAccessKey': 'string',
'sessionToken': 'string'
},
'durationInMinutes': 123
}
Response Structure
(dict) -- Response for GetProgrammaticAccessCredentials operation
credentials (dict) --
Returns the programmatic credentials.
accessKeyId (string) --
The access key identifier.
secretAccessKey (string) --
The access key.
sessionToken (string) --
The session token.
durationInMinutes (integer) --
Returns the duration in which the credentials will remain valid.
Exceptions
Retrieves details for a specific user.
See also: AWS API Documentation
Request Syntax
response = client.get_user(
userId='string'
)
[REQUIRED]
The unique identifier of the user to get data for.
{
'userId': 'string',
'status': 'CREATING'|'ENABLED'|'DISABLED',
'firstName': 'string',
'lastName': 'string',
'emailAddress': 'string',
'type': 'SUPER_USER'|'APP_USER',
'apiAccess': 'ENABLED'|'DISABLED',
'apiAccessPrincipalArn': 'string',
'createTime': 123,
'lastEnabledTime': 123,
'lastDisabledTime': 123,
'lastModifiedTime': 123,
'lastLoginTime': 123
}
Response Structure
The unique identifier for the user account that is retrieved.
The current status of the user account.
The first name of the user.
The last name of the user.
The email address that is associated with the user.
Indicates the type of user.
Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
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.
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
Exceptions
Returns an object that can wait for some condition.
A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.
See also: AWS API Documentation
Request Syntax
response = client.get_working_location(
locationType='INGESTION'|'SAGEMAKER'
)
Specify the type of the working location.
{
's3Uri': 'string',
's3Path': 'string',
's3Bucket': 'string'
}
Response Structure
Returns the Amazon S3 URI for the working location.
Returns the Amazon S3 Path for the working location.
Returns the Amazon S3 bucket name for the working location.
Exceptions
Lists the FinSpace Changesets for a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.list_changesets(
datasetId='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The unique identifier for the FinSpace Dataset to which the Changeset belongs.
dict
Response Syntax
{
'changesets': [
{
'changesetId': 'string',
'changesetArn': 'string',
'datasetId': 'string',
'changeType': 'REPLACE'|'APPEND'|'MODIFY',
'sourceParams': {
'string': 'string'
},
'formatParams': {
'string': 'string'
},
'createTime': 123,
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'activeUntilTimestamp': 123,
'activeFromTimestamp': 123,
'updatesChangesetId': 'string',
'updatedByChangesetId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) -- Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
changesets (list) --
List of Changesets found.
(dict) --
A Changeset is unit of data in a Dataset.
changesetId (string) --
The unique identifier for a Changeset.
changesetArn (string) --
The ARN identifier of the Changeset.
datasetId (string) --
The unique identifier for the FinSpace Dataset in which the Changeset is created.
changeType (string) --
Type that indicates how a Changeset is applied to a Dataset.
sourceParams (dict) --
Options that define the location of the data being ingested.
formatParams (dict) --
Options that define the structure of the source file(s).
createTime (integer) --
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.
status (string) --
Status of the Changeset ingestion.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
activeUntilTimestamp (integer) --
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.
activeFromTimestamp (integer) --
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.
updatesChangesetId (string) --
The unique identifier of the Changeset that is updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
nextToken (string) --
A token that indicates where a results page should begin.
Exceptions
Lists all available Dataviews for a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.list_data_views(
datasetId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique identifier of the Dataset for which to retrieve Dataviews.
dict
Response Syntax
{
'nextToken': 'string',
'dataViews': [
{
'dataViewId': 'string',
'dataViewArn': 'string',
'datasetId': 'string',
'asOfTimestamp': 123,
'partitionColumns': [
'string',
],
'sortColumns': [
'string',
],
'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'destinationTypeProperties': {
'destinationType': 'string',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': 'string'
}
},
'autoUpdate': True|False,
'createTime': 123,
'lastModifiedTime': 123
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates where a results page should begin.
dataViews (list) --
A list of Dataviews.
(dict) --
Structure for the summary of a Dataview.
dataViewId (string) --
The unique identifier for the Dataview.
dataViewArn (string) --
The ARN identifier of the Dataview.
datasetId (string) --
Th unique identifier for the Dataview Dataset.
asOfTimestamp (integer) --
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.
partitionColumns (list) --
Ordered set of column names used to partition data.
sortColumns (list) --
Columns to be used for sorting the data.
status (string) --
The status of a Dataview creation.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
destinationTypeProperties (dict) --
Information about the Dataview destination.
destinationType (string) --
Destination type for a Dataview.
s3DestinationExportFileFormat (string) --
Data view export file format.
s3DestinationExportFileFormatOptions (dict) --
Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }
autoUpdate (boolean) --
The flag to indicate Dataview should be updated automatically.
createTime (integer) --
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.
lastModifiedTime (integer) --
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.
Exceptions
Lists all of the active Datasets that a user has access to.
See also: AWS API Documentation
Request Syntax
response = client.list_datasets(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'datasets': [
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetTitle': 'string',
'kind': 'TABULAR'|'NON_TABULAR',
'datasetDescription': 'string',
'ownerInfo': {
'name': 'string',
'phoneNumber': 'string',
'email': 'string'
},
'createTime': 123,
'lastModifiedTime': 123,
'schemaDefinition': {
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
},
'alias': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) -- Response for the ListDatasets operation
datasets (list) --
List of Datasets.
(dict) --
The structure for a Dataset.
datasetId (string) --
An identifier for a Dataset.
datasetArn (string) --
The ARN identifier of the Dataset.
datasetTitle (string) --
Display title for a Dataset.
kind (string) --
The format in which Dataset data is structured.
datasetDescription (string) --
Description for a Dataset.
ownerInfo (dict) --
Contact information for a Dataset owner.
name (string) --
The name of the Dataset owner.
phoneNumber (string) --
Phone number for the Dataset owner.
email (string) --
Email address for the Dataset owner.
createTime (integer) --
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.
lastModifiedTime (integer) --
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.
schemaDefinition (dict) --
Definition for a schema on a tabular Dataset.
tabularSchemaConfig (dict) --
The configuration for a schema on a tabular Dataset.
columns (list) --
List of column definitions.
(dict) --
The definition of a column in a tabular Dataset.
dataType (string) --
Data type of a column.
columnName (string) --
The name of a column.
columnDescription (string) --
Description for a column.
primaryKeyColumns (list) --
List of column names used for primary key.
alias (string) --
The unique resource identifier for a Dataset.
nextToken (string) --
A token that indicates where a results page should begin.
Exceptions
Lists all available permission groups in FinSpace.
See also: AWS API Documentation
Request Syntax
response = client.list_permission_groups(
nextToken='string',
maxResults=123
)
[REQUIRED]
The maximum number of results per page.
dict
Response Syntax
{
'permissionGroups': [
{
'permissionGroupId': 'string',
'name': 'string',
'description': 'string',
'applicationPermissions': [
'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
],
'createTime': 123,
'lastModifiedTime': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
permissionGroups (list) --
A list of all the permission groups.
(dict) --
The structure for a permission group.
permissionGroupId (string) --
The unique identifier for the permission group.
name (string) --
The name of the permission group.
description (string) --
A brief description for the permission group.
applicationPermissions (list) --
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
createTime (integer) --
The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
lastModifiedTime (integer) --
Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
nextToken (string) --
A token that indicates where a results page should begin.
Exceptions
Lists all available user accounts in FinSpace.
See also: AWS API Documentation
Request Syntax
response = client.list_users(
nextToken='string',
maxResults=123
)
[REQUIRED]
The maximum number of results per page.
dict
Response Syntax
{
'users': [
{
'userId': 'string',
'status': 'CREATING'|'ENABLED'|'DISABLED',
'firstName': 'string',
'lastName': 'string',
'emailAddress': 'string',
'type': 'SUPER_USER'|'APP_USER',
'apiAccess': 'ENABLED'|'DISABLED',
'apiAccessPrincipalArn': 'string',
'createTime': 123,
'lastEnabledTime': 123,
'lastDisabledTime': 123,
'lastModifiedTime': 123,
'lastLoginTime': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
users (list) --
A list of all the user accounts.
(dict) --
The details of the user account.
userId (string) --
The unique identifier for the user.
status (string) --
The current status of the user account.
firstName (string) --
The first name of the user.
lastName (string) --
The last name of the user.
emailAddress (string) --
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) --
Indicates the type of user.
apiAccess (string) --
Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
apiAccessPrincipalArn (string) --
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.
createTime (integer) --
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
lastEnabledTime (integer) --
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
lastDisabledTime (integer) --
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
lastModifiedTime (integer) --
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
lastLoginTime (integer) --
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
nextToken (string) --
A token that indicates where a results page should begin.
Exceptions
Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.
See also: AWS API Documentation
Request Syntax
response = client.reset_user_password(
userId='string',
clientToken='string'
)
[REQUIRED]
The unique identifier of the user that a temporary password is requested for.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'userId': 'string',
'temporaryPassword': 'string'
}
Response Structure
(dict) --
userId (string) --
The unique identifier of the user that a new password is generated for.
temporaryPassword (string) --
A randomly generated temporary password for the requested user account. This password expires in 7 days.
Exceptions
Updates a FinSpace Changeset.
See also: AWS API Documentation
Request Syntax
response = client.update_changeset(
clientToken='string',
datasetId='string',
changesetId='string',
sourceParams={
'string': 'string'
},
formatParams={
'string': 'string'
}
)
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier for the FinSpace Dataset in which the Changeset is created.
[REQUIRED]
The unique identifier for the Changeset to update.
[REQUIRED]
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.
[REQUIRED]
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:
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.
dict
Response Syntax
{
'changesetId': 'string',
'datasetId': 'string'
}
Response Structure
(dict) -- The response from a update changeset operation.
changesetId (string) --
The unique identifier for the Changeset to update.
datasetId (string) --
The unique identifier for the FinSpace Dataset in which the Changeset is created.
Exceptions
Updates a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = client.update_dataset(
clientToken='string',
datasetId='string',
datasetTitle='string',
kind='TABULAR'|'NON_TABULAR',
datasetDescription='string',
alias='string',
schemaDefinition={
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
}
)
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier for the Dataset to update.
[REQUIRED]
A display title for the Dataset.
[REQUIRED]
The format in which the Dataset data is structured.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
The name of a column.
Description for a column.
List of column names used for primary key.
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from an UpdateDataset operation
datasetId (string) --
The unique identifier for updated Dataset.
Exceptions
Modifies the details of a permission group. You cannot modify a permissionGroupID .
See also: AWS API Documentation
Request Syntax
response = client.update_permission_group(
permissionGroupId='string',
name='string',
description='string',
applicationPermissions=[
'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
],
clientToken='string'
)
[REQUIRED]
The unique identifier for the permission group to update.
The permissions that are granted to a specific group for accessing the FinSpace application.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'permissionGroupId': 'string'
}
Response Structure
(dict) --
permissionGroupId (string) --
The unique identifier for the updated permission group.
Exceptions
Modifies the details of the specified user account. You cannot update the userId for a user.
See also: AWS API Documentation
Request Syntax
response = client.update_user(
userId='string',
type='SUPER_USER'|'APP_USER',
firstName='string',
lastName='string',
apiAccess='ENABLED'|'DISABLED',
apiAccessPrincipalArn='string',
clientToken='string'
)
[REQUIRED]
The unique identifier for the user account to update.
The option to indicate the type of user.
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.
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'userId': 'string'
}
Response Structure
(dict) --
userId (string) --
The unique identifier of the updated user account.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_changesets')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_changesets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier for the FinSpace Dataset to which the Changeset belongs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'changesets': [
{
'changesetId': 'string',
'changesetArn': 'string',
'datasetId': 'string',
'changeType': 'REPLACE'|'APPEND'|'MODIFY',
'sourceParams': {
'string': 'string'
},
'formatParams': {
'string': 'string'
},
'createTime': 123,
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'activeUntilTimestamp': 123,
'activeFromTimestamp': 123,
'updatesChangesetId': 'string',
'updatedByChangesetId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
changesets (list) --
List of Changesets found.
(dict) --
A Changeset is unit of data in a Dataset.
changesetId (string) --
The unique identifier for a Changeset.
changesetArn (string) --
The ARN identifier of the Changeset.
datasetId (string) --
The unique identifier for the FinSpace Dataset in which the Changeset is created.
changeType (string) --
Type that indicates how a Changeset is applied to a Dataset.
sourceParams (dict) --
Options that define the location of the data being ingested.
formatParams (dict) --
Options that define the structure of the source file(s).
createTime (integer) --
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.
status (string) --
Status of the Changeset ingestion.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
activeUntilTimestamp (integer) --
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.
activeFromTimestamp (integer) --
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.
updatesChangesetId (string) --
The unique identifier of the Changeset that is updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_data_views')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_data_views().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier of the Dataset for which to retrieve Dataviews.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'dataViews': [
{
'dataViewId': 'string',
'dataViewArn': 'string',
'datasetId': 'string',
'asOfTimestamp': 123,
'partitionColumns': [
'string',
],
'sortColumns': [
'string',
],
'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'destinationTypeProperties': {
'destinationType': 'string',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': 'string'
}
},
'autoUpdate': True|False,
'createTime': 123,
'lastModifiedTime': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
dataViews (list) --
A list of Dataviews.
(dict) --
Structure for the summary of a Dataview.
dataViewId (string) --
The unique identifier for the Dataview.
dataViewArn (string) --
The ARN identifier of the Dataview.
datasetId (string) --
Th unique identifier for the Dataview Dataset.
asOfTimestamp (integer) --
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.
partitionColumns (list) --
Ordered set of column names used to partition data.
sortColumns (list) --
Columns to be used for sorting the data.
status (string) --
The status of a Dataview creation.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
destinationTypeProperties (dict) --
Information about the Dataview destination.
destinationType (string) --
Destination type for a Dataview.
s3DestinationExportFileFormat (string) --
Data view export file format.
s3DestinationExportFileFormatOptions (dict) --
Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }
autoUpdate (boolean) --
The flag to indicate Dataview should be updated automatically.
createTime (integer) --
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.
lastModifiedTime (integer) --
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_datasets')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_datasets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'datasets': [
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetTitle': 'string',
'kind': 'TABULAR'|'NON_TABULAR',
'datasetDescription': 'string',
'ownerInfo': {
'name': 'string',
'phoneNumber': 'string',
'email': 'string'
},
'createTime': 123,
'lastModifiedTime': 123,
'schemaDefinition': {
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
},
'alias': 'string'
},
],
'NextToken': 'string'
}
Response Structure
List of Datasets.
The structure for a Dataset.
An identifier for a Dataset.
The ARN identifier of the Dataset.
Display title for a Dataset.
The format in which Dataset data is structured.
Description for a Dataset.
Contact information for a Dataset owner.
The name of the Dataset owner.
Phone number for the Dataset owner.
Email address for the Dataset owner.
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.
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.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
The name of a column.
Description for a column.
List of column names used for primary key.
The unique resource identifier for a Dataset.
A token to resume pagination.
paginator = client.get_paginator('list_permission_groups')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_permission_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'permissionGroups': [
{
'permissionGroupId': 'string',
'name': 'string',
'description': 'string',
'applicationPermissions': [
'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
],
'createTime': 123,
'lastModifiedTime': 123
},
],
'NextToken': 'string'
}
Response Structure
A list of all the permission groups.
The structure for a permission group.
The unique identifier for the permission group.
The name of the permission group.
A brief description for the permission group.
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
A token to resume pagination.
paginator = client.get_paginator('list_users')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'users': [
{
'userId': 'string',
'status': 'CREATING'|'ENABLED'|'DISABLED',
'firstName': 'string',
'lastName': 'string',
'emailAddress': 'string',
'type': 'SUPER_USER'|'APP_USER',
'apiAccess': 'ENABLED'|'DISABLED',
'apiAccessPrincipalArn': 'string',
'createTime': 123,
'lastEnabledTime': 123,
'lastDisabledTime': 123,
'lastModifiedTime': 123,
'lastLoginTime': 123
},
],
'NextToken': 'string'
}
Response Structure
A list of all the user accounts.
The details of the user account.
The unique identifier for the user.
The current status of the user account.
The first name of the user.
The last name of the user.
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.
Indicates the type of user.
Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
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.
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
A token to resume pagination.