FinSpace User Environment Management service API skill. Use when working with FinSpace User Environment Management service for environment, kx, tags. Covers 50 endpoints.
FinSpace User Environment Management service API skill. Use when working with FinSpace User Environment Management service for environment, kx, tags. Covers 50 endpoints.
version
1.0.0
generator
lapsh
FinSpace User Environment Management service
API version: 2021-03-12
Auth
AWS SigV4
Base URL
Not specified.
Setup
Configure auth: AWS SigV4
GET /environment -- verify access
POST /environment -- create first environment
Endpoints
50 endpoints across 3 groups. See references/api-spec.lap for full details.
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.
POST
/kx/environments
Creates a managed kdb environment for the account.
POST
/kx/environments/{environmentId}/scalingGroups
Creates a new scaling group.
POST
/kx/environments/{environmentId}/users
Creates a user in FinSpace kdb environment with an associated IAM role.
POST
/kx/environments/{environmentId}/kxvolumes
Creates a new volume with a specific amount of throughput and storage capacity.
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.
DELETE
/kx/environments/{environmentId}
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 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.
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.
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. Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
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
PUT
/kx/environments/{environmentId}
Updates information for the given kdb environment.
PUT
/kx/environments/{environmentId}/network
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.
PUT
/kx/environments/{environmentId}/users/{userName}
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.
"List all clusters?" -> GET /kx/environments/{environmentId}/clusters
"List all databases?" -> GET /kx/environments/{environmentId}/databases
"List all dataviews?" -> GET /kx/environments/{environmentId}/databases/{databaseName}/dataviews
"List all environments?" -> GET /kx/environments
"List all scalingGroups?" -> GET /kx/environments/{environmentId}/scalingGroups
"List all users?" -> GET /kx/environments/{environmentId}/users
"List all kxvolumes?" -> GET /kx/environments/{environmentId}/kxvolumes
"Get tag details?" -> GET /tags/{resourceArn}
"Delete a tag?" -> DELETE /tags/{resourceArn}
"Update a environment?" -> PUT /environment/{environmentId}
"Update a database?" -> PUT /kx/environments/{environmentId}/databases/{databaseName}
"Update a dataview?" -> PUT /kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}
"Update a environment?" -> PUT /kx/environments/{environmentId}
"Update a user?" -> PUT /kx/environments/{environmentId}/users/{userName}
"Partially update a kxvolume?" -> PATCH /kx/environments/{environmentId}/kxvolumes/{volumeName}
