Finspace Data

This page documents function available when using the Finspace_Data module, created with @service Finspace_Data.

Index

Documentation

Main.Finspace_Data.associate_user_to_permission_groupMethod
associate_user_to_permission_group(permission_group_id, user_id)
associate_user_to_permission_group(permission_group_id, user_id, params::Dict{String,<:Any})

Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.

Arguments

  • permission_group_id: The unique identifier for the permission group.
  • user_id: The unique identifier for the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.create_changesetMethod
create_changeset(change_type, dataset_id, format_params, source_params)
create_changeset(change_type, dataset_id, format_params, source_params, params::Dict{String,<:Any})

Creates a new Changeset in a FinSpace Dataset.

Arguments

  • change_type: 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.
  • dataset_id: The unique identifier for the FinSpace Dataset where the Changeset will be created.
  • format_params: 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.
  • source_params: 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/inge stion/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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.create_data_viewMethod
create_data_view(dataset_id, destination_type_params)
create_data_view(dataset_id, destination_type_params, params::Dict{String,<:Any})

Creates a Dataview for a Dataset.

Arguments

  • dataset_id: The unique Dataset identifier that is used to create a Dataview.
  • destination_type_params: Options that define the destination type for the Dataview.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "autoUpdate": Flag to indicate Dataview should be updated automatically.
  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "partitionColumns": Ordered set of column names used to partition data.
  • "sortColumns": Columns to be used for sorting the data.
Main.Finspace_Data.create_datasetMethod
create_dataset(dataset_title, kind, permission_group_params)
create_dataset(dataset_title, kind, permission_group_params, params::Dict{String,<:Any})

Creates a new FinSpace Dataset.

Arguments

  • dataset_title: Display title for a FinSpace Dataset.
  • 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.
  • permission_group_params: Permission group parameters for Dataset permissions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": The unique resource identifier for a Dataset.
  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "datasetDescription": Description of a Dataset.
  • "ownerInfo": Contact information for a Dataset owner.
  • "schemaDefinition": Definition for a schema on a tabular Dataset.
Main.Finspace_Data.create_permission_groupMethod
create_permission_group(application_permissions, name)
create_permission_group(application_permissions, name, params::Dict{String,<:Any})

Creates a group of permissions for various actions that a user can perform in FinSpace.

Arguments

  • application_permissions: 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.
  • name: The name of the permission group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "description": A brief description for the permission group.
Main.Finspace_Data.create_userMethod
create_user(email_address, type)
create_user(email_address, type, params::Dict{String,<:Any})

Creates a new user in FinSpace.

Arguments

  • email_address: 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.
  • type: The option to indicate the type of user. Use one of the following options to specify this parameter: SUPERUSER – A user with permission to all the functionality and data in FinSpace. APPUSER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "firstName": The first name of the user that you want to register.
  • "lastName": The last name of the user that you want to register.
Main.Finspace_Data.delete_datasetMethod
delete_dataset(dataset_id)
delete_dataset(dataset_id, params::Dict{String,<:Any})

Deletes a FinSpace Dataset.

Arguments

  • dataset_id: The unique identifier of the Dataset to be deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.delete_permission_groupMethod
delete_permission_group(permission_group_id)
delete_permission_group(permission_group_id, params::Dict{String,<:Any})

Deletes a permission group. This action is irreversible.

Arguments

  • permission_group_id: The unique identifier for the permission group that you want to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.disable_userMethod
disable_user(user_id)
disable_user(user_id, params::Dict{String,<:Any})

Denies access to the FinSpace web application and API for the specified user.

Arguments

  • user_id: The unique identifier for the user account that you want to disable.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.disassociate_user_from_permission_groupMethod
disassociate_user_from_permission_group(permission_group_id, user_id)
disassociate_user_from_permission_group(permission_group_id, user_id, params::Dict{String,<:Any})

Removes a user account from a permission group.

Arguments

  • permission_group_id: The unique identifier for the permission group.
  • user_id: The unique identifier for the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.enable_userMethod
enable_user(user_id)
enable_user(user_id, params::Dict{String,<:Any})

Allows the specified user to access the FinSpace web application and API.

Arguments

  • user_id: The unique identifier for the user account that you want to enable.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.get_changesetMethod
get_changeset(changeset_id, dataset_id)
get_changeset(changeset_id, dataset_id, params::Dict{String,<:Any})

Get information about a Changeset.

Arguments

  • changeset_id: The unique identifier of the Changeset for which to get data.
  • dataset_id: The unique identifier for the FinSpace Dataset where the Changeset is created.
Main.Finspace_Data.get_data_viewMethod
get_data_view(dataset_id, dataview_id)
get_data_view(dataset_id, dataview_id, params::Dict{String,<:Any})

Gets information about a Dataview.

Arguments

  • dataset_id: The unique identifier for the Dataset used in the Dataview.
  • dataview_id: The unique identifier for the Dataview.
Main.Finspace_Data.get_datasetMethod
get_dataset(dataset_id)
get_dataset(dataset_id, params::Dict{String,<:Any})

Returns information about a Dataset.

Arguments

  • dataset_id: The unique identifier for a Dataset.
Main.Finspace_Data.get_external_data_view_access_detailsMethod
get_external_data_view_access_details(dataset_id, dataview_id)
get_external_data_view_access_details(dataset_id, dataview_id, params::Dict{String,<:Any})

Returns the credentials to access the external Dataview from an S3 location. To call this API: You must retrieve the programmatic credentials. You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

Arguments

  • dataset_id: The unique identifier for the Dataset.
  • dataview_id: The unique identifier for the Dataview that you want to access.
Main.Finspace_Data.get_permission_groupMethod
get_permission_group(permission_group_id)
get_permission_group(permission_group_id, params::Dict{String,<:Any})

Retrieves the details of a specific permission group.

Arguments

  • permission_group_id: The unique identifier for the permission group.
Main.Finspace_Data.get_programmatic_access_credentialsMethod
get_programmatic_access_credentials(environment_id)
get_programmatic_access_credentials(environment_id, params::Dict{String,<:Any})

Request programmatic credentials to use with FinSpace SDK.

Arguments

  • environment_id: The FinSpace environment identifier.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "durationInMinutes": The time duration in which the credentials remain valid.
Main.Finspace_Data.get_userMethod
get_user(user_id)
get_user(user_id, params::Dict{String,<:Any})

Retrieves details for a specific user.

Arguments

  • user_id: The unique identifier of the user to get data for.
Main.Finspace_Data.get_working_locationMethod
get_working_location()
get_working_location(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
Main.Finspace_Data.list_changesetsMethod
list_changesets(dataset_id)
list_changesets(dataset_id, params::Dict{String,<:Any})

Lists the FinSpace Changesets for a Dataset.

Arguments

  • dataset_id: The unique identifier for the FinSpace Dataset to which the Changeset belongs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results per page.
  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.list_data_viewsMethod
list_data_views(dataset_id)
list_data_views(dataset_id, params::Dict{String,<:Any})

Lists all available Dataviews for a Dataset.

Arguments

  • dataset_id: The unique identifier of the Dataset for which to retrieve Dataviews.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results per page.
  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.list_datasetsMethod
list_datasets()
list_datasets(params::Dict{String,<:Any})

Lists all of the active Datasets that a user has access to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results per page.
  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.list_permission_groupsMethod
list_permission_groups(max_results)
list_permission_groups(max_results, params::Dict{String,<:Any})

Lists all available permission groups in FinSpace.

Arguments

  • max_results: The maximum number of results per page.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.list_permission_groups_by_userMethod
list_permission_groups_by_user(max_results, user_id)
list_permission_groups_by_user(max_results, user_id, params::Dict{String,<:Any})

Lists all the permission groups that are associated with a specific user account.

Arguments

  • max_results: The maximum number of results per page.
  • user_id: The unique identifier for the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.list_usersMethod
list_users(max_results)
list_users(max_results, params::Dict{String,<:Any})

Lists all available user accounts in FinSpace.

Arguments

  • max_results: The maximum number of results per page.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.list_users_by_permission_groupMethod
list_users_by_permission_group(max_results, permission_group_id)
list_users_by_permission_group(max_results, permission_group_id, params::Dict{String,<:Any})

Lists details of all the users in a specific permission group.

Arguments

  • max_results: The maximum number of results per page.
  • permission_group_id: The unique identifier for the permission group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace_Data.reset_user_passwordMethod
reset_user_password(user_id)
reset_user_password(user_id, params::Dict{String,<:Any})

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.

Arguments

  • user_id: The unique identifier of the user that a temporary password is requested for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.update_changesetMethod
update_changeset(changeset_id, dataset_id, format_params, source_params)
update_changeset(changeset_id, dataset_id, format_params, source_params, params::Dict{String,<:Any})

Updates a FinSpace Changeset.

Arguments

  • changeset_id: The unique identifier for the Changeset to update.
  • dataset_id: The unique identifier for the FinSpace Dataset in which the Changeset is created.
  • format_params: 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.
  • source_params: 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/inge stion/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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
Main.Finspace_Data.update_datasetMethod
update_dataset(dataset_id, dataset_title, kind)
update_dataset(dataset_id, dataset_title, kind, params::Dict{String,<:Any})

Updates a FinSpace Dataset.

Arguments

  • dataset_id: The unique identifier for the Dataset to update.
  • dataset_title: A display title for the Dataset.
  • 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": The unique resource identifier for a Dataset.
  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "datasetDescription": A description for the Dataset.
  • "schemaDefinition": Definition for a schema on a tabular Dataset.
Main.Finspace_Data.update_permission_groupMethod
update_permission_group(permission_group_id)
update_permission_group(permission_group_id, params::Dict{String,<:Any})

Modifies the details of a permission group. You cannot modify a permissionGroupID.

Arguments

  • permission_group_id: The unique identifier for the permission group to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "description": A brief description for the permission group.
  • "name": The name of the permission group.
Main.Finspace_Data.update_userMethod
update_user(user_id)
update_user(user_id, params::Dict{String,<:Any})

Modifies the details of the specified user account. You cannot update the userId for a user.

Arguments

  • user_id: The unique identifier for the user account to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
  • "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
  • "firstName": The first name of the user.
  • "lastName": The last name of the user.
  • "type": The option to indicate the type of user. SUPERUSER– A user with permission to all the functionality and data in FinSpace. APPUSER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.