aws-sdk
Version:
AWS SDK for JavaScript
753 lines • 159 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Finspace extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Finspace.Types.ClientConfiguration)
config: Config & Finspace.Types.ClientConfiguration;
/**
* Create a new FinSpace environment.
*/
createEnvironment(params: Finspace.Types.CreateEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.CreateEnvironmentResponse) => void): Request<Finspace.Types.CreateEnvironmentResponse, AWSError>;
/**
* Create a new FinSpace environment.
*/
createEnvironment(callback?: (err: AWSError, data: Finspace.Types.CreateEnvironmentResponse) => void): Request<Finspace.Types.CreateEnvironmentResponse, AWSError>;
/**
* Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
*/
createKxChangeset(params: Finspace.Types.CreateKxChangesetRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxChangesetResponse) => void): Request<Finspace.Types.CreateKxChangesetResponse, AWSError>;
/**
* Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
*/
createKxChangeset(callback?: (err: AWSError, data: Finspace.Types.CreateKxChangesetResponse) => void): Request<Finspace.Types.CreateKxChangesetResponse, AWSError>;
/**
* Creates a new kdb cluster.
*/
createKxCluster(params: Finspace.Types.CreateKxClusterRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxClusterResponse) => void): Request<Finspace.Types.CreateKxClusterResponse, AWSError>;
/**
* Creates a new kdb cluster.
*/
createKxCluster(callback?: (err: AWSError, data: Finspace.Types.CreateKxClusterResponse) => void): Request<Finspace.Types.CreateKxClusterResponse, AWSError>;
/**
* Creates a new kdb database in the environment.
*/
createKxDatabase(params: Finspace.Types.CreateKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxDatabaseResponse) => void): Request<Finspace.Types.CreateKxDatabaseResponse, AWSError>;
/**
* Creates a new kdb database in the environment.
*/
createKxDatabase(callback?: (err: AWSError, data: Finspace.Types.CreateKxDatabaseResponse) => void): Request<Finspace.Types.CreateKxDatabaseResponse, AWSError>;
/**
* Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
*/
createKxDataview(params: Finspace.Types.CreateKxDataviewRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxDataviewResponse) => void): Request<Finspace.Types.CreateKxDataviewResponse, AWSError>;
/**
* Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
*/
createKxDataview(callback?: (err: AWSError, data: Finspace.Types.CreateKxDataviewResponse) => void): Request<Finspace.Types.CreateKxDataviewResponse, AWSError>;
/**
* Creates a managed kdb environment for the account.
*/
createKxEnvironment(params: Finspace.Types.CreateKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxEnvironmentResponse) => void): Request<Finspace.Types.CreateKxEnvironmentResponse, AWSError>;
/**
* Creates a managed kdb environment for the account.
*/
createKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.CreateKxEnvironmentResponse) => void): Request<Finspace.Types.CreateKxEnvironmentResponse, AWSError>;
/**
* Creates a new scaling group.
*/
createKxScalingGroup(params: Finspace.Types.CreateKxScalingGroupRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxScalingGroupResponse) => void): Request<Finspace.Types.CreateKxScalingGroupResponse, AWSError>;
/**
* Creates a new scaling group.
*/
createKxScalingGroup(callback?: (err: AWSError, data: Finspace.Types.CreateKxScalingGroupResponse) => void): Request<Finspace.Types.CreateKxScalingGroupResponse, AWSError>;
/**
* Creates a user in FinSpace kdb environment with an associated IAM role.
*/
createKxUser(params: Finspace.Types.CreateKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxUserResponse) => void): Request<Finspace.Types.CreateKxUserResponse, AWSError>;
/**
* Creates a user in FinSpace kdb environment with an associated IAM role.
*/
createKxUser(callback?: (err: AWSError, data: Finspace.Types.CreateKxUserResponse) => void): Request<Finspace.Types.CreateKxUserResponse, AWSError>;
/**
* Creates a new volume with a specific amount of throughput and storage capacity.
*/
createKxVolume(params: Finspace.Types.CreateKxVolumeRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxVolumeResponse) => void): Request<Finspace.Types.CreateKxVolumeResponse, AWSError>;
/**
* Creates a new volume with a specific amount of throughput and storage capacity.
*/
createKxVolume(callback?: (err: AWSError, data: Finspace.Types.CreateKxVolumeResponse) => void): Request<Finspace.Types.CreateKxVolumeResponse, AWSError>;
/**
* Delete an FinSpace environment.
*/
deleteEnvironment(params: Finspace.Types.DeleteEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteEnvironmentResponse) => void): Request<Finspace.Types.DeleteEnvironmentResponse, AWSError>;
/**
* Delete an FinSpace environment.
*/
deleteEnvironment(callback?: (err: AWSError, data: Finspace.Types.DeleteEnvironmentResponse) => void): Request<Finspace.Types.DeleteEnvironmentResponse, AWSError>;
/**
* Deletes a kdb cluster.
*/
deleteKxCluster(params: Finspace.Types.DeleteKxClusterRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxClusterResponse) => void): Request<Finspace.Types.DeleteKxClusterResponse, AWSError>;
/**
* Deletes a kdb cluster.
*/
deleteKxCluster(callback?: (err: AWSError, data: Finspace.Types.DeleteKxClusterResponse) => void): Request<Finspace.Types.DeleteKxClusterResponse, AWSError>;
/**
* Deletes the specified nodes from a cluster.
*/
deleteKxClusterNode(params: Finspace.Types.DeleteKxClusterNodeRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxClusterNodeResponse) => void): Request<Finspace.Types.DeleteKxClusterNodeResponse, AWSError>;
/**
* Deletes the specified nodes from a cluster.
*/
deleteKxClusterNode(callback?: (err: AWSError, data: Finspace.Types.DeleteKxClusterNodeResponse) => void): Request<Finspace.Types.DeleteKxClusterNodeResponse, AWSError>;
/**
* Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
*/
deleteKxDatabase(params: Finspace.Types.DeleteKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxDatabaseResponse) => void): Request<Finspace.Types.DeleteKxDatabaseResponse, AWSError>;
/**
* Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
*/
deleteKxDatabase(callback?: (err: AWSError, data: Finspace.Types.DeleteKxDatabaseResponse) => void): Request<Finspace.Types.DeleteKxDatabaseResponse, AWSError>;
/**
* Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
*/
deleteKxDataview(params: Finspace.Types.DeleteKxDataviewRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxDataviewResponse) => void): Request<Finspace.Types.DeleteKxDataviewResponse, AWSError>;
/**
* Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
*/
deleteKxDataview(callback?: (err: AWSError, data: Finspace.Types.DeleteKxDataviewResponse) => void): Request<Finspace.Types.DeleteKxDataviewResponse, AWSError>;
/**
* Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
*/
deleteKxEnvironment(params: Finspace.Types.DeleteKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxEnvironmentResponse) => void): Request<Finspace.Types.DeleteKxEnvironmentResponse, AWSError>;
/**
* Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
*/
deleteKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.DeleteKxEnvironmentResponse) => void): Request<Finspace.Types.DeleteKxEnvironmentResponse, AWSError>;
/**
* Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
*/
deleteKxScalingGroup(params: Finspace.Types.DeleteKxScalingGroupRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxScalingGroupResponse) => void): Request<Finspace.Types.DeleteKxScalingGroupResponse, AWSError>;
/**
* Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
*/
deleteKxScalingGroup(callback?: (err: AWSError, data: Finspace.Types.DeleteKxScalingGroupResponse) => void): Request<Finspace.Types.DeleteKxScalingGroupResponse, AWSError>;
/**
* Deletes a user in the specified kdb environment.
*/
deleteKxUser(params: Finspace.Types.DeleteKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxUserResponse) => void): Request<Finspace.Types.DeleteKxUserResponse, AWSError>;
/**
* Deletes a user in the specified kdb environment.
*/
deleteKxUser(callback?: (err: AWSError, data: Finspace.Types.DeleteKxUserResponse) => void): Request<Finspace.Types.DeleteKxUserResponse, AWSError>;
/**
* Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.
*/
deleteKxVolume(params: Finspace.Types.DeleteKxVolumeRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxVolumeResponse) => void): Request<Finspace.Types.DeleteKxVolumeResponse, AWSError>;
/**
* Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.
*/
deleteKxVolume(callback?: (err: AWSError, data: Finspace.Types.DeleteKxVolumeResponse) => void): Request<Finspace.Types.DeleteKxVolumeResponse, AWSError>;
/**
* Returns the FinSpace environment object.
*/
getEnvironment(params: Finspace.Types.GetEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.GetEnvironmentResponse) => void): Request<Finspace.Types.GetEnvironmentResponse, AWSError>;
/**
* Returns the FinSpace environment object.
*/
getEnvironment(callback?: (err: AWSError, data: Finspace.Types.GetEnvironmentResponse) => void): Request<Finspace.Types.GetEnvironmentResponse, AWSError>;
/**
* Returns information about a kdb changeset.
*/
getKxChangeset(params: Finspace.Types.GetKxChangesetRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxChangesetResponse) => void): Request<Finspace.Types.GetKxChangesetResponse, AWSError>;
/**
* Returns information about a kdb changeset.
*/
getKxChangeset(callback?: (err: AWSError, data: Finspace.Types.GetKxChangesetResponse) => void): Request<Finspace.Types.GetKxChangesetResponse, AWSError>;
/**
* Retrieves information about a kdb cluster.
*/
getKxCluster(params: Finspace.Types.GetKxClusterRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxClusterResponse) => void): Request<Finspace.Types.GetKxClusterResponse, AWSError>;
/**
* Retrieves information about a kdb cluster.
*/
getKxCluster(callback?: (err: AWSError, data: Finspace.Types.GetKxClusterResponse) => void): Request<Finspace.Types.GetKxClusterResponse, AWSError>;
/**
* Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
*/
getKxConnectionString(params: Finspace.Types.GetKxConnectionStringRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxConnectionStringResponse) => void): Request<Finspace.Types.GetKxConnectionStringResponse, AWSError>;
/**
* Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
*/
getKxConnectionString(callback?: (err: AWSError, data: Finspace.Types.GetKxConnectionStringResponse) => void): Request<Finspace.Types.GetKxConnectionStringResponse, AWSError>;
/**
* Returns database information for the specified environment ID.
*/
getKxDatabase(params: Finspace.Types.GetKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxDatabaseResponse) => void): Request<Finspace.Types.GetKxDatabaseResponse, AWSError>;
/**
* Returns database information for the specified environment ID.
*/
getKxDatabase(callback?: (err: AWSError, data: Finspace.Types.GetKxDatabaseResponse) => void): Request<Finspace.Types.GetKxDatabaseResponse, AWSError>;
/**
* Retrieves details of the dataview.
*/
getKxDataview(params: Finspace.Types.GetKxDataviewRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxDataviewResponse) => void): Request<Finspace.Types.GetKxDataviewResponse, AWSError>;
/**
* Retrieves details of the dataview.
*/
getKxDataview(callback?: (err: AWSError, data: Finspace.Types.GetKxDataviewResponse) => void): Request<Finspace.Types.GetKxDataviewResponse, AWSError>;
/**
* Retrieves all the information for the specified kdb environment.
*/
getKxEnvironment(params: Finspace.Types.GetKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxEnvironmentResponse) => void): Request<Finspace.Types.GetKxEnvironmentResponse, AWSError>;
/**
* Retrieves all the information for the specified kdb environment.
*/
getKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.GetKxEnvironmentResponse) => void): Request<Finspace.Types.GetKxEnvironmentResponse, AWSError>;
/**
* Retrieves details of a scaling group.
*/
getKxScalingGroup(params: Finspace.Types.GetKxScalingGroupRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxScalingGroupResponse) => void): Request<Finspace.Types.GetKxScalingGroupResponse, AWSError>;
/**
* Retrieves details of a scaling group.
*/
getKxScalingGroup(callback?: (err: AWSError, data: Finspace.Types.GetKxScalingGroupResponse) => void): Request<Finspace.Types.GetKxScalingGroupResponse, AWSError>;
/**
* Retrieves information about the specified kdb user.
*/
getKxUser(params: Finspace.Types.GetKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxUserResponse) => void): Request<Finspace.Types.GetKxUserResponse, AWSError>;
/**
* Retrieves information about the specified kdb user.
*/
getKxUser(callback?: (err: AWSError, data: Finspace.Types.GetKxUserResponse) => void): Request<Finspace.Types.GetKxUserResponse, AWSError>;
/**
* Retrieves the information about the volume.
*/
getKxVolume(params: Finspace.Types.GetKxVolumeRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxVolumeResponse) => void): Request<Finspace.Types.GetKxVolumeResponse, AWSError>;
/**
* Retrieves the information about the volume.
*/
getKxVolume(callback?: (err: AWSError, data: Finspace.Types.GetKxVolumeResponse) => void): Request<Finspace.Types.GetKxVolumeResponse, AWSError>;
/**
* A list of all of your FinSpace environments.
*/
listEnvironments(params: Finspace.Types.ListEnvironmentsRequest, callback?: (err: AWSError, data: Finspace.Types.ListEnvironmentsResponse) => void): Request<Finspace.Types.ListEnvironmentsResponse, AWSError>;
/**
* A list of all of your FinSpace environments.
*/
listEnvironments(callback?: (err: AWSError, data: Finspace.Types.ListEnvironmentsResponse) => void): Request<Finspace.Types.ListEnvironmentsResponse, AWSError>;
/**
* Returns a list of all the changesets for a database.
*/
listKxChangesets(params: Finspace.Types.ListKxChangesetsRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxChangesetsResponse) => void): Request<Finspace.Types.ListKxChangesetsResponse, AWSError>;
/**
* Returns a list of all the changesets for a database.
*/
listKxChangesets(callback?: (err: AWSError, data: Finspace.Types.ListKxChangesetsResponse) => void): Request<Finspace.Types.ListKxChangesetsResponse, AWSError>;
/**
* Lists all the nodes in a kdb cluster.
*/
listKxClusterNodes(params: Finspace.Types.ListKxClusterNodesRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxClusterNodesResponse) => void): Request<Finspace.Types.ListKxClusterNodesResponse, AWSError>;
/**
* Lists all the nodes in a kdb cluster.
*/
listKxClusterNodes(callback?: (err: AWSError, data: Finspace.Types.ListKxClusterNodesResponse) => void): Request<Finspace.Types.ListKxClusterNodesResponse, AWSError>;
/**
* Returns a list of clusters.
*/
listKxClusters(params: Finspace.Types.ListKxClustersRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxClustersResponse) => void): Request<Finspace.Types.ListKxClustersResponse, AWSError>;
/**
* Returns a list of clusters.
*/
listKxClusters(callback?: (err: AWSError, data: Finspace.Types.ListKxClustersResponse) => void): Request<Finspace.Types.ListKxClustersResponse, AWSError>;
/**
* Returns a list of all the databases in the kdb environment.
*/
listKxDatabases(params: Finspace.Types.ListKxDatabasesRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxDatabasesResponse) => void): Request<Finspace.Types.ListKxDatabasesResponse, AWSError>;
/**
* Returns a list of all the databases in the kdb environment.
*/
listKxDatabases(callback?: (err: AWSError, data: Finspace.Types.ListKxDatabasesResponse) => void): Request<Finspace.Types.ListKxDatabasesResponse, AWSError>;
/**
* Returns a list of all the dataviews in the database.
*/
listKxDataviews(params: Finspace.Types.ListKxDataviewsRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxDataviewsResponse) => void): Request<Finspace.Types.ListKxDataviewsResponse, AWSError>;
/**
* Returns a list of all the dataviews in the database.
*/
listKxDataviews(callback?: (err: AWSError, data: Finspace.Types.ListKxDataviewsResponse) => void): Request<Finspace.Types.ListKxDataviewsResponse, AWSError>;
/**
* Returns a list of kdb environments created in an account.
*/
listKxEnvironments(params: Finspace.Types.ListKxEnvironmentsRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxEnvironmentsResponse) => void): Request<Finspace.Types.ListKxEnvironmentsResponse, AWSError>;
/**
* Returns a list of kdb environments created in an account.
*/
listKxEnvironments(callback?: (err: AWSError, data: Finspace.Types.ListKxEnvironmentsResponse) => void): Request<Finspace.Types.ListKxEnvironmentsResponse, AWSError>;
/**
* Returns a list of scaling groups in a kdb environment.
*/
listKxScalingGroups(params: Finspace.Types.ListKxScalingGroupsRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxScalingGroupsResponse) => void): Request<Finspace.Types.ListKxScalingGroupsResponse, AWSError>;
/**
* Returns a list of scaling groups in a kdb environment.
*/
listKxScalingGroups(callback?: (err: AWSError, data: Finspace.Types.ListKxScalingGroupsResponse) => void): Request<Finspace.Types.ListKxScalingGroupsResponse, AWSError>;
/**
* Lists all the users in a kdb environment.
*/
listKxUsers(params: Finspace.Types.ListKxUsersRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxUsersResponse) => void): Request<Finspace.Types.ListKxUsersResponse, AWSError>;
/**
* Lists all the users in a kdb environment.
*/
listKxUsers(callback?: (err: AWSError, data: Finspace.Types.ListKxUsersResponse) => void): Request<Finspace.Types.ListKxUsersResponse, AWSError>;
/**
* Lists all the volumes in a kdb environment.
*/
listKxVolumes(params: Finspace.Types.ListKxVolumesRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxVolumesResponse) => void): Request<Finspace.Types.ListKxVolumesResponse, AWSError>;
/**
* Lists all the volumes in a kdb environment.
*/
listKxVolumes(callback?: (err: AWSError, data: Finspace.Types.ListKxVolumesResponse) => void): Request<Finspace.Types.ListKxVolumesResponse, AWSError>;
/**
* A list of all tags for a resource.
*/
listTagsForResource(params: Finspace.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Finspace.Types.ListTagsForResourceResponse) => void): Request<Finspace.Types.ListTagsForResourceResponse, AWSError>;
/**
* A list of all tags for a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Finspace.Types.ListTagsForResourceResponse) => void): Request<Finspace.Types.ListTagsForResourceResponse, AWSError>;
/**
* Adds metadata tags to a FinSpace resource.
*/
tagResource(params: Finspace.Types.TagResourceRequest, callback?: (err: AWSError, data: Finspace.Types.TagResourceResponse) => void): Request<Finspace.Types.TagResourceResponse, AWSError>;
/**
* Adds metadata tags to a FinSpace resource.
*/
tagResource(callback?: (err: AWSError, data: Finspace.Types.TagResourceResponse) => void): Request<Finspace.Types.TagResourceResponse, AWSError>;
/**
* Removes metadata tags from a FinSpace resource.
*/
untagResource(params: Finspace.Types.UntagResourceRequest, callback?: (err: AWSError, data: Finspace.Types.UntagResourceResponse) => void): Request<Finspace.Types.UntagResourceResponse, AWSError>;
/**
* Removes metadata tags from a FinSpace resource.
*/
untagResource(callback?: (err: AWSError, data: Finspace.Types.UntagResourceResponse) => void): Request<Finspace.Types.UntagResourceResponse, AWSError>;
/**
* Update your FinSpace environment.
*/
updateEnvironment(params: Finspace.Types.UpdateEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateEnvironmentResponse) => void): Request<Finspace.Types.UpdateEnvironmentResponse, AWSError>;
/**
* Update your FinSpace environment.
*/
updateEnvironment(callback?: (err: AWSError, data: Finspace.Types.UpdateEnvironmentResponse) => void): Request<Finspace.Types.UpdateEnvironmentResponse, AWSError>;
/**
* Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.
*/
updateKxClusterCodeConfiguration(params: Finspace.Types.UpdateKxClusterCodeConfigurationRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxClusterCodeConfigurationResponse) => void): Request<Finspace.Types.UpdateKxClusterCodeConfigurationResponse, AWSError>;
/**
* Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.
*/
updateKxClusterCodeConfiguration(callback?: (err: AWSError, data: Finspace.Types.UpdateKxClusterCodeConfigurationResponse) => void): Request<Finspace.Types.UpdateKxClusterCodeConfigurationResponse, AWSError>;
/**
* Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one. Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
*/
updateKxClusterDatabases(params: Finspace.Types.UpdateKxClusterDatabasesRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxClusterDatabasesResponse) => void): Request<Finspace.Types.UpdateKxClusterDatabasesResponse, AWSError>;
/**
* Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one. Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
*/
updateKxClusterDatabases(callback?: (err: AWSError, data: Finspace.Types.UpdateKxClusterDatabasesResponse) => void): Request<Finspace.Types.UpdateKxClusterDatabasesResponse, AWSError>;
/**
* Updates information for the given kdb database.
*/
updateKxDatabase(params: Finspace.Types.UpdateKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxDatabaseResponse) => void): Request<Finspace.Types.UpdateKxDatabaseResponse, AWSError>;
/**
* Updates information for the given kdb database.
*/
updateKxDatabase(callback?: (err: AWSError, data: Finspace.Types.UpdateKxDatabaseResponse) => void): Request<Finspace.Types.UpdateKxDatabaseResponse, AWSError>;
/**
* Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
*/
updateKxDataview(params: Finspace.Types.UpdateKxDataviewRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxDataviewResponse) => void): Request<Finspace.Types.UpdateKxDataviewResponse, AWSError>;
/**
* Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
*/
updateKxDataview(callback?: (err: AWSError, data: Finspace.Types.UpdateKxDataviewResponse) => void): Request<Finspace.Types.UpdateKxDataviewResponse, AWSError>;
/**
* Updates information for the given kdb environment.
*/
updateKxEnvironment(params: Finspace.Types.UpdateKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentResponse, AWSError>;
/**
* Updates information for the given kdb environment.
*/
updateKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentResponse, AWSError>;
/**
* Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
*/
updateKxEnvironmentNetwork(params: Finspace.Types.UpdateKxEnvironmentNetworkRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentNetworkResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentNetworkResponse, AWSError>;
/**
* Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
*/
updateKxEnvironmentNetwork(callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentNetworkResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentNetworkResponse, AWSError>;
/**
* Updates the user details. You can only update the IAM role associated with a user.
*/
updateKxUser(params: Finspace.Types.UpdateKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxUserResponse) => void): Request<Finspace.Types.UpdateKxUserResponse, AWSError>;
/**
* Updates the user details. You can only update the IAM role associated with a user.
*/
updateKxUser(callback?: (err: AWSError, data: Finspace.Types.UpdateKxUserResponse) => void): Request<Finspace.Types.UpdateKxUserResponse, AWSError>;
/**
* Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.
*/
updateKxVolume(params: Finspace.Types.UpdateKxVolumeRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxVolumeResponse) => void): Request<Finspace.Types.UpdateKxVolumeResponse, AWSError>;
/**
* Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.
*/
updateKxVolume(callback?: (err: AWSError, data: Finspace.Types.UpdateKxVolumeResponse) => void): Request<Finspace.Types.UpdateKxVolumeResponse, AWSError>;
}
declare namespace Finspace {
export type AttachedClusterList = KxClusterName[];
export type AttributeMap = {[key: string]: FederationAttributeValue};
export interface AutoScalingConfiguration {
/**
* 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.
*/
minNodeCount?: NodeCount;
/**
* The highest number of nodes to scale. This value cannot be greater than 5.
*/
maxNodeCount?: NodeCount;
/**
* 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.
*/
autoScalingMetric?: AutoScalingMetric;
/**
* 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.
*/
metricTarget?: AutoScalingMetricTarget;
/**
* The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
*/
scaleInCooldownSeconds?: CooldownTime;
/**
* The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
*/
scaleOutCooldownSeconds?: CooldownTime;
}
export type AutoScalingMetric = "CPU_UTILIZATION_PERCENTAGE"|string;
export type AutoScalingMetricTarget = number;
export type AvailabilityZoneId = string;
export type AvailabilityZoneIds = AvailabilityZoneId[];
export type BoxedInteger = number;
export interface CapacityConfiguration {
/**
* 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.
*/
nodeType?: NodeType;
/**
* The number of instances running in a cluster.
*/
nodeCount?: NodeCount;
}
export interface ChangeRequest {
/**
* 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.
*/
changeType: ChangeType;
/**
* Defines the S3 path of the source file that is required to add or update files in a database.
*/
s3Path?: S3Path;
/**
* Defines the path within the database directory.
*/
dbPath: DbPath;
}
export type ChangeRequests = ChangeRequest[];
export type ChangeType = "PUT"|"DELETE"|string;
export type ChangesetId = string;
export type ChangesetStatus = "PENDING"|"PROCESSING"|"FAILED"|"COMPLETED"|string;
export type ClientToken = string;
export type ClientTokenString = string;
export type ClusterNodeCount = number;
export interface CodeConfiguration {
/**
* A unique name for the S3 bucket.
*/
s3Bucket?: S3Bucket;
/**
* 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.
*/
s3Key?: S3Key;
/**
* The version of an S3 object.
*/
s3ObjectVersion?: S3ObjectVersion;
}
export type CooldownTime = number;
export type CpuCount = number;
export interface CreateEnvironmentRequest {
/**
* The name of the FinSpace environment to be created.
*/
name: EnvironmentName;
/**
* The description of the FinSpace environment to be created.
*/
description?: Description;
/**
* The KMS key id to encrypt your data in the FinSpace environment.
*/
kmsKeyId?: KmsKeyId;
/**
* Add tags to your FinSpace environment.
*/
tags?: TagMap;
/**
* Authentication mode for the environment. FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider. LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
*/
federationMode?: FederationMode;
/**
* Configuration information when authentication mode is FEDERATED.
*/
federationParameters?: FederationParameters;
/**
* Configuration information for the superuser.
*/
superuserParameters?: SuperuserParameters;
/**
* The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs: arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies. arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
*/
dataBundles?: DataBundleArns;
}
export interface CreateEnvironmentResponse {
/**
* The unique identifier for FinSpace environment that you created.
*/
environmentId?: IdType;
/**
* The Amazon Resource Name (ARN) of the FinSpace environment that you created.
*/
environmentArn?: EnvironmentArn;
/**
* The sign-in URL for the web application of the FinSpace environment you created.
*/
environmentUrl?: url;
}
export interface CreateKxChangesetRequest {
/**
* A unique identifier of the kdb environment.
*/
environmentId: EnvironmentId;
/**
* The name of the kdb database.
*/
databaseName: DatabaseName;
/**
* 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: This request adds a single sym file at database root location. { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"} 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/"} 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/"}] This request deletes the 2020.01.02 partition of the database. [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ] 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/"}]
*/
changeRequests: ChangeRequests;
/**
* A token that ensures idempotency. This token expires in 10 minutes.
*/
clientToken: ClientTokenString;
}
export interface CreateKxChangesetResponse {
/**
* A unique identifier for the changeset.
*/
changesetId?: ChangesetId;
/**
* The name of the kdb database.
*/
databaseName?: DatabaseName;
/**
* A unique identifier for the kdb environment.
*/
environmentId?: EnvironmentId;
/**
* A list of change requests.
*/
changeRequests?: ChangeRequests;
/**
* 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.
*/
createdTimestamp?: Timestamp;
/**
* 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.
*/
lastModifiedTimestamp?: Timestamp;
/**
* 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.
*/
status?: ChangesetStatus;
/**
* The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
*/
errorInfo?: ErrorInfo;
}
export interface CreateKxClusterRequest {
/**
* A token that ensures idempotency. This token expires in 10 minutes.
*/
clientToken?: ClientToken;
/**
* A unique identifier for the kdb environment.
*/
environmentId: KxEnvironmentId;
/**
* A unique name for the cluster that you want to create.
*/
clusterName: KxClusterName;
/**
* 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.
*/
clusterType: KxClusterType;
/**
* 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.
*/
tickerplantLogConfiguration?: TickerplantLogConfiguration;
/**
* A list of databases that will be available for querying.
*/
databases?: KxDatabaseConfigurations;
/**
* 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.
*/
cacheStorageConfigurations?: KxCacheStorageConfigurations;
/**
* The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
*/
autoScalingConfiguration?: AutoScalingConfiguration;
/**
* A description of the cluster.
*/
clusterDescription?: KxClusterDescription;
/**
* A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
*/
capacityConfiguration?: CapacityConfiguration;
/**
* The version of FinSpace managed kdb to run.
*/
releaseLabel: ReleaseLabel;
/**
* Configuration details about the network where the Privatelink endpoint of the cluster resides.
*/
vpcConfiguration: VpcConfiguration;
/**
* 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.
*/
initializationScript?: InitializationScriptFilePath;
/**
* Defines the key-value pairs to make them available inside the cluster.
*/
commandLineArguments?: KxCommandLineArguments;
/**
* 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.
*/
code?: CodeConfiguration;
/**
* 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.
*/
executionRole?: ExecutionRoleArn;
/**
* 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.
*/
savedownStorageConfiguration?: KxSavedownStorageConfiguration;
/**
* 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.
*/
azMode: KxAzMode;
/**
* The availability zone identifiers for the requested regions.
*/
availabilityZoneId?: AvailabilityZoneId;
/**
* A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
*/
tags?: TagMap;
/**
* The structure that stores the configuration details of a scaling group.
*/
scalingGroupConfiguration?: KxScalingGroupConfiguration;
}
export interface CreateKxClusterResponse {
/**
* A unique identifier for the kdb environment.
*/
environmentId?: KxEnvironmentId;
/**
* 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.
*/
status?: KxClusterStatus;
/**
* The error message when a failed state occurs.
*/
statusReason?: KxClusterStatusReason;
/**
* A unique name for the cluster.
*/
clusterName?: KxClusterName;
/**
* 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.
*/
clusterType?: KxClusterType;
tickerplantLogConfiguration?: TickerplantLogConfiguration;
/**
* A list of volumes mounted on the cluster.
*/
volumes?: Volumes;
/**
* A list of databases that will be available for querying.
*/
databases?: KxDatabaseConfigurations;
/**
* 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.
*/
cacheStorageConfigurations?: KxCacheStorageConfigurations;
/**
* The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
*/
autoScalingConfiguration?: AutoScalingConfiguration;
/**
* A description of the cluster.
*/
clusterDescription?: KxClusterDescription;
/**
* A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
*/
capacityConfiguration?: CapacityConfiguration;
/**
* A version of the FinSpace managed kdb to run.
*/
releaseLabel?: ReleaseLabel;
/**
* Configuration details about the network where the Privatelink endpoint of the cluster resides.
*/
vpcConfiguration?: VpcConfiguration;
/**
* 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.
*/
initializationScript?: InitializationScriptFilePath;
/**
* Defines the key-value pairs to make them available inside the cluster.
*/
commandLineArguments?: KxCommandLineArguments;
/**
* 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.
*/
code?: CodeConfiguration;
/**
* 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.
*/
executionRole?: ExecutionRoleArn;
/**
* The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the valu