aws
v1.0.4

View Source aws_finspace_data (aws v1.0.4)

The FinSpace APIs let you take actions inside the FinSpace.

Summary

Functions

associate_user_to_permission_group(Client, PermissionGroupId, UserId, Input)
Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
associate_user_to_permission_group(Client, PermissionGroupId, UserId, Input0, Options0)
create_changeset(Client, DatasetId, Input)
Creates a new Changeset in a FinSpace Dataset.
create_changeset(Client, DatasetId, Input0, Options0)
create_data_view(Client, DatasetId, Input)
Creates a Dataview for a Dataset.
create_data_view(Client, DatasetId, Input0, Options0)
create_dataset(Client, Input)
Creates a new FinSpace Dataset.
create_dataset(Client, Input0, Options0)
create_permission_group(Client, Input)
Creates a group of permissions for various actions that a user can perform in FinSpace.
create_permission_group(Client, Input0, Options0)
create_user(Client, Input)
Creates a new user in FinSpace.
create_user(Client, Input0, Options0)
delete_dataset(Client, DatasetId, Input)
Deletes a FinSpace Dataset.
delete_dataset(Client, DatasetId, Input0, Options0)
delete_permission_group(Client, PermissionGroupId, Input)

Deletes a permission group.

delete_permission_group(Client, PermissionGroupId, Input0, Options0)
disable_user(Client, UserId, Input)
Denies access to the FinSpace web application and API for the specified user.
disable_user(Client, UserId, Input0, Options0)
disassociate_user_from_permission_group(Client, PermissionGroupId, UserId, Input)
Removes a user from a permission group.
disassociate_user_from_permission_group(Client, PermissionGroupId, UserId, Input0, Options0)
enable_user(Client, UserId, Input)
Allows the specified user to access the FinSpace web application and API.
enable_user(Client, UserId, Input0, Options0)
get_changeset(Client, ChangesetId, DatasetId)
Get information about a Changeset.
get_changeset(Client, ChangesetId, DatasetId, QueryMap, HeadersMap)
get_changeset(Client, ChangesetId, DatasetId, QueryMap, HeadersMap, Options0)
get_data_view(Client, DataViewId, DatasetId)
Gets information about a Dataview.
get_data_view(Client, DataViewId, DatasetId, QueryMap, HeadersMap)
get_data_view(Client, DataViewId, DatasetId, QueryMap, HeadersMap, Options0)
get_dataset(Client, DatasetId)
Returns information about a Dataset.
get_dataset(Client, DatasetId, QueryMap, HeadersMap)
get_dataset(Client, DatasetId, QueryMap, HeadersMap, Options0)
get_external_data_view_access_details(Client, DataViewId, DatasetId, Input)

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

get_external_data_view_access_details(Client, DataViewId, DatasetId, Input0, Options0)
get_permission_group(Client, PermissionGroupId)
Retrieves the details of a specific permission group.
get_permission_group(Client, PermissionGroupId, QueryMap, HeadersMap)
get_permission_group(Client, PermissionGroupId, QueryMap, HeadersMap, Options0)
get_programmatic_access_credentials(Client, EnvironmentId)

Request programmatic credentials to use with FinSpace SDK.

get_programmatic_access_credentials(Client, EnvironmentId, QueryMap, HeadersMap)
get_programmatic_access_credentials(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
get_user(Client, UserId)
Retrieves details for a specific user.
get_user(Client, UserId, QueryMap, HeadersMap)
get_user(Client, UserId, QueryMap, HeadersMap, Options0)
get_working_location(Client, Input)
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.
get_working_location(Client, Input0, Options0)
list_changesets(Client, DatasetId)
Lists the FinSpace Changesets for a Dataset.
list_changesets(Client, DatasetId, QueryMap, HeadersMap)
list_changesets(Client, DatasetId, QueryMap, HeadersMap, Options0)
list_data_views(Client, DatasetId)
Lists all available Dataviews for a Dataset.
list_data_views(Client, DatasetId, QueryMap, HeadersMap)
list_data_views(Client, DatasetId, QueryMap, HeadersMap, Options0)
list_datasets(Client)
Lists all of the active Datasets that a user has access to.
list_datasets(Client, QueryMap, HeadersMap)
list_datasets(Client, QueryMap, HeadersMap, Options0)
list_permission_groups(Client, MaxResults)
Lists all available permission groups in FinSpace.
list_permission_groups(Client, MaxResults, QueryMap, HeadersMap)
list_permission_groups(Client, MaxResults, QueryMap, HeadersMap, Options0)
list_permission_groups_by_user(Client, UserId, MaxResults)
Lists all the permission groups that are associated with a specific user.
list_permission_groups_by_user(Client, UserId, MaxResults, QueryMap, HeadersMap)
list_permission_groups_by_user(Client, UserId, MaxResults, QueryMap, HeadersMap, Options0)
list_users(Client, MaxResults)
Lists all available users in FinSpace.
list_users(Client, MaxResults, QueryMap, HeadersMap)
list_users(Client, MaxResults, QueryMap, HeadersMap, Options0)
list_users_by_permission_group(Client, PermissionGroupId, MaxResults)
Lists details of all the users in a specific permission group.
list_users_by_permission_group(Client, PermissionGroupId, MaxResults, QueryMap, HeadersMap)
list_users_by_permission_group(Client, PermissionGroupId, MaxResults, QueryMap, HeadersMap, Options0)
reset_user_password(Client, UserId, Input)

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

reset_user_password(Client, UserId, Input0, Options0)
update_changeset(Client, ChangesetId, DatasetId, Input)
Updates a FinSpace Changeset.
update_changeset(Client, ChangesetId, DatasetId, Input0, Options0)
update_dataset(Client, DatasetId, Input)
Updates a FinSpace Dataset.
update_dataset(Client, DatasetId, Input0, Options0)
update_permission_group(Client, PermissionGroupId, Input)

Modifies the details of a permission group.

update_permission_group(Client, PermissionGroupId, Input0, Options0)
update_user(Client, UserId, Input)

Modifies the details of the specified user.

update_user(Client, UserId, Input0, Options0)

Functions

Link to this function

associate_user_to_permission_group(Client, PermissionGroupId, UserId, Input)

View Source
Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
Link to this function

associate_user_to_permission_group(Client, PermissionGroupId, UserId, Input0, Options0)

View Source
Link to this function

create_changeset(Client, DatasetId, Input)

View Source
Creates a new Changeset in a FinSpace Dataset.
Link to this function

create_changeset(Client, DatasetId, Input0, Options0)

View Source
Link to this function

create_data_view(Client, DatasetId, Input)

View Source
Creates a Dataview for a Dataset.
Link to this function

create_data_view(Client, DatasetId, Input0, Options0)

View Source
Link to this function

create_dataset(Client, Input)

View Source
Creates a new FinSpace Dataset.
Link to this function

create_dataset(Client, Input0, Options0)

View Source
Link to this function

create_permission_group(Client, Input)

View Source
Creates a group of permissions for various actions that a user can perform in FinSpace.
Link to this function

create_permission_group(Client, Input0, Options0)

View Source
Link to this function

create_user(Client, Input)

View Source
Creates a new user in FinSpace.
Link to this function

create_user(Client, Input0, Options0)

View Source
Link to this function

delete_dataset(Client, DatasetId, Input)

View Source
Deletes a FinSpace Dataset.
Link to this function

delete_dataset(Client, DatasetId, Input0, Options0)

View Source
Link to this function

delete_permission_group(Client, PermissionGroupId, Input)

View Source

Deletes a permission group.

This action is irreversible.
Link to this function

delete_permission_group(Client, PermissionGroupId, Input0, Options0)

View Source
Link to this function

disable_user(Client, UserId, Input)

View Source
Denies access to the FinSpace web application and API for the specified user.
Link to this function

disable_user(Client, UserId, Input0, Options0)

View Source
Link to this function

disassociate_user_from_permission_group(Client, PermissionGroupId, UserId, Input)

View Source
Removes a user from a permission group.
Link to this function

disassociate_user_from_permission_group(Client, PermissionGroupId, UserId, Input0, Options0)

View Source
Link to this function

enable_user(Client, UserId, Input)

View Source
Allows the specified user to access the FinSpace web application and API.
Link to this function

enable_user(Client, UserId, Input0, Options0)

View Source
Link to this function

get_changeset(Client, ChangesetId, DatasetId)

View Source
Get information about a Changeset.
Link to this function

get_changeset(Client, ChangesetId, DatasetId, QueryMap, HeadersMap)

View Source
Link to this function

get_changeset(Client, ChangesetId, DatasetId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_data_view(Client, DataViewId, DatasetId)

View Source
Gets information about a Dataview.
Link to this function

get_data_view(Client, DataViewId, DatasetId, QueryMap, HeadersMap)

View Source
Link to this function

get_data_view(Client, DataViewId, DatasetId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_dataset(Client, DatasetId)

View Source
Returns information about a Dataset.
Link to this function

get_dataset(Client, DatasetId, QueryMap, HeadersMap)

View Source
Link to this function

get_dataset(Client, DatasetId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_external_data_view_access_details(Client, DataViewId, DatasetId, Input)

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_external_data_view_access_details(Client, DataViewId, DatasetId, Input0, Options0)

View Source
Link to this function

get_permission_group(Client, PermissionGroupId)

View Source
Retrieves the details of a specific permission group.
Link to this function

get_permission_group(Client, PermissionGroupId, QueryMap, HeadersMap)

View Source
Link to this function

get_permission_group(Client, PermissionGroupId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_programmatic_access_credentials(Client, EnvironmentId)

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: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials.
Link to this function

get_programmatic_access_credentials(Client, EnvironmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_programmatic_access_credentials(Client, EnvironmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_user(Client, UserId)

View Source
Retrieves details for a specific user.
Link to this function

get_user(Client, UserId, QueryMap, HeadersMap)

View Source
Link to this function

get_user(Client, UserId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_working_location(Client, Input)

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

get_working_location(Client, Input0, Options0)

View Source
Link to this function

list_changesets(Client, DatasetId)

View Source
Lists the FinSpace Changesets for a Dataset.
Link to this function

list_changesets(Client, DatasetId, QueryMap, HeadersMap)

View Source
Link to this function

list_changesets(Client, DatasetId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_data_views(Client, DatasetId)

View Source
Lists all available Dataviews for a Dataset.
Link to this function

list_data_views(Client, DatasetId, QueryMap, HeadersMap)

View Source
Link to this function

list_data_views(Client, DatasetId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_datasets(Client)

View Source
Lists all of the active Datasets that a user has access to.
Link to this function

list_datasets(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_datasets(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_permission_groups(Client, MaxResults)

View Source
Lists all available permission groups in FinSpace.
Link to this function

list_permission_groups(Client, MaxResults, QueryMap, HeadersMap)

View Source
Link to this function

list_permission_groups(Client, MaxResults, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_permission_groups_by_user(Client, UserId, MaxResults)

View Source
Lists all the permission groups that are associated with a specific user.
Link to this function

list_permission_groups_by_user(Client, UserId, MaxResults, QueryMap, HeadersMap)

View Source
Link to this function

list_permission_groups_by_user(Client, UserId, MaxResults, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_users(Client, MaxResults)

View Source
Lists all available users in FinSpace.
Link to this function

list_users(Client, MaxResults, QueryMap, HeadersMap)

View Source
Link to this function

list_users(Client, MaxResults, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_users_by_permission_group(Client, PermissionGroupId, MaxResults)

View Source
Lists details of all the users in a specific permission group.
Link to this function

list_users_by_permission_group(Client, PermissionGroupId, MaxResults, QueryMap, HeadersMap)

View Source
Link to this function

list_users_by_permission_group(Client, PermissionGroupId, MaxResults, QueryMap, HeadersMap, Options0)

View Source
Link to this function

reset_user_password(Client, UserId, Input)

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

reset_user_password(Client, UserId, Input0, Options0)

View Source
Link to this function

update_changeset(Client, ChangesetId, DatasetId, Input)

View Source
Updates a FinSpace Changeset.
Link to this function

update_changeset(Client, ChangesetId, DatasetId, Input0, Options0)

View Source
Link to this function

update_dataset(Client, DatasetId, Input)

View Source
Updates a FinSpace Dataset.
Link to this function

update_dataset(Client, DatasetId, Input0, Options0)

View Source
Link to this function

update_permission_group(Client, PermissionGroupId, Input)

View Source

Modifies the details of a permission group.

You cannot modify a permissionGroupID.
Link to this function

update_permission_group(Client, PermissionGroupId, Input0, Options0)

View Source
Link to this function

update_user(Client, UserId, Input)

View Source

Modifies the details of the specified user.

You cannot update the userId for a user.
Link to this function

update_user(Client, UserId, Input0, Options0)

View Source