AWS.Finspacedata — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The FinSpace APIs let you take actions inside the FinSpace.

Sending a Request Using Finspacedata

var finspacedata = new AWS.Finspacedata();
finspacedata.associateUserToPermissionGroup(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Finspacedata object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var finspacedata = new AWS.Finspacedata({apiVersion: '2020-07-13'});

You can also set the API version globally in AWS.config.apiVersions using the finspacedata service identifier:

AWS.config.apiVersions = {
  finspacedata: '2020-07-13',
  // other service API versions
};

var finspacedata = new AWS.Finspacedata();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Finspacedata(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateUserToPermissionGroup(params = {}, callback) ⇒ AWS.Request

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

createChangeset(params = {}, callback) ⇒ AWS.Request

Creates a new Changeset in a FinSpace Dataset.

createDataset(params = {}, callback) ⇒ AWS.Request

Creates a new FinSpace Dataset.

createDataView(params = {}, callback) ⇒ AWS.Request

Creates a Dataview for a Dataset.

createPermissionGroup(params = {}, callback) ⇒ AWS.Request

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

createUser(params = {}, callback) ⇒ AWS.Request

Creates a new user in FinSpace.

deleteDataset(params = {}, callback) ⇒ AWS.Request

Deletes a FinSpace Dataset.

deletePermissionGroup(params = {}, callback) ⇒ AWS.Request

Deletes a permission group. This action is irreversible.

disableUser(params = {}, callback) ⇒ AWS.Request

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

disassociateUserFromPermissionGroup(params = {}, callback) ⇒ AWS.Request

Removes a user from a permission group.

enableUser(params = {}, callback) ⇒ AWS.Request

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

getChangeset(params = {}, callback) ⇒ AWS.Request

Get information about a Changeset.

getDataset(params = {}, callback) ⇒ AWS.Request

Returns information about a Dataset.

getDataView(params = {}, callback) ⇒ AWS.Request

Gets information about a Dataview.

getExternalDataViewAccessDetails(params = {}, callback) ⇒ AWS.Request

Returns the credentials to access the external Dataview from an S3 location. To call this API:

getPermissionGroup(params = {}, callback) ⇒ AWS.Request

Retrieves the details of a specific permission group.

getProgrammaticAccessCredentials(params = {}, callback) ⇒ AWS.Request

getUser(params = {}, callback) ⇒ AWS.Request

Retrieves details for a specific user.

getWorkingLocation(params = {}, callback) ⇒ AWS.Request

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.

listChangesets(params = {}, callback) ⇒ AWS.Request

Lists the FinSpace Changesets for a Dataset.

listDatasets(params = {}, callback) ⇒ AWS.Request

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

listDataViews(params = {}, callback) ⇒ AWS.Request

Lists all available Dataviews for a Dataset.

listPermissionGroups(params = {}, callback) ⇒ AWS.Request

Lists all available permission groups in FinSpace.

listPermissionGroupsByUser(params = {}, callback) ⇒ AWS.Request

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

listUsers(params = {}, callback) ⇒ AWS.Request

Lists all available users in FinSpace.

listUsersByPermissionGroup(params = {}, callback) ⇒ AWS.Request

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

resetUserPassword(params = {}, callback) ⇒ AWS.Request

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.

updateChangeset(params = {}, callback) ⇒ AWS.Request

Updates a FinSpace Changeset.

updateDataset(params = {}, callback) ⇒ AWS.Request

Updates a FinSpace Dataset.

updatePermissionGroup(params = {}, callback) ⇒ AWS.Request

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

updateUser(params = {}, callback) ⇒ AWS.Request

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