Class: AWS.Finspace

var params = {
  changeRequests: [ /* required */
    {
      changeType: PUT | DELETE, /* required */
      dbPath: 'STRING_VALUE', /* required */
      s3Path: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.createKxChangeset(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: {}) —
  • environmentId — (String)

    A unique identifier of the kdb environment.

  • databaseName — (String)

    The name of the kdb database.

  • changeRequests — (Array<map>)

    A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. A changeType can have the following values:

    • PUT – Adds or updates files in a database.

    • DELETE – Deletes files in a database.

    All the change requests require a mandatory dbPath attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

    Here are few examples of how you can use the change request object:

    1. This request adds a single sym file at database root location.

       { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

    2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

       { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

    3. This request adds files in the given s3Path under the taq table partition of the database.

       [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

    4. This request deletes the 2020.01.02 partition of the database.

       [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

    5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

       [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

    • changeType — required — (String)

      Defines the type of change request. A changeType can have the following values:

      • PUT – Adds or updates files in a database.

      • DELETE – Deletes files in a database.

      Possible values include:
      • "PUT"
      • "DELETE"
    • s3Path — (String)

      Defines the S3 path of the source file that is required to add or update files in a database.

    • dbPath — required — (String)

      Defines the path within the database directory.

  • 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:

    • changesetId — (String)

      A unique identifier for the changeset.

    • databaseName — (String)

      The name of the kdb database.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • changeRequests — (Array<map>)

      A list of change requests.

      • changeType — required — (String)

        Defines the type of change request. A changeType can have the following values:

        • PUT – Adds or updates files in a database.

        • DELETE – Deletes files in a database.

        Possible values include:
        • "PUT"
        • "DELETE"
      • s3Path — (String)

        Defines the S3 path of the source file that is required to add or update files in a database.

      • dbPath — required — (String)

        Defines the path within the database directory.

    • createdTimestamp — (Date)

      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.

    • lastModifiedTimestamp — (Date)

      The timestamp at which the changeset was updated 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 creation process.

      • Pending – Changeset creation is pending.

      • Processing – Changeset creation is running.

      • Failed – Changeset creation has failed.

      • Complete – Changeset creation has succeeded.

      Possible values include:
      • "PENDING"
      • "PROCESSING"
      • "FAILED"
      • "COMPLETED"
    • errorInfo — (map)

      The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.

      • errorMessage — (String)

        Specifies the error message that appears if a flow fails.

      • errorType — (String)

        Specifies the type of error.

        Possible values include:
        • "The inputs to this request are invalid."
        • "Service limits have been exceeded."
        • "Missing required permission to perform this request."
        • "One or more inputs to this request were not found."
        • "The system temporarily lacks sufficient resources to process the request."
        • "An internal error has occurred."
        • "Cancelled"
        • "A user recoverable error has occurred"

Returns:

• (AWS.Request) —

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

var params = {
  azMode: SINGLE | MULTI, /* required */
  clusterName: 'STRING_VALUE', /* required */
  clusterType: HDB | RDB | GATEWAY | GP | TICKERPLANT, /* required */
  environmentId: 'STRING_VALUE', /* required */
  releaseLabel: 'STRING_VALUE', /* required */
  vpcConfiguration: { /* required */
    ipAddressType: IP_V4,
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [
      'STRING_VALUE',
      /* more items */
    ],
    vpcId: 'STRING_VALUE'
  },
  autoScalingConfiguration: {
    autoScalingMetric: CPU_UTILIZATION_PERCENTAGE,
    maxNodeCount: 'NUMBER_VALUE',
    metricTarget: 'NUMBER_VALUE',
    minNodeCount: 'NUMBER_VALUE',
    scaleInCooldownSeconds: 'NUMBER_VALUE',
    scaleOutCooldownSeconds: 'NUMBER_VALUE'
  },
  availabilityZoneId: 'STRING_VALUE',
  cacheStorageConfigurations: [
    {
      size: 'NUMBER_VALUE', /* required */
      type: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  capacityConfiguration: {
    nodeCount: 'NUMBER_VALUE',
    nodeType: 'STRING_VALUE'
  },
  clientToken: 'STRING_VALUE',
  clusterDescription: 'STRING_VALUE',
  code: {
    s3Bucket: 'STRING_VALUE',
    s3Key: 'STRING_VALUE',
    s3ObjectVersion: 'STRING_VALUE'
  },
  commandLineArguments: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  databases: [
    {
      databaseName: 'STRING_VALUE', /* required */
      cacheConfigurations: [
        {
          cacheType: 'STRING_VALUE', /* required */
          dbPaths: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          dataviewName: 'STRING_VALUE'
        },
        /* more items */
      ],
      changesetId: 'STRING_VALUE',
      dataviewConfiguration: {
        changesetId: 'STRING_VALUE',
        dataviewName: 'STRING_VALUE',
        dataviewVersionId: 'STRING_VALUE',
        segmentConfigurations: [
          {
            dbPaths: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            volumeName: 'STRING_VALUE', /* required */
            onDemand: true || false
          },
          /* more items */
        ]
      },
      dataviewName: 'STRING_VALUE'
    },
    /* more items */
  ],
  executionRole: 'STRING_VALUE',
  initializationScript: 'STRING_VALUE',
  savedownStorageConfiguration: {
    size: 'NUMBER_VALUE',
    type: SDS01,
    volumeName: 'STRING_VALUE'
  },
  scalingGroupConfiguration: {
    memoryReservation: 'NUMBER_VALUE', /* required */
    nodeCount: 'NUMBER_VALUE', /* required */
    scalingGroupName: 'STRING_VALUE', /* required */
    cpu: 'NUMBER_VALUE',
    memoryLimit: 'NUMBER_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  tickerplantLogConfiguration: {
    tickerplantLogVolumes: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
finspace.createKxCluster(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.
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterName — (String)

    A unique name for the cluster that you want to create.

  • clusterType — (String)

    Specifies the type of KDB database that is being created. The following types are available:

    • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

    • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

    • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

    • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

    • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

    Possible values include:
    • "HDB"
    • "RDB"
    • "GATEWAY"
    • "GP"
    • "TICKERPLANT"
  • tickerplantLogConfiguration — (map)

    A configuration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

    • tickerplantLogVolumes — (Array<String>)

      The name of the volumes for tickerplant logs.

  • databases — (Array<map>)

    A list of databases that will be available for querying.

    • databaseName — required — (String)

      The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

    • cacheConfigurations — (Array<map>)

      Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

      • cacheType — required — (String)

        The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

        • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

      • dbPaths — required — (Array<String>)

        Specifies the portions of database that will be loaded into the cache for access.

      • dataviewName — (String)

        The name of the dataview to be used for caching historical data on disk.

    • changesetId — (String)

      A unique identifier of the changeset that is associated with the cluster.

    • dataviewName — (String)

      The name of the dataview to be used for caching historical data on disk.

    • dataviewConfiguration — (map)

      The configuration of the dataview to be used with specified cluster.

      • dataviewName — (String)

        The unique identifier of the dataview.

      • dataviewVersionId — (String)

        The version of the dataview corresponding to a given changeset.

      • changesetId — (String)

        A unique identifier for the changeset.

      • segmentConfigurations — (Array<map>)

        The db path and volume configuration for the segmented database.

        • dbPaths — required — (Array<String>)

          The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

        • volumeName — required — (String)

          The name of the volume where you want to add data.

        • onDemand — (Boolean)

          Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

  • cacheStorageConfigurations — (Array<map>)

    The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

    • type — required — (String)

      The type of cache storage. The valid values are:

      • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

      • CACHE_250 – This type provides at least 250 MB/s disk access throughput.

      • CACHE_12 – This type provides at least 12 MB/s disk access throughput.

      For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.

    • size — required — (Integer)

      The size of cache in Gigabytes.

  • autoScalingConfiguration — (map)

    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

    • minNodeCount — (Integer)

      The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

    • maxNodeCount — (Integer)

      The highest number of nodes to scale. This value cannot be greater than 5.

    • autoScalingMetric — (String)

      The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

      Possible values include:
      • "CPU_UTILIZATION_PERCENTAGE"
    • metricTarget — (Float)

      The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

    • scaleInCooldownSeconds — (Float)

      The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

    • scaleOutCooldownSeconds — (Float)

      The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.

  • clusterDescription — (String)

    A description of the cluster.

  • capacityConfiguration — (map)

    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

    • nodeType — (String)

      The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.

      You can only specify one of the following values:

      • kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.

      • kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.

      • kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.

      • kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.

      • kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.

      • kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.

      • kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.

    • nodeCount — (Integer)

      The number of instances running in a cluster.

  • releaseLabel — (String)

    The version of FinSpace managed kdb to run.

  • vpcConfiguration — (map)

    Configuration details about the network where the Privatelink endpoint of the cluster resides.

    • vpcId — (String)

      The identifier of the VPC endpoint.

    • securityGroupIds — (Array<String>)

      The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.

    • subnetIds — (Array<String>)

      The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.

    • ipAddressType — (String)

      The IP address type for cluster network configuration parameters. The following type is available:

      • IP_V4 – IP address version 4

      Possible values include:
      • "IP_V4"
  • initializationScript — (String)

    Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

  • commandLineArguments — (Array<map>)

    Defines the key-value pairs to make them available inside the cluster.

    • key — (String)

      The name of the key.

    • value — (String)

      The value of the key.

  • code — (map)

    The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

    • s3Bucket — (String)

      A unique name for the S3 bucket.

    • s3Key — (String)

      The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

    • s3ObjectVersion — (String)

      The version of an S3 object.

  • executionRole — (String)

    An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

  • savedownStorageConfiguration — (map)

    The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

    • type — (String)

      The type of writeable storage space for temporarily storing your savedown data. The valid values are:

      • SDS01 – This type represents 3000 IOPS and io2 ebs volume type.

      Possible values include:
      • "SDS01"
    • size — (Integer)

      The size of temporary storage in gibibytes.

    • volumeName — (String)

      The name of the kdb volume that you want to use as writeable save-down storage for clusters.

  • azMode — (String)

    The number of availability zones you want to assign per cluster. This can be one of the following

    • SINGLE – Assigns one availability zone per cluster.

    • MULTI – Assigns all the availability zones per cluster.

    Possible values include:
    • "SINGLE"
    • "MULTI"
  • availabilityZoneId — (String)

    The availability zone identifiers for the requested regions.

  • tags — (map<String>)

    A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.

  • scalingGroupConfiguration — (map)

    The structure that stores the configuration details of a scaling group.

    • scalingGroupName — required — (String)

      A unique identifier for the kdb scaling group.

    • memoryLimit — (Integer)

      An optional hard limit on the amount of memory a kdb cluster can use.

    • memoryReservation — required — (Integer)

      A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.

    • nodeCount — required — (Integer)

      The number of kdb cluster nodes.

    • cpu — (Float)

      The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.

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:

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • status — (String)

      The status of cluster creation.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

      Possible values include:
      • "PENDING"
      • "CREATING"
      • "CREATE_FAILED"
      • "RUNNING"
      • "UPDATING"
      • "DELETING"
      • "DELETED"
      • "DELETE_FAILED"
    • statusReason — (String)

      The error message when a failed state occurs.

    • clusterName — (String)

      A unique name for the cluster.

    • clusterType — (String)

      Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Possible values include:
      • "HDB"
      • "RDB"
      • "GATEWAY"
      • "GP"
      • "TICKERPLANT"
    • tickerplantLogConfiguration — (map)

      A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

      • tickerplantLogVolumes — (Array<String>)

        The name of the volumes for tickerplant logs.

    • volumes — (Array<map>)

      A list of volumes mounted on the cluster.

      • volumeName — (String)

        A unique identifier for the volume.

      • volumeType — (String)

        The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

        Possible values include:
        • "NAS_1"
    • databases — (Array<map>)

      A list of databases that will be available for querying.

      • databaseName — required — (String)

        The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

      • cacheConfigurations — (Array<map>)

        Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

        • cacheType — required — (String)

          The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

          • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

        • dbPaths — required — (Array<String>)

          Specifies the portions of database that will be loaded into the cache for access.

        • dataviewName — (String)

          The name of the dataview to be used for caching historical data on disk.

      • changesetId — (String)

        A unique identifier of the changeset that is associated with the cluster.

      • dataviewName — (String)

        The name of the dataview to be used for caching historical data on disk.

      • dataviewConfiguration — (map)

        The configuration of the dataview to be used with specified cluster.

        • dataviewName — (String)

          The unique identifier of the dataview.

        • dataviewVersionId — (String)

          The version of the dataview corresponding to a given changeset.

        • changesetId — (String)

          A unique identifier for the changeset.

        • segmentConfigurations — (Array<map>)

          The db path and volume configuration for the segmented database.

          • dbPaths — required — (Array<String>)

            The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

          • volumeName — required — (String)

            The name of the volume where you want to add data.

          • onDemand — (Boolean)

            Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

    • cacheStorageConfigurations — (Array<map>)

      The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

      • type — required — (String)

        The type of cache storage. The valid values are:

        • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

        • CACHE_250 – This type provides at least 250 MB/s disk access throughput.

        • CACHE_12 – This type provides at least 12 MB/s disk access throughput.

        For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.

      • size — required — (Integer)

        The size of cache in Gigabytes.

    • autoScalingConfiguration — (map)

      The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

      • minNodeCount — (Integer)

        The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

      • maxNodeCount — (Integer)

        The highest number of nodes to scale. This value cannot be greater than 5.

      • autoScalingMetric — (String)

        The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

        Possible values include:
        • "CPU_UTILIZATION_PERCENTAGE"
      • metricTarget — (Float)

        The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

      • scaleInCooldownSeconds — (Float)

        The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

      • scaleOutCooldownSeconds — (Float)

        The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.

    • clusterDescription — (String)

      A description of the cluster.

    • capacityConfiguration — (map)

      A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

      • nodeType — (String)

        The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.

        You can only specify one of the following values:

        • kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.

        • kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.

        • kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.

        • kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.

        • kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.

        • kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.

        • kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.

      • nodeCount — (Integer)

        The number of instances running in a cluster.

    • releaseLabel — (String)

      A version of the FinSpace managed kdb to run.

    • vpcConfiguration — (map)

      Configuration details about the network where the Privatelink endpoint of the cluster resides.

      • vpcId — (String)

        The identifier of the VPC endpoint.

      • securityGroupIds — (Array<String>)

        The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.

      • subnetIds — (Array<String>)

        The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.

      • ipAddressType — (String)

        The IP address type for cluster network configuration parameters. The following type is available:

        • IP_V4 – IP address version 4

        Possible values include:
        • "IP_V4"
    • initializationScript — (String)

      Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

    • commandLineArguments — (Array<map>)

      Defines the key-value pairs to make them available inside the cluster.

      • key — (String)

        The name of the key.

      • value — (String)

        The value of the key.

    • code — (map)

      The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

      • s3Bucket — (String)

        A unique name for the S3 bucket.

      • s3Key — (String)

        The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

      • s3ObjectVersion — (String)

        The version of an S3 object.

    • executionRole — (String)

      An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

    • lastModifiedTimestamp — (Date)

      The last time that the cluster 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.

    • savedownStorageConfiguration — (map)

      The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

      • type — (String)

        The type of writeable storage space for temporarily storing your savedown data. The valid values are:

        • SDS01 – This type represents 3000 IOPS and io2 ebs volume type.

        Possible values include:
        • "SDS01"
      • size — (Integer)

        The size of temporary storage in gibibytes.

      • volumeName — (String)

        The name of the kdb volume that you want to use as writeable save-down storage for clusters.

    • azMode — (String)

      The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • availabilityZoneId — (String)

      The availability zone identifiers for the requested regions.

    • createdTimestamp — (Date)

      The timestamp at which the cluster 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.

    • scalingGroupConfiguration — (map)

      The structure that stores the configuration details of a scaling group.

      • scalingGroupName — required — (String)

        A unique identifier for the kdb scaling group.

      • memoryLimit — (Integer)

        An optional hard limit on the amount of memory a kdb cluster can use.

      • memoryReservation — required — (Integer)

        A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.

      • nodeCount — required — (Integer)

        The number of kdb cluster nodes.

      • cpu — (Float)

        The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.

Returns:

• (AWS.Request) —

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

var params = {
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxDatabase(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • databaseName — (String)

    The name of the kdb database.

  • description — (String)

    A description of the database.

  • tags — (map<String>)

    A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database

  • 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:

    • databaseName — (String)

      The name of the kdb database.

    • databaseArn — (String)

      The ARN identifier of the database.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • description — (String)

      A description of the database.

    • createdTimestamp — (Date)

      The timestamp at which the database is 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.

    • lastModifiedTimestamp — (Date)

      The last time that the database was updated 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.

Returns:

• (AWS.Request) —

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

var params = {
  azMode: SINGLE | MULTI, /* required */
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  dataviewName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  autoUpdate: true || false,
  availabilityZoneId: 'STRING_VALUE',
  changesetId: 'STRING_VALUE',
  description: 'STRING_VALUE',
  readWrite: true || false,
  segmentConfigurations: [
    {
      dbPaths: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      volumeName: 'STRING_VALUE', /* required */
      onDemand: true || false
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxDataview(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, where you want to create the dataview.

  • databaseName — (String)

    The name of the database where you want to create a dataview.

  • dataviewName — (String)

    A unique identifier for the dataview.

  • azMode — (String)

    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

    Possible values include:
    • "SINGLE"
    • "MULTI"
  • availabilityZoneId — (String)

    The identifier of the availability zones.

  • changesetId — (String)

    A unique identifier of the changeset that you want to use to ingest data.

  • segmentConfigurations — (Array<map>)

    The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

    • dbPaths — required — (Array<String>)

      The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

    • volumeName — required — (String)

      The name of the volume where you want to add data.

    • onDemand — (Boolean)

      Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

  • autoUpdate — (Boolean)

    The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

  • readWrite — (Boolean)

    The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.



    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.

    • You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview.

    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.

    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.

  • description — (String)

    A description of the dataview.

  • tags — (map<String>)

    A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

  • 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:

    • dataviewName — (String)

      A unique identifier for the dataview.

    • databaseName — (String)

      The name of the database where you want to create a dataview.

    • environmentId — (String)

      A unique identifier for the kdb environment, where you want to create the dataview.

    • azMode — (String)

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • availabilityZoneId — (String)

      The identifier of the availability zones.

    • changesetId — (String)

      A unique identifier for the changeset.

    • segmentConfigurations — (Array<map>)

      The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

      • dbPaths — required — (Array<String>)

        The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

      • volumeName — required — (String)

        The name of the volume where you want to add data.

      • onDemand — (Boolean)

        Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

    • description — (String)

      A description of the dataview.

    • autoUpdate — (Boolean)

      The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.

    • readWrite — (Boolean)

      Returns True if the dataview is created as writeable and False otherwise.

    • createdTimestamp — (Date)

      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.

    • lastModifiedTimestamp — (Date)

      The last time that the dataview was updated 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 dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "UPDATING"
      • "FAILED"
      • "DELETING"

Returns:

• (AWS.Request) —

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

var params = {
  kmsKeyId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxEnvironment(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 kdb environment that you want to create.

  • description — (String)

    A description for the kdb environment.

  • kmsKeyId — (String)

    The KMS key ID to encrypt your data in the FinSpace environment.

  • tags — (map<String>)

    A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

  • 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:

    • name — (String)

      The name of the kdb environment.

    • status — (String)

      The status of the kdb environment.

      Possible values include:
      • "CREATE_REQUESTED"
      • "CREATING"
      • "CREATED"
      • "DELETE_REQUESTED"
      • "DELETING"
      • "DELETED"
      • "FAILED_CREATION"
      • "RETRY_DELETION"
      • "FAILED_DELETION"
      • "UPDATE_NETWORK_REQUESTED"
      • "UPDATING_NETWORK"
      • "FAILED_UPDATING_NETWORK"
      • "SUSPENDED"
    • environmentId — (String)

      A unique identifier for the kdb environment.

    • description — (String)

      A description for the kdb environment.

    • environmentArn — (String)

      The ARN identifier of the environment.

    • kmsKeyId — (String)

      The KMS key ID to encrypt your data in the FinSpace environment.

    • creationTimestamp — (Date)

      The timestamp at which the kdb environment was created in FinSpace.

Returns:

• (AWS.Request) —

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

var params = {
  availabilityZoneId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  hostType: 'STRING_VALUE', /* required */
  scalingGroupName: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxScalingGroup(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.
  • environmentId — (String)

    A unique identifier for the kdb environment, where you want to create the scaling group.

  • scalingGroupName — (String)

    A unique identifier for the kdb scaling group.

  • hostType — (String)

    The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

    You can add one of the following values:

    • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

    • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

    • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

    • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

    • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

    • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

  • availabilityZoneId — (String)

    The identifier of the availability zones.

  • tags — (map<String>)

    A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling 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:

    • environmentId — (String)

      A unique identifier for the kdb environment, where you create the scaling group.

    • scalingGroupName — (String)

      A unique identifier for the kdb scaling group.

    • hostType — (String)

      The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

    • availabilityZoneId — (String)

      The identifier of the availability zones.

    • status — (String)

      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

      Possible values include:
      • "CREATING"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "DELETE_FAILED"
    • lastModifiedTimestamp — (Date)

      The last time that the scaling group was updated 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.

    • createdTimestamp — (Date)

      The timestamp at which the scaling group 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.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  iamRole: 'STRING_VALUE', /* required */
  userName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxUser(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment where you want to create a user.

  • userName — (String)

    A unique identifier for the user.

  • iamRole — (String)

    The IAM role ARN that will be associated with the user.

  • tags — (map<String>)

    A list of key-value pairs to label the user. You can add up to 50 tags to a 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:

    • userName — (String)

      A unique identifier for the user.

    • userArn — (String)

      The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • iamRole — (String)

      The IAM role ARN that will be associated with the user.

Returns:

• (AWS.Request) —

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

var params = {
  availabilityZoneIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  azMode: SINGLE | MULTI, /* required */
  environmentId: 'STRING_VALUE', /* required */
  volumeName: 'STRING_VALUE', /* required */
  volumeType: NAS_1, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  nas1Configuration: {
    size: 'NUMBER_VALUE',
    type: SSD_1000 | SSD_250 | HDD_12
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxVolume(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.
  • environmentId — (String)

    A unique identifier for the kdb environment, whose clusters can attach to the volume.

  • volumeType — (String)

    The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.

    Possible values include:
    • "NAS_1"
  • volumeName — (String)

    A unique identifier for the volume.

  • description — (String)

    A description of the volume.

  • nas1Configuration — (map)

    Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose volumeType as NAS_1.

    • type — (String)

      The type of the network attached storage.

      Possible values include:
      • "SSD_1000"
      • "SSD_250"
      • "HDD_12"
    • size — (Integer)

      The size of the network attached storage. For storage type SSD_1000 and SSD_250 you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB.

  • azMode — (String)

    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

    Possible values include:
    • "SINGLE"
    • "MULTI"
  • availabilityZoneIds — (Array<String>)

    The identifier of the availability zones.

  • tags — (map<String>)

    A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.

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:

    • environmentId — (String)

      A unique identifier for the kdb environment, whose clusters can attach to the volume.

    • volumeName — (String)

      A unique identifier for the volume.

    • volumeType — (String)

      The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

      Possible values include:
      • "NAS_1"
    • volumeArn — (String)

      The ARN identifier of the volume.

    • nas1Configuration — (map)

      Specifies the configuration for the Network attached storage (NAS_1) file system volume.

      • type — (String)

        The type of the network attached storage.

        Possible values include:
        • "SSD_1000"
        • "SSD_250"
        • "HDD_12"
      • size — (Integer)

        The size of the network attached storage. For storage type SSD_1000 and SSD_250 you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB.

    • status — (String)

      The status of volume creation.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

      Possible values include:
      • "CREATING"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "UPDATING"
      • "UPDATED"
      • "UPDATE_FAILED"
      • "DELETING"
      • "DELETED"
      • "DELETE_FAILED"
    • statusReason — (String)

      The error message when a failed state occurs.

    • azMode — (String)

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • description — (String)

      A description of the volume.

    • availabilityZoneIds — (Array<String>)

      The identifier of the availability zones.

    • createdTimestamp — (Date)

      The timestamp at which the volume 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.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
finspace.deleteEnvironment(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: {}) —
  • environmentId — (String)

    The identifier for the FinSpace environment.

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.

Returns:

• (AWS.Request) —

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

var params = {
  clusterName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspace.deleteKxCluster(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterName — (String)

    The name of the cluster 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.

Returns:

• (AWS.Request) —

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

var params = {
  clusterName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  nodeId: 'STRING_VALUE' /* required */
};
finspace.deleteKxClusterNode(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterName — (String)

    The name of the cluster, for which you want to delete the nodes.

  • nodeId — (String)

    A unique identifier for the node that you want to delete.

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.

Returns:

• (AWS.Request) —

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

var params = {
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.deleteKxDatabase(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • databaseName — (String)

    The name of the kdb database 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.

Returns:

• (AWS.Request) —

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

var params = {
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  dataviewName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.deleteKxDataview(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, from where you want to delete the dataview.

  • databaseName — (String)

    The name of the database whose dataview you want to delete.

  • dataviewName — (String)

    The name of the dataview 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.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspace.deleteKxEnvironment(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

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

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  scalingGroupName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspace.deleteKxScalingGroup(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, from where you want to delete the dataview.

  • scalingGroupName — (String)

    A unique identifier for the kdb scaling group.

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

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  userName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspace.deleteKxUser(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: {}) —
  • userName — (String)

    A unique identifier for the user that you want to delete.

  • environmentId — (String)

    A unique identifier for the kdb environment.

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

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  volumeName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
finspace.deleteKxVolume(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, whose clusters can attach to the volume.

  • volumeName — (String)

    The name of the volume 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.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
finspace.getEnvironment(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: {}) —
  • environmentId — (String)

    The identifier of the FinSpace environment.

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:

    • environment — (map)

      The name of the FinSpace environment.

      • name — (String)

        The name of the FinSpace environment.

      • environmentId — (String)

        The identifier of the FinSpace environment.

      • awsAccountId — (String)

        The ID of the AWS account in which the FinSpace environment is created.

      • status — (String)

        The current status of creation of the FinSpace environment.

        Possible values include:
        • "CREATE_REQUESTED"
        • "CREATING"
        • "CREATED"
        • "DELETE_REQUESTED"
        • "DELETING"
        • "DELETED"
        • "FAILED_CREATION"
        • "RETRY_DELETION"
        • "FAILED_DELETION"
        • "UPDATE_NETWORK_REQUESTED"
        • "UPDATING_NETWORK"
        • "FAILED_UPDATING_NETWORK"
        • "SUSPENDED"
      • environmentUrl — (String)

        The sign-in URL for the web application of your FinSpace environment.

      • description — (String)

        The description of the FinSpace environment.

      • environmentArn — (String)

        The Amazon Resource Name (ARN) of your FinSpace environment.

      • sageMakerStudioDomainUrl — (String)

        The URL of the integrated FinSpace notebook environment in your web application.

      • kmsKeyId — (String)

        The KMS key id used to encrypt in the FinSpace environment.

      • dedicatedServiceAccountId — (String)

        The AWS account ID of the dedicated service account associated with your FinSpace environment.

      • federationMode — (String)

        The authentication mode for the environment.

        Possible values include:
        • "FEDERATED"
        • "LOCAL"
      • federationParameters — (map)

        Configuration information when authentication mode is FEDERATED.

        • samlMetadataDocument — (String)

          SAML 2.0 Metadata document from identity provider (IdP).

        • samlMetadataURL — (String)

          Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

        • applicationCallBackURL — (String)

          The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

        • federationURN — (String)

          The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

        • federationProviderName — (String)

          Name of the identity provider (IdP).

        • attributeMap — (map<String>)

          SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Returns:

• (AWS.Request) —

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

var params = {
  changesetId: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.getKxChangeset(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • databaseName — (String)

    The name of the kdb database.

  • changesetId — (String)

    A unique identifier of the changeset for which you want to retrieve 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)

      A unique identifier for the changeset.

    • databaseName — (String)

      The name of the kdb database.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • changeRequests — (Array<map>)

      A list of change request objects that are run in order.

      • changeType — required — (String)

        Defines the type of change request. A changeType can have the following values:

        • PUT – Adds or updates files in a database.

        • DELETE – Deletes files in a database.

        Possible values include:
        • "PUT"
        • "DELETE"
      • s3Path — (String)

        Defines the S3 path of the source file that is required to add or update files in a database.

      • dbPath — required — (String)

        Defines the path within the database directory.

    • createdTimestamp — (Date)

      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.

    • activeFromTimestamp — (Date)

      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.

    • lastModifiedTimestamp — (Date)

      The timestamp at which the changeset was updated 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 creation process.

      • Pending – Changeset creation is pending.

      • Processing – Changeset creation is running.

      • Failed – Changeset creation has failed.

      • Complete – Changeset creation has succeeded.

      Possible values include:
      • "PENDING"
      • "PROCESSING"
      • "FAILED"
      • "COMPLETED"
    • errorInfo — (map)

      Provides details in the event of a failed flow, including the error type and the related error message.

      • errorMessage — (String)

        Specifies the error message that appears if a flow fails.

      • errorType — (String)

        Specifies the type of error.

        Possible values include:
        • "The inputs to this request are invalid."
        • "Service limits have been exceeded."
        • "Missing required permission to perform this request."
        • "One or more inputs to this request were not found."
        • "The system temporarily lacks sufficient resources to process the request."
        • "An internal error has occurred."
        • "Cancelled"
        • "A user recoverable error has occurred"

Returns:

• (AWS.Request) —

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

var params = {
  clusterName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.getKxCluster(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterName — (String)

    The name of the cluster that you want to retrieve.

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:

    • status — (String)

      The status of cluster creation.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

      Possible values include:
      • "PENDING"
      • "CREATING"
      • "CREATE_FAILED"
      • "RUNNING"
      • "UPDATING"
      • "DELETING"
      • "DELETED"
      • "DELETE_FAILED"
    • statusReason — (String)

      The error message when a failed state occurs.

    • clusterName — (String)

      A unique name for the cluster.

    • clusterType — (String)

      Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Possible values include:
      • "HDB"
      • "RDB"
      • "GATEWAY"
      • "GP"
      • "TICKERPLANT"
    • tickerplantLogConfiguration — (map)

      A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

      • tickerplantLogVolumes — (Array<String>)

        The name of the volumes for tickerplant logs.

    • volumes — (Array<map>)

      A list of volumes attached to the cluster.

      • volumeName — (String)

        A unique identifier for the volume.

      • volumeType — (String)

        The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

        Possible values include:
        • "NAS_1"
    • databases — (Array<map>)

      A list of databases mounted on the cluster.

      • databaseName — required — (String)

        The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

      • cacheConfigurations — (Array<map>)

        Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

        • cacheType — required — (String)

          The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

          • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

        • dbPaths — required — (Array<String>)

          Specifies the portions of database that will be loaded into the cache for access.

        • dataviewName — (String)

          The name of the dataview to be used for caching historical data on disk.

      • changesetId — (String)

        A unique identifier of the changeset that is associated with the cluster.

      • dataviewName — (String)

        The name of the dataview to be used for caching historical data on disk.

      • dataviewConfiguration — (map)

        The configuration of the dataview to be used with specified cluster.

        • dataviewName — (String)

          The unique identifier of the dataview.

        • dataviewVersionId — (String)

          The version of the dataview corresponding to a given changeset.

        • changesetId — (String)

          A unique identifier for the changeset.

        • segmentConfigurations — (Array<map>)

          The db path and volume configuration for the segmented database.

          • dbPaths — required — (Array<String>)

            The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

          • volumeName — required — (String)

            The name of the volume where you want to add data.

          • onDemand — (Boolean)

            Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

    • cacheStorageConfigurations — (Array<map>)

      The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

      • type — required — (String)

        The type of cache storage. The valid values are:

        • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

        • CACHE_250 – This type provides at least 250 MB/s disk access throughput.

        • CACHE_12 – This type provides at least 12 MB/s disk access throughput.

        For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.

      • size — required — (Integer)

        The size of cache in Gigabytes.

    • autoScalingConfiguration — (map)

      The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

      • minNodeCount — (Integer)

        The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

      • maxNodeCount — (Integer)

        The highest number of nodes to scale. This value cannot be greater than 5.

      • autoScalingMetric — (String)

        The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

        Possible values include:
        • "CPU_UTILIZATION_PERCENTAGE"
      • metricTarget — (Float)

        The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

      • scaleInCooldownSeconds — (Float)

        The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

      • scaleOutCooldownSeconds — (Float)

        The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.

    • clusterDescription — (String)

      A description of the cluster.

    • capacityConfiguration — (map)

      A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

      • nodeType — (String)

        The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.

        You can only specify one of the following values:

        • kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.

        • kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.

        • kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.

        • kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.

        • kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.

        • kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.

        • kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.

      • nodeCount — (Integer)

        The number of instances running in a cluster.

    • releaseLabel — (String)

      The version of FinSpace managed kdb to run.

    • vpcConfiguration — (map)

      Configuration details about the network where the Privatelink endpoint of the cluster resides.

      • vpcId — (String)

        The identifier of the VPC endpoint.

      • securityGroupIds — (Array<String>)

        The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.

      • subnetIds — (Array<String>)

        The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.

      • ipAddressType — (String)

        The IP address type for cluster network configuration parameters. The following type is available:

        • IP_V4 – IP address version 4

        Possible values include:
        • "IP_V4"
    • initializationScript — (String)

      Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

    • commandLineArguments — (Array<map>)

      Defines key-value pairs to make them available inside the cluster.

      • key — (String)

        The name of the key.

      • value — (String)

        The value of the key.

    • code — (map)

      The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

      • s3Bucket — (String)

        A unique name for the S3 bucket.

      • s3Key — (String)

        The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

      • s3ObjectVersion — (String)

        The version of an S3 object.

    • executionRole — (String)

      An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

    • lastModifiedTimestamp — (Date)

      The last time that the cluster 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.

    • savedownStorageConfiguration — (map)

      The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

      • type — (String)

        The type of writeable storage space for temporarily storing your savedown data. The valid values are:

        • SDS01 – This type represents 3000 IOPS and io2 ebs volume type.

        Possible values include:
        • "SDS01"
      • size — (Integer)

        The size of temporary storage in gibibytes.

      • volumeName — (String)

        The name of the kdb volume that you want to use as writeable save-down storage for clusters.

    • azMode — (String)

      The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • availabilityZoneId — (String)

      The availability zone identifiers for the requested regions.

    • createdTimestamp — (Date)

      The timestamp at which the cluster 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.

    • scalingGroupConfiguration — (map)

      The structure that stores the capacity configuration details of a scaling group.

      • scalingGroupName — required — (String)

        A unique identifier for the kdb scaling group.

      • memoryLimit — (Integer)

        An optional hard limit on the amount of memory a kdb cluster can use.

      • memoryReservation — required — (Integer)

        A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.

      • nodeCount — required — (Integer)

        The number of kdb cluster nodes.

      • cpu — (Float)

        The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.

Returns:

• (AWS.Request) —

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

var params = {
  clusterName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  userArn: 'STRING_VALUE' /* required */
};
finspace.getKxConnectionString(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: {}) —
  • userArn — (String)

    The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterName — (String)

    A name of the kdb cluster.

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:

    • signedConnectionString — (String)

      The signed connection string that you can use to connect to clusters.

Returns:

• (AWS.Request) —

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

var params = {
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.getKxDatabase(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • databaseName — (String)

    The name of the kdb database.

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:

    • databaseName — (String)

      The name of the kdb database for which the information is retrieved.

    • databaseArn — (String)

      The ARN identifier of the database.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • description — (String)

      A description of the database.

    • createdTimestamp — (Date)

      The timestamp at which the database is 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.

    • lastModifiedTimestamp — (Date)

      The last time that the database 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.

    • lastCompletedChangesetId — (String)

      A unique identifier for the changeset.

    • numBytes — (Integer)

      The total number of bytes in the database.

    • numChangesets — (Integer)

      The total number of changesets in the database.

    • numFiles — (Integer)

      The total number of files in the database.

Returns:

• (AWS.Request) —

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

var params = {
  databaseName: 'STRING_VALUE', /* required */
  dataviewName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.getKxDataview(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

  • databaseName — (String)

    The name of the database where you created the dataview.

  • dataviewName — (String)

    A unique identifier for 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:

    • databaseName — (String)

      The name of the database where you created the dataview.

    • dataviewName — (String)

      A unique identifier for the dataview.

    • azMode — (String)

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • availabilityZoneId — (String)

      The identifier of the availability zones.

    • changesetId — (String)

      A unique identifier of the changeset that you want to use to ingest data.

    • segmentConfigurations — (Array<map>)

      The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

      • dbPaths — required — (Array<String>)

        The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

      • volumeName — required — (String)

        The name of the volume where you want to add data.

      • onDemand — (Boolean)

        Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

    • activeVersions — (Array<map>)

      The current active changeset versions of the database on the given dataview.

      • changesetId — (String)

        A unique identifier for the changeset.

      • segmentConfigurations — (Array<map>)

        The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

        • dbPaths — required — (Array<String>)

          The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

        • volumeName — required — (String)

          The name of the volume where you want to add data.

        • onDemand — (Boolean)

          Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

      • attachedClusters — (Array<String>)

        The list of clusters that are currently using this dataview.

      • createdTimestamp — (Date)

        The timestamp at which the dataview version was 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.

      • versionId — (String)

        A unique identifier of the active version.

    • description — (String)

      A description of the dataview.

    • autoUpdate — (Boolean)

      The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

    • readWrite — (Boolean)

      Returns True if the dataview is created as writeable and False otherwise.

    • environmentId — (String)

      A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

    • createdTimestamp — (Date)

      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.

    • lastModifiedTimestamp — (Date)

      The last time that the dataview was updated 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 dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "UPDATING"
      • "FAILED"
      • "DELETING"
    • statusReason — (String)

      The error message when a failed state occurs.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE' /* required */
};
finspace.getKxEnvironment(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

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:

    • name — (String)

      The name of the kdb environment.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • awsAccountId — (String)

      The unique identifier of the AWS account that is used to create the kdb environment.

    • status — (String)

      The status of the kdb environment.

      Possible values include:
      • "CREATE_REQUESTED"
      • "CREATING"
      • "CREATED"
      • "DELETE_REQUESTED"
      • "DELETING"
      • "DELETED"
      • "FAILED_CREATION"
      • "RETRY_DELETION"
      • "FAILED_DELETION"
      • "UPDATE_NETWORK_REQUESTED"
      • "UPDATING_NETWORK"
      • "FAILED_UPDATING_NETWORK"
      • "SUSPENDED"
    • tgwStatus — (String)

      The status of the network configuration.

      Possible values include:
      • "NONE"
      • "UPDATE_REQUESTED"
      • "UPDATING"
      • "FAILED_UPDATE"
      • "SUCCESSFULLY_UPDATED"
    • dnsStatus — (String)

      The status of DNS configuration.

      Possible values include:
      • "NONE"
      • "UPDATE_REQUESTED"
      • "UPDATING"
      • "FAILED_UPDATE"
      • "SUCCESSFULLY_UPDATED"
    • errorMessage — (String)

      Specifies the error message that appears if a flow fails.

    • description — (String)

      A description for the kdb environment.

    • environmentArn — (String)

      The ARN identifier of the environment.

    • kmsKeyId — (String)

      The KMS key ID to encrypt your data in the FinSpace environment.

    • dedicatedServiceAccountId — (String)

      A unique identifier for the AWS environment infrastructure account.

    • transitGatewayConfiguration — (map)

      The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

      • transitGatewayID — required — (String)

        The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.

      • routableCIDRSpace — required — (String)

        The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.

      • attachmentNetworkAclConfiguration — (Array<map>)

        The rules that define how you manage the outbound traffic from kdb network to your internal network.

        • ruleNumber — required — (Integer)

          The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.

        • protocol — required — (String)

          The protocol number. A value of -1 means all the protocols.

        • ruleAction — required — (String)

          Indicates whether to allow or deny the traffic that matches the rule.

          Possible values include:
          • "allow"
          • "deny"
        • portRange — (map)

          The range of ports the rule applies to.

          • from — required — (Integer)

            The first port in the range.

          • to — required — (Integer)

            The last port in the range.

        • icmpTypeCode — (map)

          Defines the ICMP protocol that consists of the ICMP type and code.

          • type — required — (Integer)

            The ICMP type. A value of -1 means all types.

          • code — required — (Integer)

            The ICMP code. A value of -1 means all codes for the specified ICMP type.

        • cidrBlock — required — (String)

          The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

    • customDNSConfiguration — (Array<map>)

      A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

      • customDNSServerName — required — (String)

        The name of the DNS server.

      • customDNSServerIP — required — (String)

        The IP address of the DNS server.

    • creationTimestamp — (Date)

      The timestamp at which the kdb environment was created in FinSpace.

    • updateTimestamp — (Date)

      The timestamp at which the kdb environment was updated.

    • availabilityZoneIds — (Array<String>)

      The identifier of the availability zones where subnets for the environment are created.

    • certificateAuthorityArn — (String)

      The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  scalingGroupName: 'STRING_VALUE' /* required */
};
finspace.getKxScalingGroup(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • scalingGroupName — (String)

    A unique identifier for the kdb scaling 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:

    • scalingGroupName — (String)

      A unique identifier for the kdb scaling group.

    • scalingGroupArn — (String)

      The ARN identifier for the scaling group.

    • hostType — (String)

      The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

      It can have one of the following values:

      • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

      • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

      • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

      • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

      • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

      • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

    • clusters — (Array<String>)

      The list of Managed kdb clusters that are currently active in the given scaling group.

    • availabilityZoneId — (String)

      The identifier of the availability zones.

    • status — (String)

      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

      Possible values include:
      • "CREATING"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
      • "DELETE_FAILED"
    • statusReason — (String)

      The error message when a failed state occurs.

    • lastModifiedTimestamp — (Date)

      The last time that the scaling group was updated 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.

    • createdTimestamp — (Date)

      The timestamp at which the scaling group 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.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  userName: 'STRING_VALUE' /* required */
};
finspace.getKxUser(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: {}) —
  • userName — (String)

    A unique identifier for the user.

  • environmentId — (String)

    A unique identifier for the kdb environment.

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:

    • userName — (String)

      A unique identifier for the user.

    • userArn — (String)

      The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

    • environmentId — (String)

      A unique identifier for the kdb environment.

    • iamRole — (String)

      The IAM role ARN that is associated with the user.

Returns:

• (AWS.Request) —

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

var params = {
  environmentId: 'STRING_VALUE', /* required */
  volumeName: 'STRING_VALUE' /* required */
};
finspace.getKxVolume(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, whose clusters can attach to the volume.

  • volumeName — (String)

    A unique identifier for the volume.

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:

    • environmentId — (String)

      A unique identifier for the kdb environment, whose clusters can attach to the volume.

    • volumeName — (String)

      A unique identifier for the volume.

    • volumeType — (String)

      The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

      Possible values include:
      • "NAS_1"
    • volumeArn — (String)

      The ARN identifier of the volume.

    • nas1Configuration — (map)

      Specifies the configuration for the Network attached storage (NAS_1) file system volume.

      • type — (String)

        The type of the network attached storage.

        Possible values include:
        • "SSD_1000"
        • "SSD_250"
        • "HDD_12"
      • size — (Integer)

        The size of the network attached storage. For storage type SSD_1000 and SSD_250 you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB.

    • status — (String)

      The status of volume creation.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

      Possible values include:
      • "CREATING"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "UPDATING"
      • "UPDATED"
      • "UPDATE_FAILED"
      • "DELETING"
      • "DELETED"
      • "DELETE_FAILED"
    • statusReason — (String)

      The error message when a failed state occurs.

    • createdTimestamp — (Date)

      The timestamp at which the volume 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.

    • description — (String)

      A description of the volume.

    • azMode — (String)

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • availabilityZoneIds — (Array<String>)

      The identifier of the availability zones.

    • lastModifiedTimestamp — (Date)

      The last time that the volume was updated 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.

    • attachedClusters — (Array<map>)

      A list of cluster identifiers that a volume is attached to.

      • clusterName — (String)

        A unique name for the attached cluster.

      • clusterType — (String)

        Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

        Possible values include:
        • "HDB"
        • "RDB"
        • "GATEWAY"
        • "GP"
        • "TICKERPLANT"
      • clusterStatus — (String)

        The status of the attached cluster.

        • PENDING – The cluster is pending creation.

        • CREATING – The cluster creation process is in progress.

        • CREATE_FAILED – The cluster creation process has failed.

        • RUNNING – The cluster creation process is running.

        • UPDATING – The cluster is in the process of being updated.

        • DELETING – The cluster is in the process of being deleted.

        • DELETED – The cluster has been deleted.

        • DELETE_FAILED – The cluster failed to delete.

        Possible values include:
        • "PENDING"
        • "CREATING"
        • "CREATE_FAILED"
        • "RUNNING"
        • "UPDATING"
        • "DELETING"
        • "DELETED"
        • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspace.listEnvironments(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 generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the response object of the previous page call.

  • maxResults — (Integer)

    The maximum number of results to return in this request.

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:

    • environments — (Array<map>)

      A list of all of your FinSpace environments.

      • name — (String)

        The name of the FinSpace environment.

      • environmentId — (String)

        The identifier of the FinSpace environment.

      • awsAccountId — (String)

        The ID of the AWS account in which the FinSpace environment is created.

      • status — (String)

        The current status of creation of the FinSpace environment.

        Possible values include:
        • "CREATE_REQUESTED"
        • "CREATING"
        • "CREATED"
        • "DELETE_REQUESTED"
        • "DELETING"
        • "DELETED"
        • "FAILED_CREATION"
        • "RETRY_DELETION"
        • "FAILED_DELETION"
        • "UPDATE_NETWORK_REQUESTED"
        • "UPDATING_NETWORK"
        • "FAILED_UPDATING_NETWORK"
        • "SUSPENDED"
      • environmentUrl — (String)

        The sign-in URL for the web application of your FinSpace environment.

      • description — (String)

        The description of the FinSpace environment.

      • environmentArn — (String)

        The Amazon Resource Name (ARN) of your FinSpace environment.

      • sageMakerStudioDomainUrl — (String)

        The URL of the integrated FinSpace notebook environment in your web application.

      • kmsKeyId — (String)

        The KMS key id used to encrypt in the FinSpace environment.

      • dedicatedServiceAccountId — (String)

        The AWS account ID of the dedicated service account associated with your FinSpace environment.

      • federationMode — (String)

        The authentication mode for the environment.

        Possible values include:
        • "FEDERATED"
        • "LOCAL"
      • federationParameters — (map)

        Configuration information when authentication mode is FEDERATED.

        • samlMetadataDocument — (String)

          SAML 2.0 Metadata document from identity provider (IdP).

        • samlMetadataURL — (String)

          Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

        • applicationCallBackURL — (String)

          The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

        • federationURN — (String)

          The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

        • federationProviderName — (String)

          Name of the identity provider (IdP).

        • attributeMap — (map<String>)

          SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

    • nextToken — (String)

      A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspace.listKxChangesets(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • databaseName — (String)

    The name of the kdb database.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results to return in this request.

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:

    • kxChangesets — (Array<map>)

      A list of changesets for a database.

      • changesetId — (String)

        A unique identifier for the changeset.

      • createdTimestamp — (Date)

        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.

      • activeFromTimestamp — (Date)

        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.

      • lastModifiedTimestamp — (Date)

        The timestamp at which the changeset 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.

      • status — (String)

        Status of the changeset.

        • Pending – Changeset creation is pending.

        • Processing – Changeset creation is running.

        • Failed – Changeset creation has failed.

        • Complete – Changeset creation has succeeded.

        Possible values include:
        • "PENDING"
        • "PROCESSING"
        • "FAILED"
        • "COMPLETED"
    • 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 = {
  clusterName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspace.listKxClusterNodes(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterName — (String)

    A unique name for the cluster.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results to return in this request.

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:

    • nodes — (Array<map>)

      A list of nodes associated with the cluster.

      • nodeId — (String)

        A unique identifier for the node.

      • availabilityZoneId — (String)

        The identifier of the availability zones where subnets for the environment are created.

      • launchTime — (Date)

        The time when a particular node is started. 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)

        Specifies the status of the cluster nodes.

        • RUNNING – The node is actively serving.

        • PROVISIONING – The node is being prepared.

        Possible values include:
        • "RUNNING"
        • "PROVISIONING"
    • 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 = {
  environmentId: 'STRING_VALUE', /* required */
  clusterType: HDB | RDB | GATEWAY | GP | TICKERPLANT,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspace.listKxClusters(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • clusterType — (String)

    Specifies the type of KDB database that is being created. The following types are available:

    • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

    • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

    • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

    • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

    • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

    Possible values include:
    • "HDB"
    • "RDB"
    • "GATEWAY"
    • "GP"
    • "TICKERPLANT"
  • maxResults — (Integer)

    The maximum number of results to return in this request.

  • 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:

    • kxClusterSummaries — (Array<map>)

      Lists the cluster details.

      • status — (String)

        The status of a cluster.

        • PENDING – The cluster is pending creation.

        • CREATING –The cluster creation process is in progress.

        • CREATE_FAILED– The cluster creation process has failed.

        • RUNNING – The cluster creation process is running.

        • UPDATING – The cluster is in the process of being updated.

        • DELETING – The cluster is in the process of being deleted.

        • DELETED – The cluster has been deleted.

        • DELETE_FAILED – The cluster failed to delete.

        Possible values include:
        • "PENDING"
        • "CREATING"
        • "CREATE_FAILED"
        • "RUNNING"
        • "UPDATING"
        • "DELETING"
        • "DELETED"
        • "DELETE_FAILED"
      • statusReason — (String)

        The error message when a failed state occurs.

      • clusterName — (String)

        A unique name for the cluster.

      • clusterType — (String)

        Specifies the type of KDB database that is being created. The following types are available:

        • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

        • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

        • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

        • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

        • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

        Possible values include:
        • "HDB"
        • "RDB"
        • "GATEWAY"
        • "GP"
        • "TICKERPLANT"
      • clusterDescription — (String)

        A description of the cluster.

      • releaseLabel — (String)

        A version of the FinSpace managed kdb to run.

      • volumes — (Array<map>)

        A list of volumes attached to the cluster.

        • volumeName — (String)

          A unique identifier for the volume.

        • volumeType — (String)

          The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

          Possible values include:
          • "NAS_1"
      • initializationScript — (String)

        Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

      • executionRole — (String)

        An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

      • azMode — (String)

        The number of availability zones assigned per cluster. This can be one of the following:

        • SINGLE – Assigns one availability zone per cluster.

        • MULTI – Assigns all the availability zones per cluster.

        Possible values include:
        • "SINGLE"
        • "MULTI"
      • availabilityZoneId — (String)

        The availability zone identifiers for the requested regions.

      • lastModifiedTimestamp — (Date)

        The last time that the cluster 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.

      • createdTimestamp — (Date)

        The timestamp at which the cluster 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.

    • 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 = {
  environmentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspace.listKxDatabases(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results to return in this request.

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:

    • kxDatabases — (Array<map>)

      A list of databases in the kdb environment.

      • databaseName — (String)

        The name of the kdb database.

      • createdTimestamp — (Date)

        The timestamp at which the database 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.

      • lastModifiedTimestamp — (Date)

        The last time that the database 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.

    • 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 = {
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
finspace.listKxDataviews(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: {}) —
  • environmentId — (String)

    A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.

  • databaseName — (String)

    The name of the database where the dataviews were created.

  • nextToken — (String)

    A token that indicates where a results page should begin.

  • maxResults — (Integer)

    The maximum number of results to return in this request.

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:

    • kxDataviews — (Array<map>)

      The list of kdb dataviews that are currently active for the given database.

      • environmentId — (String)

        A unique identifier for the kdb environment.

      • databaseName — (String)

        A unique identifier of the database.

      • dataviewName — (String)

        A unique identifier of the dataview.

      • azMode — (String)

        The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

        Possible values include:
        • "SINGLE"
        • "MULTI"
      • availabilityZoneId — (String)

        The identifier of the availability zones.

      • changesetId — (String)

        A unique identifier for the changeset.

      • segmentConfigurations — (Array<map>)

        The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

        • dbPaths — required — (Array<String>)

          The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

        • volumeName — required — (String)

          The name of the volume where you want to add data.

        • onDemand — (Boolean)

          Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

      • activeVersions — (Array<map>)

        The active changeset versions for the given dataview entry.

        • changesetId — (String)

          A unique identifier for the changeset.

        • segmentConfigurations — (Array<map>)

          The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

          • dbPaths — required — (Array<String>)

            The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

          • volumeName — required — (String)

            The name of the volume where you want to add data.

          • onDemand — (Boolean)

            Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

        • attachedClusters — (Array<String>)

          The list of clusters that are currently using this dataview.

        • createdTimestamp — (Date)

          The timestamp at which the dataview version was 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.

        • versionId — (String)

          A unique identifier of the active version.

      • status — (String)

        The status of a given dataview entry.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "FAILED"
        • "DELETING"
      • description — (String)

        A description for the dataview list entry.

      • autoUpdate — (Boolean)

        The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.

      • readWrite — (Boolean)

        Returns True if the dataview is created as writeable and False otherwise.

      • createdTimestamp — (Date)

        The timestamp at which the dataview list entry 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.

      • lastModifiedTimestamp — (Date)

        The last time that the dataview list was updated 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.

      • statusReason — (String)

        The error message when a failed state occurs.

    • 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'
};
finspace.listKxEnvironments(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 to return in this request.

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:

    • environments — (Array<map>)

      A list of environments in an account.

      • name — (String)

        The name of the kdb environment.

      • environmentId — (String)

        A unique identifier for the kdb environment.

      • awsAccountId — (String)

        The unique identifier of the AWS account in which you create the kdb environment.

      • status — (String)

        The status of the environment creation.

        • CREATE_REQUESTED – Environment creation has been requested.

        • CREATING – Environment is in the process of being created.

        • FAILED_CREATION – Environment creation has failed.

        • CREATED – Environment is successfully created and is currently active.

        • DELETE REQUESTED – Environment deletion has been requested.

        • DELETING – Environment is in the process of being deleted.

        • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

        • DELETED – Environment has been deleted.

        • FAILED_DELETION – Environment deletion has failed.

        Possible values include:
        • "CREATE_REQUESTED"
        • "CREATING"
        • "CREATED"
        • "DELETE_REQUESTED"
        • "DELETING"
        • "DELETED"
        • "FAILED_CREATION"
        • "RETRY_DELETION"
        • "FAILED_DELETION"
        • "UPDATE_NETWORK_REQUESTED"
        • "UPDATING_NETWORK"
        • "FAILED_UPDATING_NETWORK"
        • "SUSPENDED"
      • tgwStatus — (String)

        The status of the network configuration.

        Possible values include:
        • "NONE"
        • "UPDATE_REQUESTED"
        • "UPDATING"
        • "FAILED_UPDATE"
        • "SUCCESSFULLY_UPDATED"
      • dnsStatus — (String)

        The status of DNS configuration.

        Possible values include:
        • "NONE"
        • "UPDATE_REQUESTED"
        • "UPDATING"
        • "FAILED_UPDATE"
        • "SUCCESSFULLY_UPDATED"
      • errorMessage — (String)

        Specifies the error message that appears if a flow fails.

      • description — (String)

        A description of the kdb environment.

      • environmentArn — (String)

        The Amazon Resource Name (ARN) of your kdb environment.

      • kmsKeyId — (String)

        The unique identifier of the KMS key.

      • dedicatedServiceAccountId — (String)

        A unique identifier for the AWS environment infrastructure account.

      • transitGatewayConfiguration — (map)

        Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

        • transitGatewayID — required — (String)

          The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.

        • routableCIDRSpace — required — (String)

          The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.

        • attachmentNetworkAclConfiguration — (Array<map>)

          The rules that define how you manage the outbound traffic from kdb network to your internal network.

          • ruleNumber — required — (Integer)

            The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.

          • protocol — required — (String)

            The protocol number. A value of -1 means all the protocols.

          • ruleAction — required — (String)

            Indicates whether to allow or deny the traffic that matches the rule.

            Possible values include:
            • "allow"
            • "deny"
          • portRange — (map)

            The range of ports the rule applies to.

            • from — required — (Integer)

              The first port in the range.

            • to — required — (Integer)

              The last port in the range.

          • icmpTypeCode — (map)

            Defines the ICMP protocol that consists of the ICMP type and code.

            • type — required — (Integer)

              The ICMP type. A value of -1 means all types.

            • code — required — (Integer)

              The ICMP code. A value of -1 means all codes for the specified ICMP type.

          • cidrBlock — required — (String)

            The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

      • customDNSConfiguration — (Array<map>)

        A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

        • customDNSServerName — required — (String)

          The name of the DNS server.

        • customDNSServerIP — required — (String)

          The IP address of the DNS server.

      • creationTimestamp — (Date)

        The timestamp at which the kdb environment 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.

      • updateTimestamp — (Date)

        The timestamp at which the kdb environment was modified 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.

      • availabilityZoneIds — (Array<String>)

        The identifier of the availability zones where subnets for the environment are created.

      • certificateAuthorityArn — (String)

        The Amazon Resource Name (ARN) of the certificate authority:

    • nextToken — (String)

      A token that indicates where a results page should begin.