Finspace

This page documents function available when using the Finspace module, created with @service Finspace.

Index

Documentation

Main.Finspace.create_environmentMethod
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.
Main.Finspace.create_kx_changesetMethod
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 a dbPath. A changeType can has 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. The s3Path attribute defines the s3 source file path and is required for a PUT change type. Here is an example of how you can use the change request object: [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ] In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.
  • 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.
Main.Finspace.create_kx_clusterMethod
create_kx_cluster(az_mode, capacity_configuration, cluster_name, cluster_type, environment_id, release_label)
create_kx_cluster(az_mode, capacity_configuration, cluster_name, cluster_type, environment_id, release_label, 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.
  • capacity_configuration: A structure for the metadata of a cluster. It includes information about like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
  • 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.
  • environment_id: A unique identifier for the kdb environment.
  • release_label: The version of FinSpace managed kdb to run.

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.
  • "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.
  • "tags": A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
  • "vpcConfiguration": Configuration details about the network where the Privatelink endpoint of the cluster resides.
Main.Finspace.create_kx_databaseMethod
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
Main.Finspace.create_kx_environmentMethod
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.
Main.Finspace.create_kx_userMethod
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.
Main.Finspace.delete_environmentMethod
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.
Main.Finspace.delete_kx_clusterMethod
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.
Main.Finspace.delete_kx_databaseMethod
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.
Main.Finspace.delete_kx_environmentMethod
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.
Main.Finspace.delete_kx_userMethod
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.
Main.Finspace.get_environmentMethod
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.
Main.Finspace.get_kx_changesetMethod
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.
Main.Finspace.get_kx_clusterMethod
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.
Main.Finspace.get_kx_connection_stringMethod
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.
Main.Finspace.get_kx_databaseMethod
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.
Main.Finspace.get_kx_environmentMethod
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.
Main.Finspace.get_kx_userMethod
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.
Main.Finspace.list_environmentsMethod
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.
Main.Finspace.list_kx_changesetsMethod
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.
Main.Finspace.list_kx_cluster_nodesMethod
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.
Main.Finspace.list_kx_clustersMethod
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.
  • "maxResults": The maximum number of results to return in this request.
  • "nextToken": A token that indicates where a results page should begin.
Main.Finspace.list_kx_databasesMethod
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.
Main.Finspace.list_kx_environmentsMethod
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.
Main.Finspace.list_kx_usersMethod
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.
Main.Finspace.list_tags_for_resourceMethod
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.
Main.Finspace.tag_resourceMethod
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.
Main.Finspace.untag_resourceMethod
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.
Main.Finspace.update_environmentMethod
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.
Main.Finspace.update_kx_cluster_databasesMethod
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.
Main.Finspace.update_kx_databaseMethod
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.
Main.Finspace.update_kx_environmentMethod
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.
Main.Finspace.update_kx_environment_networkMethod
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.
Main.Finspace.update_kx_userMethod
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.