FinSpace User Environment Management service 2021-03-12
- Client: Aws\finspace\finspaceClient
- Service ID: finspace
- Version: 2021-03-12
This page describes the parameters and results for the operations of the FinSpace User Environment Management service (2021-03-12), and shows how to use the Aws\finspace\finspaceClient object to call the described operations. This documentation is specific to the 2021-03-12 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateEnvironment ( array $params = [] )
Create a new FinSpace environment.
- CreateKxChangeset ( array $params = [] )
Creates a changeset for a kdb database.
- CreateKxCluster ( array $params = [] )
Creates a new kdb cluster.
- CreateKxDatabase ( array $params = [] )
Creates a new kdb database in the environment.
- CreateKxEnvironment ( array $params = [] )
Creates a managed kdb environment for the account.
- CreateKxUser ( array $params = [] )
Creates a user in FinSpace kdb environment with an associated IAM role.
- DeleteEnvironment ( array $params = [] )
Delete an FinSpace environment.
- DeleteKxCluster ( array $params = [] )
Deletes a kdb cluster.
- DeleteKxDatabase ( array $params = [] )
Deletes the specified database and all of its associated data.
- DeleteKxEnvironment ( array $params = [] )
Deletes the kdb environment.
- DeleteKxUser ( array $params = [] )
Deletes a user in the specified kdb environment.
- GetEnvironment ( array $params = [] )
Returns the FinSpace environment object.
- GetKxChangeset ( array $params = [] )
Returns information about a kdb changeset.
- GetKxCluster ( array $params = [] )
Retrieves information about a kdb cluster.
- GetKxConnectionString ( array $params = [] )
Retrieves a connection string for a user to connect to a kdb cluster.
- GetKxDatabase ( array $params = [] )
Returns database information for the specified environment ID.
- GetKxEnvironment ( array $params = [] )
Retrieves all the information for the specified kdb environment.
- GetKxUser ( array $params = [] )
Retrieves information about the specified kdb user.
- ListEnvironments ( array $params = [] )
A list of all of your FinSpace environments.
- ListKxChangesets ( array $params = [] )
Returns a list of all the changesets for a database.
- ListKxClusterNodes ( array $params = [] )
Lists all the nodes in a kdb cluster.
- ListKxClusters ( array $params = [] )
Returns a list of clusters.
- ListKxDatabases ( array $params = [] )
Returns a list of all the databases in the kdb environment.
- ListKxEnvironments ( array $params = [] )
Returns a list of kdb environments created in an account.
- ListKxUsers ( array $params = [] )
Lists all the users in a kdb environment.
- ListTagsForResource ( array $params = [] )
A list of all tags for a resource.
- TagResource ( array $params = [] )
Adds metadata tags to a FinSpace resource.
- UntagResource ( array $params = [] )
Removes metadata tags from a FinSpace resource.
- UpdateEnvironment ( array $params = [] )
Update your FinSpace environment.
- UpdateKxClusterCodeConfiguration ( array $params = [] )
Allows you to update code configuration on a running cluster.
- UpdateKxClusterDatabases ( array $params = [] )
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.
- UpdateKxDatabase ( array $params = [] )
Updates information for the given kdb database.
- UpdateKxEnvironment ( array $params = [] )
Updates information for the given kdb environment.
- UpdateKxEnvironmentNetwork ( array $params = [] )
Updates environment network to connect to your internal network by using a transit gateway.
- UpdateKxUser ( array $params = [] )
Updates the user details.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateEnvironment
$result = $client->createEnvironment
([/* ... */]); $promise = $client->createEnvironmentAsync
([/* ... */]);
Create a new FinSpace environment.
Parameter Syntax
$result = $client->createEnvironment([ 'dataBundles' => ['<string>', ...], 'description' => '<string>', 'federationMode' => 'FEDERATED|LOCAL', 'federationParameters' => [ 'applicationCallBackURL' => '<string>', 'attributeMap' => ['<string>', ...], 'federationProviderName' => '<string>', 'federationURN' => '<string>', 'samlMetadataDocument' => '<string>', 'samlMetadataURL' => '<string>', ], 'kmsKeyId' => '<string>', 'name' => '<string>', // REQUIRED 'superuserParameters' => [ 'emailAddress' => '<string>', // REQUIRED 'firstName' => '<string>', // REQUIRED 'lastName' => '<string>', // REQUIRED ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- dataBundles
-
- Type: Array of strings
The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
-
arn:aws:finspace:${Region}::data-bundle/capital-markets-sample
- Contains sample Capital Markets datasets, categories and controlled vocabularies. -
arn:aws:finspace:${Region}::data-bundle/taq
(default) - Contains trades and quotes data in addition to sample Capital Markets data.
- description
-
- Type: string
The description of the FinSpace environment to be created.
- federationMode
-
- Type: string
Authentication mode for the environment.
-
FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your Identity provider. -
LOCAL
- Users access FinSpace via email and password managed within the FinSpace environment.
- federationParameters
-
- Type: FederationParameters structure
Configuration information when authentication mode is FEDERATED.
- kmsKeyId
-
- Type: string
The KMS key id to encrypt your data in the FinSpace environment.
- name
-
- Required: Yes
- Type: string
The name of the FinSpace environment to be created.
- superuserParameters
-
- Type: SuperuserParameters structure
Configuration information for the superuser.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Add tags to your FinSpace environment.
Result Syntax
[ 'environmentArn' => '<string>', 'environmentId' => '<string>', 'environmentUrl' => '<string>', ]
Result Details
Members
- environmentArn
-
- Type: string
The Amazon Resource Name (ARN) of the FinSpace environment that you created.
- environmentId
-
- Type: string
The unique identifier for FinSpace environment that you created.
- environmentUrl
-
- Type: string
The sign-in URL for the web application of the FinSpace environment you created.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
ServiceQuotaExceededException:
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.
-
A service limit or quota is exceeded.
CreateKxChangeset
$result = $client->createKxChangeset
([/* ... */]); $promise = $client->createKxChangesetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createKxChangeset([ 'changeRequests' => [ // REQUIRED [ 'changeType' => 'PUT|DELETE', // REQUIRED 'dbPath' => '<string>', // REQUIRED 's3Path' => '<string>', ], // ... ], 'clientToken' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- changeRequests
-
- Required: Yes
- Type: Array of ChangeRequest structures
A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:
-
PUT – Adds or updates files in a database.
-
DELETE – Deletes files in a database.
All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.
Here is an example of how you can use the change request object:
[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]
In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.
- clientToken
-
- Required: Yes
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier of the kdb environment.
Result Syntax
[ 'changeRequests' => [ [ 'changeType' => 'PUT|DELETE', 'dbPath' => '<string>', 's3Path' => '<string>', ], // ... ], 'changesetId' => '<string>', 'createdTimestamp' => <DateTime>, 'databaseName' => '<string>', 'environmentId' => '<string>', 'errorInfo' => [ 'errorMessage' => '<string>', 'errorType' => 'The inputs to this request are invalid.|Service limits have been exceeded.|Missing required permission to perform this request.|One or more inputs to this request were not found.|The system temporarily lacks sufficient resources to process the request.|An internal error has occurred.|Cancelled|A user recoverable error has occurred', ], 'lastModifiedTimestamp' => <DateTime>, 'status' => 'PENDING|PROCESSING|FAILED|COMPLETED', ]
Result Details
Members
- changeRequests
-
- Type: Array of ChangeRequest structures
A list of change requests.
- changesetId
-
- Type: string
A unique identifier for the changeset.
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databaseName
-
- Type: string
The name of the kdb database.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- errorInfo
-
- Type: ErrorInfo structure
The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- status
-
- Type: string
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.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
There was a conflict with this action, and it could not be completed.
-
A service limit or quota is exceeded.
CreateKxCluster
$result = $client->createKxCluster
([/* ... */]); $promise = $client->createKxClusterAsync
([/* ... */]);
Creates a new kdb cluster.
Parameter Syntax
$result = $client->createKxCluster([ 'autoScalingConfiguration' => [ 'autoScalingMetric' => 'CPU_UTILIZATION_PERCENTAGE', 'maxNodeCount' => <integer>, 'metricTarget' => <float>, 'minNodeCount' => <integer>, 'scaleInCooldownSeconds' => <float>, 'scaleOutCooldownSeconds' => <float>, ], 'availabilityZoneId' => '<string>', 'azMode' => 'SINGLE|MULTI', // REQUIRED 'cacheStorageConfigurations' => [ [ 'size' => <integer>, // REQUIRED 'type' => '<string>', // REQUIRED ], // ... ], 'capacityConfiguration' => [ // REQUIRED 'nodeCount' => <integer>, 'nodeType' => '<string>', ], 'clientToken' => '<string>', 'clusterDescription' => '<string>', 'clusterName' => '<string>', // REQUIRED 'clusterType' => 'HDB|RDB|GATEWAY', // REQUIRED 'code' => [ 's3Bucket' => '<string>', 's3Key' => '<string>', 's3ObjectVersion' => '<string>', ], 'commandLineArguments' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'databases' => [ [ 'cacheConfigurations' => [ [ 'cacheType' => '<string>', // REQUIRED 'dbPaths' => ['<string>', ...], // REQUIRED ], // ... ], 'changesetId' => '<string>', 'databaseName' => '<string>', // REQUIRED ], // ... ], 'environmentId' => '<string>', // REQUIRED 'executionRole' => '<string>', 'initializationScript' => '<string>', 'releaseLabel' => '<string>', // REQUIRED 'savedownStorageConfiguration' => [ 'size' => <integer>, // REQUIRED 'type' => 'SDS01', // REQUIRED ], 'tags' => ['<string>', ...], 'vpcConfiguration' => [ 'ipAddressType' => 'IP_V4', 'securityGroupIds' => ['<string>', ...], 'subnetIds' => ['<string>', ...], 'vpcId' => '<string>', ], ]);
Parameter Details
Members
- autoScalingConfiguration
-
- Type: AutoScalingConfiguration structure
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
- availabilityZoneId
-
- Type: string
The availability zone identifiers for the requested regions.
- azMode
-
- Required: Yes
- Type: string
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.
- cacheStorageConfigurations
-
- Type: Array of KxCacheStorageConfiguration structures
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
- capacityConfiguration
-
- Required: Yes
- Type: CapacityConfiguration structure
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- clusterDescription
-
- Type: string
A description of the cluster.
- clusterName
-
- Required: Yes
- Type: string
A unique name for the cluster that you want to create.
- clusterType
-
- Required: Yes
- Type: string
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.
- code
-
- Type: CodeConfiguration structure
The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
- commandLineArguments
-
- Type: Array of KxCommandLineArgument structures
Defines the key-value pairs to make them available inside the cluster.
- databases
-
- Type: Array of KxDatabaseConfiguration structures
A list of databases that will be available for querying.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- executionRole
-
- Type: string
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
- initializationScript
-
- Type: string
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
. - releaseLabel
-
- Required: Yes
- Type: string
The version of FinSpace managed kdb to run.
- savedownStorageConfiguration
-
- Type: KxSavedownStorageConfiguration structure
The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose
clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
- vpcConfiguration
-
- Type: VpcConfiguration structure
Configuration details about the network where the Privatelink endpoint of the cluster resides.
Result Syntax
[ 'autoScalingConfiguration' => [ 'autoScalingMetric' => 'CPU_UTILIZATION_PERCENTAGE', 'maxNodeCount' => <integer>, 'metricTarget' => <float>, 'minNodeCount' => <integer>, 'scaleInCooldownSeconds' => <float>, 'scaleOutCooldownSeconds' => <float>, ], 'availabilityZoneId' => '<string>', 'azMode' => 'SINGLE|MULTI', 'cacheStorageConfigurations' => [ [ 'size' => <integer>, 'type' => '<string>', ], // ... ], 'capacityConfiguration' => [ 'nodeCount' => <integer>, 'nodeType' => '<string>', ], 'clusterDescription' => '<string>', 'clusterName' => '<string>', 'clusterType' => 'HDB|RDB|GATEWAY', 'code' => [ 's3Bucket' => '<string>', 's3Key' => '<string>', 's3ObjectVersion' => '<string>', ], 'commandLineArguments' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'createdTimestamp' => <DateTime>, 'databases' => [ [ 'cacheConfigurations' => [ [ 'cacheType' => '<string>', 'dbPaths' => ['<string>', ...], ], // ... ], 'changesetId' => '<string>', 'databaseName' => '<string>', ], // ... ], 'environmentId' => '<string>', 'executionRole' => '<string>', 'initializationScript' => '<string>', 'lastModifiedTimestamp' => <DateTime>, 'releaseLabel' => '<string>', 'savedownStorageConfiguration' => [ 'size' => <integer>, 'type' => 'SDS01', ], 'status' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED', 'statusReason' => '<string>', 'vpcConfiguration' => [ 'ipAddressType' => 'IP_V4', 'securityGroupIds' => ['<string>', ...], 'subnetIds' => ['<string>', ...], 'vpcId' => '<string>', ], ]
Result Details
Members
- autoScalingConfiguration
-
- Type: AutoScalingConfiguration structure
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
- availabilityZoneId
-
- Type: string
The availability zone identifiers for the requested regions.
- azMode
-
- Type: string
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.
- cacheStorageConfigurations
-
- Type: Array of KxCacheStorageConfiguration structures
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
- capacityConfiguration
-
- Type: CapacityConfiguration structure
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
- clusterDescription
-
- Type: string
A description of the cluster.
- clusterName
-
- Type: string
A unique name for the cluster.
- clusterType
-
- Type: string
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.
- code
-
- Type: CodeConfiguration structure
The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
- commandLineArguments
-
- Type: Array of KxCommandLineArgument structures
Defines the key-value pairs to make them available inside the cluster.
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databases
-
- Type: Array of KxDatabaseConfiguration structures
A list of databases that will be available for querying.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- executionRole
-
- Type: string
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
- initializationScript
-
- Type: string
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
. - lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- releaseLabel
-
- Type: string
A version of the FinSpace managed kdb to run.
- savedownStorageConfiguration
-
- Type: KxSavedownStorageConfiguration structure
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. - status
-
- Type: string
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.
- statusReason
-
- Type: string
The error message when a failed state occurs.
- vpcConfiguration
-
- Type: VpcConfiguration structure
Configuration details about the network where the Privatelink endpoint of the cluster resides.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
-
One or more resources can't be found.
-
You do not have sufficient access to perform this action.
CreateKxDatabase
$result = $client->createKxDatabase
([/* ... */]); $promise = $client->createKxDatabaseAsync
([/* ... */]);
Creates a new kdb database in the environment.
Parameter Syntax
$result = $client->createKxDatabase([ 'clientToken' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'description' => '<string>', 'environmentId' => '<string>', // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- clientToken
-
- Required: Yes
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database.
- description
-
- Type: string
A description of the database.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
Result Syntax
[ 'createdTimestamp' => <DateTime>, 'databaseArn' => '<string>', 'databaseName' => '<string>', 'description' => '<string>', 'environmentId' => '<string>', 'lastModifiedTimestamp' => <DateTime>, ]
Result Details
Members
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databaseArn
-
- Type: string
The ARN identifier of the database.
- databaseName
-
- Type: string
The name of the kdb database.
- description
-
- Type: string
A description of the database.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
There was a conflict with this action, and it could not be completed.
-
ResourceAlreadyExistsException:
The specified resource group already exists.
-
One or more resources can't be found.
-
A service limit or quota is exceeded.
CreateKxEnvironment
$result = $client->createKxEnvironment
([/* ... */]); $promise = $client->createKxEnvironmentAsync
([/* ... */]);
Creates a managed kdb environment for the account.
Parameter Syntax
$result = $client->createKxEnvironment([ 'clientToken' => '<string>', 'description' => '<string>', 'kmsKeyId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- description
-
- Type: string
A description for the kdb environment.
- kmsKeyId
-
- Required: Yes
- Type: string
The KMS key ID to encrypt your data in the FinSpace environment.
- name
-
- Required: Yes
- Type: string
The name of the kdb environment that you want to create.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
Result Syntax
[ 'creationTimestamp' => <DateTime>, 'description' => '<string>', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'kmsKeyId' => '<string>', 'name' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', ]
Result Details
Members
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was created in FinSpace.
- description
-
- Type: string
A description for the kdb environment.
- environmentArn
-
- Type: string
The ARN identifier of the environment.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- kmsKeyId
-
- Type: string
The KMS key ID to encrypt your data in the FinSpace environment.
- name
-
- Type: string
The name of the kdb environment.
- status
-
- Type: string
The status of the kdb environment.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
ServiceQuotaExceededException:
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.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
CreateKxUser
$result = $client->createKxUser
([/* ... */]); $promise = $client->createKxUserAsync
([/* ... */]);
Creates a user in FinSpace kdb environment with an associated IAM role.
Parameter Syntax
$result = $client->createKxUser([ 'clientToken' => '<string>', 'environmentId' => '<string>', // REQUIRED 'iamRole' => '<string>', // REQUIRED 'tags' => ['<string>', ...], 'userName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment where you want to create a user.
- iamRole
-
- Required: Yes
- Type: string
The IAM role ARN that will be associated with the user.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of key-value pairs to label the user. You can add up to 50 tags to a user.
- userName
-
- Required: Yes
- Type: string
A unique identifier for the user.
Result Syntax
[ 'environmentId' => '<string>', 'iamRole' => '<string>', 'userArn' => '<string>', 'userName' => '<string>', ]
Result Details
Members
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- iamRole
-
- Type: string
The IAM role ARN that will be associated with the user.
- userArn
-
- Type: string
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.
- userName
-
- Type: string
A unique identifier for the user.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input fails to satisfy the constraints specified by an AWS service.
-
ResourceAlreadyExistsException:
The specified resource group already exists.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
DeleteEnvironment
$result = $client->deleteEnvironment
([/* ... */]); $promise = $client->deleteEnvironmentAsync
([/* ... */]);
Delete an FinSpace environment.
Parameter Syntax
$result = $client->deleteEnvironment([ 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
The identifier for the FinSpace environment.
Result Syntax
[]
Result Details
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
DeleteKxCluster
$result = $client->deleteKxCluster
([/* ... */]); $promise = $client->deleteKxClusterAsync
([/* ... */]);
Deletes a kdb cluster.
Parameter Syntax
$result = $client->deleteKxCluster([ 'clientToken' => '<string>', 'clusterName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- clusterName
-
- Required: Yes
- Type: string
The name of the cluster that you want to delete.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
-
One or more resources can't be found.
DeleteKxDatabase
$result = $client->deleteKxDatabase
([/* ... */]); $promise = $client->deleteKxDatabaseAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteKxDatabase([ 'clientToken' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Required: Yes
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database that you want to delete.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
There was a conflict with this action, and it could not be completed.
DeleteKxEnvironment
$result = $client->deleteKxEnvironment
([/* ... */]); $promise = $client->deleteKxEnvironmentAsync
([/* ... */]);
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
Parameter Syntax
$result = $client->deleteKxEnvironment([ 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[]
Result Details
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
DeleteKxUser
$result = $client->deleteKxUser
([/* ... */]); $promise = $client->deleteKxUserAsync
([/* ... */]);
Deletes a user in the specified kdb environment.
Parameter Syntax
$result = $client->deleteKxUser([ 'environmentId' => '<string>', // REQUIRED 'userName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- userName
-
- Required: Yes
- Type: string
A unique identifier for the user that you want to delete.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
The input fails to satisfy the constraints specified by an AWS service.
GetEnvironment
$result = $client->getEnvironment
([/* ... */]); $promise = $client->getEnvironmentAsync
([/* ... */]);
Returns the FinSpace environment object.
Parameter Syntax
$result = $client->getEnvironment([ 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
The identifier of the FinSpace environment.
Result Syntax
[ 'environment' => [ 'awsAccountId' => '<string>', 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'environmentUrl' => '<string>', 'federationMode' => 'FEDERATED|LOCAL', 'federationParameters' => [ 'applicationCallBackURL' => '<string>', 'attributeMap' => ['<string>', ...], 'federationProviderName' => '<string>', 'federationURN' => '<string>', 'samlMetadataDocument' => '<string>', 'samlMetadataURL' => '<string>', ], 'kmsKeyId' => '<string>', 'name' => '<string>', 'sageMakerStudioDomainUrl' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', ], ]
Result Details
Members
- environment
-
- Type: Environment structure
The name of the FinSpace environment.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
GetKxChangeset
$result = $client->getKxChangeset
([/* ... */]); $promise = $client->getKxChangesetAsync
([/* ... */]);
Returns information about a kdb changeset.
Parameter Syntax
$result = $client->getKxChangeset([ 'changesetId' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- changesetId
-
- Required: Yes
- Type: string
A unique identifier of the changeset for which you want to retrieve data.
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[ 'activeFromTimestamp' => <DateTime>, 'changeRequests' => [ [ 'changeType' => 'PUT|DELETE', 'dbPath' => '<string>', 's3Path' => '<string>', ], // ... ], 'changesetId' => '<string>', 'createdTimestamp' => <DateTime>, 'databaseName' => '<string>', 'environmentId' => '<string>', 'errorInfo' => [ 'errorMessage' => '<string>', 'errorType' => 'The inputs to this request are invalid.|Service limits have been exceeded.|Missing required permission to perform this request.|One or more inputs to this request were not found.|The system temporarily lacks sufficient resources to process the request.|An internal error has occurred.|Cancelled|A user recoverable error has occurred', ], 'lastModifiedTimestamp' => <DateTime>, 'status' => 'PENDING|PROCESSING|FAILED|COMPLETED', ]
Result Details
Members
- activeFromTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- changeRequests
-
- Type: Array of ChangeRequest structures
A list of change request objects that are run in order.
- changesetId
-
- Type: string
A unique identifier for the changeset.
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databaseName
-
- Type: string
The name of the kdb database.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- errorInfo
-
- Type: ErrorInfo structure
Provides details in the event of a failed flow, including the error type and the related error message.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- status
-
- Type: string
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.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
GetKxCluster
$result = $client->getKxCluster
([/* ... */]); $promise = $client->getKxClusterAsync
([/* ... */]);
Retrieves information about a kdb cluster.
Parameter Syntax
$result = $client->getKxCluster([ 'clusterName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clusterName
-
- Required: Yes
- Type: string
The name of the cluster that you want to retrieve.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[ 'autoScalingConfiguration' => [ 'autoScalingMetric' => 'CPU_UTILIZATION_PERCENTAGE', 'maxNodeCount' => <integer>, 'metricTarget' => <float>, 'minNodeCount' => <integer>, 'scaleInCooldownSeconds' => <float>, 'scaleOutCooldownSeconds' => <float>, ], 'availabilityZoneId' => '<string>', 'azMode' => 'SINGLE|MULTI', 'cacheStorageConfigurations' => [ [ 'size' => <integer>, 'type' => '<string>', ], // ... ], 'capacityConfiguration' => [ 'nodeCount' => <integer>, 'nodeType' => '<string>', ], 'clusterDescription' => '<string>', 'clusterName' => '<string>', 'clusterType' => 'HDB|RDB|GATEWAY', 'code' => [ 's3Bucket' => '<string>', 's3Key' => '<string>', 's3ObjectVersion' => '<string>', ], 'commandLineArguments' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'createdTimestamp' => <DateTime>, 'databases' => [ [ 'cacheConfigurations' => [ [ 'cacheType' => '<string>', 'dbPaths' => ['<string>', ...], ], // ... ], 'changesetId' => '<string>', 'databaseName' => '<string>', ], // ... ], 'executionRole' => '<string>', 'initializationScript' => '<string>', 'lastModifiedTimestamp' => <DateTime>, 'releaseLabel' => '<string>', 'savedownStorageConfiguration' => [ 'size' => <integer>, 'type' => 'SDS01', ], 'status' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED', 'statusReason' => '<string>', 'vpcConfiguration' => [ 'ipAddressType' => 'IP_V4', 'securityGroupIds' => ['<string>', ...], 'subnetIds' => ['<string>', ...], 'vpcId' => '<string>', ], ]
Result Details
Members
- autoScalingConfiguration
-
- Type: AutoScalingConfiguration structure
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
- availabilityZoneId
-
- Type: string
The availability zone identifiers for the requested regions.
- azMode
-
- Type: string
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.
- cacheStorageConfigurations
-
- Type: Array of KxCacheStorageConfiguration structures
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
- capacityConfiguration
-
- Type: CapacityConfiguration structure
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
- clusterDescription
-
- Type: string
A description of the cluster.
- clusterName
-
- Type: string
A unique name for the cluster.
- clusterType
-
- Type: string
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.
- code
-
- Type: CodeConfiguration structure
The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
- commandLineArguments
-
- Type: Array of KxCommandLineArgument structures
Defines key-value pairs to make them available inside the cluster.
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databases
-
- Type: Array of KxDatabaseConfiguration structures
A list of databases mounted on the cluster.
- executionRole
-
- Type: string
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
- initializationScript
-
- Type: string
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
. - lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- releaseLabel
-
- Type: string
The version of FinSpace managed kdb to run.
- savedownStorageConfiguration
-
- Type: KxSavedownStorageConfiguration structure
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. - status
-
- Type: string
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.
- statusReason
-
- Type: string
The error message when a failed state occurs.
- vpcConfiguration
-
- Type: VpcConfiguration structure
Configuration details about the network where the Privatelink endpoint of the cluster resides.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
-
One or more resources can't be found.
GetKxConnectionString
$result = $client->getKxConnectionString
([/* ... */]); $promise = $client->getKxConnectionStringAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getKxConnectionString([ 'clusterName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED 'userArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clusterName
-
- Required: Yes
- Type: string
A name of the kdb cluster.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- userArn
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'signedConnectionString' => '<string>', ]
Result Details
Members
- signedConnectionString
-
- Type: string
The signed connection string that you can use to connect to clusters.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
The input fails to satisfy the constraints specified by an AWS service.
GetKxDatabase
$result = $client->getKxDatabase
([/* ... */]); $promise = $client->getKxDatabaseAsync
([/* ... */]);
Returns database information for the specified environment ID.
Parameter Syntax
$result = $client->getKxDatabase([ 'databaseName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[ 'createdTimestamp' => <DateTime>, 'databaseArn' => '<string>', 'databaseName' => '<string>', 'description' => '<string>', 'environmentId' => '<string>', 'lastCompletedChangesetId' => '<string>', 'lastModifiedTimestamp' => <DateTime>, 'numBytes' => <integer>, 'numChangesets' => <integer>, 'numFiles' => <integer>, ]
Result Details
Members
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databaseArn
-
- Type: string
The ARN identifier of the database.
- databaseName
-
- Type: string
The name of the kdb database for which the information is retrieved.
- description
-
- Type: string
A description of the database.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- lastCompletedChangesetId
-
- Type: string
A unique identifier for the changeset.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- numBytes
-
- Type: long (int|float)
The total number of bytes in the database.
- numChangesets
-
- Type: int
The total number of changesets in the database.
- numFiles
-
- Type: int
The total number of files in the database.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
GetKxEnvironment
$result = $client->getKxEnvironment
([/* ... */]); $promise = $client->getKxEnvironmentAsync
([/* ... */]);
Retrieves all the information for the specified kdb environment.
Parameter Syntax
$result = $client->getKxEnvironment([ 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[ 'availabilityZoneIds' => ['<string>', ...], 'awsAccountId' => '<string>', 'certificateAuthorityArn' => '<string>', 'creationTimestamp' => <DateTime>, 'customDNSConfiguration' => [ [ 'customDNSServerIP' => '<string>', 'customDNSServerName' => '<string>', ], // ... ], 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'dnsStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'errorMessage' => '<string>', 'kmsKeyId' => '<string>', 'name' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', 'tgwStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'transitGatewayConfiguration' => [ 'attachmentNetworkAclConfiguration' => [ [ 'cidrBlock' => '<string>', 'icmpTypeCode' => [ 'code' => <integer>, 'type' => <integer>, ], 'portRange' => [ 'from' => <integer>, 'to' => <integer>, ], 'protocol' => '<string>', 'ruleAction' => 'allow|deny', 'ruleNumber' => <integer>, ], // ... ], 'routableCIDRSpace' => '<string>', 'transitGatewayID' => '<string>', ], 'updateTimestamp' => <DateTime>, ]
Result Details
Members
- availabilityZoneIds
-
- Type: Array of strings
The identifier of the availability zones where subnets for the environment are created.
- awsAccountId
-
- Type: string
The unique identifier of the AWS account that is used to create the kdb environment.
- certificateAuthorityArn
-
- Type: string
The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was created in FinSpace.
- customDNSConfiguration
-
- Type: Array of CustomDNSServer structures
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
- dedicatedServiceAccountId
-
- Type: string
A unique identifier for the AWS environment infrastructure account.
- description
-
- Type: string
A description for the kdb environment.
- dnsStatus
-
- Type: string
The status of DNS configuration.
- environmentArn
-
- Type: string
The ARN identifier of the environment.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- errorMessage
-
- Type: string
Specifies the error message that appears if a flow fails.
- kmsKeyId
-
- Type: string
The KMS key ID to encrypt your data in the FinSpace environment.
- name
-
- Type: string
The name of the kdb environment.
- status
-
- Type: string
The status of the kdb environment.
- tgwStatus
-
- Type: string
The status of the network configuration.
- transitGatewayConfiguration
-
- Type: TransitGatewayConfiguration structure
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
- updateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was updated.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
GetKxUser
$result = $client->getKxUser
([/* ... */]); $promise = $client->getKxUserAsync
([/* ... */]);
Retrieves information about the specified kdb user.
Parameter Syntax
$result = $client->getKxUser([ 'environmentId' => '<string>', // REQUIRED 'userName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- userName
-
- Required: Yes
- Type: string
A unique identifier for the user.
Result Syntax
[ 'environmentId' => '<string>', 'iamRole' => '<string>', 'userArn' => '<string>', 'userName' => '<string>', ]
Result Details
Members
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- iamRole
-
- Type: string
The IAM role ARN that is associated with the user.
- userArn
-
- Type: string
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.
- userName
-
- Type: string
A unique identifier for the user.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
The input fails to satisfy the constraints specified by an AWS service.
ListEnvironments
$result = $client->listEnvironments
([/* ... */]); $promise = $client->listEnvironmentsAsync
([/* ... */]);
A list of all of your FinSpace environments.
Parameter Syntax
$result = $client->listEnvironments([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
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
nextToken
nextToken value from the response object of the previous page call.
Result Syntax
[ 'environments' => [ [ 'awsAccountId' => '<string>', 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'environmentUrl' => '<string>', 'federationMode' => 'FEDERATED|LOCAL', 'federationParameters' => [ 'applicationCallBackURL' => '<string>', 'attributeMap' => ['<string>', ...], 'federationProviderName' => '<string>', 'federationURN' => '<string>', 'samlMetadataDocument' => '<string>', 'samlMetadataURL' => '<string>', ], 'kmsKeyId' => '<string>', 'name' => '<string>', 'sageMakerStudioDomainUrl' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- environments
-
- Type: Array of Environment structures
A list of all of your FinSpace environments.
- nextToken
-
- Type: string
A token that you can use in a subsequent call to retrieve the next set of results.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
ListKxChangesets
$result = $client->listKxChangesets
([/* ... */]); $promise = $client->listKxChangesetsAsync
([/* ... */]);
Returns a list of all the changesets for a database.
Parameter Syntax
$result = $client->listKxChangesets([ 'databaseName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Result Syntax
[ 'kxChangesets' => [ [ 'activeFromTimestamp' => <DateTime>, 'changesetId' => '<string>', 'createdTimestamp' => <DateTime>, 'lastModifiedTimestamp' => <DateTime>, 'status' => 'PENDING|PROCESSING|FAILED|COMPLETED', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- kxChangesets
-
- Type: Array of KxChangesetListEntry structures
A list of changesets for a database.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
ListKxClusterNodes
$result = $client->listKxClusterNodes
([/* ... */]); $promise = $client->listKxClusterNodesAsync
([/* ... */]);
Lists all the nodes in a kdb cluster.
Parameter Syntax
$result = $client->listKxClusterNodes([ 'clusterName' => '<string>', // REQUIRED 'environmentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- clusterName
-
- Required: Yes
- Type: string
A unique name for the cluster.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Result Syntax
[ 'nextToken' => '<string>', 'nodes' => [ [ 'availabilityZoneId' => '<string>', 'launchTime' => <DateTime>, 'nodeId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
- nodes
-
- Type: Array of KxNode structures
A list of nodes associated with the cluster.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
The input fails to satisfy the constraints specified by an AWS service.
-
One or more resources can't be found.
ListKxClusters
$result = $client->listKxClusters
([/* ... */]); $promise = $client->listKxClustersAsync
([/* ... */]);
Returns a list of clusters.
Parameter Syntax
$result = $client->listKxClusters([ 'clusterType' => 'HDB|RDB|GATEWAY', 'environmentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- clusterType
-
- Type: string
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.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Result Syntax
[ 'kxClusterSummaries' => [ [ 'availabilityZoneId' => '<string>', 'azMode' => 'SINGLE|MULTI', 'clusterDescription' => '<string>', 'clusterName' => '<string>', 'clusterType' => 'HDB|RDB|GATEWAY', 'createdTimestamp' => <DateTime>, 'executionRole' => '<string>', 'initializationScript' => '<string>', 'lastModifiedTimestamp' => <DateTime>, 'releaseLabel' => '<string>', 'status' => 'PENDING|CREATING|CREATE_FAILED|RUNNING|UPDATING|DELETING|DELETED|DELETE_FAILED', 'statusReason' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- kxClusterSummaries
-
- Type: Array of KxCluster structures
Lists the cluster details.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
-
One or more resources can't be found.
ListKxDatabases
$result = $client->listKxDatabases
([/* ... */]); $promise = $client->listKxDatabasesAsync
([/* ... */]);
Returns a list of all the databases in the kdb environment.
Parameter Syntax
$result = $client->listKxDatabases([ 'environmentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Result Syntax
[ 'kxDatabases' => [ [ 'createdTimestamp' => <DateTime>, 'databaseName' => '<string>', 'lastModifiedTimestamp' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- kxDatabases
-
- Type: Array of KxDatabaseListEntry structures
A list of databases in the kdb environment.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
ListKxEnvironments
$result = $client->listKxEnvironments
([/* ... */]); $promise = $client->listKxEnvironmentsAsync
([/* ... */]);
Returns a list of kdb environments created in an account.
Parameter Syntax
$result = $client->listKxEnvironments([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Result Syntax
[ 'environments' => [ [ 'availabilityZoneIds' => ['<string>', ...], 'awsAccountId' => '<string>', 'certificateAuthorityArn' => '<string>', 'creationTimestamp' => <DateTime>, 'customDNSConfiguration' => [ [ 'customDNSServerIP' => '<string>', 'customDNSServerName' => '<string>', ], // ... ], 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'dnsStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'errorMessage' => '<string>', 'kmsKeyId' => '<string>', 'name' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', 'tgwStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'transitGatewayConfiguration' => [ 'attachmentNetworkAclConfiguration' => [ [ 'cidrBlock' => '<string>', 'icmpTypeCode' => [ 'code' => <integer>, 'type' => <integer>, ], 'portRange' => [ 'from' => <integer>, 'to' => <integer>, ], 'protocol' => '<string>', 'ruleAction' => 'allow|deny', 'ruleNumber' => <integer>, ], // ... ], 'routableCIDRSpace' => '<string>', 'transitGatewayID' => '<string>', ], 'updateTimestamp' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- environments
-
- Type: Array of KxEnvironment structures
A list of environments in an account.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
ListKxUsers
$result = $client->listKxUsers
([/* ... */]); $promise = $client->listKxUsersAsync
([/* ... */]);
Lists all the users in a kdb environment.
Parameter Syntax
$result = $client->listKxUsers([ 'environmentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
Result Syntax
[ 'nextToken' => '<string>', 'users' => [ [ 'createTimestamp' => <DateTime>, 'iamRole' => '<string>', 'updateTimestamp' => <DateTime>, 'userArn' => '<string>', 'userName' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token that indicates where a results page should begin.
- users
-
- Type: Array of KxUser structures
A list of users in a kdb environment.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input fails to satisfy the constraints specified by an AWS service.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
A list of all tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name of the resource.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of all tags for a resource.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request is invalid. Something is wrong with the input to the request.
-
One or more resources can't be found.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds metadata tags to a FinSpace resource.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
One or more tags to be assigned to the resource.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request is invalid. Something is wrong with the input to the request.
-
One or more resources can't be found.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes metadata tags from a FinSpace resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys (names) of one or more tags to be removed.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request is invalid. Something is wrong with the input to the request.
-
One or more resources can't be found.
UpdateEnvironment
$result = $client->updateEnvironment
([/* ... */]); $promise = $client->updateEnvironmentAsync
([/* ... */]);
Update your FinSpace environment.
Parameter Syntax
$result = $client->updateEnvironment([ 'description' => '<string>', 'environmentId' => '<string>', // REQUIRED 'federationMode' => 'FEDERATED|LOCAL', 'federationParameters' => [ 'applicationCallBackURL' => '<string>', 'attributeMap' => ['<string>', ...], 'federationProviderName' => '<string>', 'federationURN' => '<string>', 'samlMetadataDocument' => '<string>', 'samlMetadataURL' => '<string>', ], 'name' => '<string>', ]);
Parameter Details
Members
- description
-
- Type: string
The description of the environment.
- environmentId
-
- Required: Yes
- Type: string
The identifier of the FinSpace environment.
- federationMode
-
- Type: string
Authentication mode for the environment.
-
FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your Identity provider. -
LOCAL
- Users access FinSpace via email and password managed within the FinSpace environment.
- federationParameters
-
- Type: FederationParameters structure
Configuration information when authentication mode is FEDERATED.
- name
-
- Type: string
The name of the environment.
Result Syntax
[ 'environment' => [ 'awsAccountId' => '<string>', 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'environmentUrl' => '<string>', 'federationMode' => 'FEDERATED|LOCAL', 'federationParameters' => [ 'applicationCallBackURL' => '<string>', 'attributeMap' => ['<string>', ...], 'federationProviderName' => '<string>', 'federationURN' => '<string>', 'samlMetadataDocument' => '<string>', 'samlMetadataURL' => '<string>', ], 'kmsKeyId' => '<string>', 'name' => '<string>', 'sageMakerStudioDomainUrl' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', ], ]
Result Details
Members
- environment
-
- Type: Environment structure
Returns the FinSpace environment object.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
UpdateKxClusterCodeConfiguration
$result = $client->updateKxClusterCodeConfiguration
([/* ... */]); $promise = $client->updateKxClusterCodeConfigurationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateKxClusterCodeConfiguration([ 'clientToken' => '<string>', 'clusterName' => '<string>', // REQUIRED 'code' => [ // REQUIRED 's3Bucket' => '<string>', 's3Key' => '<string>', 's3ObjectVersion' => '<string>', ], 'commandLineArguments' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'deploymentConfiguration' => [ 'deploymentStrategy' => 'ROLLING|FORCE', // REQUIRED ], 'environmentId' => '<string>', // REQUIRED 'initializationScript' => '<string>', ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- clusterName
-
- Required: Yes
- Type: string
The name of the cluster.
- code
-
- Required: Yes
- Type: CodeConfiguration structure
The structure of the customer code available within the running cluster.
- commandLineArguments
-
- Type: Array of KxCommandLineArgument structures
Specifies the key-value pairs to make them available inside the cluster.
- deploymentConfiguration
-
- Type: KxClusterCodeDeploymentConfiguration structure
The configuration that allows you to choose how you want to update the code on a cluster.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier of the kdb environment.
- initializationScript
-
- Type: string
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
.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
The input fails to satisfy the constraints specified by an AWS service.
-
There was a conflict with this action, and it could not be completed.
-
One or more resources can't be found.
UpdateKxClusterDatabases
$result = $client->updateKxClusterDatabases
([/* ... */]); $promise = $client->updateKxClusterDatabasesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateKxClusterDatabases([ 'clientToken' => '<string>', 'clusterName' => '<string>', // REQUIRED 'databases' => [ // REQUIRED [ 'cacheConfigurations' => [ [ 'cacheType' => '<string>', // REQUIRED 'dbPaths' => ['<string>', ...], // REQUIRED ], // ... ], 'changesetId' => '<string>', 'databaseName' => '<string>', // REQUIRED ], // ... ], 'deploymentConfiguration' => [ 'deploymentStrategy' => 'NO_RESTART|ROLLING', // REQUIRED ], 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- clusterName
-
- Required: Yes
- Type: string
A unique name for the cluster that you want to modify.
- databases
-
- Required: Yes
- Type: Array of KxDatabaseConfiguration structures
The structure of databases mounted on the cluster.
- deploymentConfiguration
-
- Type: KxDeploymentConfiguration structure
The configuration that allows you to choose how you want to update the databases on a cluster.
- environmentId
-
- Required: Yes
- Type: string
The unique identifier of a kdb environment.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
A service limit or quota is exceeded.
-
The input fails to satisfy the constraints specified by an AWS service.
-
There was a conflict with this action, and it could not be completed.
-
One or more resources can't be found.
UpdateKxDatabase
$result = $client->updateKxDatabase
([/* ... */]); $promise = $client->updateKxDatabaseAsync
([/* ... */]);
Updates information for the given kdb database.
Parameter Syntax
$result = $client->updateKxDatabase([ 'clientToken' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'description' => '<string>', 'environmentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Required: Yes
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database.
- description
-
- Type: string
A description of the database.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
Result Syntax
[ 'databaseName' => '<string>', 'description' => '<string>', 'environmentId' => '<string>', 'lastModifiedTimestamp' => <DateTime>, ]
Result Details
Members
- databaseName
-
- Type: string
The name of the kdb database.
- description
-
- Type: string
A description of the database.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
There was a conflict with this action, and it could not be completed.
UpdateKxEnvironment
$result = $client->updateKxEnvironment
([/* ... */]); $promise = $client->updateKxEnvironmentAsync
([/* ... */]);
Updates information for the given kdb environment.
Parameter Syntax
$result = $client->updateKxEnvironment([ 'clientToken' => '<string>', 'description' => '<string>', 'environmentId' => '<string>', // REQUIRED 'name' => '<string>', ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- description
-
- Type: string
A description of the kdb environment.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- name
-
- Type: string
The name of the kdb environment.
Result Syntax
[ 'availabilityZoneIds' => ['<string>', ...], 'awsAccountId' => '<string>', 'creationTimestamp' => <DateTime>, 'customDNSConfiguration' => [ [ 'customDNSServerIP' => '<string>', 'customDNSServerName' => '<string>', ], // ... ], 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'dnsStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'errorMessage' => '<string>', 'kmsKeyId' => '<string>', 'name' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', 'tgwStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'transitGatewayConfiguration' => [ 'attachmentNetworkAclConfiguration' => [ [ 'cidrBlock' => '<string>', 'icmpTypeCode' => [ 'code' => <integer>, 'type' => <integer>, ], 'portRange' => [ 'from' => <integer>, 'to' => <integer>, ], 'protocol' => '<string>', 'ruleAction' => 'allow|deny', 'ruleNumber' => <integer>, ], // ... ], 'routableCIDRSpace' => '<string>', 'transitGatewayID' => '<string>', ], 'updateTimestamp' => <DateTime>, ]
Result Details
Members
- availabilityZoneIds
-
- Type: Array of strings
The identifier of the availability zones where subnets for the environment are created.
- awsAccountId
-
- Type: string
The unique identifier of the AWS account that is used to create the kdb environment.
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was created in FinSpace.
- customDNSConfiguration
-
- Type: Array of CustomDNSServer structures
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
- dedicatedServiceAccountId
-
- Type: string
A unique identifier for the AWS environment infrastructure account.
- description
-
- Type: string
The description of the environment.
- dnsStatus
-
- Type: string
The status of DNS configuration.
- environmentArn
-
- Type: string
The ARN identifier of the environment.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- errorMessage
-
- Type: string
Specifies the error message that appears if a flow fails.
- kmsKeyId
-
- Type: string
The KMS key ID to encrypt your data in the FinSpace environment.
- name
-
- Type: string
The name of the kdb environment.
- status
-
- Type: string
The status of the kdb environment.
- tgwStatus
-
- Type: string
The status of the network configuration.
- transitGatewayConfiguration
-
- Type: TransitGatewayConfiguration structure
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
- updateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was updated.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
There was a conflict with this action, and it could not be completed.
UpdateKxEnvironmentNetwork
$result = $client->updateKxEnvironmentNetwork
([/* ... */]); $promise = $client->updateKxEnvironmentNetworkAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateKxEnvironmentNetwork([ 'clientToken' => '<string>', 'customDNSConfiguration' => [ [ 'customDNSServerIP' => '<string>', // REQUIRED 'customDNSServerName' => '<string>', // REQUIRED ], // ... ], 'environmentId' => '<string>', // REQUIRED 'transitGatewayConfiguration' => [ 'attachmentNetworkAclConfiguration' => [ [ 'cidrBlock' => '<string>', // REQUIRED 'icmpTypeCode' => [ 'code' => <integer>, // REQUIRED 'type' => <integer>, // REQUIRED ], 'portRange' => [ 'from' => <integer>, // REQUIRED 'to' => <integer>, // REQUIRED ], 'protocol' => '<string>', // REQUIRED 'ruleAction' => 'allow|deny', // REQUIRED 'ruleNumber' => <integer>, // REQUIRED ], // ... ], 'routableCIDRSpace' => '<string>', // REQUIRED 'transitGatewayID' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- customDNSConfiguration
-
- Type: Array of CustomDNSServer structures
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- transitGatewayConfiguration
-
- Type: TransitGatewayConfiguration structure
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
Result Syntax
[ 'availabilityZoneIds' => ['<string>', ...], 'awsAccountId' => '<string>', 'creationTimestamp' => <DateTime>, 'customDNSConfiguration' => [ [ 'customDNSServerIP' => '<string>', 'customDNSServerName' => '<string>', ], // ... ], 'dedicatedServiceAccountId' => '<string>', 'description' => '<string>', 'dnsStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'environmentArn' => '<string>', 'environmentId' => '<string>', 'errorMessage' => '<string>', 'kmsKeyId' => '<string>', 'name' => '<string>', 'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|UPDATE_NETWORK_REQUESTED|UPDATING_NETWORK|FAILED_UPDATING_NETWORK|SUSPENDED', 'tgwStatus' => 'NONE|UPDATE_REQUESTED|UPDATING|FAILED_UPDATE|SUCCESSFULLY_UPDATED', 'transitGatewayConfiguration' => [ 'attachmentNetworkAclConfiguration' => [ [ 'cidrBlock' => '<string>', 'icmpTypeCode' => [ 'code' => <integer>, 'type' => <integer>, ], 'portRange' => [ 'from' => <integer>, 'to' => <integer>, ], 'protocol' => '<string>', 'ruleAction' => 'allow|deny', 'ruleNumber' => <integer>, ], // ... ], 'routableCIDRSpace' => '<string>', 'transitGatewayID' => '<string>', ], 'updateTimestamp' => <DateTime>, ]
Result Details
Members
- availabilityZoneIds
-
- Type: Array of strings
The identifier of the availability zones where subnets for the environment are created.
- awsAccountId
-
- Type: string
The unique identifier of the AWS account that is used to create the kdb environment.
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was created in FinSpace.
- customDNSConfiguration
-
- Type: Array of CustomDNSServer structures
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
- dedicatedServiceAccountId
-
- Type: string
A unique identifier for the AWS environment infrastructure account.
- description
-
- Type: string
The description of the environment.
- dnsStatus
-
- Type: string
The status of DNS configuration.
- environmentArn
-
- Type: string
The ARN identifier of the environment.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- errorMessage
-
- Type: string
Specifies the error message that appears if a flow fails.
- kmsKeyId
-
- Type: string
The KMS key ID to encrypt your data in the FinSpace environment.
- name
-
- Type: string
The name of the kdb environment.
- status
-
- Type: string
The status of the kdb environment.
- tgwStatus
-
- Type: string
The status of the network configuration.
- transitGatewayConfiguration
-
- Type: TransitGatewayConfiguration structure
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
- updateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb environment was updated.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
There was a conflict with this action, and it could not be completed.
UpdateKxUser
$result = $client->updateKxUser
([/* ... */]); $promise = $client->updateKxUserAsync
([/* ... */]);
Updates the user details. You can only update the IAM role associated with a user.
Parameter Syntax
$result = $client->updateKxUser([ 'clientToken' => '<string>', 'environmentId' => '<string>', // REQUIRED 'iamRole' => '<string>', // REQUIRED 'userName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A token that ensures idempotency. This token expires in 10 minutes.
- environmentId
-
- Required: Yes
- Type: string
A unique identifier for the kdb environment.
- iamRole
-
- Required: Yes
- Type: string
The IAM role ARN that is associated with the user.
- userName
-
- Required: Yes
- Type: string
A unique identifier for the user.
Result Syntax
[ 'environmentId' => '<string>', 'iamRole' => '<string>', 'userArn' => '<string>', 'userName' => '<string>', ]
Result Details
Members
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- iamRole
-
- Type: string
The IAM role ARN that is associated with the user.
- userArn
-
- Type: string
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.
- userName
-
- Type: string
A unique identifier for the user.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
One or more resources can't be found.
-
The input fails to satisfy the constraints specified by an AWS service.
-
A service limit or quota is exceeded.
-
There was a conflict with this action, and it could not be completed.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Type: string
AutoScalingConfiguration
Description
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
Members
- autoScalingMetric
-
- Type: string
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. - maxNodeCount
-
- Type: int
The highest number of nodes to scale. This value cannot be greater than 5.
- metricTarget
-
- Type: double
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. - minNodeCount
-
- Type: int
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, thenminNodeCount
must be at least 3. - scaleInCooldownSeconds
-
- Type: double
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- scaleOutCooldownSeconds
-
- Type: double
The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
CapacityConfiguration
Description
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
Members
- nodeCount
-
- Type: int
The number of instances running in a cluster.
- nodeType
-
- Type: string
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.
ChangeRequest
Description
A list of change request objects.
Members
- changeType
-
- Required: Yes
- Type: string
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.
- dbPath
-
- Required: Yes
- Type: string
Defines the path within the database directory.
- s3Path
-
- Type: string
Defines the S3 path of the source file that is required to add or update files in a database.
CodeConfiguration
Description
The structure of the customer code available within the running cluster.
Members
- s3Bucket
-
- Type: string
A unique name for the S3 bucket.
- s3Key
-
- Type: string
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
-
- Type: string
The version of an S3 object.
ConflictException
Description
There was a conflict with this action, and it could not be completed.
Members
- message
-
- Type: string
- reason
-
- Type: string
The reason for the conflict exception.
CustomDNSServer
Description
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
Members
- customDNSServerIP
-
- Required: Yes
- Type: string
The IP address of the DNS server.
- customDNSServerName
-
- Required: Yes
- Type: string
The name of the DNS server.
Environment
Description
Represents an FinSpace environment.
Members
- awsAccountId
-
- Type: string
The ID of the AWS account in which the FinSpace environment is created.
- dedicatedServiceAccountId
-
- Type: string
The AWS account ID of the dedicated service account associated with your FinSpace environment.
- description
-
- Type: string
The description of the FinSpace environment.
- environmentArn
-
- Type: string
The Amazon Resource Name (ARN) of your FinSpace environment.
- environmentId
-
- Type: string
The identifier of the FinSpace environment.
- environmentUrl
-
- Type: string
The sign-in URL for the web application of your FinSpace environment.
- federationMode
-
- Type: string
The authentication mode for the environment.
- federationParameters
-
- Type: FederationParameters structure
Configuration information when authentication mode is FEDERATED.
- kmsKeyId
-
- Type: string
The KMS key id used to encrypt in the FinSpace environment.
- name
-
- Type: string
The name of the FinSpace environment.
- sageMakerStudioDomainUrl
-
- Type: string
The URL of the integrated FinSpace notebook environment in your web application.
- status
-
- Type: string
The current status of creation of the FinSpace environment.
ErrorInfo
Description
Provides details in the event of a failed flow, including the error type and the related error message.
Members
- errorMessage
-
- Type: string
Specifies the error message that appears if a flow fails.
- errorType
-
- Type: string
Specifies the type of error.
FederationParameters
Description
Configuration information when authentication mode is FEDERATED.
Members
- applicationCallBackURL
-
- Type: string
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
- attributeMap
-
- Type: Associative array of custom strings keys (FederationAttributeKey) to strings
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 beEmail
and valuehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details. - federationProviderName
-
- Type: string
Name of the identity provider (IdP).
- federationURN
-
- Type: string
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
- samlMetadataDocument
-
- Type: string
SAML 2.0 Metadata document from identity provider (IdP).
- samlMetadataURL
-
- Type: string
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
IcmpTypeCode
Description
Defines the ICMP protocol that consists of the ICMP type and code.
Members
- code
-
- Required: Yes
- Type: int
The ICMP code. A value of -1 means all codes for the specified ICMP type.
- type
-
- Required: Yes
- Type: int
The ICMP type. A value of -1 means all types.
InternalServerException
Description
The request processing has failed because of an unknown error, exception or failure.
Members
- message
-
- Type: string
InvalidRequestException
Description
The request is invalid. Something is wrong with the input to the request.
Members
- message
-
- Type: string
KxCacheStorageConfiguration
Description
The configuration for read only disk cache associated with a cluster.
Members
- size
-
- Required: Yes
- Type: int
The size of cache in Gigabytes.
- type
-
- Required: Yes
- Type: string
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
andCACHE_250
you can select cache size as 1200 GB or increments of 2400 GB. For cache typeCACHE_12
you can select the cache size in increments of 6000 GB.
KxChangesetListEntry
Description
Details of changeset.
Members
- activeFromTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- changesetId
-
- Type: string
A unique identifier for the changeset.
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- status
-
- Type: string
Status of the changeset.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
KxCluster
Description
The details of a kdb cluster.
Members
- availabilityZoneId
-
- Type: string
The availability zone identifiers for the requested regions.
- azMode
-
- Type: string
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.
- clusterDescription
-
- Type: string
A description of the cluster.
- clusterName
-
- Type: string
A unique name for the cluster.
- clusterType
-
- Type: string
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.
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- executionRole
-
- Type: string
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
- initializationScript
-
- Type: string
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
. - lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- releaseLabel
-
- Type: string
A version of the FinSpace managed kdb to run.
- status
-
- Type: string
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.
- statusReason
-
- Type: string
The error message when a failed state occurs.
KxClusterCodeDeploymentConfiguration
Description
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.
Members
- deploymentStrategy
-
- Required: Yes
- Type: string
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.
-
FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.
KxCommandLineArgument
Description
Defines the key-value pairs to make them available inside the cluster.
Members
- key
-
- Type: string
The name of the key.
- value
-
- Type: string
The value of the key.
KxDatabaseCacheConfiguration
Description
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
Members
- cacheType
-
- Required: Yes
- Type: string
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.
- dbPaths
-
- Required: Yes
- Type: Array of strings
Specifies the portions of database that will be loaded into the cache for access.
KxDatabaseConfiguration
Description
The configuration of data that is available for querying from this database.
Members
- cacheConfigurations
-
- Type: Array of KxDatabaseCacheConfiguration structures
Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
- changesetId
-
- Type: string
A unique identifier of the changeset that is associated with the cluster.
- databaseName
-
- Required: Yes
- Type: string
The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
KxDatabaseListEntry
Description
Details about a FinSpace managed kdb database
Members
- createdTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- databaseName
-
- Type: string
The name of the kdb database.
- lastModifiedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
KxDeploymentConfiguration
Description
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.
Members
- deploymentStrategy
-
- Required: Yes
- Type: string
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
andcommandLineArguments
parameters.
KxEnvironment
Description
The details of a kdb environment.
Members
- availabilityZoneIds
-
- Type: Array of strings
The identifier of the availability zones where subnets for the environment are created.
- awsAccountId
-
- Type: string
The unique identifier of the AWS account in which you create the kdb environment.
- certificateAuthorityArn
-
- Type: string
The Amazon Resource Name (ARN) of the certificate authority:
- creationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- customDNSConfiguration
-
- Type: Array of CustomDNSServer structures
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
- dedicatedServiceAccountId
-
- Type: string
A unique identifier for the AWS environment infrastructure account.
- description
-
- Type: string
A description of the kdb environment.
- dnsStatus
-
- Type: string
The status of DNS configuration.
- environmentArn
-
- Type: string
The Amazon Resource Name (ARN) of your kdb environment.
- environmentId
-
- Type: string
A unique identifier for the kdb environment.
- errorMessage
-
- Type: string
Specifies the error message that appears if a flow fails.
- kmsKeyId
-
- Type: string
The unique identifier of the KMS key.
- name
-
- Type: string
The name of the kdb environment.
- status
-
- Type: string
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.
- tgwStatus
-
- Type: string
The status of the network configuration.
- transitGatewayConfiguration
-
- Type: TransitGatewayConfiguration structure
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
- updateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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
Description
A structure that stores metadata for a kdb node.
Members
- availabilityZoneId
-
- Type: string
The identifier of the availability zones where subnets for the environment are created.
- launchTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- nodeId
-
- Type: string
A unique identifier for the node.
KxSavedownStorageConfiguration
Description
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.
Members
- size
-
- Required: Yes
- Type: int
The size of temporary storage in gibibytes.
- type
-
- Required: Yes
- Type: string
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.
KxUser
Description
A structure that stores metadata for a kdb user.
Members
- createTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb user was created.
- iamRole
-
- Type: string
The IAM role ARN that is associated with the user.
- updateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the kdb user was updated.
- userArn
-
- Type: string
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.
- userName
-
- Type: string
A unique identifier for the user.
LimitExceededException
Description
A service limit or quota is exceeded.
Members
- message
-
- Type: string
NetworkACLEntry
Description
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.
Members
- cidrBlock
-
- Required: Yes
- Type: string
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 specify100.68.0.18/18
, we modify it to100.68.0.0/18
. - icmpTypeCode
-
- Type: IcmpTypeCode structure
Defines the ICMP protocol that consists of the ICMP type and code.
- portRange
-
- Type: PortRange structure
The range of ports the rule applies to.
- protocol
-
- Required: Yes
- Type: string
The protocol number. A value of -1 means all the protocols.
- ruleAction
-
- Required: Yes
- Type: string
Indicates whether to allow or deny the traffic that matches the rule.
- ruleNumber
-
- Required: Yes
- Type: int
The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.
PortRange
Description
The range of ports the rule applies to.
Members
- from
-
- Required: Yes
- Type: int
The first port in the range.
- to
-
- Required: Yes
- Type: int
The last port in the range.
ResourceAlreadyExistsException
Description
The specified resource group already exists.
Members
- message
-
- Type: string
ResourceNotFoundException
Description
One or more resources can't be found.
Members
- message
-
- Type: string
ServiceQuotaExceededException
Description
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.
Members
- message
-
- Type: string
SuperuserParameters
Description
Configuration information for the superuser.
Members
- emailAddress
-
- Required: Yes
- Type: string
The email address of the superuser.
- firstName
-
- Required: Yes
- Type: string
The first name of the superuser.
- lastName
-
- Required: Yes
- Type: string
The last name of the superuser.
ThrottlingException
Description
The request was denied due to request throttling.
Members
- message
-
- Type: string
TransitGatewayConfiguration
Description
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
Members
- attachmentNetworkAclConfiguration
-
- Type: Array of NetworkACLEntry structures
The rules that define how you manage the outbound traffic from kdb network to your internal network.
- routableCIDRSpace
-
- Required: Yes
- Type: string
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.
- transitGatewayID
-
- Required: Yes
- Type: string
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- message
-
- Type: string
VpcConfiguration
Description
Configuration details about the network where the Privatelink endpoint of the cluster resides.
Members
- ipAddressType
-
- Type: string
The IP address type for cluster network configuration parameters. The following type is available:
-
IP_V4 – IP address version 4
- securityGroupIds
-
- Type: Array of strings
The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
- subnetIds
-
- Type: Array of strings
The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- vpcId
-
- Type: string
The identifier of the VPC endpoint.