2023/06/05 - FinSpace User Environment Management service - 26 new3 updated api methods
Changes Releasing new Managed kdb Insights APIs
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.
See also: AWS API Documentation
Request Syntax
client.create_kx_changeset(
environmentId='string',
databaseName='string',
changeRequests=[
{
'changeType': 'PUT'|'DELETE',
's3Path': 'string',
'dbPath': 'string'
},
],
clientToken='string'
)
string
[REQUIRED]
A unique identifier of the kdb environment.
string
[REQUIRED]
The name of the kdb database.
list
[REQUIRED]
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.
(dict) --
A list of change request objects.
changeType (string) -- [REQUIRED]
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.
s3Path (string) --
Defines the S3 path of the source file that is required to add or update files in a database.
dbPath (string) -- [REQUIRED]
Defines the path within the database directory.
string
[REQUIRED]
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'changesetId': 'string',
'databaseName': 'string',
'environmentId': 'string',
'changeRequests': [
{
'changeType': 'PUT'|'DELETE',
's3Path': 'string',
'dbPath': 'string'
},
],
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED',
'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'
}
}
Response Structure
(dict) --
changesetId (string) --
A unique identifier for the changeset.
databaseName (string) --
The name of the kdb database.
environmentId (string) --
A unique identifier for the kdb environment.
changeRequests (list) --
A list of change requests.
(dict) --
A list of change request objects.
changeType (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.
s3Path (string) --
Defines the S3 path of the source file that is required to add or update files in a database.
dbPath (string) --
Defines the path within the database directory.
createdTimestamp (datetime) --
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 (datetime) --
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 (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.
errorInfo (dict) --
The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
errorMessage (string) --
Specifies the error message that appears if a flow fails.
errorType (string) --
Specifies the type of error.
Returns a list of all the databases in the kdb environment.
See also: AWS API Documentation
Request Syntax
client.list_kx_databases(
environmentId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
A token that indicates where a results page should begin.
integer
The maximum number of results to return in this request.
dict
Response Syntax
{
'kxDatabases': [
{
'databaseName': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
kxDatabases (list) --
A list of databases in the kdb environment.
(dict) --
Details about a FinSpace managed kdb database
databaseName (string) --
The name of the kdb database.
createdTimestamp (datetime) --
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.
lastModifiedTimestamp (datetime) --
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.
nextToken (string) --
A token that indicates where a results page should begin.
Deletes a user in the specified kdb environment.
See also: AWS API Documentation
Request Syntax
client.delete_kx_user(
userName='string',
environmentId='string'
)
string
[REQUIRED]
A unique identifier for the user that you want to delete.
string
[REQUIRED]
A unique identifier for the kdb environment.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new kdb cluster.
See also: AWS API Documentation
Request Syntax
client.create_kx_cluster(
clientToken='string',
environmentId='string',
clusterName='string',
clusterType='HDB'|'RDB'|'GATEWAY',
databases=[
{
'databaseName': 'string',
'cacheConfigurations': [
{
'cacheType': 'string',
'dbPaths': [
'string',
]
},
],
'changesetId': 'string'
},
],
cacheStorageConfigurations=[
{
'type': 'string',
'size': 123
},
],
autoScalingConfiguration={
'minNodeCount': 123,
'maxNodeCount': 123,
'autoScalingMetric': 'CPU_UTILIZATION_PERCENTAGE',
'metricTarget': 123.0,
'scaleInCooldownSeconds': 123.0,
'scaleOutCooldownSeconds': 123.0
},
clusterDescription='string',
capacityConfiguration={
'nodeType': 'string',
'nodeCount': 123
},
releaseLabel='string',
vpcConfiguration={
'vpcId': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'ipAddressType': 'IP_V4'
},
initializationScript='string',
commandLineArguments=[
{
'key': 'string',
'value': 'string'
},
],
code={
's3Bucket': 'string',
's3Key': 'string',
's3ObjectVersion': 'string'
},
executionRole='string',
savedownStorageConfiguration={
'type': 'SDS01',
'size': 123
},
azMode='SINGLE'|'MULTI',
availabilityZoneId='string',
tags={
'string': 'string'
}
)
string
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
A unique name for the cluster that you want to create.
string
[REQUIRED]
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.
list
A list of databases that will be available for querying.
(dict) --
The configuration of data that is available for querying from this database.
databaseName (string) -- [REQUIRED]
The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
cacheConfigurations (list) --
Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
(dict) --
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
cacheType (string) -- [REQUIRED]
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 (list) -- [REQUIRED]
Specifies the portions of database that will be loaded into the cache for access.
(string) --
changesetId (string) --
A unique identifier of the changeset that is associated with the cluster.
list
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.
(dict) --
The configuration for read only disk cache associated with a cluster.
type (string) -- [REQUIRED]
The type of cache storage . The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
size (integer) -- [REQUIRED]
The size of cache in Gigabytes.
dict
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
minNodeCount (integer) --
The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
maxNodeCount (integer) --
The highest number of nodes to scale. This value cannot be greater than 5.
autoScalingMetric (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.
metricTarget (float) --
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.
scaleInCooldownSeconds (float) --
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
scaleOutCooldownSeconds (float) --
The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
string
A description of the cluster.
dict
[REQUIRED]
A structure for the metadata of a cluster. It includes information about like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
nodeType (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.
nodeCount (integer) --
The number of instances running in a cluster.
string
[REQUIRED]
The version of FinSpace managed kdb to run.
dict
Configuration details about the network where the Privatelink endpoint of the cluster resides.
vpcId (string) --
The identifier of the VPC endpoint.
securityGroupIds (list) --
The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
(string) --
subnetIds (list) --
The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
(string) --
ipAddressType (string) --
The IP address type for cluster network configuration parameters. The following type is available:
IP_V4 – IP address version 4
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.
list
Defines the key-value pairs to make them available inside the cluster.
(dict) --
Defines the key-value pairs to make them available inside the cluster.
key (string) --
The name of the key.
value (string) --
The value of the key.
dict
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.
s3Bucket (string) --
A unique name for the S3 bucket.
s3Key (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 (string) --
The version of an S3 object.
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.
dict
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.
type (string) -- [REQUIRED]
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.
size (integer) -- [REQUIRED]
The size of temporary storage in bytes.
string
[REQUIRED]
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.
string
The availability zone identifiers for the requested regions.
dict
A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
(string) --
(string) --
dict
Response Syntax
{
'environmentId': 'string',
'status': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusReason': 'string',
'clusterName': 'string',
'clusterType': 'HDB'|'RDB'|'GATEWAY',
'databases': [
{
'databaseName': 'string',
'cacheConfigurations': [
{
'cacheType': 'string',
'dbPaths': [
'string',
]
},
],
'changesetId': 'string'
},
],
'cacheStorageConfigurations': [
{
'type': 'string',
'size': 123
},
],
'autoScalingConfiguration': {
'minNodeCount': 123,
'maxNodeCount': 123,
'autoScalingMetric': 'CPU_UTILIZATION_PERCENTAGE',
'metricTarget': 123.0,
'scaleInCooldownSeconds': 123.0,
'scaleOutCooldownSeconds': 123.0
},
'clusterDescription': 'string',
'capacityConfiguration': {
'nodeType': 'string',
'nodeCount': 123
},
'releaseLabel': 'string',
'vpcConfiguration': {
'vpcId': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'ipAddressType': 'IP_V4'
},
'initializationScript': 'string',
'commandLineArguments': [
{
'key': 'string',
'value': 'string'
},
],
'code': {
's3Bucket': 'string',
's3Key': 'string',
's3ObjectVersion': 'string'
},
'executionRole': 'string',
'lastModifiedTimestamp': datetime(2015, 1, 1),
'savedownStorageConfiguration': {
'type': 'SDS01',
'size': 123
},
'azMode': 'SINGLE'|'MULTI',
'availabilityZoneId': 'string',
'createdTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
environmentId (string) --
A unique identifier for the kdb environment.
status (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 (string) --
The error message when a failed state occurs.
clusterName (string) --
A unique name for the cluster.
clusterType (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.
databases (list) --
A list of databases that will be available for querying.
(dict) --
The configuration of data that is available for querying from this database.
databaseName (string) --
The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
cacheConfigurations (list) --
Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
(dict) --
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
cacheType (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 (list) --
Specifies the portions of database that will be loaded into the cache for access.
(string) --
changesetId (string) --
A unique identifier of the changeset that is associated with the cluster.
cacheStorageConfigurations (list) --
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.
(dict) --
The configuration for read only disk cache associated with a cluster.
type (string) --
The type of cache storage . The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
size (integer) --
The size of cache in Gigabytes.
autoScalingConfiguration (dict) --
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
minNodeCount (integer) --
The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
maxNodeCount (integer) --
The highest number of nodes to scale. This value cannot be greater than 5.
autoScalingMetric (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.
metricTarget (float) --
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.
scaleInCooldownSeconds (float) --
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
scaleOutCooldownSeconds (float) --
The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
clusterDescription (string) --
A description of the cluster.
capacityConfiguration (dict) --
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
nodeType (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.
nodeCount (integer) --
The number of instances running in a cluster.
releaseLabel (string) --
A version of the FinSpace managed kdb to run.
vpcConfiguration (dict) --
Configuration details about the network where the Privatelink endpoint of the cluster resides.
vpcId (string) --
The identifier of the VPC endpoint.
securityGroupIds (list) --
The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
(string) --
subnetIds (list) --
The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
(string) --
ipAddressType (string) --
The IP address type for cluster network configuration parameters. The following type is available:
IP_V4 – IP address version 4
initializationScript (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.
commandLineArguments (list) --
Defines the key-value pairs to make them available inside the cluster.
(dict) --
Defines the key-value pairs to make them available inside the cluster.
key (string) --
The name of the key.
value (string) --
The value of the key.
code (dict) --
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.
s3Bucket (string) --
A unique name for the S3 bucket.
s3Key (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 (string) --
The version of an S3 object.
executionRole (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.
lastModifiedTimestamp (datetime) --
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.
savedownStorageConfiguration (dict) --
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.
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.
size (integer) --
The size of temporary storage in bytes.
azMode (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.
availabilityZoneId (string) --
The availability zone identifiers for the requested regions.
createdTimestamp (datetime) --
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.
Updates information for the given kdb environment.
See also: AWS API Documentation
Request Syntax
client.update_kx_environment(
environmentId='string',
name='string',
description='string',
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
The name of the kdb environment.
string
A description of the kdb environment.
string
A token that ensures idempotency. This token expires in 10 minutes.
dict
Response Syntax
{
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'dnsStatus': 'NONE'|'UPDATE_REQUESTED'|'UPDATING'|'FAILED_UPDATE'|'SUCCESSFULLY_UPDATED',
'errorMessage': 'string',
'description': 'string',
'environmentArn': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'transitGatewayConfiguration': {
'transitGatewayID': 'string',
'routableCIDRSpace': 'string'
},
'customDNSConfiguration': [
{
'customDNSServerName': 'string',
'customDNSServerIP': 'string'
},
],
'creationTimestamp': datetime(2015, 1, 1),
'updateTimestamp': datetime(2015, 1, 1),
'availabilityZoneIds': [
'string',
]
}
Response Structure
(dict) --
name (string) --
The name of the kdb environment.
environmentId (string) --
A unique identifier for the kdb environment.
awsAccountId (string) --
The unique identifier of the AWS account that is used to create the kdb environment.
status (string) --
The status of the kdb environment.
tgwStatus (string) --
The status of the network configuration.
dnsStatus (string) --
The status of DNS configuration.
errorMessage (string) --
Specifies the error message that appears if a flow fails.
description (string) --
The description of the environment.
environmentArn (string) --
The ARN identifier of the environment.
kmsKeyId (string) --
The KMS key ID to encrypt your data in the FinSpace environment.
dedicatedServiceAccountId (string) --
A unique identifier for the AWS environment infrastructure account.
transitGatewayConfiguration (dict) --
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
transitGatewayID (string) --
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
routableCIDRSpace (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.
customDNSConfiguration (list) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
(dict) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
customDNSServerName (string) --
The name of the DNS server.
customDNSServerIP (string) --
The IP address of the DNS server.
creationTimestamp (datetime) --
The timestamp at which the kdb environment was created in FinSpace.
updateTimestamp (datetime) --
The timestamp at which the kdb environment was updated.
availabilityZoneIds (list) --
The identifier of the availability zones where subnets for the environment are created.
(string) --
Returns a list of clusters.
See also: AWS API Documentation
Request Syntax
client.list_kx_clusters(
environmentId='string',
clusterType='HDB'|'RDB'|'GATEWAY',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
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.
integer
The maximum number of results to return in this request.
string
A token that indicates where a results page should begin.
dict
Response Syntax
{
'kxClusterSummaries': [
{
'status': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusReason': 'string',
'clusterName': 'string',
'clusterType': 'HDB'|'RDB'|'GATEWAY',
'clusterDescription': 'string',
'releaseLabel': 'string',
'initializationScript': 'string',
'executionRole': 'string',
'azMode': 'SINGLE'|'MULTI',
'availabilityZoneId': 'string',
'lastModifiedTimestamp': datetime(2015, 1, 1),
'createdTimestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
kxClusterSummaries (list) --
Lists the cluster details.
(dict) --
The details of a kdb cluster.
status (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 (string) --
The error message when a failed state occurs.
clusterName (string) --
A unique name for the cluster.
clusterType (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.
clusterDescription (string) --
A description of the cluster.
releaseLabel (string) --
A version of the FinSpace managed kdb to run.
initializationScript (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.
executionRole (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.
azMode (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.
availabilityZoneId (string) --
The availability zone identifiers for the requested regions.
lastModifiedTimestamp (datetime) --
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.
createdTimestamp (datetime) --
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.
nextToken (string) --
A token that indicates where a results page should begin.
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.
See also: AWS API Documentation
Request Syntax
client.delete_kx_database(
environmentId='string',
databaseName='string',
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the kdb database that you want to delete.
string
[REQUIRED]
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves information about a kdb cluster.
See also: AWS API Documentation
Request Syntax
client.get_kx_cluster(
environmentId='string',
clusterName='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the cluster that you want to retrieve.
dict
Response Syntax
{
'status': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusReason': 'string',
'clusterName': 'string',
'clusterType': 'HDB'|'RDB'|'GATEWAY',
'databases': [
{
'databaseName': 'string',
'cacheConfigurations': [
{
'cacheType': 'string',
'dbPaths': [
'string',
]
},
],
'changesetId': 'string'
},
],
'cacheStorageConfigurations': [
{
'type': 'string',
'size': 123
},
],
'autoScalingConfiguration': {
'minNodeCount': 123,
'maxNodeCount': 123,
'autoScalingMetric': 'CPU_UTILIZATION_PERCENTAGE',
'metricTarget': 123.0,
'scaleInCooldownSeconds': 123.0,
'scaleOutCooldownSeconds': 123.0
},
'clusterDescription': 'string',
'capacityConfiguration': {
'nodeType': 'string',
'nodeCount': 123
},
'releaseLabel': 'string',
'vpcConfiguration': {
'vpcId': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'ipAddressType': 'IP_V4'
},
'initializationScript': 'string',
'commandLineArguments': [
{
'key': 'string',
'value': 'string'
},
],
'code': {
's3Bucket': 'string',
's3Key': 'string',
's3ObjectVersion': 'string'
},
'executionRole': 'string',
'lastModifiedTimestamp': datetime(2015, 1, 1),
'savedownStorageConfiguration': {
'type': 'SDS01',
'size': 123
},
'azMode': 'SINGLE'|'MULTI',
'availabilityZoneId': 'string',
'createdTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
status (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 (string) --
The error message when a failed state occurs.
clusterName (string) --
A unique name for the cluster.
clusterType (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.
databases (list) --
A list of databases mounted on the cluster.
(dict) --
The configuration of data that is available for querying from this database.
databaseName (string) --
The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
cacheConfigurations (list) --
Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
(dict) --
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
cacheType (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 (list) --
Specifies the portions of database that will be loaded into the cache for access.
(string) --
changesetId (string) --
A unique identifier of the changeset that is associated with the cluster.
cacheStorageConfigurations (list) --
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.
(dict) --
The configuration for read only disk cache associated with a cluster.
type (string) --
The type of cache storage . The valid values are:
CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
size (integer) --
The size of cache in Gigabytes.
autoScalingConfiguration (dict) --
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
minNodeCount (integer) --
The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
maxNodeCount (integer) --
The highest number of nodes to scale. This value cannot be greater than 5.
autoScalingMetric (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.
metricTarget (float) --
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.
scaleInCooldownSeconds (float) --
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
scaleOutCooldownSeconds (float) --
The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
clusterDescription (string) --
A description of the cluster.
capacityConfiguration (dict) --
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.
nodeType (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.
nodeCount (integer) --
The number of instances running in a cluster.
releaseLabel (string) --
The version of FinSpace managed kdb to run.
vpcConfiguration (dict) --
Configuration details about the network where the Privatelink endpoint of the cluster resides.
vpcId (string) --
The identifier of the VPC endpoint.
securityGroupIds (list) --
The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
(string) --
subnetIds (list) --
The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
(string) --
ipAddressType (string) --
The IP address type for cluster network configuration parameters. The following type is available:
IP_V4 – IP address version 4
initializationScript (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.
commandLineArguments (list) --
Defines key-value pairs to make them available inside the cluster.
(dict) --
Defines the key-value pairs to make them available inside the cluster.
key (string) --
The name of the key.
value (string) --
The value of the key.
code (dict) --
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.
s3Bucket (string) --
A unique name for the S3 bucket.
s3Key (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 (string) --
The version of an S3 object.
executionRole (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.
lastModifiedTimestamp (datetime) --
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.
savedownStorageConfiguration (dict) --
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.
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.
size (integer) --
The size of temporary storage in bytes.
azMode (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.
availabilityZoneId (string) --
The availability zone identifiers for the requested regions.
createdTimestamp (datetime) --
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.
Returns database information for the specified environment ID.
See also: AWS API Documentation
Request Syntax
client.get_kx_database(
environmentId='string',
databaseName='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the kdb database.
dict
Response Syntax
{
'databaseName': 'string',
'databaseArn': 'string',
'environmentId': 'string',
'description': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1),
'lastCompletedChangesetId': 'string',
'numBytes': 123,
'numChangesets': 123,
'numFiles': 123
}
Response Structure
(dict) --
databaseName (string) --
The name of the kdb database for which the information is retrieved.
databaseArn (string) --
The ARN identifier of the database.
environmentId (string) --
A unique identifier for the kdb environment.
description (string) --
A description of the database.
createdTimestamp (datetime) --
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.
lastModifiedTimestamp (datetime) --
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.
lastCompletedChangesetId (string) --
A unique identifier for the changeset.
numBytes (integer) --
The total number of bytes in the database.
numChangesets (integer) --
The total number of changesets in the database.
numFiles (integer) --
The total number of files in the database.
Retrieves all the information for the specified kdb environment.
See also: AWS API Documentation
Request Syntax
client.get_kx_environment(
environmentId='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
dict
Response Syntax
{
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'dnsStatus': 'NONE'|'UPDATE_REQUESTED'|'UPDATING'|'FAILED_UPDATE'|'SUCCESSFULLY_UPDATED',
'errorMessage': 'string',
'description': 'string',
'environmentArn': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'transitGatewayConfiguration': {
'transitGatewayID': 'string',
'routableCIDRSpace': 'string'
},
'customDNSConfiguration': [
{
'customDNSServerName': 'string',
'customDNSServerIP': 'string'
},
],
'creationTimestamp': datetime(2015, 1, 1),
'updateTimestamp': datetime(2015, 1, 1),
'availabilityZoneIds': [
'string',
],
'certificateAuthorityArn': 'string'
}
Response Structure
(dict) --
name (string) --
The name of the kdb environment.
environmentId (string) --
A unique identifier for the kdb environment.
awsAccountId (string) --
The unique identifier of the AWS account that is used to create the kdb environment.
status (string) --
The status of the kdb environment.
tgwStatus (string) --
The status of the network configuration.
dnsStatus (string) --
The status of DNS configuration.
errorMessage (string) --
Specifies the error message that appears if a flow fails.
description (string) --
A description for the kdb environment.
environmentArn (string) --
The ARN identifier of the environment.
kmsKeyId (string) --
The KMS key ID to encrypt your data in the FinSpace environment.
dedicatedServiceAccountId (string) --
A unique identifier for the AWS environment infrastructure account.
transitGatewayConfiguration (dict) --
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
transitGatewayID (string) --
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
routableCIDRSpace (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.
customDNSConfiguration (list) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
(dict) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
customDNSServerName (string) --
The name of the DNS server.
customDNSServerIP (string) --
The IP address of the DNS server.
creationTimestamp (datetime) --
The timestamp at which the kdb environment was created in FinSpace.
updateTimestamp (datetime) --
The timestamp at which the kdb environment was updated.
availabilityZoneIds (list) --
The identifier of the availability zones where subnets for the environment are created.
(string) --
certificateAuthorityArn (string) --
The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
Returns a list of all the changesets for a database.
See also: AWS API Documentation
Request Syntax
client.list_kx_changesets(
environmentId='string',
databaseName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the kdb database.
string
A token that indicates where a results page should begin.
integer
The maximum number of results to return in this request.
dict
Response Syntax
{
'kxChangesets': [
{
'changesetId': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'activeFromTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
kxChangesets (list) --
A list of changesets for a database.
(dict) --
Details of changeset.
changesetId (string) --
A unique identifier for the changeset.
createdTimestamp (datetime) --
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.
activeFromTimestamp (datetime) --
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.
lastModifiedTimestamp (datetime) --
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 (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.
nextToken (string) --
A token that indicates where a results page should begin.
Creates a managed kdb environment for the account.
See also: AWS API Documentation
Request Syntax
client.create_kx_environment(
name='string',
description='string',
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the kdb environment that you want to create.
string
A description for the kdb environment.
string
[REQUIRED]
The KMS key ID to encrypt your data in the FinSpace environment.
dict
A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
(string) --
(string) --
string
A token that ensures idempotency. This token expires in 10 minutes.
dict
Response Syntax
{
'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',
'environmentId': 'string',
'description': 'string',
'environmentArn': 'string',
'kmsKeyId': 'string',
'creationTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
name (string) --
The name of the kdb environment.
status (string) --
The status of the kdb environment.
environmentId (string) --
A unique identifier for the kdb environment.
description (string) --
A description for the kdb environment.
environmentArn (string) --
The ARN identifier of the environment.
kmsKeyId (string) --
The KMS key ID to encrypt your data in the FinSpace environment.
creationTimestamp (datetime) --
The timestamp at which the kdb environment was created in FinSpace.
Lists all the users in a kdb environment.
See also: AWS API Documentation
Request Syntax
client.list_kx_users(
environmentId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
A token that indicates where a results page should begin.
integer
The maximum number of results to return in this request.
dict
Response Syntax
{
'users': [
{
'userArn': 'string',
'userName': 'string',
'iamRole': 'string',
'createTimestamp': datetime(2015, 1, 1),
'updateTimestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
users (list) --
A list of users in a kdb environment.
(dict) --
A structure that stores metadata for a kdb user.
userArn (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 (string) --
A unique identifier for the user.
iamRole (string) --
The IAM role ARN that is associated with the user.
createTimestamp (datetime) --
The timestamp at which the kdb user was created.
updateTimestamp (datetime) --
The timestamp at which the kdb user was updated.
nextToken (string) --
A token that indicates where a results page should begin.
Retrieves information about the specified kdb user.
See also: AWS API Documentation
Request Syntax
client.get_kx_user(
userName='string',
environmentId='string'
)
string
[REQUIRED]
A unique identifier for the user.
string
[REQUIRED]
A unique identifier for the kdb environment.
dict
Response Syntax
{
'userName': 'string',
'userArn': 'string',
'environmentId': 'string',
'iamRole': 'string'
}
Response Structure
(dict) --
userName (string) --
A unique identifier for the user.
userArn (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.
environmentId (string) --
A unique identifier for the kdb environment.
iamRole (string) --
The IAM role ARN that is associated with the user.
Returns information about a kdb changeset.
See also: AWS API Documentation
Request Syntax
client.get_kx_changeset(
environmentId='string',
databaseName='string',
changesetId='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the kdb database.
string
[REQUIRED]
A unique identifier of the changeset for which you want to retrieve data.
dict
Response Syntax
{
'changesetId': 'string',
'databaseName': 'string',
'environmentId': 'string',
'changeRequests': [
{
'changeType': 'PUT'|'DELETE',
's3Path': 'string',
'dbPath': 'string'
},
],
'createdTimestamp': datetime(2015, 1, 1),
'activeFromTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED',
'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'
}
}
Response Structure
(dict) --
changesetId (string) --
A unique identifier for the changeset.
databaseName (string) --
The name of the kdb database.
environmentId (string) --
A unique identifier for the kdb environment.
changeRequests (list) --
A list of change request objects that are run in order.
(dict) --
A list of change request objects.
changeType (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.
s3Path (string) --
Defines the S3 path of the source file that is required to add or update files in a database.
dbPath (string) --
Defines the path within the database directory.
createdTimestamp (datetime) --
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.
activeFromTimestamp (datetime) --
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.
lastModifiedTimestamp (datetime) --
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 (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.
errorInfo (dict) --
Provides details in the event of a failed flow, including the error type and the related error message.
errorMessage (string) --
Specifies the error message that appears if a flow fails.
errorType (string) --
Specifies the type of error.
Updates information for the given kdb database.
See also: AWS API Documentation
Request Syntax
client.update_kx_database(
environmentId='string',
databaseName='string',
description='string',
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the kdb database.
string
A description of the database.
string
[REQUIRED]
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'databaseName': 'string',
'environmentId': 'string',
'description': 'string',
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
databaseName (string) --
The name of the kdb database.
environmentId (string) --
A unique identifier for the kdb environment.
description (string) --
A description of the database.
lastModifiedTimestamp (datetime) --
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.
Deletes a kdb cluster.
See also: AWS API Documentation
Request Syntax
client.delete_kx_cluster(
environmentId='string',
clusterName='string',
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the cluster that you want to delete.
string
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the user details. You can only update the IAM role associated with a user.
See also: AWS API Documentation
Request Syntax
client.update_kx_user(
environmentId='string',
userName='string',
iamRole='string',
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
A unique identifier for the user.
string
[REQUIRED]
The IAM role ARN that is associated with the user.
string
A token that ensures idempotency. This token expires in 10 minutes.
dict
Response Syntax
{
'userName': 'string',
'userArn': 'string',
'environmentId': 'string',
'iamRole': 'string'
}
Response Structure
(dict) --
userName (string) --
A unique identifier for the user.
userArn (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.
environmentId (string) --
A unique identifier for the kdb environment.
iamRole (string) --
The IAM role ARN that is associated with the user.
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.
See also: AWS API Documentation
Request Syntax
client.update_kx_environment_network(
environmentId='string',
transitGatewayConfiguration={
'transitGatewayID': 'string',
'routableCIDRSpace': 'string'
},
customDNSConfiguration=[
{
'customDNSServerName': 'string',
'customDNSServerIP': 'string'
},
],
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
dict
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
transitGatewayID (string) -- [REQUIRED]
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
routableCIDRSpace (string) -- [REQUIRED]
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.
list
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
(dict) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
customDNSServerName (string) -- [REQUIRED]
The name of the DNS server.
customDNSServerIP (string) -- [REQUIRED]
The IP address of the DNS server.
string
A token that ensures idempotency. This token expires in 10 minutes.
dict
Response Syntax
{
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'dnsStatus': 'NONE'|'UPDATE_REQUESTED'|'UPDATING'|'FAILED_UPDATE'|'SUCCESSFULLY_UPDATED',
'errorMessage': 'string',
'description': 'string',
'environmentArn': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'transitGatewayConfiguration': {
'transitGatewayID': 'string',
'routableCIDRSpace': 'string'
},
'customDNSConfiguration': [
{
'customDNSServerName': 'string',
'customDNSServerIP': 'string'
},
],
'creationTimestamp': datetime(2015, 1, 1),
'updateTimestamp': datetime(2015, 1, 1),
'availabilityZoneIds': [
'string',
]
}
Response Structure
(dict) --
name (string) --
The name of the kdb environment.
environmentId (string) --
A unique identifier for the kdb environment.
awsAccountId (string) --
The unique identifier of the AWS account that is used to create the kdb environment.
status (string) --
The status of the kdb environment.
tgwStatus (string) --
The status of the network configuration.
dnsStatus (string) --
The status of DNS configuration.
errorMessage (string) --
Specifies the error message that appears if a flow fails.
description (string) --
The description of the environment.
environmentArn (string) --
The ARN identifier of the environment.
kmsKeyId (string) --
The KMS key ID to encrypt your data in the FinSpace environment.
dedicatedServiceAccountId (string) --
A unique identifier for the AWS environment infrastructure account.
transitGatewayConfiguration (dict) --
The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
transitGatewayID (string) --
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
routableCIDRSpace (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.
customDNSConfiguration (list) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
(dict) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
customDNSServerName (string) --
The name of the DNS server.
customDNSServerIP (string) --
The IP address of the DNS server.
creationTimestamp (datetime) --
The timestamp at which the kdb environment was created in FinSpace.
updateTimestamp (datetime) --
The timestamp at which the kdb environment was updated.
availabilityZoneIds (list) --
The identifier of the availability zones where subnets for the environment are created.
(string) --
Creates a user in FinSpace kdb environment with an associated IAM role.
See also: AWS API Documentation
Request Syntax
client.create_kx_user(
environmentId='string',
userName='string',
iamRole='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment where you want to create a user.
string
[REQUIRED]
A unique identifier for the user.
string
[REQUIRED]
The IAM role ARN that will be associated with the user.
dict
A list of key-value pairs to label the user. You can add up to 50 tags to a user.
(string) --
(string) --
string
A token that ensures idempotency. This token expires in 10 minutes.
dict
Response Syntax
{
'userName': 'string',
'userArn': 'string',
'environmentId': 'string',
'iamRole': 'string'
}
Response Structure
(dict) --
userName (string) --
A unique identifier for the user.
userArn (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.
environmentId (string) --
A unique identifier for the kdb environment.
iamRole (string) --
The IAM role ARN that will be associated with the user.
Creates a new kdb database in the environment.
See also: AWS API Documentation
Request Syntax
client.create_kx_database(
environmentId='string',
databaseName='string',
description='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
The name of the kdb database.
string
A description of the database.
dict
A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
(string) --
(string) --
string
[REQUIRED]
A token that ensures idempotency. This token expires in 10 minutes.
This field is autopopulated if not provided.
dict
Response Syntax
{
'databaseName': 'string',
'databaseArn': 'string',
'environmentId': 'string',
'description': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
databaseName (string) --
The name of the kdb database.
databaseArn (string) --
The ARN identifier of the database.
environmentId (string) --
A unique identifier for the kdb environment.
description (string) --
A description of the database.
createdTimestamp (datetime) --
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.
lastModifiedTimestamp (datetime) --
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.
Returns a list of kdb environments created in an account.
See also: AWS API Documentation
Request Syntax
client.list_kx_environments(
nextToken='string',
maxResults=123
)
string
A token that indicates where a results page should begin.
integer
The maximum number of results to return in this request.
dict
Response Syntax
{
'environments': [
{
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'dnsStatus': 'NONE'|'UPDATE_REQUESTED'|'UPDATING'|'FAILED_UPDATE'|'SUCCESSFULLY_UPDATED',
'errorMessage': 'string',
'description': 'string',
'environmentArn': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'transitGatewayConfiguration': {
'transitGatewayID': 'string',
'routableCIDRSpace': 'string'
},
'customDNSConfiguration': [
{
'customDNSServerName': 'string',
'customDNSServerIP': 'string'
},
],
'creationTimestamp': datetime(2015, 1, 1),
'updateTimestamp': datetime(2015, 1, 1),
'availabilityZoneIds': [
'string',
],
'certificateAuthorityArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
environments (list) --
A list of environments in an account.
(dict) --
The details of a kdb environment.
name (string) --
The name of the kdb environment.
environmentId (string) --
A unique identifier for the kdb environment.
awsAccountId (string) --
The unique identifier of the AWS account in which you create the kdb environment.
status (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 (string) --
The status of the network configuration.
dnsStatus (string) --
The status of DNS configuration.
errorMessage (string) --
Specifies the error message that appears if a flow fails.
description (string) --
A description of the kdb environment.
environmentArn (string) --
The Amazon Resource Name (ARN) of your kdb environment.
kmsKeyId (string) --
The unique identifier of the KMS key.
dedicatedServiceAccountId (string) --
A unique identifier for the AWS environment infrastructure account.
transitGatewayConfiguration (dict) --
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
transitGatewayID (string) --
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
routableCIDRSpace (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.
customDNSConfiguration (list) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
(dict) --
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
customDNSServerName (string) --
The name of the DNS server.
customDNSServerIP (string) --
The IP address of the DNS server.
creationTimestamp (datetime) --
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.
updateTimestamp (datetime) --
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.
availabilityZoneIds (list) --
The identifier of the availability zones where subnets for the environment are created.
(string) --
certificateAuthorityArn (string) --
The Amazon Resource Name (ARN) of the certificate authority:
nextToken (string) --
A token that indicates where a results page should begin.
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
See also: AWS API Documentation
Request Syntax
client.delete_kx_environment(
environmentId='string'
)
string
[REQUIRED]
A unique identifier for the kdb environment.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.get_kx_connection_string(
userArn='string',
environmentId='string',
clusterName='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
A name of the kdb cluster.
dict
Response Syntax
{
'signedConnectionString': 'string'
}
Response Structure
(dict) --
signedConnectionString (string) --
The signed connection string that you can use to connect to clusters.
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.
See also: AWS API Documentation
Request Syntax
client.update_kx_cluster_databases(
environmentId='string',
clusterName='string',
clientToken='string',
databases=[
{
'databaseName': 'string',
'cacheConfigurations': [
{
'cacheType': 'string',
'dbPaths': [
'string',
]
},
],
'changesetId': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of a kdb environment.
string
[REQUIRED]
A unique name for the cluster that you want to modify.
string
A token that ensures idempotency. This token expires in 10 minutes.
list
[REQUIRED]
The structure of databases mounted on the cluster.
(dict) --
The configuration of data that is available for querying from this database.
databaseName (string) -- [REQUIRED]
The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
cacheConfigurations (list) --
Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
(dict) --
The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
cacheType (string) -- [REQUIRED]
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 (list) -- [REQUIRED]
Specifies the portions of database that will be loaded into the cache for access.
(string) --
changesetId (string) --
A unique identifier of the changeset that is associated with the cluster.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all the nodes in a kdb cluster.
See also: AWS API Documentation
Request Syntax
client.list_kx_cluster_nodes(
environmentId='string',
clusterName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for the kdb environment.
string
[REQUIRED]
A unique name for the cluster.
string
A token that indicates where a results page should begin.
integer
The maximum number of results to return in this request.
dict
Response Syntax
{
'nodes': [
{
'nodeId': 'string',
'availabilityZoneId': 'string',
'launchTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
nodes (list) --
A list of nodes associated with the cluster.
(dict) --
A structure that stores metadata for a kdb node.
nodeId (string) --
A unique identifier for the node.
availabilityZoneId (string) --
The identifier of the availability zones where subnets for the environment are created.
launchTime (datetime) --
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.
nextToken (string) --
A token that indicates where a results page should begin.
{'environment': {'status': {'FAILED_UPDATING_NETWORK',
'UPDATE_NETWORK_REQUESTED',
'UPDATING_NETWORK'}}}
Returns the FinSpace environment object.
See also: AWS API Documentation
Request Syntax
client.get_environment(
environmentId='string'
)
string
[REQUIRED]
The identifier of the FinSpace environment.
dict
Response Syntax
{
'environment': {
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'environmentUrl': 'string',
'description': 'string',
'environmentArn': 'string',
'sageMakerStudioDomainUrl': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'federationMode': 'FEDERATED'|'LOCAL',
'federationParameters': {
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
}
}
Response Structure
(dict) --
environment (dict) --
The name of the FinSpace environment.
name (string) --
The name of the FinSpace environment.
environmentId (string) --
The identifier of the FinSpace environment.
awsAccountId (string) --
The ID of the AWS account in which the FinSpace environment is created.
status (string) --
The current status of creation of the FinSpace environment.
environmentUrl (string) --
The sign-in URL for the web application of your FinSpace environment.
description (string) --
The description of the FinSpace environment.
environmentArn (string) --
The Amazon Resource Name (ARN) of your FinSpace environment.
sageMakerStudioDomainUrl (string) --
The URL of the integrated FinSpace notebook environment in your web application.
kmsKeyId (string) --
The KMS key id used to encrypt in the FinSpace environment.
dedicatedServiceAccountId (string) --
The AWS account ID of the dedicated service account associated with your FinSpace environment.
federationMode (string) --
The authentication mode for the environment.
federationParameters (dict) --
Configuration information when authentication mode is FEDERATED.
samlMetadataDocument (string) --
SAML 2.0 Metadata document from identity provider (IdP).
samlMetadataURL (string) --
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
applicationCallBackURL (string) --
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
federationURN (string) --
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
federationProviderName (string) --
Name of the identity provider (IdP).
attributeMap (dict) --
SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
(string) --
(string) --
{'environments': {'status': {'FAILED_UPDATING_NETWORK',
'UPDATE_NETWORK_REQUESTED',
'UPDATING_NETWORK'}}}
A list of all of your FinSpace environments.
See also: AWS API Documentation
Request Syntax
client.list_environments(
nextToken='string',
maxResults=123
)
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.
integer
The maximum number of results to return in this request.
dict
Response Syntax
{
'environments': [
{
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'environmentUrl': 'string',
'description': 'string',
'environmentArn': 'string',
'sageMakerStudioDomainUrl': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'federationMode': 'FEDERATED'|'LOCAL',
'federationParameters': {
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
environments (list) --
A list of all of your FinSpace environments.
(dict) --
Represents an FinSpace environment.
name (string) --
The name of the FinSpace environment.
environmentId (string) --
The identifier of the FinSpace environment.
awsAccountId (string) --
The ID of the AWS account in which the FinSpace environment is created.
status (string) --
The current status of creation of the FinSpace environment.
environmentUrl (string) --
The sign-in URL for the web application of your FinSpace environment.
description (string) --
The description of the FinSpace environment.
environmentArn (string) --
The Amazon Resource Name (ARN) of your FinSpace environment.
sageMakerStudioDomainUrl (string) --
The URL of the integrated FinSpace notebook environment in your web application.
kmsKeyId (string) --
The KMS key id used to encrypt in the FinSpace environment.
dedicatedServiceAccountId (string) --
The AWS account ID of the dedicated service account associated with your FinSpace environment.
federationMode (string) --
The authentication mode for the environment.
federationParameters (dict) --
Configuration information when authentication mode is FEDERATED.
samlMetadataDocument (string) --
SAML 2.0 Metadata document from identity provider (IdP).
samlMetadataURL (string) --
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
applicationCallBackURL (string) --
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
federationURN (string) --
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
federationProviderName (string) --
Name of the identity provider (IdP).
attributeMap (dict) --
SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
(string) --
(string) --
nextToken (string) --
A token that you can use in a subsequent call to retrieve the next set of results.
{'environment': {'status': {'FAILED_UPDATING_NETWORK',
'UPDATE_NETWORK_REQUESTED',
'UPDATING_NETWORK'}}}
Update your FinSpace environment.
See also: AWS API Documentation
Request Syntax
client.update_environment(
environmentId='string',
name='string',
description='string',
federationMode='FEDERATED'|'LOCAL',
federationParameters={
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
)
string
[REQUIRED]
The identifier of the FinSpace environment.
string
The name of the environment.
string
The description of the environment.
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.
dict
Configuration information when authentication mode is FEDERATED.
samlMetadataDocument (string) --
SAML 2.0 Metadata document from identity provider (IdP).
samlMetadataURL (string) --
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
applicationCallBackURL (string) --
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
federationURN (string) --
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
federationProviderName (string) --
Name of the identity provider (IdP).
attributeMap (dict) --
SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
(string) --
(string) --
dict
Response Syntax
{
'environment': {
'name': 'string',
'environmentId': 'string',
'awsAccountId': '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',
'environmentUrl': 'string',
'description': 'string',
'environmentArn': 'string',
'sageMakerStudioDomainUrl': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'federationMode': 'FEDERATED'|'LOCAL',
'federationParameters': {
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
}
}
Response Structure
(dict) --
environment (dict) --
Returns the FinSpace environment object.
name (string) --
The name of the FinSpace environment.
environmentId (string) --
The identifier of the FinSpace environment.
awsAccountId (string) --
The ID of the AWS account in which the FinSpace environment is created.
status (string) --
The current status of creation of the FinSpace environment.
environmentUrl (string) --
The sign-in URL for the web application of your FinSpace environment.
description (string) --
The description of the FinSpace environment.
environmentArn (string) --
The Amazon Resource Name (ARN) of your FinSpace environment.
sageMakerStudioDomainUrl (string) --
The URL of the integrated FinSpace notebook environment in your web application.
kmsKeyId (string) --
The KMS key id used to encrypt in the FinSpace environment.
dedicatedServiceAccountId (string) --
The AWS account ID of the dedicated service account associated with your FinSpace environment.
federationMode (string) --
The authentication mode for the environment.
federationParameters (dict) --
Configuration information when authentication mode is FEDERATED.
samlMetadataDocument (string) --
SAML 2.0 Metadata document from identity provider (IdP).
samlMetadataURL (string) --
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
applicationCallBackURL (string) --
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
federationURN (string) --
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
federationProviderName (string) --
Name of the identity provider (IdP).
attributeMap (dict) --
SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
(string) --
(string) --