aws-elixir

View Source AWS.Finspacedata (aws-elixir v1.0.4)

The FinSpace APIs let you take actions inside the FinSpace.

Link to this section Summary

Functions

associate_user_to_permission_group(client, permission_group_id, user_id, input, options \\ [])

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

create_changeset(client, dataset_id, input, options \\ [])

Creates a new Changeset in a FinSpace Dataset.

create_data_view(client, dataset_id, input, options \\ [])

Creates a Dataview for a Dataset.

create_dataset(client, input, options \\ [])

Creates a new FinSpace Dataset.

create_permission_group(client, input, options \\ [])

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

create_user(client, input, options \\ [])

Creates a new user in FinSpace.

delete_dataset(client, dataset_id, input, options \\ [])

Deletes a FinSpace Dataset.

delete_permission_group(client, permission_group_id, input, options \\ [])

Deletes a permission group.

disable_user(client, user_id, input, options \\ [])

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

disassociate_user_from_permission_group(client, permission_group_id, user_id, input, options \\ [])

Removes a user from a permission group.

enable_user(client, user_id, input, options \\ [])

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

get_changeset(client, changeset_id, dataset_id, options \\ [])

Get information about a Changeset.

get_data_view(client, data_view_id, dataset_id, options \\ [])

Gets information about a Dataview.

get_dataset(client, dataset_id, options \\ [])

Returns information about a Dataset.

get_external_data_view_access_details(client, data_view_id, dataset_id, input, options \\ [])

Returns the credentials to access the external Dataview from an S3 location.

get_permission_group(client, permission_group_id, options \\ [])

Retrieves the details of a specific permission group.

get_programmatic_access_credentials(client, duration_in_minutes \\ nil, environment_id, options \\ [])

Request programmatic credentials to use with FinSpace SDK.

get_user(client, user_id, options \\ [])

Retrieves details for a specific user.

get_working_location(client, input, options \\ [])

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.

list_changesets(client, dataset_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the FinSpace Changesets for a Dataset.

list_data_views(client, dataset_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all available Dataviews for a Dataset.

list_datasets(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_permission_groups(client, max_results, next_token \\ nil, options \\ [])

Lists all available permission groups in FinSpace.

list_permission_groups_by_user(client, user_id, max_results, next_token \\ nil, options \\ [])

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

list_users(client, max_results, next_token \\ nil, options \\ [])

Lists all available users in FinSpace.

list_users_by_permission_group(client, permission_group_id, max_results, next_token \\ nil, options \\ [])

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

metadata()
reset_user_password(client, user_id, input, options \\ [])

Resets the password for a specified user ID and generates a temporary one.

update_changeset(client, changeset_id, dataset_id, input, options \\ [])

Updates a FinSpace Changeset.

update_dataset(client, dataset_id, input, options \\ [])

Updates a FinSpace Dataset.

update_permission_group(client, permission_group_id, input, options \\ [])

Modifies the details of a permission group.

update_user(client, user_id, input, options \\ [])

Modifies the details of the specified user.

Link to this section Functions

Link to this function

associate_user_to_permission_group(client, permission_group_id, user_id, input, options \\ [])

View Source

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

Link to this function

create_changeset(client, dataset_id, input, options \\ [])

View Source

Creates a new Changeset in a FinSpace Dataset.

Link to this function

create_data_view(client, dataset_id, input, options \\ [])

View Source

Creates a Dataview for a Dataset.

Link to this function

create_dataset(client, input, options \\ [])

View Source

Creates a new FinSpace Dataset.

Link to this function

create_permission_group(client, input, options \\ [])

View Source

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

Link to this function

create_user(client, input, options \\ [])

View Source

Creates a new user in FinSpace.

Link to this function

delete_dataset(client, dataset_id, input, options \\ [])

View Source

Deletes a FinSpace Dataset.

Link to this function

delete_permission_group(client, permission_group_id, input, options \\ [])

View Source

Deletes a permission group.

This action is irreversible.

Link to this function

disable_user(client, user_id, input, options \\ [])

View Source

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

Link to this function

disassociate_user_from_permission_group(client, permission_group_id, user_id, input, options \\ [])

View Source

Removes a user from a permission group.

Link to this function

enable_user(client, user_id, input, options \\ [])

View Source

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

Link to this function

get_changeset(client, changeset_id, dataset_id, options \\ [])

View Source

Get information about a Changeset.

Link to this function

get_data_view(client, data_view_id, dataset_id, options \\ [])

View Source

Gets information about a Dataview.

Link to this function

get_dataset(client, dataset_id, options \\ [])

View Source

Returns information about a Dataset.

Link to this function

get_external_data_view_access_details(client, data_view_id, dataset_id, input, options \\ [])

View Source

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.

Link to this function

get_permission_group(client, permission_group_id, options \\ [])

View Source

Retrieves the details of a specific permission group.

Link to this function

get_programmatic_access_credentials(client, duration_in_minutes \\ nil, environment_id, options \\ [])

View Source

Request programmatic credentials to use with FinSpace SDK.

For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

Link to this function

get_user(client, user_id, options \\ [])

View Source

Retrieves details for a specific user.

Link to this function

get_working_location(client, input, options \\ [])

View Source

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.

Link to this function

list_changesets(client, dataset_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the FinSpace Changesets for a Dataset.

Link to this function

list_data_views(client, dataset_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all available Dataviews for a Dataset.

Link to this function

list_datasets(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_permission_groups(client, max_results, next_token \\ nil, options \\ [])

View Source

Lists all available permission groups in FinSpace.

Link to this function

list_permission_groups_by_user(client, user_id, max_results, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_users(client, max_results, next_token \\ nil, options \\ [])

View Source

Lists all available users in FinSpace.

Link to this function

list_users_by_permission_group(client, permission_group_id, max_results, next_token \\ nil, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

reset_user_password(client, user_id, input, options \\ [])

View Source

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.

Link to this function

update_changeset(client, changeset_id, dataset_id, input, options \\ [])

View Source

Updates a FinSpace Changeset.

Link to this function

update_dataset(client, dataset_id, input, options \\ [])

View Source

Updates a FinSpace Dataset.

Link to this function

update_permission_group(client, permission_group_id, input, options \\ [])

View Source

Modifies the details of a permission group.

You cannot modify a permissionGroupID.

Link to this function

update_user(client, user_id, input, options \\ [])

View Source

Modifies the details of the specified user.

You cannot update the userId for a user.