FinspaceDataClient

Suggest an Edit

The FinSpace APIs let you take actions inside the FinSpace.

Installation

NPM
npm install @aws-sdk/client-finspace-data
Yarn
yarn add @aws-sdk/client-finspace-data
pnpm
pnpm add @aws-sdk/client-finspace-data

FinspaceDataClient Operations

Command
Summary
AssociateUserToPermissionGroupCommand

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

CreateChangesetCommand

Creates a new Changeset in a FinSpace Dataset.

CreateDataViewCommand

Creates a Dataview for a Dataset.

CreateDatasetCommand

Creates a new FinSpace Dataset.

CreatePermissionGroupCommand

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

CreateUserCommand

Creates a new user in FinSpace.

DeleteDatasetCommand

Deletes a FinSpace Dataset.

DeletePermissionGroupCommand

Deletes a permission group. This action is irreversible.

DisableUserCommand

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

DisassociateUserFromPermissionGroupCommand

Removes a user from a permission group.

EnableUserCommand

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

GetChangesetCommand

Get information about a Changeset.

GetDataViewCommand

Gets information about a Dataview.

GetDatasetCommand

Returns information about a Dataset.

GetExternalDataViewAccessDetailsCommand

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.

GetPermissionGroupCommand

Retrieves the details of a specific permission group.

GetProgrammaticAccessCredentialsCommand

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 .

GetUserCommand

Retrieves details for a specific user.

GetWorkingLocationCommand

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.

ListChangesetsCommand

Lists the FinSpace Changesets for a Dataset.

ListDataViewsCommand

Lists all available Dataviews for a Dataset.

ListDatasetsCommand

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

ListPermissionGroupsByUserCommand

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

ListPermissionGroupsCommand

Lists all available permission groups in FinSpace.

ListUsersByPermissionGroupCommand

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

ListUsersCommand

Lists all available users in FinSpace.

ResetUserPasswordCommand

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.

UpdateChangesetCommand

Updates a FinSpace Changeset.

UpdateDatasetCommand

Updates a FinSpace Dataset.

UpdatePermissionGroupCommand

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

UpdateUserCommand

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

FinspaceDataClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: FinspaceDataClientConfig