Class: AWS.Finspacedata

var params = {
  changeType: REPLACE | APPEND | MODIFY, /* required */
  datasetId: 'STRING_VALUE', /* required */
  formatParams: { /* required */
    '<StringMapKey>': 'STRING_VALUE',
    /* '<StringMapKey>': ... */
  },
  sourceParams: { /* required */
    '<StringMapKey>': 'STRING_VALUE',
    /* '<StringMapKey>': ... */
  },
  clientToken: 'STRING_VALUE'
};
finspacedata.createChangeset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.
  • datasetId — (String)

    The unique identifier for the FinSpace Dataset where the Changeset will be created.

  • changeType — (String)

    The 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.

    • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

    Possible values include:
    • "REPLACE"
    • "APPEND"
    • "MODIFY"
  • sourceParams — (map<String>)

    Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

    Both s3SourcePath and sourceType are required attributes.

    Here is an example of how you could specify the sourceParams:

    "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

    The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

  • formatParams — (map<String>)

    Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).

    formatType is a required attribute and can have the following values:

    • PARQUET – Parquet source file format.

    • CSV – CSV source file format.

    • JSON – JSON source file format.

    • XML – XML source file format.

    Here is an example of how you could specify the formatParams:

    "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

    Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

    { "withHeader": "true", "separator": "," }

    For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetId — (String)

      The unique identifier for the FinSpace Dataset where the Changeset is created.

    • changesetId — (String)

      The unique identifier of the Changeset that is created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetTitle: 'STRING_VALUE', /* required */
  kind: TABULAR | NON_TABULAR, /* required */
  permissionGroupParams: { /* required */
    datasetPermissions: [
      {
        permission: 'STRING_VALUE'
      },
      /* more items */
    ],
    permissionGroupId: 'STRING_VALUE'
  },
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  datasetDescription: 'STRING_VALUE',
  ownerInfo: {
    email: 'STRING_VALUE',
    name: 'STRING_VALUE',
    phoneNumber: 'STRING_VALUE'
  },
  schemaDefinition: {
    tabularSchemaConfig: {
      columns: [
        {
          columnDescription: 'STRING_VALUE',
          columnName: 'STRING_VALUE',
          dataType: STRING | CHAR | INTEGER | TINYINT | SMALLINT | BIGINT | FLOAT | DOUBLE | DATE | DATETIME | BOOLEAN | BINARY
        },
        /* more items */
      ],
      primaryKeyColumns: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
finspacedata.createDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.
  • datasetTitle — (String)

    Display title for a FinSpace Dataset.

  • kind — (String)

    The format in which Dataset data is structured.

    • TABULAR – Data is structured in a tabular format.

    • NON_TABULAR – Data is structured in a non-tabular format.

    Possible values include:
    • "TABULAR"
    • "NON_TABULAR"
  • datasetDescription — (String)

    Description of a Dataset.

  • ownerInfo — (map)

    Contact information for a Dataset owner.

    • name — (String)

      The name of the Dataset owner.

    • phoneNumber — (String)

      Phone number for the Dataset owner.

    • email — (String)

      Email address for the Dataset owner.

  • permissionGroupParams — (map)

    Permission group parameters for Dataset permissions.

    • permissionGroupId — (String)

      The unique identifier for the PermissionGroup.

    • datasetPermissions — (Array<map>)

      List of resource permissions.

      • permission — (String)

        Permission for a resource.

  • alias — (String)

    The unique resource identifier for a Dataset.

  • schemaDefinition — (map)

    Definition for a schema on a tabular Dataset.

    • tabularSchemaConfig — (map)

      The configuration for a schema on a tabular Dataset.

      • columns — (Array<map>)

        List of column definitions.

        • dataType — (String)

          Data type of a column.

          • STRING – A String data type.

            CHAR – A char data type.

            INTEGER – An integer data type.

            TINYINT – A tinyint data type.

            SMALLINT – A smallint data type.

            BIGINT – A bigint data type.

            FLOAT – A float data type.

            DOUBLE – A double data type.

            DATE – A date data type.

            DATETIME – A datetime data type.

            BOOLEAN – A boolean data type.

            BINARY – A binary data type.

          Possible values include:
          • "STRING"
          • "CHAR"
          • "INTEGER"
          • "TINYINT"
          • "SMALLINT"
          • "BIGINT"
          • "FLOAT"
          • "DOUBLE"
          • "DATE"
          • "DATETIME"
          • "BOOLEAN"
          • "BINARY"
        • columnName — (String)

          The name of a column.

        • columnDescription — (String)

          Description for a column.

      • primaryKeyColumns — (Array<String>)

        List of column names used for primary key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetId — (String)

      The unique identifier for the created Dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetId: 'STRING_VALUE', /* required */
  destinationTypeParams: { /* required */
    destinationType: 'STRING_VALUE', /* required */
    s3DestinationExportFileFormat: PARQUET | DELIMITED_TEXT,
    s3DestinationExportFileFormatOptions: {
      '<StringMapKey>': 'STRING_VALUE',
      /* '<StringMapKey>': ... */
    }
  },
  asOfTimestamp: 'NUMBER_VALUE',
  autoUpdate: true || false,
  clientToken: 'STRING_VALUE',
  partitionColumns: [
    'STRING_VALUE',
    /* more items */
  ],
  sortColumns: [
    'STRING_VALUE',
    /* more items */
  ]
};
finspacedata.createDataView(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.
  • datasetId — (String)

    The unique Dataset identifier that is used to create a Dataview.

  • autoUpdate — (Boolean)

    Flag to indicate Dataview should be updated automatically.

  • sortColumns — (Array<String>)

    Columns to be used for sorting the data.

  • partitionColumns — (Array<String>)

    Ordered set of column names used to partition data.

  • asOfTimestamp — (Integer)

    Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • destinationTypeParams — (map)

    Options that define the destination type for the Dataview.

    • destinationType — required — (String)

      Destination type for a Dataview.

      • GLUE_TABLE – Glue table destination type.

      • S3 – S3 destination type.

    • s3DestinationExportFileFormat — (String)

      Dataview export file format.

      • PARQUET – Parquet export file format.

      • DELIMITED_TEXT – Delimited text export file format.

      Possible values include:
      • "PARQUET"
      • "DELIMITED_TEXT"
    • s3DestinationExportFileFormatOptions — (map<String>)

      Format Options for S3 Destination type.

      Here is an example of how you could specify the s3DestinationExportFileFormatOptions

      { "header": "true", "delimiter": ",", "compression": "gzip" }

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetId — (String)

      The unique identifier of the Dataset used for the Dataview.

    • dataViewId — (String)

      The unique identifier for the created Dataview.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  applicationPermissions: [ /* required */
    CreateDataset | ManageClusters | ManageUsersAndGroups | ManageAttributeSets | ViewAuditData | AccessNotebooks | GetTemporaryCredentials,
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
finspacedata.createPermissionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the permission group.

  • description — (String)

    A brief description for the permission group.

  • applicationPermissions — (Array<String>)

    The option to indicate FinSpace application permissions that are granted to a specific group.

    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

    • CreateDataset – Group members can create new datasets.

    • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

    • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

    • ManageAttributeSets – Group members can manage attribute sets.

    • ViewAuditData – Group members can view audit data.

    • AccessNotebooks – Group members will have access to FinSpace notebooks.

    • GetTemporaryCredentials – Group members can get temporary API credentials.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • permissionGroupId — (String)

      The unique identifier for the permission group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  emailAddress: 'STRING_VALUE', /* required */
  type: SUPER_USER | APP_USER, /* required */
  apiAccess: ENABLED | DISABLED,
  apiAccessPrincipalArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  firstName: 'STRING_VALUE',
  lastName: 'STRING_VALUE'
};
finspacedata.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • emailAddress — (String)

    The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

  • type — (String)

    The option to indicate the type of user. Use one of the following options to specify this parameter:

    • SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    Possible values include:
    • "SUPER_USER"
    • "APP_USER"
  • firstName — (String)

    The first name of the user that you want to register.

  • lastName — (String)

    The last name of the user that you want to register.

  • apiAccess — (String)

    The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

    • ENABLED – The user has permissions to use the APIs.

    • DISABLED – The user does not have permissions to use any APIs.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • apiAccessPrincipalArn — (String)

    The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The unique identifier for the user.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspacedata.deleteDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.
  • datasetId — (String)

    The unique identifier of the Dataset to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetId — (String)

      The unique identifier for the deleted Dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  permissionGroupId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspacedata.deletePermissionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • permissionGroupId — (String)

    The unique identifier for the permission group that you want to delete.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • permissionGroupId — (String)

      The unique identifier for the deleted permission group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  userId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspacedata.disableUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userId — (String)

    The unique identifier for the user that you want to deactivate.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The unique identifier for the deactivated user.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  permissionGroupId: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspacedata.disassociateUserFromPermissionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • permissionGroupId — (String)

    The unique identifier for the permission group.

  • userId — (String)

    The unique identifier for the user.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • statusCode — (Integer)

      The returned status code of the response.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  userId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspacedata.enableUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userId — (String)

    The unique identifier for the user that you want to activate.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The unique identifier for the active user.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  changesetId: 'STRING_VALUE', /* required */
  datasetId: 'STRING_VALUE' /* required */
};
finspacedata.getChangeset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • datasetId — (String)

    The unique identifier for the FinSpace Dataset where the Changeset is created.

  • changesetId — (String)

    The unique identifier of the Changeset for which to get data.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • changesetId — (String)

      The unique identifier for a Changeset.

    • changesetArn — (String)

      The ARN identifier of the Changeset.

    • datasetId — (String)

      The unique identifier for the FinSpace Dataset where the Changeset is created.

    • changeType — (String)

      Type that indicates how a Changeset is applied to a Dataset.

      • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

      • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

      • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

      Possible values include:
      • "REPLACE"
      • "APPEND"
      • "MODIFY"
    • sourceParams — (map<String>)

      Options that define the location of the data being ingested.

    • formatParams — (map<String>)

      Structure of the source file(s).

    • createTime — (Integer)

      The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • status — (String)

      The status of Changeset creation operation.

      Possible values include:
      • "PENDING"
      • "FAILED"
      • "SUCCESS"
      • "RUNNING"
      • "STOP_REQUESTED"
    • errorInfo — (map)

      The structure with error messages.

      • errorMessage — (String)

        The text of the error message.

      • errorCategory — (String)

        The category of the error.

        • VALIDATION – The inputs to this request are invalid.

        • SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.

        • ACCESS_DENIED – Missing required permission to perform this request.

        • RESOURCE_NOT_FOUND – One or more inputs to this request were not found.

        • THROTTLING – The system temporarily lacks sufficient resources to process the request.

        • INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.

        • CANCELLED – Cancelled.

        • USER_RECOVERABLE – A user recoverable error has occurred.

        Possible values include:
        • "VALIDATION"
        • "SERVICE_QUOTA_EXCEEDED"
        • "ACCESS_DENIED"
        • "RESOURCE_NOT_FOUND"
        • "THROTTLING"
        • "INTERNAL_SERVICE_EXCEPTION"
        • "CANCELLED"
        • "USER_RECOVERABLE"
    • activeUntilTimestamp — (Integer)

      Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • activeFromTimestamp — (Integer)

      Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • updatesChangesetId — (String)

      The unique identifier of the Changeset that is being updated.

    • updatedByChangesetId — (String)

      The unique identifier of the updated Changeset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetId: 'STRING_VALUE' /* required */
};
finspacedata.getDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • datasetId — (String)

    The unique identifier for a Dataset.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetId — (String)

      The unique identifier for a Dataset.

    • datasetArn — (String)

      The ARN identifier of the Dataset.

    • datasetTitle — (String)

      Display title for a Dataset.

    • kind — (String)

      The format in which Dataset data is structured.

      • TABULAR – Data is structured in a tabular format.

      • NON_TABULAR – Data is structured in a non-tabular format.

      Possible values include:
      • "TABULAR"
      • "NON_TABULAR"
    • datasetDescription — (String)

      A description of the Dataset.

    • createTime — (Integer)

      The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • lastModifiedTime — (Integer)

      The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • schemaDefinition — (map)

      Definition for a schema on a tabular Dataset.

      • tabularSchemaConfig — (map)

        The configuration for a schema on a tabular Dataset.

        • columns — (Array<map>)

          List of column definitions.

          • dataType — (String)

            Data type of a column.

            • STRING – A String data type.

              CHAR – A char data type.

              INTEGER – An integer data type.

              TINYINT – A tinyint data type.

              SMALLINT – A smallint data type.

              BIGINT – A bigint data type.

              FLOAT – A float data type.

              DOUBLE – A double data type.

              DATE – A date data type.

              DATETIME – A datetime data type.

              BOOLEAN – A boolean data type.

              BINARY – A binary data type.

            Possible values include:
            • "STRING"
            • "CHAR"
            • "INTEGER"
            • "TINYINT"
            • "SMALLINT"
            • "BIGINT"
            • "FLOAT"
            • "DOUBLE"
            • "DATE"
            • "DATETIME"
            • "BOOLEAN"
            • "BINARY"
          • columnName — (String)

            The name of a column.

          • columnDescription — (String)

            Description for a column.

        • primaryKeyColumns — (Array<String>)

          List of column names used for primary key.

    • alias — (String)

      The unique resource identifier for a Dataset.

    • status — (String)

      Status of the Dataset creation.

      • PENDING – Dataset is pending creation.

      • FAILED – Dataset creation has failed.

      • SUCCESS – Dataset creation has succeeded.

      • RUNNING – Dataset creation is running.

      Possible values include:
      • "PENDING"
      • "FAILED"
      • "SUCCESS"
      • "RUNNING"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataViewId: 'STRING_VALUE', /* required */
  datasetId: 'STRING_VALUE' /* required */
};
finspacedata.getDataView(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataViewId — (String)

    The unique identifier for the Dataview.

  • datasetId — (String)

    The unique identifier for the Dataset used in the Dataview.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • autoUpdate — (Boolean)

      Flag to indicate Dataview should be updated automatically.

    • partitionColumns — (Array<String>)

      Ordered set of column names used to partition data.

    • datasetId — (String)

      The unique identifier for the Dataset used in the Dataview.

    • asOfTimestamp — (Integer)

      Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • errorInfo — (map)

      Information about an error that occurred for the Dataview.

      • errorMessage — (String)

        The text of the error message.

      • errorCategory — (String)

        The category of the error.

        • VALIDATION – The inputs to this request are invalid.

        • SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.

        • ACCESS_DENIED – Missing required permission to perform this request.

        • RESOURCE_NOT_FOUND – One or more inputs to this request were not found.

        • THROTTLING – The system temporarily lacks sufficient resources to process the request.

        • INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.

        • CANCELLED – Cancelled.

        • USER_RECOVERABLE – A user recoverable error has occurred.

        Possible values include:
        • "VALIDATION"
        • "SERVICE_QUOTA_EXCEEDED"
        • "ACCESS_DENIED"
        • "RESOURCE_NOT_FOUND"
        • "THROTTLING"
        • "INTERNAL_SERVICE_EXCEPTION"
        • "CANCELLED"
        • "USER_RECOVERABLE"
    • lastModifiedTime — (Integer)

      The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • createTime — (Integer)

      The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • sortColumns — (Array<String>)

      Columns to be used for sorting the data.

    • dataViewId — (String)

      The unique identifier for the Dataview.

    • dataViewArn — (String)

      The ARN identifier of the Dataview.

    • destinationTypeParams — (map)

      Options that define the destination type for the Dataview.

      • destinationType — required — (String)

        Destination type for a Dataview.

        • GLUE_TABLE – Glue table destination type.

        • S3 – S3 destination type.

      • s3DestinationExportFileFormat — (String)

        Dataview export file format.

        • PARQUET – Parquet export file format.

        • DELIMITED_TEXT – Delimited text export file format.

        Possible values include:
        • "PARQUET"
        • "DELIMITED_TEXT"
      • s3DestinationExportFileFormatOptions — (map<String>)

        Format Options for S3 Destination type.

        Here is an example of how you could specify the s3DestinationExportFileFormatOptions

        { "header": "true", "delimiter": ",", "compression": "gzip" }

    • status — (String)

      The status of a Dataview creation.

      • RUNNING – Dataview creation is running.

      • STARTING – Dataview creation is starting.

      • FAILED – Dataview creation has failed.

      • CANCELLED – Dataview creation has been cancelled.

      • TIMEOUT – Dataview creation has timed out.

      • SUCCESS – Dataview creation has succeeded.

      • PENDING – Dataview creation is pending.

      • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

      Possible values include:
      • "RUNNING"
      • "STARTING"
      • "FAILED"
      • "CANCELLED"
      • "TIMEOUT"
      • "SUCCESS"
      • "PENDING"
      • "FAILED_CLEANUP_FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataViewId: 'STRING_VALUE', /* required */
  datasetId: 'STRING_VALUE' /* required */
};
finspacedata.getExternalDataViewAccessDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataViewId — (String)

    The unique identifier for the Dataview that you want to access.

  • datasetId — (String)

    The unique identifier for the Dataset.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • credentials — (map)

      The credentials required to access the external Dataview from the S3 location.

      • accessKeyId — (String)

        The unique identifier for the security credentials.

      • secretAccessKey — (String)

        The secret access key that can be used to sign requests.

      • sessionToken — (String)

        The token that users must pass to use the credentials.

      • expiration — (Integer)

        The Epoch time when the current credentials expire.

    • s3Location — (map)

      The location where the external Dataview is stored.

      • bucket — required — (String)

        The name of the S3 bucket.

      • key — required — (String)

        The path of the folder, within the S3 bucket that contains the Dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  permissionGroupId: 'STRING_VALUE' /* required */
};
finspacedata.getPermissionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • permissionGroupId — (String)

    The unique identifier for the permission group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • permissionGroup — (map)

      The structure for a permission group.

      • permissionGroupId — (String)

        The unique identifier for the permission group.

      • name — (String)

        The name of the permission group.

      • description — (String)

        A brief description for the permission group.

      • applicationPermissions — (Array<String>)

        Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

        When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

        • CreateDataset – Group members can create new datasets.

        • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

        • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

        • ManageAttributeSets – Group members can manage attribute sets.

        • ViewAuditData – Group members can view audit data.

        • AccessNotebooks – Group members will have access to FinSpace notebooks.

        • GetTemporaryCredentials – Group members can get temporary API credentials.

      • createTime — (Integer)

        The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

      • lastModifiedTime — (Integer)

        Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

      • membershipStatus — (String)

        Indicates the status of the user within a permission group.

        • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

        • ADDITION_SUCCESS – The user is successfully added to the permission group.

        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

        Possible values include:
        • "ADDITION_IN_PROGRESS"
        • "ADDITION_SUCCESS"
        • "REMOVAL_IN_PROGRESS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  environmentId: 'STRING_VALUE', /* required */
  durationInMinutes: 'NUMBER_VALUE'
};
finspacedata.getProgrammaticAccessCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • durationInMinutes — (Integer)

    The time duration in which the credentials remain valid.

  • environmentId — (String)

    The FinSpace environment identifier.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • credentials — (map)

      Returns the programmatic credentials.

      • accessKeyId — (String)

        The access key identifier.

      • secretAccessKey — (String)

        The access key.

      • sessionToken — (String)

        The session token.

    • durationInMinutes — (Integer)

      Returns the duration in which the credentials will remain valid.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  userId: 'STRING_VALUE' /* required */
};
finspacedata.getUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userId — (String)

    The unique identifier of the user to get data for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The unique identifier for the user that is retrieved.

    • status — (String)

      The current status of the user.

      • CREATING – The creation is in progress.

      • ENABLED – The user is created and is currently active.

      • DISABLED – The user is currently inactive.

      Possible values include:
      • "CREATING"
      • "ENABLED"
      • "DISABLED"
    • firstName — (String)

      The first name of the user.

    • lastName — (String)

      The last name of the user.

    • emailAddress — (String)

      The email address that is associated with the user.

    • type — (String)

      Indicates the type of user.

      • SUPER_USER – A user with permission to all the functionality and data in FinSpace.

      • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

      Possible values include:
      • "SUPER_USER"
      • "APP_USER"
    • apiAccess — (String)

      Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

      • ENABLED – The user has permissions to use the APIs.

      • DISABLED – The user does not have permissions to use any APIs.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • apiAccessPrincipalArn — (String)

      The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

    • createTime — (Integer)

      The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

    • lastEnabledTime — (Integer)

      Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

    • lastDisabledTime — (Integer)

      Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

    • lastModifiedTime — (Integer)

      Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

    • lastLoginTime — (Integer)

      Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  locationType: INGESTION | SAGEMAKER
};
finspacedata.getWorkingLocation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • locationType — (String)

    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.

    Possible values include:
    • "INGESTION"
    • "SAGEMAKER"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • s3Uri — (String)

      Returns the Amazon S3 URI for the working location.

    • s3Path — (String)

      Returns the Amazon S3 Path for the working location.

    • s3Bucket — (String)

      Returns the Amazon S3 bucket name for the working location.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspacedata.listChangesets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • datasetId — (String)

    The unique identifier for the FinSpace Dataset to which the Changeset belongs.

  • maxResults — (Integer)

    The maximum number of results per page.

  • nextToken — (String)

    A token that indicates where a results page should begin.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • changesets — (Array<map>)

      List of Changesets found.

      • changesetId — (String)

        The unique identifier for a Changeset.

      • changesetArn — (String)

        The ARN identifier of the Changeset.

      • datasetId — (String)

        The unique identifier for the FinSpace Dataset in which the Changeset is created.

      • changeType — (String)

        Type that indicates how a Changeset is applied to a Dataset.

        • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

        • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

        • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

        Possible values include:
        • "REPLACE"
        • "APPEND"
        • "MODIFY"
      • sourceParams — (map<String>)

        Options that define the location of the data being ingested.

      • formatParams — (map<String>)

        Options that define the structure of the source file(s).

      • createTime — (Integer)

        The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • status — (String)

        Status of the Changeset ingestion.

        • PENDING – Changeset is pending creation.

        • FAILED – Changeset creation has failed.

        • SUCCESS – Changeset creation has succeeded.

        • RUNNING – Changeset creation is running.

        • STOP_REQUESTED – User requested Changeset creation to stop.

        Possible values include:
        • "PENDING"
        • "FAILED"
        • "SUCCESS"
        • "RUNNING"
        • "STOP_REQUESTED"
      • errorInfo — (map)

        The structure with error messages.

        • errorMessage — (String)

          The text of the error message.

        • errorCategory — (String)

          The category of the error.

          • VALIDATION – The inputs to this request are invalid.

          • SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.

          • ACCESS_DENIED – Missing required permission to perform this request.

          • RESOURCE_NOT_FOUND – One or more inputs to this request were not found.

          • THROTTLING – The system temporarily lacks sufficient resources to process the request.

          • INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.

          • CANCELLED – Cancelled.

          • USER_RECOVERABLE – A user recoverable error has occurred.

          Possible values include:
          • "VALIDATION"
          • "SERVICE_QUOTA_EXCEEDED"
          • "ACCESS_DENIED"
          • "RESOURCE_NOT_FOUND"
          • "THROTTLING"
          • "INTERNAL_SERVICE_EXCEPTION"
          • "CANCELLED"
          • "USER_RECOVERABLE"
      • activeUntilTimestamp — (Integer)

        Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • activeFromTimestamp — (Integer)

        Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • updatesChangesetId — (String)

        The unique identifier of the Changeset that is updated.

      • updatedByChangesetId — (String)

        The unique identifier of the updated Changeset.

    • nextToken — (String)

      A token that indicates where a results page should begin.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspacedata.listDatasets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results per page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasets — (Array<map>)

      List of Datasets.

      • datasetId — (String)

        An identifier for a Dataset.

      • datasetArn — (String)

        The ARN identifier of the Dataset.

      • datasetTitle — (String)

        Display title for a Dataset.

      • kind — (String)

        The format in which Dataset data is structured.

        • TABULAR – Data is structured in a tabular format.

        • NON_TABULAR – Data is structured in a non-tabular format.

        Possible values include:
        • "TABULAR"
        • "NON_TABULAR"
      • datasetDescription — (String)

        Description for a Dataset.

      • ownerInfo — (map)

        Contact information for a Dataset owner.

        • name — (String)

          The name of the Dataset owner.

        • phoneNumber — (String)

          Phone number for the Dataset owner.

        • email — (String)

          Email address for the Dataset owner.

      • createTime — (Integer)

        The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • lastModifiedTime — (Integer)

        The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • schemaDefinition — (map)

        Definition for a schema on a tabular Dataset.

        • tabularSchemaConfig — (map)

          The configuration for a schema on a tabular Dataset.

          • columns — (Array<map>)

            List of column definitions.

            • dataType — (String)

              Data type of a column.

              • STRING – A String data type.

                CHAR – A char data type.

                INTEGER – An integer data type.

                TINYINT – A tinyint data type.

                SMALLINT – A smallint data type.

                BIGINT – A bigint data type.

                FLOAT – A float data type.

                DOUBLE – A double data type.

                DATE – A date data type.

                DATETIME – A datetime data type.

                BOOLEAN – A boolean data type.

                BINARY – A binary data type.

              Possible values include:
              • "STRING"
              • "CHAR"
              • "INTEGER"
              • "TINYINT"
              • "SMALLINT"
              • "BIGINT"
              • "FLOAT"
              • "DOUBLE"
              • "DATE"
              • "DATETIME"
              • "BOOLEAN"
              • "BINARY"
            • columnName — (String)

              The name of a column.

            • columnDescription — (String)

              Description for a column.

          • primaryKeyColumns — (Array<String>)

            List of column names used for primary key.

      • alias — (String)

        The unique resource identifier for a Dataset.

    • nextToken — (String)

      A token that indicates where a results page should begin.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspacedata.listDataViews(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • datasetId — (String)

    The unique identifier of the Dataset for which to retrieve Dataviews.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results per page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      A token that indicates where a results page should begin.

    • dataViews — (Array<map>)

      A list of Dataviews.

      • dataViewId — (String)

        The unique identifier for the Dataview.

      • dataViewArn — (String)

        The ARN identifier of the Dataview.

      • datasetId — (String)

        Th unique identifier for the Dataview Dataset.

      • asOfTimestamp — (Integer)

        Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • partitionColumns — (Array<String>)

        Ordered set of column names used to partition data.

      • sortColumns — (Array<String>)

        Columns to be used for sorting the data.

      • status — (String)

        The status of a Dataview creation.

        • RUNNING – Dataview creation is running.

        • STARTING – Dataview creation is starting.

        • FAILED – Dataview creation has failed.

        • CANCELLED – Dataview creation has been cancelled.

        • TIMEOUT – Dataview creation has timed out.

        • SUCCESS – Dataview creation has succeeded.

        • PENDING – Dataview creation is pending.

        • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

        Possible values include:
        • "RUNNING"
        • "STARTING"
        • "FAILED"
        • "CANCELLED"
        • "TIMEOUT"
        • "SUCCESS"
        • "PENDING"
        • "FAILED_CLEANUP_FAILED"
      • errorInfo — (map)

        The structure with error messages.

        • errorMessage — (String)

          The text of the error message.

        • errorCategory — (String)

          The category of the error.

          • VALIDATION – The inputs to this request are invalid.

          • SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.

          • ACCESS_DENIED – Missing required permission to perform this request.

          • RESOURCE_NOT_FOUND – One or more inputs to this request were not found.

          • THROTTLING – The system temporarily lacks sufficient resources to process the request.

          • INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.

          • CANCELLED – Cancelled.

          • USER_RECOVERABLE – A user recoverable error has occurred.

          Possible values include:
          • "VALIDATION"
          • "SERVICE_QUOTA_EXCEEDED"
          • "ACCESS_DENIED"
          • "RESOURCE_NOT_FOUND"
          • "THROTTLING"
          • "INTERNAL_SERVICE_EXCEPTION"
          • "CANCELLED"
          • "USER_RECOVERABLE"
      • destinationTypeProperties — (map)

        Information about the Dataview destination.

        • destinationType — required — (String)

          Destination type for a Dataview.

          • GLUE_TABLE – Glue table destination type.

          • S3 – S3 destination type.

        • s3DestinationExportFileFormat — (String)

          Dataview export file format.

          • PARQUET – Parquet export file format.

          • DELIMITED_TEXT – Delimited text export file format.

          Possible values include:
          • "PARQUET"
          • "DELIMITED_TEXT"
        • s3DestinationExportFileFormatOptions — (map<String>)

          Format Options for S3 Destination type.

          Here is an example of how you could specify the s3DestinationExportFileFormatOptions

          { "header": "true", "delimiter": ",", "compression": "gzip" }

      • autoUpdate — (Boolean)

        The flag to indicate Dataview should be updated automatically.

      • createTime — (Integer)

        The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • lastModifiedTime — (Integer)

        The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
finspacedata.listPermissionGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results per page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • permissionGroups — (Array<map>)

      A list of all the permission groups.

      • permissionGroupId — (String)

        The unique identifier for the permission group.

      • name — (String)

        The name of the permission group.

      • description — (String)

        A brief description for the permission group.

      • applicationPermissions — (Array<String>)

        Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

        When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

        • CreateDataset – Group members can create new datasets.

        • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

        • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

        • ManageAttributeSets – Group members can manage attribute sets.

        • ViewAuditData – Group members can view audit data.

        • AccessNotebooks – Group members will have access to FinSpace notebooks.

        • GetTemporaryCredentials – Group members can get temporary API credentials.

      • createTime — (Integer)

        The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

      • lastModifiedTime — (Integer)

        Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

      • membershipStatus — (String)

        Indicates the status of the user within a permission group.

        • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

        • ADDITION_SUCCESS – The user is successfully added to the permission group.

        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

        Possible values include:
        • "ADDITION_IN_PROGRESS"
        • "ADDITION_SUCCESS"
        • "REMOVAL_IN_PROGRESS"
    • nextToken — (String)

      A token that indicates where a results page should begin.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE', /* required */
  userId: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
finspacedata.listPermissionGroupsByUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userId — (String)

    The unique identifier for the user.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results per page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • permissionGroups — (Array<map>)

      A list of returned permission groups.

      • permissionGroupId — (String)

        The unique identifier for the permission group.

      • name — (String)

        The name of the permission group.

      • membershipStatus — (String)

        Indicates the status of the user within a permission group.

        • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

        • ADDITION_SUCCESS – The user is successfully added to the permission group.

        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

        Possible values include:
        • "ADDITION_IN_PROGRESS"
        • "ADDITION_SUCCESS"
        • "REMOVAL_IN_PROGRESS"
    • nextToken — (String)

      A token that indicates where a results page should begin.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
finspacedata.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results per page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • users — (Array<map>)

      A list of all the users.

      • userId — (String)

        The unique identifier for the user.

      • status — (String)

        The current status of the user.

        • CREATING – The user creation is in progress.

        • ENABLED – The user is created and is currently active.

        • DISABLED – The user is currently inactive.

        Possible values include:
        • "CREATING"
        • "ENABLED"
        • "DISABLED"
      • firstName — (String)

        The first name of the user.

      • lastName — (String)

        The last name of the user.

      • emailAddress — (String)

        The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

      • type — (String)

        Indicates the type of user.

        • SUPER_USER – A user with permission to all the functionality and data in FinSpace.

        • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

        Possible values include:
        • "SUPER_USER"
        • "APP_USER"
      • apiAccess — (String)

        Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

        • ENABLED – The user has permissions to use the APIs.

        • DISABLED – The user does not have permissions to use any APIs.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • apiAccessPrincipalArn — (String)

        The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

      • createTime — (Integer)

        The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

      • lastEnabledTime — (Integer)

        Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

      • lastDisabledTime — (Integer)

        Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

      • lastModifiedTime — (Integer)

        Describes the last time the user was updated. The value is determined as epoch time in milliseconds.

      • lastLoginTime — (Integer)

        Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

    • nextToken — (String)

      A token that indicates where a results page should begin.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE', /* required */
  permissionGroupId: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
finspacedata.listUsersByPermissionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • permissionGroupId — (String)

    The unique identifier for the permission group.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results per page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • users — (Array<map>)

      Lists details of all users in a specific permission group.

      • userId — (String)

        The unique identifier for the user.

      • status — (String)

        The current status of the user.

        • CREATING – The user creation is in progress.

        • ENABLED – The user is created and is currently active.

        • DISABLED – The user is currently inactive.

        Possible values include:
        • "CREATING"
        • "ENABLED"
        • "DISABLED"
      • firstName — (String)

        The first name of the user.

      • lastName — (String)

        The last name of the user.

      • emailAddress — (String)

        The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

      • type — (String)

        Indicates the type of user.

        • SUPER_USER – A user with permission to all the functionality and data in FinSpace.

        • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

        Possible values include:
        • "SUPER_USER"
        • "APP_USER"
      • apiAccess — (String)

        Indicates whether the user can access FinSpace API operations.

        • ENABLED – The user has permissions to use the API operations.

        • DISABLED – The user does not have permissions to use any API operations.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • apiAccessPrincipalArn — (String)

        The IAM ARN identifier that is attached to FinSpace API calls.

      • membershipStatus — (String)

        Indicates the status of the user within a permission group.

        • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

        • ADDITION_SUCCESS – The user is successfully added to the permission group.

        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

        Possible values include:
        • "ADDITION_IN_PROGRESS"
        • "ADDITION_SUCCESS"
        • "REMOVAL_IN_PROGRESS"
    • nextToken — (String)

      A token that indicates where a results page should begin.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  userId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspacedata.resetUserPassword(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userId — (String)

    The unique identifier of the user that a temporary password is requested for.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The unique identifier of the user that a new password is generated for.

    • temporaryPassword — (String)

      A randomly generated temporary password for the requested user. This password expires in 7 days.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  changesetId: 'STRING_VALUE', /* required */
  datasetId: 'STRING_VALUE', /* required */
  formatParams: { /* required */
    '<StringMapKey>': 'STRING_VALUE',
    /* '<StringMapKey>': ... */
  },
  sourceParams: { /* required */
    '<StringMapKey>': 'STRING_VALUE',
    /* '<StringMapKey>': ... */
  },
  clientToken: 'STRING_VALUE'
};
finspacedata.updateChangeset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.
  • datasetId — (String)

    The unique identifier for the FinSpace Dataset in which the Changeset is created.

  • changesetId — (String)

    The unique identifier for the Changeset to update.

  • sourceParams — (map<String>)

    Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

    Both s3SourcePath and sourceType are required attributes.

    Here is an example of how you could specify the sourceParams:

    "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

    The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.

  • formatParams — (map<String>)

    Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).

    formatType is a required attribute and can have the following values:

    • PARQUET – Parquet source file format.

    • CSV – CSV source file format.

    • JSON – JSON source file format.

    • XML – XML source file format.

    Here is an example of how you could specify the formatParams:

    "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

    Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

    { "withHeader": "true", "separator": "," }

    For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • changesetId — (String)

      The unique identifier for the Changeset to update.

    • datasetId — (String)

      The unique identifier for the FinSpace Dataset in which the Changeset is created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  datasetId: 'STRING_VALUE', /* required */
  datasetTitle: 'STRING_VALUE', /* required */
  kind: TABULAR | NON_TABULAR, /* required */
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  datasetDescription: 'STRING_VALUE',
  schemaDefinition: {
    tabularSchemaConfig: {
      columns: [
        {
          columnDescription: 'STRING_VALUE',
          columnName: 'STRING_VALUE',
          dataType: STRING | CHAR | INTEGER | TINYINT | SMALLINT | BIGINT | FLOAT | DOUBLE | DATE | DATETIME | BOOLEAN | BINARY
        },
        /* more items */
      ],
      primaryKeyColumns: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
finspacedata.updateDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.
  • datasetId — (String)

    The unique identifier for the Dataset to update.

  • datasetTitle — (String)

    A display title for the Dataset.

  • kind — (String)

    The format in which the Dataset data is structured.

    • TABULAR – Data is structured in a tabular format.

    • NON_TABULAR – Data is structured in a non-tabular format.

    Possible values include:
    • "TABULAR"
    • "NON_TABULAR"
  • datasetDescription — (String)

    A description for the Dataset.

  • alias — (String)

    The unique resource identifier for a Dataset.

  • schemaDefinition — (map)

    Definition for a schema on a tabular Dataset.

    • tabularSchemaConfig — (map)

      The configuration for a schema on a tabular Dataset.

      • columns — (Array<map>)

        List of column definitions.

        • dataType — (String)

          Data type of a column.

          • STRING – A String data type.

            CHAR – A char data type.

            INTEGER – An integer data type.

            TINYINT – A tinyint data type.

            SMALLINT – A smallint data type.

            BIGINT – A bigint data type.

            FLOAT – A float data type.

            DOUBLE – A double data type.

            DATE – A date data type.

            DATETIME – A datetime data type.

            BOOLEAN – A boolean data type.

            BINARY – A binary data type.

          Possible values include:
          • "STRING"
          • "CHAR"
          • "INTEGER"
          • "TINYINT"
          • "SMALLINT"
          • "BIGINT"
          • "FLOAT"
          • "DOUBLE"
          • "DATE"
          • "DATETIME"
          • "BOOLEAN"
          • "BINARY"
        • columnName — (String)

          The name of a column.

        • columnDescription — (String)

          Description for a column.

      • primaryKeyColumns — (Array<String>)

        List of column names used for primary key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • datasetId — (String)

      The unique identifier for updated Dataset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  permissionGroupId: 'STRING_VALUE', /* required */
  applicationPermissions: [
    CreateDataset | ManageClusters | ManageUsersAndGroups | ManageAttributeSets | ViewAuditData | AccessNotebooks | GetTemporaryCredentials,
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
finspacedata.updatePermissionGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • permissionGroupId — (String)

    The unique identifier for the permission group to update.

  • name — (String)

    The name of the permission group.

  • description — (String)

    A brief description for the permission group.

  • applicationPermissions — (Array<String>)

    The permissions that are granted to a specific group for accessing the FinSpace application.

    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

    • CreateDataset – Group members can create new datasets.

    • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

    • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

    • ManageAttributeSets – Group members can manage attribute sets.

    • ViewAuditData – Group members can view audit data.

    • AccessNotebooks – Group members will have access to FinSpace notebooks.

    • GetTemporaryCredentials – Group members can get temporary API credentials.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • permissionGroupId — (String)

      The unique identifier for the updated permission group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  userId: 'STRING_VALUE', /* required */
  apiAccess: ENABLED | DISABLED,
  apiAccessPrincipalArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  firstName: 'STRING_VALUE',
  lastName: 'STRING_VALUE',
  type: SUPER_USER | APP_USER
};
finspacedata.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • userId — (String)

    The unique identifier for the user that you want to update.

  • type — (String)

    The option to indicate the type of user.

    • SUPER_USER– A user with permission to all the functionality and data in FinSpace.

    • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    Possible values include:
    • "SUPER_USER"
    • "APP_USER"
  • firstName — (String)

    The first name of the user.

  • lastName — (String)

    The last name of the user.

  • apiAccess — (String)

    The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

    • ENABLED – The user has permissions to use the APIs.

    • DISABLED – The user does not have permissions to use any APIs.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • apiAccessPrincipalArn — (String)

    The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

  • clientToken — (String)

    A token that ensures idempotency. This token expires in 10 minutes.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • userId — (String)

      The unique identifier of the updated user.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.