The FinSpace management service provides the APIs for managing FinSpace environments.
", "operations": { "CreateEnvironment": "Create a new FinSpace environment.
", "CreateKxChangeset": "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.
", "CreateKxCluster": "Creates a new kdb cluster.
", "CreateKxDatabase": "Creates a new kdb database in the environment.
", "CreateKxDataview": "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.
", "CreateKxEnvironment": "Creates a managed kdb environment for the account.
", "CreateKxScalingGroup": "Creates a new scaling group.
", "CreateKxUser": "Creates a user in FinSpace kdb environment with an associated IAM role.
", "CreateKxVolume": "Creates a new volume with a specific amount of throughput and storage capacity.
", "DeleteEnvironment": "Delete an FinSpace environment.
", "DeleteKxCluster": "Deletes a kdb cluster.
", "DeleteKxDatabase": "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.
", "DeleteKxDataview": "Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
", "DeleteKxEnvironment": "Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
", "DeleteKxScalingGroup": "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.
", "DeleteKxUser": "Deletes a user in the specified kdb environment.
", "DeleteKxVolume": "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.
", "GetEnvironment": "Returns the FinSpace environment object.
", "GetKxChangeset": "Returns information about a kdb changeset.
", "GetKxCluster": "Retrieves information about a kdb cluster.
", "GetKxConnectionString": "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.
", "GetKxDatabase": "Returns database information for the specified environment ID.
", "GetKxDataview": "Retrieves details of the dataview.
", "GetKxEnvironment": "Retrieves all the information for the specified kdb environment.
", "GetKxScalingGroup": "Retrieves details of a scaling group.
", "GetKxUser": "Retrieves information about the specified kdb user.
", "GetKxVolume": "Retrieves the information about the volume.
", "ListEnvironments": "A list of all of your FinSpace environments.
", "ListKxChangesets": "Returns a list of all the changesets for a database.
", "ListKxClusterNodes": "Lists all the nodes in a kdb cluster.
", "ListKxClusters": "Returns a list of clusters.
", "ListKxDatabases": "Returns a list of all the databases in the kdb environment.
", "ListKxDataviews": "Returns a list of all the dataviews in the database.
", "ListKxEnvironments": "Returns a list of kdb environments created in an account.
", "ListKxScalingGroups": "Returns a list of scaling groups in a kdb environment.
", "ListKxUsers": "Lists all the users in a kdb environment.
", "ListKxVolumes": "Lists all the volumes in a kdb environment.
", "ListTagsForResource": "A list of all tags for a resource.
", "TagResource": "Adds metadata tags to a FinSpace resource.
", "UntagResource": "Removes metadata tags from a FinSpace resource.
", "UpdateEnvironment": "Update your FinSpace environment.
", "UpdateKxClusterCodeConfiguration": "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.
", "UpdateKxClusterDatabases": "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.
", "UpdateKxDatabase": "Updates information for the given kdb database.
", "UpdateKxDataview": "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
", "UpdateKxEnvironment": "Updates information for the given kdb environment.
", "UpdateKxEnvironmentNetwork": "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.
", "UpdateKxUser": "Updates the user details. You can only update the IAM role associated with a user.
", "UpdateKxVolume": "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.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AttachedClusterList": { "base": null, "refs": { "KxDataviewActiveVersion$attachedClusters": "The list of clusters that are currently using this dataview.
" } }, "AttributeMap": { "base": null, "refs": { "FederationParameters$attributeMap": "SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
", "refs": { "CreateKxClusterRequest$autoScalingConfiguration": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
", "CreateKxClusterResponse$autoScalingConfiguration": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
", "GetKxClusterResponse$autoScalingConfiguration": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" } }, "AutoScalingMetric": { "base": null, "refs": { "AutoScalingConfiguration$autoScalingMetric": " The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.
The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.
The availability zone identifiers for the requested regions.
", "CreateKxClusterResponse$availabilityZoneId": "The availability zone identifiers for the requested regions.
", "CreateKxDataviewRequest$availabilityZoneId": "The identifier of the availability zones.
", "CreateKxDataviewResponse$availabilityZoneId": "The identifier of the availability zones.
", "CreateKxScalingGroupRequest$availabilityZoneId": "The identifier of the availability zones.
", "CreateKxScalingGroupResponse$availabilityZoneId": "The identifier of the availability zones.
", "GetKxClusterResponse$availabilityZoneId": "The availability zone identifiers for the requested regions.
", "GetKxDataviewResponse$availabilityZoneId": "The identifier of the availability zones.
", "GetKxScalingGroupResponse$availabilityZoneId": "The identifier of the availability zones.
", "KxCluster$availabilityZoneId": "The availability zone identifiers for the requested regions.
", "KxDataviewListEntry$availabilityZoneId": "The identifier of the availability zones.
", "KxNode$availabilityZoneId": "The identifier of the availability zones where subnets for the environment are created.
", "KxScalingGroup$availabilityZoneId": "The identifier of the availability zones.
", "UpdateKxDataviewResponse$availabilityZoneId": "The identifier of the availability zones.
" } }, "AvailabilityZoneIds": { "base": null, "refs": { "CreateKxVolumeRequest$availabilityZoneIds": "The identifier of the availability zones.
", "CreateKxVolumeResponse$availabilityZoneIds": "The identifier of the availability zones.
", "GetKxEnvironmentResponse$availabilityZoneIds": "The identifier of the availability zones where subnets for the environment are created.
", "GetKxVolumeResponse$availabilityZoneIds": "The identifier of the availability zones.
", "KxEnvironment$availabilityZoneIds": "The identifier of the availability zones where subnets for the environment are created.
", "KxVolume$availabilityZoneIds": "The identifier of the availability zones.
", "UpdateKxEnvironmentNetworkResponse$availabilityZoneIds": "The identifier of the availability zones where subnets for the environment are created.
", "UpdateKxEnvironmentResponse$availabilityZoneIds": "The identifier of the availability zones where subnets for the environment are created.
", "UpdateKxVolumeResponse$availabilityZoneIds": "The identifier of the availability zones.
" } }, "BoxedInteger": { "base": null, "refs": { "ListKxEnvironmentsRequest$maxResults": "The maximum number of results to return in this request.
" } }, "CapacityConfiguration": { "base": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
", "refs": { "CreateKxClusterRequest$capacityConfiguration": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
", "CreateKxClusterResponse$capacityConfiguration": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
", "GetKxClusterResponse$capacityConfiguration": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" } }, "ChangeRequest": { "base": "A list of change request objects.
", "refs": { "ChangeRequests$member": null } }, "ChangeRequests": { "base": null, "refs": { "CreateKxChangesetRequest$changeRequests": "A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and 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. 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/\"}]
A list of change requests.
", "GetKxChangesetResponse$changeRequests": "A list of change request objects that are run in order.
" } }, "ChangeType": { "base": null, "refs": { "ChangeRequest$changeType": "Defines the type of change request. A changeType can have the following values:
PUT – Adds or updates files in a database.
DELETE – Deletes files in a database.
A unique identifier for the changeset.
", "CreateKxDataviewRequest$changesetId": "A unique identifier of the changeset that you want to use to ingest data.
", "CreateKxDataviewResponse$changesetId": "A unique identifier for the changeset.
", "GetKxChangesetRequest$changesetId": "A unique identifier of the changeset for which you want to retrieve data.
", "GetKxChangesetResponse$changesetId": "A unique identifier for the changeset.
", "GetKxDatabaseResponse$lastCompletedChangesetId": "A unique identifier for the changeset.
", "GetKxDataviewResponse$changesetId": "A unique identifier of the changeset that you want to use to ingest data.
", "KxChangesetListEntry$changesetId": "A unique identifier for the changeset.
", "KxDatabaseConfiguration$changesetId": "A unique identifier of the changeset that is associated with the cluster.
", "KxDataviewActiveVersion$changesetId": "A unique identifier for the changeset.
", "KxDataviewConfiguration$changesetId": "A unique identifier for the changeset.
", "KxDataviewListEntry$changesetId": "A unique identifier for the changeset.
", "UpdateKxDataviewRequest$changesetId": "A unique identifier for the changeset.
", "UpdateKxDataviewResponse$changesetId": "A unique identifier for the changeset.
" } }, "ChangesetStatus": { "base": null, "refs": { "CreateKxChangesetResponse$status": "Status of the changeset creation process.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
Status of the changeset creation process.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
Status of the changeset.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
A token that ensures idempotency. This token expires in 10 minutes.
", "CreateKxEnvironmentRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "CreateKxScalingGroupRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "CreateKxUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "CreateKxVolumeRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxEnvironmentRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxEnvironmentNetworkRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxEnvironmentRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
" } }, "ClientTokenString": { "base": null, "refs": { "CreateKxChangesetRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "CreateKxDatabaseRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "CreateKxDataviewRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxClusterRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxDatabaseRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxDataviewRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxScalingGroupRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteKxVolumeRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxClusterCodeConfigurationRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxClusterDatabasesRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxDatabaseRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxDataviewRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateKxVolumeRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
" } }, "ClusterNodeCount": { "base": null, "refs": { "KxScalingGroupConfiguration$nodeCount": "The number of kdb cluster nodes.
" } }, "CodeConfiguration": { "base": "The structure of the customer code available within the running cluster.
", "refs": { "CreateKxClusterRequest$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.
", "CreateKxClusterResponse$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.
", "GetKxClusterResponse$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.
", "UpdateKxClusterCodeConfigurationRequest$code": null } }, "ConflictException": { "base": "There was a conflict with this action, and it could not be completed.
", "refs": { } }, "CooldownTime": { "base": null, "refs": { "AutoScalingConfiguration$scaleInCooldownSeconds": "The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
", "AutoScalingConfiguration$scaleOutCooldownSeconds": "The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
" } }, "CpuCount": { "base": null, "refs": { "KxScalingGroupConfiguration$cpu": "The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
" } }, "CreateEnvironmentRequest": { "base": null, "refs": { } }, "CreateEnvironmentResponse": { "base": null, "refs": { } }, "CreateKxChangesetRequest": { "base": null, "refs": { } }, "CreateKxChangesetResponse": { "base": null, "refs": { } }, "CreateKxClusterRequest": { "base": null, "refs": { } }, "CreateKxClusterResponse": { "base": null, "refs": { } }, "CreateKxDatabaseRequest": { "base": null, "refs": { } }, "CreateKxDatabaseResponse": { "base": null, "refs": { } }, "CreateKxDataviewRequest": { "base": null, "refs": { } }, "CreateKxDataviewResponse": { "base": null, "refs": { } }, "CreateKxEnvironmentRequest": { "base": null, "refs": { } }, "CreateKxEnvironmentResponse": { "base": null, "refs": { } }, "CreateKxScalingGroupRequest": { "base": null, "refs": { } }, "CreateKxScalingGroupResponse": { "base": null, "refs": { } }, "CreateKxUserRequest": { "base": null, "refs": { } }, "CreateKxUserResponse": { "base": null, "refs": { } }, "CreateKxVolumeRequest": { "base": null, "refs": { } }, "CreateKxVolumeResponse": { "base": null, "refs": { } }, "CustomDNSConfiguration": { "base": null, "refs": { "GetKxEnvironmentResponse$customDNSConfiguration": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
", "KxEnvironment$customDNSConfiguration": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
", "UpdateKxEnvironmentNetworkRequest$customDNSConfiguration": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
", "UpdateKxEnvironmentNetworkResponse$customDNSConfiguration": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
", "UpdateKxEnvironmentResponse$customDNSConfiguration": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" } }, "CustomDNSServer": { "base": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
", "refs": { "CustomDNSConfiguration$member": null } }, "DataBundleArn": { "base": "The Amazon Resource Name (ARN) of the data bundle.
", "refs": { "DataBundleArns$member": null } }, "DataBundleArns": { "base": null, "refs": { "CreateEnvironmentRequest$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.
The ARN identifier of the database.
", "GetKxDatabaseResponse$databaseArn": "The ARN identifier of the database.
" } }, "DatabaseName": { "base": null, "refs": { "CreateKxChangesetRequest$databaseName": "The name of the kdb database.
", "CreateKxChangesetResponse$databaseName": "The name of the kdb database.
", "CreateKxDatabaseRequest$databaseName": "The name of the kdb database.
", "CreateKxDatabaseResponse$databaseName": "The name of the kdb database.
", "CreateKxDataviewRequest$databaseName": "The name of the database where you want to create a dataview.
", "CreateKxDataviewResponse$databaseName": "The name of the database where you want to create a dataview.
", "DeleteKxDatabaseRequest$databaseName": "The name of the kdb database that you want to delete.
", "DeleteKxDataviewRequest$databaseName": "The name of the database whose dataview you want to delete.
", "GetKxChangesetRequest$databaseName": "The name of the kdb database.
", "GetKxChangesetResponse$databaseName": "The name of the kdb database.
", "GetKxDatabaseRequest$databaseName": "The name of the kdb database.
", "GetKxDatabaseResponse$databaseName": "The name of the kdb database for which the information is retrieved.
", "GetKxDataviewRequest$databaseName": "The name of the database where you created the dataview.
", "GetKxDataviewResponse$databaseName": "The name of the database where you created the dataview.
", "KxDatabaseConfiguration$databaseName": "The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
", "KxDatabaseListEntry$databaseName": "The name of the kdb database.
", "KxDataviewListEntry$databaseName": "A unique identifier of the database.
", "ListKxChangesetsRequest$databaseName": "The name of the kdb database.
", "ListKxDataviewsRequest$databaseName": "The name of the database where the dataviews were created.
", "UpdateKxDatabaseRequest$databaseName": "The name of the kdb database.
", "UpdateKxDatabaseResponse$databaseName": "The name of the kdb database.
", "UpdateKxDataviewRequest$databaseName": "The name of the database.
", "UpdateKxDataviewResponse$databaseName": "The name of the database.
" } }, "DbPath": { "base": null, "refs": { "ChangeRequest$dbPath": "Defines the path within the database directory.
", "DbPaths$member": null, "SegmentConfigurationDbPathList$member": null } }, "DbPaths": { "base": null, "refs": { "KxDatabaseCacheConfiguration$dbPaths": "Specifies the portions of database that will be loaded into the cache for access.
" } }, "DeleteEnvironmentRequest": { "base": null, "refs": { } }, "DeleteEnvironmentResponse": { "base": null, "refs": { } }, "DeleteKxClusterRequest": { "base": null, "refs": { } }, "DeleteKxClusterResponse": { "base": null, "refs": { } }, "DeleteKxDatabaseRequest": { "base": null, "refs": { } }, "DeleteKxDatabaseResponse": { "base": null, "refs": { } }, "DeleteKxDataviewRequest": { "base": null, "refs": { } }, "DeleteKxDataviewResponse": { "base": null, "refs": { } }, "DeleteKxEnvironmentRequest": { "base": null, "refs": { } }, "DeleteKxEnvironmentResponse": { "base": null, "refs": { } }, "DeleteKxScalingGroupRequest": { "base": null, "refs": { } }, "DeleteKxScalingGroupResponse": { "base": null, "refs": { } }, "DeleteKxUserRequest": { "base": null, "refs": { } }, "DeleteKxUserResponse": { "base": null, "refs": { } }, "DeleteKxVolumeRequest": { "base": null, "refs": { } }, "DeleteKxVolumeResponse": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "CreateEnvironmentRequest$description": "The description of the FinSpace environment to be created.
", "CreateKxDatabaseRequest$description": "A description of the database.
", "CreateKxDatabaseResponse$description": "A description of the database.
", "CreateKxDataviewRequest$description": "A description of the dataview.
", "CreateKxDataviewResponse$description": "A description of the dataview.
", "CreateKxEnvironmentRequest$description": "A description for the kdb environment.
", "CreateKxEnvironmentResponse$description": "A description for the kdb environment.
", "CreateKxVolumeRequest$description": "A description of the volume.
", "CreateKxVolumeResponse$description": "A description of the volume.
", "Environment$description": "The description of the FinSpace environment.
", "GetKxDatabaseResponse$description": "A description of the database.
", "GetKxDataviewResponse$description": "A description of the dataview.
", "GetKxEnvironmentResponse$description": "A description for the kdb environment.
", "GetKxVolumeResponse$description": "A description of the volume.
", "KxDataviewListEntry$description": "A description for the dataview list entry.
", "KxEnvironment$description": "A description of the kdb environment.
", "KxVolume$description": "A description of the volume.
", "UpdateEnvironmentRequest$description": "The description of the environment.
", "UpdateKxDatabaseRequest$description": "A description of the database.
", "UpdateKxDatabaseResponse$description": "A description of the database.
", "UpdateKxDataviewRequest$description": "The description for a dataview.
", "UpdateKxDataviewResponse$description": "A description of the dataview.
", "UpdateKxEnvironmentNetworkResponse$description": "The description of the environment.
", "UpdateKxEnvironmentRequest$description": "A description of the kdb environment.
", "UpdateKxEnvironmentResponse$description": "The description of the environment.
", "UpdateKxVolumeRequest$description": "A description of the volume.
", "UpdateKxVolumeResponse$description": "The description for the volume.
" } }, "EmailId": { "base": null, "refs": { "SuperuserParameters$emailAddress": "The email address of the superuser.
" } }, "Environment": { "base": "Represents an FinSpace environment.
", "refs": { "EnvironmentList$member": null, "GetEnvironmentResponse$environment": "The name of the FinSpace environment.
", "UpdateEnvironmentResponse$environment": "Returns the FinSpace environment object.
" } }, "EnvironmentArn": { "base": null, "refs": { "CreateEnvironmentResponse$environmentArn": "The Amazon Resource Name (ARN) of the FinSpace environment that you created.
", "CreateKxEnvironmentResponse$environmentArn": "The ARN identifier of the environment.
", "Environment$environmentArn": "The Amazon Resource Name (ARN) of your FinSpace environment.
", "GetKxEnvironmentResponse$environmentArn": "The ARN identifier of the environment.
", "KxEnvironment$environmentArn": "The Amazon Resource Name (ARN) of your kdb environment.
", "UpdateKxEnvironmentNetworkResponse$environmentArn": "The ARN identifier of the environment.
", "UpdateKxEnvironmentResponse$environmentArn": "The ARN identifier of the environment.
" } }, "EnvironmentErrorMessage": { "base": null, "refs": { "GetKxEnvironmentResponse$errorMessage": "Specifies the error message that appears if a flow fails.
", "KxEnvironment$errorMessage": "Specifies the error message that appears if a flow fails.
", "UpdateKxEnvironmentNetworkResponse$errorMessage": "Specifies the error message that appears if a flow fails.
", "UpdateKxEnvironmentResponse$errorMessage": "Specifies the error message that appears if a flow fails.
" } }, "EnvironmentId": { "base": null, "refs": { "CreateKxChangesetRequest$environmentId": "A unique identifier of the kdb environment.
", "CreateKxChangesetResponse$environmentId": "A unique identifier for the kdb environment.
", "CreateKxDatabaseRequest$environmentId": "A unique identifier for the kdb environment.
", "CreateKxDatabaseResponse$environmentId": "A unique identifier for the kdb environment.
", "CreateKxDataviewRequest$environmentId": "A unique identifier for the kdb environment, where you want to create the dataview.
", "CreateKxDataviewResponse$environmentId": "A unique identifier for the kdb environment, where you want to create the dataview.
", "DeleteKxDatabaseRequest$environmentId": "A unique identifier for the kdb environment.
", "DeleteKxDataviewRequest$environmentId": "A unique identifier for the kdb environment, from where you want to delete the dataview.
", "GetKxChangesetRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxChangesetResponse$environmentId": "A unique identifier for the kdb environment.
", "GetKxDatabaseRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxDatabaseResponse$environmentId": "A unique identifier for the kdb environment.
", "GetKxDataviewRequest$environmentId": "A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
", "GetKxDataviewResponse$environmentId": "A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
", "KxDataviewListEntry$environmentId": "A unique identifier for the kdb environment.
", "ListKxChangesetsRequest$environmentId": "A unique identifier for the kdb environment.
", "ListKxDatabasesRequest$environmentId": "A unique identifier for the kdb environment.
", "ListKxDataviewsRequest$environmentId": "A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.
", "UpdateKxDatabaseRequest$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxDatabaseResponse$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxDataviewRequest$environmentId": "A unique identifier for the kdb environment, where you want to update the dataview.
", "UpdateKxDataviewResponse$environmentId": "A unique identifier for the kdb environment, where you want to update the dataview.
" } }, "EnvironmentList": { "base": null, "refs": { "ListEnvironmentsResponse$environments": "A list of all of your FinSpace environments.
" } }, "EnvironmentName": { "base": null, "refs": { "CreateEnvironmentRequest$name": "The name of the FinSpace environment to be created.
", "Environment$name": "The name of the FinSpace environment.
", "UpdateEnvironmentRequest$name": "The name of the environment.
" } }, "EnvironmentStatus": { "base": null, "refs": { "CreateKxEnvironmentResponse$status": "The status of the kdb environment.
", "Environment$status": "The current status of creation of the FinSpace environment.
", "GetKxEnvironmentResponse$status": "The status of the kdb environment.
", "KxEnvironment$status": "The status of the environment creation.
CREATE_REQUESTED – Environment creation has been requested.
CREATING – Environment is in the process of being created.
FAILED_CREATION – Environment creation has failed.
CREATED – Environment is successfully created and is currently active.
DELETE REQUESTED – Environment deletion has been requested.
DELETING – Environment is in the process of being deleted.
RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.
DELETED – Environment has been deleted.
FAILED_DELETION – Environment deletion has failed.
The status of the kdb environment.
", "UpdateKxEnvironmentResponse$status": "The status of the kdb environment.
" } }, "ErrorDetails": { "base": null, "refs": { "ErrorInfo$errorType": "Specifies the type of error.
" } }, "ErrorInfo": { "base": "Provides details in the event of a failed flow, including the error type and the related error message.
", "refs": { "CreateKxChangesetResponse$errorInfo": "The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
", "GetKxChangesetResponse$errorInfo": "Provides details in the event of a failed flow, including the error type and the related error message.
" } }, "ErrorMessage": { "base": null, "refs": { "ErrorInfo$errorMessage": "Specifies the error message that appears if a flow fails.
" } }, "ExecutionRoleArn": { "base": null, "refs": { "CreateKxClusterRequest$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.
", "CreateKxClusterResponse$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.
", "GetKxClusterResponse$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.
", "KxCluster$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.
" } }, "FederationAttributeKey": { "base": null, "refs": { "AttributeMap$key": null } }, "FederationAttributeValue": { "base": null, "refs": { "AttributeMap$value": null } }, "FederationMode": { "base": null, "refs": { "CreateEnvironmentRequest$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.
The authentication mode for the environment.
", "UpdateEnvironmentRequest$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.
Configuration information when authentication mode is FEDERATED.
", "refs": { "CreateEnvironmentRequest$federationParameters": "Configuration information when authentication mode is FEDERATED.
", "Environment$federationParameters": "Configuration information when authentication mode is FEDERATED.
", "UpdateEnvironmentRequest$federationParameters": null } }, "FederationProviderName": { "base": null, "refs": { "FederationParameters$federationProviderName": "Name of the identity provider (IdP).
" } }, "FinSpaceTaggableArn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name of the resource.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) for the resource.
", "UntagResourceRequest$resourceArn": "A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
" } }, "GetEnvironmentRequest": { "base": null, "refs": { } }, "GetEnvironmentResponse": { "base": null, "refs": { } }, "GetKxChangesetRequest": { "base": null, "refs": { } }, "GetKxChangesetResponse": { "base": null, "refs": { } }, "GetKxClusterRequest": { "base": null, "refs": { } }, "GetKxClusterResponse": { "base": null, "refs": { } }, "GetKxConnectionStringRequest": { "base": null, "refs": { } }, "GetKxConnectionStringResponse": { "base": null, "refs": { } }, "GetKxDatabaseRequest": { "base": null, "refs": { } }, "GetKxDatabaseResponse": { "base": null, "refs": { } }, "GetKxDataviewRequest": { "base": null, "refs": { } }, "GetKxDataviewResponse": { "base": null, "refs": { } }, "GetKxEnvironmentRequest": { "base": null, "refs": { } }, "GetKxEnvironmentResponse": { "base": null, "refs": { } }, "GetKxScalingGroupRequest": { "base": null, "refs": { } }, "GetKxScalingGroupResponse": { "base": null, "refs": { } }, "GetKxUserRequest": { "base": null, "refs": { } }, "GetKxUserResponse": { "base": null, "refs": { } }, "GetKxVolumeRequest": { "base": null, "refs": { } }, "GetKxVolumeResponse": { "base": null, "refs": { } }, "IPAddressType": { "base": null, "refs": { "VpcConfiguration$ipAddressType": "The IP address type for cluster network configuration parameters. The following type is available:
IP_V4 – IP address version 4
Defines the ICMP protocol that consists of the ICMP type and code.
", "refs": { "NetworkACLEntry$icmpTypeCode": "Defines the ICMP protocol that consists of the ICMP type and code.
" } }, "IcmpTypeOrCode": { "base": null, "refs": { "IcmpTypeCode$type": "The ICMP type. A value of -1 means all types.
", "IcmpTypeCode$code": "The ICMP code. A value of -1 means all codes for the specified ICMP type.
" } }, "IdType": { "base": null, "refs": { "CreateEnvironmentResponse$environmentId": "The unique identifier for FinSpace environment that you created.
", "CreateKxEnvironmentResponse$environmentId": "A unique identifier for the kdb environment.
", "CreateKxUserRequest$environmentId": "A unique identifier for the kdb environment where you want to create a user.
", "CreateKxUserResponse$environmentId": "A unique identifier for the kdb environment.
", "DeleteEnvironmentRequest$environmentId": "The identifier for the FinSpace environment.
", "DeleteKxEnvironmentRequest$environmentId": "A unique identifier for the kdb environment.
", "DeleteKxUserRequest$environmentId": "A unique identifier for the kdb environment.
", "Environment$environmentId": "The identifier of the FinSpace environment.
", "Environment$awsAccountId": "The ID of the AWS account in which the FinSpace environment is created.
", "Environment$dedicatedServiceAccountId": "The AWS account ID of the dedicated service account associated with your FinSpace environment.
", "GetEnvironmentRequest$environmentId": "The identifier of the FinSpace environment.
", "GetKxConnectionStringRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxEnvironmentRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxEnvironmentResponse$environmentId": "A unique identifier for the kdb environment.
", "GetKxEnvironmentResponse$awsAccountId": "The unique identifier of the AWS account that is used to create the kdb environment.
", "GetKxEnvironmentResponse$dedicatedServiceAccountId": "A unique identifier for the AWS environment infrastructure account.
", "GetKxUserRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxUserResponse$userName": "A unique identifier for the user.
", "GetKxUserResponse$environmentId": "A unique identifier for the kdb environment.
", "KxEnvironment$environmentId": "A unique identifier for the kdb environment.
", "KxEnvironment$awsAccountId": "The unique identifier of the AWS account in which you create the kdb environment.
", "KxEnvironment$dedicatedServiceAccountId": "A unique identifier for the AWS environment infrastructure account.
", "ListKxUsersRequest$environmentId": "A unique identifier for the kdb environment.
", "UpdateEnvironmentRequest$environmentId": "The identifier of the FinSpace environment.
", "UpdateKxEnvironmentNetworkRequest$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxEnvironmentNetworkResponse$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxEnvironmentNetworkResponse$awsAccountId": "The unique identifier of the AWS account that is used to create the kdb environment.
", "UpdateKxEnvironmentNetworkResponse$dedicatedServiceAccountId": "A unique identifier for the AWS environment infrastructure account.
", "UpdateKxEnvironmentRequest$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxEnvironmentResponse$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxEnvironmentResponse$awsAccountId": "The unique identifier of the AWS account that is used to create the kdb environment.
", "UpdateKxEnvironmentResponse$dedicatedServiceAccountId": "A unique identifier for the AWS environment infrastructure account.
", "UpdateKxUserRequest$environmentId": "A unique identifier for the kdb environment.
", "UpdateKxUserResponse$environmentId": "A unique identifier for the kdb environment.
" } }, "InitializationScriptFilePath": { "base": null, "refs": { "CreateKxClusterRequest$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.
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.
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.
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.
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.
The request processing has failed because of an unknown error, exception or failure.
", "refs": { } }, "InvalidRequestException": { "base": "The request is invalid. Something is wrong with the input to the request.
", "refs": { } }, "KmsKeyARN": { "base": null, "refs": { "CreateKxEnvironmentRequest$kmsKeyId": "The KMS key ID to encrypt your data in the FinSpace environment.
" } }, "KmsKeyId": { "base": null, "refs": { "CreateEnvironmentRequest$kmsKeyId": "The KMS key id to encrypt your data in the FinSpace environment.
", "CreateKxEnvironmentResponse$kmsKeyId": "The KMS key ID to encrypt your data in the FinSpace environment.
", "Environment$kmsKeyId": "The KMS key id used to encrypt in the FinSpace environment.
", "GetKxEnvironmentResponse$kmsKeyId": "The KMS key ID to encrypt your data in the FinSpace environment.
", "KxEnvironment$kmsKeyId": "The unique identifier of the KMS key.
", "UpdateKxEnvironmentNetworkResponse$kmsKeyId": "The KMS key ID to encrypt your data in the FinSpace environment.
", "UpdateKxEnvironmentResponse$kmsKeyId": "The KMS key ID to encrypt your data in the FinSpace environment.
" } }, "KxAttachedCluster": { "base": "The structure containing the metadata of the attached clusters.
", "refs": { "KxAttachedClusters$member": null } }, "KxAttachedClusters": { "base": null, "refs": { "GetKxVolumeResponse$attachedClusters": "A list of cluster identifiers that a volume is attached to.
", "UpdateKxVolumeResponse$attachedClusters": "Specifies the clusters that a volume is attached to.
" } }, "KxAzMode": { "base": null, "refs": { "CreateKxClusterRequest$azMode": "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.
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.
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.
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.
The number of availability zones you want to assign per cluster. Currently, FinSpace only support SINGLE for volumes.
The number of availability zones you want to assign per cluster. Currently, FinSpace only support SINGLE for volumes.
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.
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.
The number of availability zones you want to assign per cluster. Currently, FinSpace only support SINGLE for volumes.
The number of availability zones assigned per cluster. This can be one of the following:
SINGLE – Assigns one availability zone per cluster.
MULTI – Assigns all the availability zones per cluster.
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.
The number of availability zones assigned to the volume. Currently, only SINGLE is supported.
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.
The number of availability zones you want to assign per cluster. Currently, FinSpace only support SINGLE for volumes.
The configuration for read only disk cache associated with a cluster.
", "refs": { "KxCacheStorageConfigurations$member": null } }, "KxCacheStorageConfigurations": { "base": null, "refs": { "CreateKxClusterRequest$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.
", "CreateKxClusterResponse$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.
", "GetKxClusterResponse$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.
" } }, "KxCacheStorageSize": { "base": null, "refs": { "KxCacheStorageConfiguration$size": "The size of cache in Gigabytes.
" } }, "KxCacheStorageType": { "base": null, "refs": { "KxCacheStorageConfiguration$type": "The type of cache storage. The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
CACHE_250 – This type provides at least 250 MB/s disk access throughput.
CACHE_12 – This type provides at least 12 MB/s disk access throughput.
For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.
The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
Details of changeset.
", "refs": { "KxChangesets$member": null } }, "KxChangesets": { "base": null, "refs": { "ListKxChangesetsResponse$kxChangesets": "A list of changesets for a database.
" } }, "KxCluster": { "base": "The details of a kdb cluster.
", "refs": { "KxClusters$member": null } }, "KxClusterCodeDeploymentConfiguration": { "base": "The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.
", "refs": { "UpdateKxClusterCodeConfigurationRequest$deploymentConfiguration": "The configuration that allows you to choose how you want to update the code on a cluster.
" } }, "KxClusterCodeDeploymentStrategy": { "base": null, "refs": { "KxClusterCodeDeploymentConfiguration$deploymentStrategy": "The type of deployment that you want on a cluster.
ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.
A description of the cluster.
", "CreateKxClusterResponse$clusterDescription": "A description of the cluster.
", "GetKxClusterResponse$clusterDescription": "A description of the cluster.
", "KxCluster$clusterDescription": "A description of the cluster.
" } }, "KxClusterName": { "base": null, "refs": { "AttachedClusterList$member": null, "CreateKxClusterRequest$clusterName": "A unique name for the cluster that you want to create.
", "CreateKxClusterResponse$clusterName": "A unique name for the cluster.
", "DeleteKxClusterRequest$clusterName": "The name of the cluster that you want to delete.
", "GetKxClusterRequest$clusterName": "The name of the cluster that you want to retrieve.
", "GetKxClusterResponse$clusterName": "A unique name for the cluster.
", "GetKxConnectionStringRequest$clusterName": "A name of the kdb cluster.
", "KxAttachedCluster$clusterName": "A unique name for the attached cluster.
", "KxCluster$clusterName": "A unique name for the cluster.
", "KxClusterNameList$member": null, "ListKxClusterNodesRequest$clusterName": "A unique name for the cluster.
", "UpdateKxClusterCodeConfigurationRequest$clusterName": "The name of the cluster.
", "UpdateKxClusterDatabasesRequest$clusterName": "A unique name for the cluster that you want to modify.
" } }, "KxClusterNameList": { "base": null, "refs": { "GetKxScalingGroupResponse$clusters": "The list of Managed kdb clusters that are currently active in the given scaling group.
", "KxScalingGroup$clusters": "The list of clusters currently active in a given scaling group.
" } }, "KxClusterNodeIdString": { "base": null, "refs": { "KxNode$nodeId": "A unique identifier for the node.
" } }, "KxClusterStatus": { "base": null, "refs": { "CreateKxClusterResponse$status": "The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The status of the attached cluster.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The status of a cluster.
PENDING – The cluster is pending creation.
CREATING –The cluster creation process is in progress.
CREATE_FAILED– The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
The error message when a failed state occurs.
", "GetKxClusterResponse$statusReason": "The error message when a failed state occurs.
", "GetKxScalingGroupResponse$statusReason": "The error message when a failed state occurs.
", "KxCluster$statusReason": "The error message when a failed state occurs.
", "KxScalingGroup$statusReason": "The error message when a failed state occurs.
" } }, "KxClusterType": { "base": null, "refs": { "CreateKxClusterRequest$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.
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.
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.
Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.
", "KxCluster$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.
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.
Lists the cluster details.
" } }, "KxCommandLineArgument": { "base": "Defines the key-value pairs to make them available inside the cluster.
", "refs": { "KxCommandLineArguments$member": null } }, "KxCommandLineArgumentKey": { "base": null, "refs": { "KxCommandLineArgument$key": "The name of the key.
" } }, "KxCommandLineArgumentValue": { "base": null, "refs": { "KxCommandLineArgument$value": "The value of the key.
" } }, "KxCommandLineArguments": { "base": null, "refs": { "CreateKxClusterRequest$commandLineArguments": "Defines the key-value pairs to make them available inside the cluster.
", "CreateKxClusterResponse$commandLineArguments": "Defines the key-value pairs to make them available inside the cluster.
", "GetKxClusterResponse$commandLineArguments": "Defines key-value pairs to make them available inside the cluster.
", "UpdateKxClusterCodeConfigurationRequest$commandLineArguments": "Specifies the key-value pairs to make them available inside the cluster.
You cannot update this parameter for a NO_RESTART deployment.
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
", "refs": { "KxDatabaseCacheConfigurations$member": null } }, "KxDatabaseCacheConfigurations": { "base": null, "refs": { "KxDatabaseConfiguration$cacheConfigurations": "Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
" } }, "KxDatabaseConfiguration": { "base": "The configuration of data that is available for querying from this database.
", "refs": { "KxDatabaseConfigurations$member": null } }, "KxDatabaseConfigurations": { "base": null, "refs": { "CreateKxClusterRequest$databases": "A list of databases that will be available for querying.
", "CreateKxClusterResponse$databases": "A list of databases that will be available for querying.
", "GetKxClusterResponse$databases": "A list of databases mounted on the cluster.
", "UpdateKxClusterDatabasesRequest$databases": "The structure of databases mounted on the cluster.
" } }, "KxDatabaseListEntry": { "base": "Details about a FinSpace managed kdb database
", "refs": { "KxDatabases$member": null } }, "KxDatabases": { "base": null, "refs": { "ListKxDatabasesResponse$kxDatabases": "A list of databases in the kdb environment.
" } }, "KxDataviewActiveVersion": { "base": "The active version of the dataview that is currently in use by this cluster.
", "refs": { "KxDataviewActiveVersionList$member": null } }, "KxDataviewActiveVersionList": { "base": null, "refs": { "GetKxDataviewResponse$activeVersions": "The current active changeset versions of the database on the given dataview.
", "KxDataviewListEntry$activeVersions": "The active changeset versions for the given dataview entry.
", "UpdateKxDataviewResponse$activeVersions": "The current active changeset versions of the database on the given dataview.
" } }, "KxDataviewConfiguration": { "base": "The structure that stores the configuration details of a dataview.
", "refs": { "KxDatabaseConfiguration$dataviewConfiguration": "The configuration of the dataview to be used with specified cluster.
" } }, "KxDataviewListEntry": { "base": "A collection of kdb dataview entries.
", "refs": { "KxDataviews$member": null } }, "KxDataviewName": { "base": null, "refs": { "CreateKxDataviewRequest$dataviewName": "A unique identifier for the dataview.
", "CreateKxDataviewResponse$dataviewName": "A unique identifier for the dataview.
", "DeleteKxDataviewRequest$dataviewName": "The name of the dataview that you want to delete.
", "GetKxDataviewRequest$dataviewName": "A unique identifier for the dataview.
", "GetKxDataviewResponse$dataviewName": "A unique identifier for the dataview.
", "KxDatabaseCacheConfiguration$dataviewName": "The name of the dataview to be used for caching historical data on disk.
", "KxDatabaseConfiguration$dataviewName": "The name of the dataview to be used for caching historical data on disk.
", "KxDataviewConfiguration$dataviewName": "The unique identifier of the dataview.
", "KxDataviewListEntry$dataviewName": "A unique identifier of the dataview.
", "UpdateKxDataviewRequest$dataviewName": "The name of the dataview that you want to update.
", "UpdateKxDataviewResponse$dataviewName": "The name of the database under which the dataview was created.
" } }, "KxDataviewSegmentConfiguration": { "base": "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.
", "refs": { "KxDataviewSegmentConfigurationList$member": null } }, "KxDataviewSegmentConfigurationList": { "base": null, "refs": { "CreateKxDataviewRequest$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.
", "CreateKxDataviewResponse$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.
", "GetKxDataviewResponse$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.
", "KxDataviewActiveVersion$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.
", "KxDataviewConfiguration$segmentConfigurations": "The db path and volume configuration for the segmented database.
", "KxDataviewListEntry$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.
", "UpdateKxDataviewRequest$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.
", "UpdateKxDataviewResponse$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.
" } }, "KxDataviewStatus": { "base": null, "refs": { "CreateKxDataviewResponse$status": "The status of dataview creation.
CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.
The status of dataview creation.
CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.
The status of a given dataview entry.
", "UpdateKxDataviewResponse$status": "The status of dataview creation.
CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.
The error message when a failed state occurs.
", "KxDataviewListEntry$statusReason": "The error message when a failed state occurs.
" } }, "KxDataviews": { "base": null, "refs": { "ListKxDataviewsResponse$kxDataviews": "The list of kdb dataviews that are currently active for the given database.
" } }, "KxDeploymentConfiguration": { "base": "The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.
", "refs": { "UpdateKxClusterDatabasesRequest$deploymentConfiguration": "The configuration that allows you to choose how you want to update the databases on a cluster.
" } }, "KxDeploymentStrategy": { "base": null, "refs": { "KxDeploymentConfiguration$deploymentStrategy": "The type of deployment that you want on a cluster.
ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for HDB type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
The details of a kdb environment.
", "refs": { "KxEnvironmentList$member": null } }, "KxEnvironmentId": { "base": null, "refs": { "CreateKxClusterRequest$environmentId": "A unique identifier for the kdb environment.
", "CreateKxClusterResponse$environmentId": "A unique identifier for the kdb environment.
", "CreateKxScalingGroupRequest$environmentId": "A unique identifier for the kdb environment, where you want to create the scaling group.
", "CreateKxScalingGroupResponse$environmentId": "A unique identifier for the kdb environment, where you create the scaling group.
", "CreateKxVolumeRequest$environmentId": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", "CreateKxVolumeResponse$environmentId": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", "DeleteKxClusterRequest$environmentId": "A unique identifier for the kdb environment.
", "DeleteKxScalingGroupRequest$environmentId": "A unique identifier for the kdb environment, from where you want to delete the dataview.
", "DeleteKxVolumeRequest$environmentId": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", "GetKxClusterRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxScalingGroupRequest$environmentId": "A unique identifier for the kdb environment.
", "GetKxVolumeRequest$environmentId": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", "GetKxVolumeResponse$environmentId": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", "ListKxClusterNodesRequest$environmentId": "A unique identifier for the kdb environment.
", "ListKxClustersRequest$environmentId": "A unique identifier for the kdb environment.
", "ListKxScalingGroupsRequest$environmentId": "A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.
", "ListKxVolumesRequest$environmentId": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", "UpdateKxClusterCodeConfigurationRequest$environmentId": "A unique identifier of the kdb environment.
", "UpdateKxClusterDatabasesRequest$environmentId": "The unique identifier of a kdb environment.
", "UpdateKxVolumeRequest$environmentId": "A unique identifier for the kdb environment where you created the storage volume.
", "UpdateKxVolumeResponse$environmentId": "A unique identifier for the kdb environment where you want to update the volume.
" } }, "KxEnvironmentList": { "base": null, "refs": { "ListKxEnvironmentsResponse$environments": "A list of environments in an account.
" } }, "KxEnvironmentName": { "base": null, "refs": { "CreateKxEnvironmentRequest$name": "The name of the kdb environment that you want to create.
", "CreateKxEnvironmentResponse$name": "The name of the kdb environment.
", "GetKxEnvironmentResponse$name": "The name of the kdb environment.
", "KxEnvironment$name": "The name of the kdb environment.
", "UpdateKxEnvironmentNetworkResponse$name": "The name of the kdb environment.
", "UpdateKxEnvironmentRequest$name": "The name of the kdb environment.
", "UpdateKxEnvironmentResponse$name": "The name of the kdb environment.
" } }, "KxHostType": { "base": null, "refs": { "CreateKxScalingGroupRequest$hostType": "The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
", "CreateKxScalingGroupResponse$hostType": "The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
", "GetKxScalingGroupResponse$hostType": "The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
", "KxScalingGroup$hostType": "The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
" } }, "KxNAS1Configuration": { "base": "The structure containing the size and type of the network attached storage (NAS_1) file system volume.
", "refs": { "CreateKxVolumeRequest$nas1Configuration": " Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose volumeType as NAS_1.
Specifies the configuration for the Network attached storage (NAS_1) file system volume.
", "GetKxVolumeResponse$nas1Configuration": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
", "UpdateKxVolumeRequest$nas1Configuration": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
", "UpdateKxVolumeResponse$nas1Configuration": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" } }, "KxNAS1Size": { "base": null, "refs": { "KxNAS1Configuration$size": "The size of the network attached storage.
" } }, "KxNAS1Type": { "base": null, "refs": { "KxNAS1Configuration$type": "The type of the network attached storage.
" } }, "KxNode": { "base": "A structure that stores metadata for a kdb node.
", "refs": { "KxNodeSummaries$member": null } }, "KxNodeSummaries": { "base": null, "refs": { "ListKxClusterNodesResponse$nodes": "A list of nodes associated with the cluster.
" } }, "KxSavedownStorageConfiguration": { "base": "The size and type of temporary storage that is used to hold data during the savedown process. All the data written to this storage space is lost when the cluster node is restarted.
", "refs": { "CreateKxClusterRequest$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.
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.
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.
The size of temporary storage in gibibytes.
" } }, "KxSavedownStorageType": { "base": null, "refs": { "KxSavedownStorageConfiguration$type": "The type of writeable storage space for temporarily storing your savedown data. The valid values are:
SDS01 – This type represents 3000 IOPS and io2 ebs volume type.
A structure for storing metadata of scaling group.
", "refs": { "KxScalingGroupList$member": null } }, "KxScalingGroupConfiguration": { "base": "The structure that stores the capacity configuration details of a scaling group.
", "refs": { "CreateKxClusterRequest$scalingGroupConfiguration": "The structure that stores the configuration details of a scaling group.
", "CreateKxClusterResponse$scalingGroupConfiguration": "The structure that stores the configuration details of a scaling group.
", "GetKxClusterResponse$scalingGroupConfiguration": null } }, "KxScalingGroupList": { "base": null, "refs": { "ListKxScalingGroupsResponse$scalingGroups": "A list of scaling groups available in a kdb environment.
" } }, "KxScalingGroupName": { "base": null, "refs": { "CreateKxScalingGroupRequest$scalingGroupName": "A unique identifier for the kdb scaling group.
", "CreateKxScalingGroupResponse$scalingGroupName": "A unique identifier for the kdb scaling group.
", "DeleteKxScalingGroupRequest$scalingGroupName": "A unique identifier for the kdb scaling group.
", "GetKxScalingGroupRequest$scalingGroupName": "A unique identifier for the kdb scaling group.
", "GetKxScalingGroupResponse$scalingGroupName": "A unique identifier for the kdb scaling group.
", "KxScalingGroup$scalingGroupName": "A unique identifier for the kdb scaling group.
", "KxScalingGroupConfiguration$scalingGroupName": "A unique identifier for the kdb scaling group.
" } }, "KxScalingGroupStatus": { "base": null, "refs": { "CreateKxScalingGroupResponse$status": "The status of scaling group.
CREATING – The scaling group creation is in progress.
CREATE_FAILED – The scaling group creation has failed.
ACTIVE – The scaling group is active.
UPDATING – The scaling group is in the process of being updated.
UPDATE_FAILED – The update action failed.
DELETING – The scaling group is in the process of being deleted.
DELETE_FAILED – The system failed to delete the scaling group.
DELETED – The scaling group is successfully deleted.
The status of scaling group.
CREATING – The scaling group creation is in progress.
CREATE_FAILED – The scaling group creation has failed.
ACTIVE – The scaling group is active.
UPDATING – The scaling group is in the process of being updated.
UPDATE_FAILED – The update action failed.
DELETING – The scaling group is in the process of being deleted.
DELETE_FAILED – The system failed to delete the scaling group.
DELETED – The scaling group is successfully deleted.
The status of scaling groups.
" } }, "KxUser": { "base": "A structure that stores metadata for a kdb user.
", "refs": { "KxUserList$member": null } }, "KxUserArn": { "base": null, "refs": { "CreateKxUserResponse$userArn": "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.
", "GetKxConnectionStringRequest$userArn": "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.
", "GetKxUserResponse$userArn": "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.
", "KxUser$userArn": "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.
", "UpdateKxUserResponse$userArn": "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.
" } }, "KxUserList": { "base": null, "refs": { "ListKxUsersResponse$users": "A list of users in a kdb environment.
" } }, "KxUserNameString": { "base": null, "refs": { "CreateKxUserRequest$userName": "A unique identifier for the user.
", "CreateKxUserResponse$userName": "A unique identifier for the user.
", "DeleteKxUserRequest$userName": "A unique identifier for the user that you want to delete.
", "GetKxUserRequest$userName": "A unique identifier for the user.
", "KxUser$userName": "A unique identifier for the user.
", "UpdateKxUserRequest$userName": "A unique identifier for the user.
", "UpdateKxUserResponse$userName": "A unique identifier for the user.
" } }, "KxVolume": { "base": "The structure that contains the metadata of the volume.
", "refs": { "KxVolumes$member": null } }, "KxVolumeArn": { "base": null, "refs": { "CreateKxVolumeResponse$volumeArn": "The ARN identifier of the volume.
", "GetKxVolumeResponse$volumeArn": "The ARN identifier of the volume.
", "UpdateKxVolumeResponse$volumeArn": "The ARN identifier of the volume.
" } }, "KxVolumeName": { "base": null, "refs": { "CreateKxVolumeRequest$volumeName": "A unique identifier for the volume.
", "CreateKxVolumeResponse$volumeName": "A unique identifier for the volume.
", "DeleteKxVolumeRequest$volumeName": "The name of the volume that you want to delete.
", "GetKxVolumeRequest$volumeName": "A unique identifier for the volume.
", "GetKxVolumeResponse$volumeName": "A unique identifier for the volume.
", "KxDataviewSegmentConfiguration$volumeName": "The name of the volume where you want to add data.
", "KxSavedownStorageConfiguration$volumeName": "The name of the kdb volume that you want to use as writeable save-down storage for clusters.
", "KxVolume$volumeName": "A unique identifier for the volume.
", "UpdateKxVolumeRequest$volumeName": "A unique identifier for the volume.
", "UpdateKxVolumeResponse$volumeName": "A unique identifier for the volume that you want to update.
" } }, "KxVolumeStatus": { "base": null, "refs": { "CreateKxVolumeResponse$status": "The status of volume creation.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
The status of volume creation.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
The status of volume.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
The status of the volume.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
The error message when a failed state occurs.
", "GetKxVolumeResponse$statusReason": "The error message when a failed state occurs.
", "KxVolume$statusReason": "The error message when a failed state occurs.
", "UpdateKxVolumeResponse$statusReason": "The error message when a failed state occurs.
" } }, "KxVolumeType": { "base": null, "refs": { "CreateKxVolumeRequest$volumeType": " The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
A summary of volumes.
" } }, "LimitExceededException": { "base": "A service limit or quota is exceeded.
", "refs": { } }, "ListEnvironmentsRequest": { "base": null, "refs": { } }, "ListEnvironmentsResponse": { "base": null, "refs": { } }, "ListKxChangesetsRequest": { "base": null, "refs": { } }, "ListKxChangesetsResponse": { "base": null, "refs": { } }, "ListKxClusterNodesRequest": { "base": null, "refs": { } }, "ListKxClusterNodesResponse": { "base": null, "refs": { } }, "ListKxClustersRequest": { "base": null, "refs": { } }, "ListKxClustersResponse": { "base": null, "refs": { } }, "ListKxDatabasesRequest": { "base": null, "refs": { } }, "ListKxDatabasesResponse": { "base": null, "refs": { } }, "ListKxDataviewsRequest": { "base": null, "refs": { } }, "ListKxDataviewsResponse": { "base": null, "refs": { } }, "ListKxEnvironmentsRequest": { "base": null, "refs": { } }, "ListKxEnvironmentsResponse": { "base": null, "refs": { } }, "ListKxScalingGroupsRequest": { "base": null, "refs": { } }, "ListKxScalingGroupsResponse": { "base": null, "refs": { } }, "ListKxUsersRequest": { "base": null, "refs": { } }, "ListKxUsersResponse": { "base": null, "refs": { } }, "ListKxVolumesRequest": { "base": null, "refs": { } }, "ListKxVolumesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListKxChangesetsRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxClustersRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxDatabasesRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxDataviewsRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxScalingGroupsRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxVolumesRequest$maxResults": "The maximum number of results to return in this request.
" } }, "MemoryMib": { "base": null, "refs": { "KxScalingGroupConfiguration$memoryLimit": "An optional hard limit on the amount of memory a kdb cluster can use.
", "KxScalingGroupConfiguration$memoryReservation": "A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.
" } }, "NameString": { "base": null, "refs": { "SuperuserParameters$firstName": "The first name of the superuser.
", "SuperuserParameters$lastName": "The last name of the superuser.
" } }, "NetworkACLConfiguration": { "base": null, "refs": { "TransitGatewayConfiguration$attachmentNetworkAclConfiguration": "The rules that define how you manage the outbound traffic from kdb network to your internal network.
" } }, "NetworkACLEntry": { "base": "The network access control list (ACL) is an optional layer of security for your VPC that acts as a firewall for controlling traffic in and out of one or more subnets. The entry is a set of numbered ingress and egress rules that determine whether a packet should be allowed in or out of a subnet associated with the ACL. We process the entries in the ACL according to the rule numbers, in ascending order.
", "refs": { "NetworkACLConfiguration$member": null } }, "NodeCount": { "base": null, "refs": { "AutoScalingConfiguration$minNodeCount": "The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
The highest number of nodes to scale. This value cannot be greater than 5.
", "CapacityConfiguration$nodeCount": "The number of instances running in a cluster.
" } }, "NodeType": { "base": null, "refs": { "CapacityConfiguration$nodeType": "The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.
You can only specify one of the following values:
kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.
kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.
kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.
kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.
kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.
kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.
kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.
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.
A token that you can use in a subsequent call to retrieve the next set of results.
", "ListKxChangesetsRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxChangesetsResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxClusterNodesRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxClusterNodesResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxClustersRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxClustersResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxDatabasesRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxDatabasesResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxDataviewsRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxDataviewsResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxEnvironmentsRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxEnvironmentsResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxScalingGroupsRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxScalingGroupsResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxUsersRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxUsersResponse$nextToken": "A token that indicates where a results page should begin.
", "ListKxVolumesRequest$nextToken": "A token that indicates where a results page should begin.
", "ListKxVolumesResponse$nextToken": "A token that indicates where a results page should begin.
" } }, "Port": { "base": null, "refs": { "PortRange$from": "The first port in the range.
", "PortRange$to": "The last port in the range.
" } }, "PortRange": { "base": "The range of ports the rule applies to.
", "refs": { "NetworkACLEntry$portRange": "The range of ports the rule applies to.
" } }, "Protocol": { "base": null, "refs": { "NetworkACLEntry$protocol": "The protocol number. A value of -1 means all the protocols.
" } }, "ReleaseLabel": { "base": null, "refs": { "CreateKxClusterRequest$releaseLabel": "The version of FinSpace managed kdb to run.
", "CreateKxClusterResponse$releaseLabel": "A version of the FinSpace managed kdb to run.
", "GetKxClusterResponse$releaseLabel": "The version of FinSpace managed kdb to run.
", "KxCluster$releaseLabel": "A version of the FinSpace managed kdb to run.
" } }, "ResourceAlreadyExistsException": { "base": "The specified resource group already exists.
", "refs": { } }, "ResourceNotFoundException": { "base": "One or more resources can't be found.
", "refs": { } }, "ResultLimit": { "base": null, "refs": { "ListEnvironmentsRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxClusterNodesRequest$maxResults": "The maximum number of results to return in this request.
", "ListKxUsersRequest$maxResults": "The maximum number of results to return in this request.
" } }, "RoleArn": { "base": null, "refs": { "CreateKxUserRequest$iamRole": "The IAM role ARN that will be associated with the user.
", "CreateKxUserResponse$iamRole": "The IAM role ARN that will be associated with the user.
", "GetKxUserResponse$iamRole": "The IAM role ARN that is associated with the user.
", "KxUser$iamRole": "The IAM role ARN that is associated with the user.
", "UpdateKxUserRequest$iamRole": "The IAM role ARN that is associated with the user.
", "UpdateKxUserResponse$iamRole": "The IAM role ARN that is associated with the user.
" } }, "RuleAction": { "base": null, "refs": { "NetworkACLEntry$ruleAction": "Indicates whether to allow or deny the traffic that matches the rule.
" } }, "RuleNumber": { "base": null, "refs": { "NetworkACLEntry$ruleNumber": "The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.
" } }, "S3Bucket": { "base": null, "refs": { "CodeConfiguration$s3Bucket": "A unique name for the S3 bucket.
" } }, "S3Key": { "base": null, "refs": { "CodeConfiguration$s3Key": "The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.
" } }, "S3ObjectVersion": { "base": null, "refs": { "CodeConfiguration$s3ObjectVersion": "The version of an S3 object.
" } }, "S3Path": { "base": null, "refs": { "ChangeRequest$s3Path": "Defines the S3 path of the source file that is required to add or update files in a database.
" } }, "SamlMetadataDocument": { "base": null, "refs": { "FederationParameters$samlMetadataDocument": "SAML 2.0 Metadata document from identity provider (IdP).
" } }, "SecurityGroupIdList": { "base": null, "refs": { "VpcConfiguration$securityGroupIds": "The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
" } }, "SecurityGroupIdString": { "base": null, "refs": { "SecurityGroupIdList$member": null } }, "SegmentConfigurationDbPathList": { "base": null, "refs": { "KxDataviewSegmentConfiguration$dbPaths": "The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.
" } }, "ServiceQuotaExceededException": { "base": "You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
", "refs": { } }, "SignedKxConnectionString": { "base": null, "refs": { "GetKxConnectionStringResponse$signedConnectionString": "The signed connection string that you can use to connect to clusters.
" } }, "SmsDomainUrl": { "base": null, "refs": { "Environment$sageMakerStudioDomainUrl": "The URL of the integrated FinSpace notebook environment in your web application.
" } }, "SubnetIdList": { "base": null, "refs": { "VpcConfiguration$subnetIds": "The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
" } }, "SubnetIdString": { "base": null, "refs": { "SubnetIdList$member": null } }, "SuperuserParameters": { "base": "Configuration information for the superuser.
", "refs": { "CreateEnvironmentRequest$superuserParameters": "Configuration information for the superuser.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag keys (names) of one or more tags to be removed.
" } }, "TagMap": { "base": null, "refs": { "CreateEnvironmentRequest$tags": "Add tags to your FinSpace environment.
", "CreateKxClusterRequest$tags": "A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
", "CreateKxDatabaseRequest$tags": "A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
", "CreateKxDataviewRequest$tags": "A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
", "CreateKxEnvironmentRequest$tags": "A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
", "CreateKxScalingGroupRequest$tags": "A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.
", "CreateKxUserRequest$tags": "A list of key-value pairs to label the user. You can add up to 50 tags to a user.
", "CreateKxVolumeRequest$tags": "A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.
", "ListTagsForResourceResponse$tags": "A list of all tags for a resource.
", "TagResourceRequest$tags": "One or more tags to be assigned to the resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "TickerplantLogConfiguration": { "base": " A configuration to store the 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.tp_log_path.
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.tp_log_path.
The name of the volumes for tickerplant logs.
" } }, "Timestamp": { "base": null, "refs": { "CreateKxChangesetResponse$createdTimestamp": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxChangesetResponse$lastModifiedTimestamp": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxClusterResponse$lastModifiedTimestamp": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxClusterResponse$createdTimestamp": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxDatabaseResponse$createdTimestamp": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxDatabaseResponse$lastModifiedTimestamp": "The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxDataviewResponse$createdTimestamp": "The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxDataviewResponse$lastModifiedTimestamp": "The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxEnvironmentResponse$creationTimestamp": "The timestamp at which the kdb environment was created in FinSpace.
", "CreateKxScalingGroupResponse$lastModifiedTimestamp": "The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxScalingGroupResponse$createdTimestamp": "The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "CreateKxVolumeResponse$createdTimestamp": "The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxChangesetResponse$createdTimestamp": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxChangesetResponse$activeFromTimestamp": "Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxChangesetResponse$lastModifiedTimestamp": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxClusterResponse$lastModifiedTimestamp": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxClusterResponse$createdTimestamp": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxDatabaseResponse$createdTimestamp": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxDatabaseResponse$lastModifiedTimestamp": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxDataviewResponse$createdTimestamp": "The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxDataviewResponse$lastModifiedTimestamp": "The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxEnvironmentResponse$creationTimestamp": "The timestamp at which the kdb environment was created in FinSpace.
", "GetKxEnvironmentResponse$updateTimestamp": "The timestamp at which the kdb environment was updated.
", "GetKxScalingGroupResponse$lastModifiedTimestamp": "The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxScalingGroupResponse$createdTimestamp": "The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxVolumeResponse$createdTimestamp": "The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "GetKxVolumeResponse$lastModifiedTimestamp": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxChangesetListEntry$createdTimestamp": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxChangesetListEntry$activeFromTimestamp": "Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxChangesetListEntry$lastModifiedTimestamp": "The timestamp at which the changeset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxCluster$lastModifiedTimestamp": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxCluster$createdTimestamp": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxDatabaseListEntry$createdTimestamp": "The timestamp at which the database was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxDatabaseListEntry$lastModifiedTimestamp": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxDataviewActiveVersion$createdTimestamp": "The timestamp at which the dataview version was active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxDataviewListEntry$createdTimestamp": "The timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxDataviewListEntry$lastModifiedTimestamp": "The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxEnvironment$creationTimestamp": "The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxEnvironment$updateTimestamp": "The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxNode$launchTime": "The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxScalingGroup$lastModifiedTimestamp": "The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxScalingGroup$createdTimestamp": "The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxUser$createTimestamp": "The timestamp at which the kdb user was created.
", "KxUser$updateTimestamp": "The timestamp at which the kdb user was updated.
", "KxVolume$createdTimestamp": "The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "KxVolume$lastModifiedTimestamp": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "UpdateKxDatabaseResponse$lastModifiedTimestamp": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "UpdateKxDataviewResponse$createdTimestamp": "The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "UpdateKxDataviewResponse$lastModifiedTimestamp": "The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "UpdateKxEnvironmentNetworkResponse$creationTimestamp": "The timestamp at which the kdb environment was created in FinSpace.
", "UpdateKxEnvironmentNetworkResponse$updateTimestamp": "The timestamp at which the kdb environment was updated.
", "UpdateKxEnvironmentResponse$creationTimestamp": "The timestamp at which the kdb environment was created in FinSpace.
", "UpdateKxEnvironmentResponse$updateTimestamp": "The timestamp at which the kdb environment was updated.
", "UpdateKxVolumeResponse$createdTimestamp": "The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "UpdateKxVolumeResponse$lastModifiedTimestamp": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" } }, "TransitGatewayConfiguration": { "base": "The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
", "refs": { "GetKxEnvironmentResponse$transitGatewayConfiguration": null, "KxEnvironment$transitGatewayConfiguration": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
", "UpdateKxEnvironmentNetworkRequest$transitGatewayConfiguration": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
", "UpdateKxEnvironmentNetworkResponse$transitGatewayConfiguration": null, "UpdateKxEnvironmentResponse$transitGatewayConfiguration": null } }, "TransitGatewayID": { "base": null, "refs": { "TransitGatewayConfiguration$transitGatewayID": "The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateEnvironmentRequest": { "base": null, "refs": { } }, "UpdateEnvironmentResponse": { "base": null, "refs": { } }, "UpdateKxClusterCodeConfigurationRequest": { "base": null, "refs": { } }, "UpdateKxClusterCodeConfigurationResponse": { "base": null, "refs": { } }, "UpdateKxClusterDatabasesRequest": { "base": null, "refs": { } }, "UpdateKxClusterDatabasesResponse": { "base": null, "refs": { } }, "UpdateKxDatabaseRequest": { "base": null, "refs": { } }, "UpdateKxDatabaseResponse": { "base": null, "refs": { } }, "UpdateKxDataviewRequest": { "base": null, "refs": { } }, "UpdateKxDataviewResponse": { "base": null, "refs": { } }, "UpdateKxEnvironmentNetworkRequest": { "base": null, "refs": { } }, "UpdateKxEnvironmentNetworkResponse": { "base": null, "refs": { } }, "UpdateKxEnvironmentRequest": { "base": null, "refs": { } }, "UpdateKxEnvironmentResponse": { "base": null, "refs": { } }, "UpdateKxUserRequest": { "base": null, "refs": { } }, "UpdateKxUserResponse": { "base": null, "refs": { } }, "UpdateKxVolumeRequest": { "base": null, "refs": { } }, "UpdateKxVolumeResponse": { "base": null, "refs": { } }, "ValidCIDRBlock": { "base": null, "refs": { "NetworkACLEntry$cidrBlock": " The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The routing CIDR on behalf of kdb environment. It could be any \"/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.
" } }, "ValidHostname": { "base": null, "refs": { "CustomDNSServer$customDNSServerName": "The name of the DNS server.
" } }, "ValidIPAddress": { "base": null, "refs": { "CustomDNSServer$customDNSServerIP": "The IP address of the DNS server.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an AWS service.
", "refs": { } }, "VersionId": { "base": null, "refs": { "KxDataviewActiveVersion$versionId": "A unique identifier of the active version.
", "KxDataviewConfiguration$dataviewVersionId": "The version of the dataview corresponding to a given changeset.
" } }, "Volume": { "base": "The structure that consists of name and type of volume.
", "refs": { "Volumes$member": null } }, "VolumeName": { "base": null, "refs": { "TickerplantLogVolumes$member": null, "Volume$volumeName": "A unique identifier for the volume.
" } }, "VolumeType": { "base": null, "refs": { "Volume$volumeType": " The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
A list of volumes mounted on the cluster.
", "GetKxClusterResponse$volumes": "A list of volumes attached to the cluster.
", "KxCluster$volumes": "A list of volumes attached to the cluster.
" } }, "VpcConfiguration": { "base": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
", "refs": { "CreateKxClusterRequest$vpcConfiguration": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
", "CreateKxClusterResponse$vpcConfiguration": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
", "GetKxClusterResponse$vpcConfiguration": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" } }, "VpcIdString": { "base": null, "refs": { "VpcConfiguration$vpcId": "The identifier of the VPC endpoint.
" } }, "arn": { "base": null, "refs": { "GetKxScalingGroupResponse$scalingGroupArn": "The ARN identifier for the scaling group.
" } }, "booleanValue": { "base": null, "refs": { "CreateKxDataviewRequest$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.
", "CreateKxDataviewResponse$autoUpdate": "The option to select 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.
", "GetKxDataviewResponse$autoUpdate": "The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
", "KxDataviewListEntry$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.
", "UpdateKxDataviewResponse$autoUpdate": "The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
" } }, "dnsStatus": { "base": null, "refs": { "GetKxEnvironmentResponse$dnsStatus": "The status of DNS configuration.
", "KxEnvironment$dnsStatus": "The status of DNS configuration.
", "UpdateKxEnvironmentNetworkResponse$dnsStatus": "The status of DNS configuration.
", "UpdateKxEnvironmentResponse$dnsStatus": "The status of DNS configuration.
" } }, "errorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "ConflictException$reason": "The reason for the conflict exception.
", "InternalServerException$message": null, "InvalidRequestException$message": null, "LimitExceededException$message": null, "ResourceAlreadyExistsException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "numBytes": { "base": null, "refs": { "GetKxDatabaseResponse$numBytes": "The total number of bytes in the database.
" } }, "numChangesets": { "base": null, "refs": { "GetKxDatabaseResponse$numChangesets": "The total number of changesets in the database.
" } }, "numFiles": { "base": null, "refs": { "GetKxDatabaseResponse$numFiles": "The total number of files in the database.
" } }, "stringValueLength1to255": { "base": null, "refs": { "GetKxEnvironmentResponse$certificateAuthorityArn": "The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
", "KxEnvironment$certificateAuthorityArn": "The Amazon Resource Name (ARN) of the certificate authority:
" } }, "tgwStatus": { "base": null, "refs": { "GetKxEnvironmentResponse$tgwStatus": "The status of the network configuration.
", "KxEnvironment$tgwStatus": "The status of the network configuration.
", "UpdateKxEnvironmentNetworkResponse$tgwStatus": "The status of the network configuration.
", "UpdateKxEnvironmentResponse$tgwStatus": "The status of the network configuration.
" } }, "url": { "base": null, "refs": { "CreateEnvironmentResponse$environmentUrl": "The sign-in URL for the web application of the FinSpace environment you created.
", "Environment$environmentUrl": "The sign-in URL for the web application of your FinSpace environment.
", "FederationParameters$samlMetadataURL": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
", "FederationParameters$applicationCallBackURL": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
" } }, "urn": { "base": null, "refs": { "FederationParameters$federationURN": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
" } } } }