View Source aws_finspace (aws v1.0.4)
Summary
Functions
Creates a changeset for a kdb database.
Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.
Deletes the specified database and all of its associated data.
Deletes the specified dataview.
Deletes the kdb environment.
Deletes the specified scaling group.
Deletes a volume.
Retrieves a connection string for a user to connect to a kdb cluster.
Allows you to update code configuration on a running cluster.
Updates the databases mounted on a kdb cluster, which includes the changesetId
and all the dbPaths to be cached.
Updates the specified dataview.
Updates environment network to connect to your internal network by using a transit gateway.
Updates the user details.
Updates the throughput or capacity of a volume.
Functions
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.create_kx_changeset(Client, DatabaseName, EnvironmentId, Input0, Options0)
View SourceCreates 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.create_kx_dataview(Client, DatabaseName, EnvironmentId, Input0, Options0)
View Sourcedelete_kx_cluster(Client, ClusterName, EnvironmentId, Input0, Options0)
View SourceDeletes 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.delete_kx_database(Client, DatabaseName, EnvironmentId, Input0, Options0)
View Sourcedelete_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId, Input)
View SourceDeletes the specified dataview.
Before deleting a dataview, make sure that it is not in use by any cluster.delete_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId, Input0, Options0)
View SourceDeletes the kdb environment.
This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.delete_kx_scaling_group(Client, EnvironmentId, ScalingGroupName, Input)
View SourceDeletes the specified scaling group.
This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.delete_kx_scaling_group(Client, EnvironmentId, ScalingGroupName, Input0, Options0)
View SourceDeletes 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.delete_kx_volume(Client, EnvironmentId, VolumeName, Input0, Options0)
View Sourceget_environment(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_kx_changeset(Client, ChangesetId, DatabaseName, EnvironmentId)
View Sourceget_kx_changeset(Client, ChangesetId, DatabaseName, EnvironmentId, QueryMap, HeadersMap)
View Sourceget_kx_changeset(Client, ChangesetId, DatabaseName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_kx_cluster(Client, ClusterName, EnvironmentId, QueryMap, HeadersMap)
View Sourceget_kx_cluster(Client, ClusterName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_kx_connection_string(Client, EnvironmentId, ClusterName, UserArn)
View SourceRetrieves 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.get_kx_connection_string(Client, EnvironmentId, ClusterName, UserArn, QueryMap, HeadersMap)
View Sourceget_kx_connection_string(Client, EnvironmentId, ClusterName, UserArn, QueryMap, HeadersMap, Options0)
View Sourceget_kx_database(Client, DatabaseName, EnvironmentId, QueryMap, HeadersMap)
View Sourceget_kx_database(Client, DatabaseName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId)
View Sourceget_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId, QueryMap, HeadersMap)
View Sourceget_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_kx_environment(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_kx_scaling_group(Client, EnvironmentId, ScalingGroupName, QueryMap, HeadersMap)
View Sourceget_kx_scaling_group(Client, EnvironmentId, ScalingGroupName, QueryMap, HeadersMap, Options0)
View Sourceget_kx_user(Client, EnvironmentId, UserName, QueryMap, HeadersMap)
View Sourceget_kx_user(Client, EnvironmentId, UserName, QueryMap, HeadersMap, Options0)
View Sourceget_kx_volume(Client, EnvironmentId, VolumeName, QueryMap, HeadersMap)
View Sourceget_kx_volume(Client, EnvironmentId, VolumeName, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_changesets(Client, DatabaseName, EnvironmentId, QueryMap, HeadersMap)
View Sourcelist_kx_changesets(Client, DatabaseName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_cluster_nodes(Client, ClusterName, EnvironmentId, QueryMap, HeadersMap)
View Sourcelist_kx_cluster_nodes(Client, ClusterName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_clusters(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_databases(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_dataviews(Client, DatabaseName, EnvironmentId, QueryMap, HeadersMap)
View Sourcelist_kx_dataviews(Client, DatabaseName, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_scaling_groups(Client, EnvironmentId, QueryMap, HeadersMap)
View Sourcelist_kx_scaling_groups(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_users(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_kx_volumes(Client, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourceupdate_kx_cluster_code_configuration(Client, ClusterName, EnvironmentId, Input)
View SourceAllows 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.update_kx_cluster_code_configuration(Client, ClusterName, EnvironmentId, Input0, Options0)
View Sourceupdate_kx_cluster_databases(Client, ClusterName, EnvironmentId, Input)
View SourceUpdates 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.update_kx_cluster_databases(Client, ClusterName, EnvironmentId, Input0, Options0)
View Sourceupdate_kx_database(Client, DatabaseName, EnvironmentId, Input0, Options0)
View Sourceupdate_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId, Input)
View SourceUpdates 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 configurationsupdate_kx_dataview(Client, DatabaseName, DataviewName, EnvironmentId, Input0, Options0)
View SourceUpdates 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.update_kx_environment_network(Client, EnvironmentId, Input0, Options0)
View SourceUpdates 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.