Finspace

create_environment(name)
create_environment(name, params::Dict{String,<:Any})

Create a new FinSpace environment.

Arguments

• name: The name of the FinSpace environment to be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "dataBundles": 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.
• "description": The description of the FinSpace environment to be created.
• "federationMode": 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.
• "federationParameters": Configuration information when authentication mode is FEDERATED.
• "kmsKeyId": The KMS key id to encrypt your data in the FinSpace environment.
• "superuserParameters": Configuration information for the superuser.
• "tags": Add tags to your FinSpace environment.

create_kx_changeset(change_requests, client_token, database_name, environment_id)
create_kx_changeset(change_requests, client_token, database_name, environment_id, params::Dict{String,<:Any})

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.

Arguments

• change_requests: 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/"}]
• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the kdb database.
• environment_id: A unique identifier of the kdb environment.

create_kx_cluster(az_mode, cluster_name, cluster_type, environment_id, release_label, vpc_configuration)
create_kx_cluster(az_mode, cluster_name, cluster_type, environment_id, release_label, vpc_configuration, params::Dict{String,<:Any})

Creates a new kdb cluster.

Arguments

• az_mode: 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.
• cluster_name: A unique name for the cluster that you want to create.
• cluster_type: 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.
• environment_id: A unique identifier for the kdb environment.
• release_label: The version of FinSpace managed kdb to run.
• vpc_configuration: Configuration details about the network where the Privatelink endpoint of the cluster resides.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "autoScalingConfiguration": The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
• "availabilityZoneId": The availability zone identifiers for the requested regions.
• "cacheStorageConfigurations": 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.
• "capacityConfiguration": A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "clusterDescription": A description of the cluster.
• "code": 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.
• "commandLineArguments": Defines the key-value pairs to make them available inside the cluster.
• "databases": A list of databases that will be available for querying.
• "executionRole": 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.
• "initializationScript": 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.
• "savedownStorageConfiguration": 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.
• "scalingGroupConfiguration": The structure that stores the configuration details of a scaling group.
• "tags": A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
• "tickerplantLogConfiguration": 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.tplogpath.

create_kx_database(client_token, database_name, environment_id)
create_kx_database(client_token, database_name, environment_id, params::Dict{String,<:Any})

Creates a new kdb database in the environment.

Arguments

• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the kdb database.
• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description of the database.
• "tags": A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database

create_kx_dataview(az_mode, client_token, database_name, dataview_name, environment_id)
create_kx_dataview(az_mode, client_token, database_name, dataview_name, environment_id, params::Dict{String,<:Any})

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.

Arguments

• az_mode: The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the database where you want to create a dataview.
• dataview_name: A unique identifier for the dataview.
• environment_id: A unique identifier for the kdb environment, where you want to create the dataview.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "autoUpdate": The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
• "availabilityZoneId": The identifier of the availability zones.
• "changesetId": A unique identifier of the changeset that you want to use to ingest data.
• "description": A description of the dataview.
• "readWrite": The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.

 You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview. You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails. Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.
• "segmentConfigurations": The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
• "tags": A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

create_kx_environment(kms_key_id, name)
create_kx_environment(kms_key_id, name, params::Dict{String,<:Any})

Creates a managed kdb environment for the account.

Arguments

• kms_key_id: The KMS key ID to encrypt your data in the FinSpace environment.
• name: The name of the kdb environment that you want to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "description": A description for the kdb environment.
• "tags": A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

create_kx_scaling_group(availability_zone_id, client_token, environment_id, host_type, scaling_group_name)
create_kx_scaling_group(availability_zone_id, client_token, environment_id, host_type, scaling_group_name, params::Dict{String,<:Any})

Creates a new scaling group.

Arguments

• availability_zone_id: The identifier of the availability zones.
• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• environment_id: A unique identifier for the kdb environment, where you want to create the scaling group.
• host_type: The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. You can add one of the following values: kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs. kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs. kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs. kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs. kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs. kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
• scaling_group_name: A unique identifier for the kdb scaling group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.

create_kx_user(environment_id, iam_role, user_name)
create_kx_user(environment_id, iam_role, user_name, params::Dict{String,<:Any})

Creates a user in FinSpace kdb environment with an associated IAM role.

Arguments

• environment_id: A unique identifier for the kdb environment where you want to create a user.
• iam_role: The IAM role ARN that will be associated with the user.
• user_name: A unique identifier for the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "tags": A list of key-value pairs to label the user. You can add up to 50 tags to a user.

create_kx_volume(availability_zone_ids, az_mode, environment_id, volume_name, volume_type)
create_kx_volume(availability_zone_ids, az_mode, environment_id, volume_name, volume_type, params::Dict{String,<:Any})

Creates a new volume with a specific amount of throughput and storage capacity.

Arguments

• availability_zone_ids: The identifier of the availability zones.
• az_mode: The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
• environment_id: A unique identifier for the kdb environment, whose clusters can attach to the volume.
• volume_name: A unique identifier for the volume.
• volume_type: The type of file system volume. Currently, FinSpace only supports NAS1 volume type. When you select NAS1 volume type, you must also provide nas1Configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "description": A description of the volume.
• "nas1Configuration": Specifies the configuration for the Network attached storage (NAS1) file system volume. This parameter is required when you choose volumeType as NAS1.
• "tags": A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.

delete_environment(environment_id)
delete_environment(environment_id, params::Dict{String,<:Any})

Delete an FinSpace environment.

Arguments

• environment_id: The identifier for the FinSpace environment.

delete_kx_cluster(cluster_name, environment_id)
delete_kx_cluster(cluster_name, environment_id, params::Dict{String,<:Any})

Deletes a kdb cluster.

Arguments

• cluster_name: The name of the cluster that you want to delete.
• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.

delete_kx_cluster_node(cluster_name, environment_id, node_id)
delete_kx_cluster_node(cluster_name, environment_id, node_id, params::Dict{String,<:Any})

Deletes the specified nodes from a cluster.

Arguments

• cluster_name: The name of the cluster, for which you want to delete the nodes.
• environment_id: A unique identifier for the kdb environment.
• node_id: A unique identifier for the node that you want to delete.

delete_kx_database(client_token, database_name, environment_id)
delete_kx_database(client_token, database_name, environment_id, params::Dict{String,<:Any})

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.

Arguments

• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the kdb database that you want to delete.
• environment_id: A unique identifier for the kdb environment.

delete_kx_dataview(client_token, database_name, dataview_name, environment_id)
delete_kx_dataview(client_token, database_name, dataview_name, environment_id, params::Dict{String,<:Any})

Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.

Arguments

• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the database whose dataview you want to delete.
• dataview_name: The name of the dataview that you want to delete.
• environment_id: A unique identifier for the kdb environment, from where you want to delete the dataview.

delete_kx_environment(environment_id)
delete_kx_environment(environment_id, params::Dict{String,<:Any})

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

Arguments

• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.

delete_kx_scaling_group(environment_id, scaling_group_name)
delete_kx_scaling_group(environment_id, scaling_group_name, params::Dict{String,<:Any})

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.

Arguments

• environment_id: A unique identifier for the kdb environment, from where you want to delete the dataview.
• scaling_group_name: A unique identifier for the kdb scaling group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.

delete_kx_user(environment_id, user_name)
delete_kx_user(environment_id, user_name, params::Dict{String,<:Any})

Deletes a user in the specified kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment.
• user_name: A unique identifier for the user that you want to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.

delete_kx_volume(environment_id, volume_name)
delete_kx_volume(environment_id, volume_name, params::Dict{String,<:Any})

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.

Arguments

• environment_id: A unique identifier for the kdb environment, whose clusters can attach to the volume.
• volume_name: The name of the volume that you want to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.

get_environment(environment_id)
get_environment(environment_id, params::Dict{String,<:Any})

Returns the FinSpace environment object.

Arguments

• environment_id: The identifier of the FinSpace environment.

get_kx_changeset(changeset_id, database_name, environment_id)
get_kx_changeset(changeset_id, database_name, environment_id, params::Dict{String,<:Any})

Returns information about a kdb changeset.

Arguments

• changeset_id: A unique identifier of the changeset for which you want to retrieve data.
• database_name: The name of the kdb database.
• environment_id: A unique identifier for the kdb environment.

get_kx_cluster(cluster_name, environment_id)
get_kx_cluster(cluster_name, environment_id, params::Dict{String,<:Any})

Retrieves information about a kdb cluster.

Arguments

• cluster_name: The name of the cluster that you want to retrieve.
• environment_id: A unique identifier for the kdb environment.

get_kx_connection_string(cluster_name, environment_id, user_arn)
get_kx_connection_string(cluster_name, environment_id, user_arn, params::Dict{String,<:Any})

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.

Arguments

• cluster_name: A name of the kdb cluster.
• environment_id: A unique identifier for the kdb environment.
• user_arn: The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

get_kx_database(database_name, environment_id)
get_kx_database(database_name, environment_id, params::Dict{String,<:Any})

Returns database information for the specified environment ID.

Arguments

• database_name: The name of the kdb database.
• environment_id: A unique identifier for the kdb environment.

get_kx_dataview(database_name, dataview_name, environment_id)
get_kx_dataview(database_name, dataview_name, environment_id, params::Dict{String,<:Any})

Retrieves details of the dataview.

Arguments

• database_name: The name of the database where you created the dataview.
• dataview_name: A unique identifier for the dataview.
• environment_id: A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

get_kx_environment(environment_id)
get_kx_environment(environment_id, params::Dict{String,<:Any})

Retrieves all the information for the specified kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment.

get_kx_scaling_group(environment_id, scaling_group_name)
get_kx_scaling_group(environment_id, scaling_group_name, params::Dict{String,<:Any})

Retrieves details of a scaling group.

Arguments

• environment_id: A unique identifier for the kdb environment.
• scaling_group_name: A unique identifier for the kdb scaling group.

get_kx_user(environment_id, user_name)
get_kx_user(environment_id, user_name, params::Dict{String,<:Any})

Retrieves information about the specified kdb user.

Arguments

• environment_id: A unique identifier for the kdb environment.
• user_name: A unique identifier for the user.

get_kx_volume(environment_id, volume_name)
get_kx_volume(environment_id, volume_name, params::Dict{String,<:Any})

Retrieves the information about the volume.

Arguments

• environment_id: A unique identifier for the kdb environment, whose clusters can attach to the volume.
• volume_name: A unique identifier for the volume.

list_environments()
list_environments(params::Dict{String,<:Any})

A list of all of your FinSpace environments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the response object of the previous page call.

list_kx_changesets(database_name, environment_id)
list_kx_changesets(database_name, environment_id, params::Dict{String,<:Any})

Returns a list of all the changesets for a database.

Arguments

• database_name: The name of the kdb database.
• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_cluster_nodes(cluster_name, environment_id)
list_kx_cluster_nodes(cluster_name, environment_id, params::Dict{String,<:Any})

Lists all the nodes in a kdb cluster.

Arguments

• cluster_name: A unique name for the cluster.
• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_clusters(environment_id)
list_kx_clusters(environment_id, params::Dict{String,<:Any})

Returns a list of clusters.

Arguments

• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clusterType": 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.
• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_databases(environment_id)
list_kx_databases(environment_id, params::Dict{String,<:Any})

Returns a list of all the databases in the kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_dataviews(database_name, environment_id)
list_kx_dataviews(database_name, environment_id, params::Dict{String,<:Any})

Returns a list of all the dataviews in the database.

Arguments

• database_name: The name of the database where the dataviews were created.
• environment_id: A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_environments()
list_kx_environments(params::Dict{String,<:Any})

Returns a list of kdb environments created in an account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_scaling_groups(environment_id)
list_kx_scaling_groups(environment_id, params::Dict{String,<:Any})

Returns a list of scaling groups in a kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_users(environment_id)
list_kx_users(environment_id, params::Dict{String,<:Any})

Lists all the users in a kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.

list_kx_volumes(environment_id)
list_kx_volumes(environment_id, params::Dict{String,<:Any})

Lists all the volumes in a kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment, whose clusters can attach to the volume.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in this request.
• "nextToken": A token that indicates where a results page should begin.
• "volumeType": The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

A list of all tags for a resource.

Arguments

• resource_arn: The Amazon Resource Name of the resource.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds metadata tags to a FinSpace resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) for the resource.
• tags: One or more tags to be assigned to the resource.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes metadata tags from a FinSpace resource.

Arguments

• resource_arn: A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
• tag_keys: The tag keys (names) of one or more tags to be removed.

update_environment(environment_id)
update_environment(environment_id, params::Dict{String,<:Any})

Update your FinSpace environment.

Arguments

• environment_id: The identifier of the FinSpace environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the environment.
• "federationMode": 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.
• "federationParameters":
• "name": The name of the environment.

update_kx_cluster_code_configuration(cluster_name, code, environment_id)
update_kx_cluster_code_configuration(cluster_name, code, environment_id, params::Dict{String,<:Any})

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.

Arguments

• cluster_name: The name of the cluster.
• code:
• environment_id: A unique identifier of the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "commandLineArguments": Specifies the key-value pairs to make them available inside the cluster. You cannot update this parameter for a NO_RESTART deployment.
• "deploymentConfiguration": The configuration that allows you to choose how you want to update the code on a cluster.
• "initializationScript": 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. You cannot update this parameter for a NO_RESTART deployment.

update_kx_cluster_databases(cluster_name, databases, environment_id)
update_kx_cluster_databases(cluster_name, databases, environment_id, params::Dict{String,<:Any})

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.

Arguments

• cluster_name: A unique name for the cluster that you want to modify.
• databases: The structure of databases mounted on the cluster.
• environment_id: The unique identifier of a kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "deploymentConfiguration": The configuration that allows you to choose how you want to update the databases on a cluster.

update_kx_database(client_token, database_name, environment_id)
update_kx_database(client_token, database_name, environment_id, params::Dict{String,<:Any})

Updates information for the given kdb database.

Arguments

• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the kdb database.
• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description of the database.

update_kx_dataview(client_token, database_name, dataview_name, environment_id)
update_kx_dataview(client_token, database_name, dataview_name, environment_id, params::Dict{String,<:Any})

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

Arguments

• client_token: A token that ensures idempotency. This token expires in 10 minutes.
• database_name: The name of the database.
• dataview_name: The name of the dataview that you want to update.
• environment_id: A unique identifier for the kdb environment, where you want to update the dataview.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "changesetId": A unique identifier for the changeset.
• "description": The description for a dataview.
• "segmentConfigurations": The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

update_kx_environment(environment_id)
update_kx_environment(environment_id, params::Dict{String,<:Any})

Updates information for the given kdb environment.

Arguments

• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "description": A description of the kdb environment.
• "name": The name of the kdb environment.

update_kx_environment_network(environment_id)
update_kx_environment_network(environment_id, params::Dict{String,<:Any})

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.

Arguments

• environment_id: A unique identifier for the kdb environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "customDNSConfiguration": A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
• "transitGatewayConfiguration": Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

update_kx_user(environment_id, iam_role, user_name)
update_kx_user(environment_id, iam_role, user_name, params::Dict{String,<:Any})

Updates the user details. You can only update the IAM role associated with a user.

Arguments

• environment_id: A unique identifier for the kdb environment.
• iam_role: The IAM role ARN that is associated with the user.
• user_name: A unique identifier for the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.

update_kx_volume(environment_id, volume_name)
update_kx_volume(environment_id, volume_name, params::Dict{String,<:Any})

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.

Arguments

• environment_id: A unique identifier for the kdb environment where you created the storage volume.
• volume_name: A unique identifier for the volume.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": A token that ensures idempotency. This token expires in 10 minutes.
• "description": A description of the volume.
• "nas1Configuration": Specifies the configuration for the Network attached storage (NAS_1) file system volume.