- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
FinspaceClient
The FinSpace management service provides the APIs for managing FinSpace environments.
Installation
npm install @aws-sdk/client-finspace
yarn add @aws-sdk/client-finspace
pnpm add @aws-sdk/client-finspace
FinspaceClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateEnvironmentCommand | Create a new FinSpace environment. |
CreateKxChangesetCommand | 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. |
CreateKxClusterCommand | Creates a new kdb cluster. |
CreateKxDatabaseCommand | Creates a new kdb database in the environment. |
CreateKxDataviewCommand | 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. |
CreateKxEnvironmentCommand | Creates a managed kdb environment for the account. |
CreateKxScalingGroupCommand | Creates a new scaling group. |
CreateKxUserCommand | Creates a user in FinSpace kdb environment with an associated IAM role. |
CreateKxVolumeCommand | Creates a new volume with a specific amount of throughput and storage capacity. |
DeleteEnvironmentCommand | Delete an FinSpace environment. |
DeleteKxClusterCommand | Deletes a kdb cluster. |
DeleteKxClusterNodeCommand | Deletes the specified nodes from a cluster. |
DeleteKxDatabaseCommand | 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. |
DeleteKxDataviewCommand | Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster. |
DeleteKxEnvironmentCommand | Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it. |
DeleteKxScalingGroupCommand | 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. |
DeleteKxUserCommand | Deletes a user in the specified kdb environment. |
DeleteKxVolumeCommand | 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. |
GetEnvironmentCommand | Returns the FinSpace environment object. |
GetKxChangesetCommand | Returns information about a kdb changeset. |
GetKxClusterCommand | Retrieves information about a kdb cluster. |
GetKxConnectionStringCommand | 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. |
GetKxDatabaseCommand | Returns database information for the specified environment ID. |
GetKxDataviewCommand | Retrieves details of the dataview. |
GetKxEnvironmentCommand | Retrieves all the information for the specified kdb environment. |
GetKxScalingGroupCommand | Retrieves details of a scaling group. |
GetKxUserCommand | Retrieves information about the specified kdb user. |
GetKxVolumeCommand | Retrieves the information about the volume. |
ListEnvironmentsCommand | A list of all of your FinSpace environments. |
ListKxChangesetsCommand | Returns a list of all the changesets for a database. |
ListKxClusterNodesCommand | Lists all the nodes in a kdb cluster. |
ListKxClustersCommand | Returns a list of clusters. |
ListKxDatabasesCommand | Returns a list of all the databases in the kdb environment. |
ListKxDataviewsCommand | Returns a list of all the dataviews in the database. |
ListKxEnvironmentsCommand | Returns a list of kdb environments created in an account. |
ListKxScalingGroupsCommand | Returns a list of scaling groups in a kdb environment. |
ListKxUsersCommand | Lists all the users in a kdb environment. |
ListKxVolumesCommand | Lists all the volumes in a kdb environment. |
ListTagsForResourceCommand | A list of all tags for a resource. |
TagResourceCommand | Adds metadata tags to a FinSpace resource. |
UntagResourceCommand | Removes metadata tags from a FinSpace resource. |
UpdateEnvironmentCommand | Update your FinSpace environment. |
UpdateKxClusterCodeConfigurationCommand | 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. |
UpdateKxClusterDatabasesCommand | Updates the databases mounted on a kdb cluster, which includes the Using this API you can point a cluster to a different changeset and modify a list of partitions being cached. |
UpdateKxDatabaseCommand | Updates information for the given kdb database. |
UpdateKxDataviewCommand | 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 |
UpdateKxEnvironmentCommand | Updates information for the given kdb environment. |
UpdateKxEnvironmentNetworkCommand | 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. |
UpdateKxUserCommand | Updates the user details. You can only update the IAM role associated with a user. |
UpdateKxVolumeCommand | 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. |
FinspaceClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: FinspaceClientConfig