FinspaceClient
The FinSpace management service provides the APIs for managing FinSpace environments.
Functions
Create a new FinSpace environment.
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.
Creates a new kdb cluster.
Creates a new kdb database in the environment.
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.
Creates a managed kdb environment for the account.
Creates a new scaling group.
Creates a user in FinSpace kdb environment with an associated IAM role.
Creates a new volume with a specific amount of throughput and storage capacity.
Delete an FinSpace environment.
Deletes a kdb cluster.
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.
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
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.
Deletes a user in the specified kdb environment.
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.
Returns the FinSpace environment object.
Returns information about a kdb changeset.
Retrieves information about a kdb cluster.
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.
Returns database information for the specified environment ID.
Retrieves details of the dataview.
Retrieves all the information for the specified kdb environment.
Retrieves details of a scaling group.
Retrieves information about the specified kdb user.
Retrieves the information about the volume.
A list of all of your FinSpace environments.
Returns a list of all the changesets for a database.
Lists all the nodes in a kdb cluster.
Returns a list of clusters.
Returns a list of all the databases in the kdb environment.
Returns a list of all the dataviews in the database.
Returns a list of kdb environments created in an account.
Returns a list of scaling groups in a kdb environment.
Lists all the users in a kdb environment.
Lists all the volumes in a kdb environment.
A list of all tags for a resource.
Adds metadata tags to a FinSpace resource.
Removes metadata tags from a FinSpace resource.
Update your FinSpace environment.
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.
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.
Updates information for the given kdb database.
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
Updates information for the given kdb environment.
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.
Updates the user details. You can only update the IAM role associated with a user.
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.
Inherited functions
Create a new FinSpace environment.
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.
Creates a new kdb cluster.
Creates a new kdb database in the environment.
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.
Creates a managed kdb environment for the account.
Creates a new scaling group.
Creates a user in FinSpace kdb environment with an associated IAM role.
Creates a new volume with a specific amount of throughput and storage capacity.
Delete an FinSpace environment.
Deletes a kdb cluster.
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.
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
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.
Deletes a user in the specified kdb environment.
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.
Returns the FinSpace environment object.
Returns information about a kdb changeset.
Retrieves information about a kdb cluster.
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.
Returns database information for the specified environment ID.
Retrieves details of the dataview.
Retrieves all the information for the specified kdb environment.
Retrieves details of a scaling group.
Retrieves information about the specified kdb user.
Retrieves the information about the volume.
A list of all of your FinSpace environments.
Returns a list of all the changesets for a database.
Paginate over ListKxChangesetsResponse results.
Lists all the nodes in a kdb cluster.
Paginate over ListKxClusterNodesResponse results.
Returns a list of clusters.
Returns a list of all the databases in the kdb environment.
Paginate over ListKxDatabasesResponse results.
Returns a list of all the dataviews in the database.
Paginate over ListKxDataviewsResponse results.
Returns a list of kdb environments created in an account.
Paginate over ListKxEnvironmentsResponse results.
Returns a list of scaling groups in a kdb environment.
Paginate over ListKxScalingGroupsResponse results.
Lists all the users in a kdb environment.
Lists all the volumes in a kdb environment.
A list of all tags for a resource.
Adds metadata tags to a FinSpace resource.
Removes metadata tags from a FinSpace resource.
Update your FinSpace environment.
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.
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.
Updates information for the given kdb database.
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
Updates information for the given kdb environment.
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.
Updates the user details. You can only update the IAM role associated with a user.
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.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.