Finspace Data

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

Index

Documentation

Main.Finspace_Data.create_changeset — Method

create_changeset(change_type, dataset_id, source_params, source_type)
create_changeset(change_type, dataset_id, source_params, source_type, params::Dict{String,<:Any})

Creates a new changeset in a FinSpace dataset.

Arguments

change_type: 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.
dataset_id: The unique identifier for the FinSpace dataset in which the changeset will be created.
source_params: Source path from which the files to create the changeset will be sourced.
source_type: Type of the data source from which the files to create the changeset will be sourced. S3 - Amazon S3.

Optional Parameters

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

"formatParams": Options that define the structure of the source file(s).
"formatType": Format type of the input files being loaded into the changeset.
"tags": Metadata tags to apply to this changeset.

source

Main.Finspace_Data.get_programmatic_access_credentials — Method

get_programmatic_access_credentials(environment_id)
get_programmatic_access_credentials(environment_id, params::Dict{String,<:Any})

Request programmatic credentials to use with Habanero SDK.

Arguments

environment_id: The habanero 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.

source

Main.Finspace_Data.get_working_location — Method

get_working_location()
get_working_location(params::Dict{String,<:Any})

A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero 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.

source