finspace ******** Client ====== class finspace.Client A low-level client representing FinSpace User Environment Management service The FinSpace management service provides the APIs for managing FinSpace environments. import boto3 client = boto3.client('finspace') These are the available methods: * can_paginate * close * create_environment * create_kx_changeset * create_kx_cluster * create_kx_database * create_kx_dataview * create_kx_environment * create_kx_scaling_group * create_kx_user * create_kx_volume * delete_environment * delete_kx_cluster * delete_kx_cluster_node * delete_kx_database * delete_kx_dataview * delete_kx_environment * delete_kx_scaling_group * delete_kx_user * delete_kx_volume * get_environment * get_kx_changeset * get_kx_cluster * get_kx_connection_string * get_kx_database * get_kx_dataview * get_kx_environment * get_kx_scaling_group * get_kx_user * get_kx_volume * get_paginator * get_waiter * list_environments * list_kx_changesets * list_kx_cluster_nodes * list_kx_clusters * list_kx_databases * list_kx_dataviews * list_kx_environments * list_kx_scaling_groups * list_kx_users * list_kx_volumes * list_tags_for_resource * tag_resource * untag_resource * update_environment * update_kx_cluster_code_configuration * update_kx_cluster_databases * update_kx_database * update_kx_dataview * update_kx_environment * update_kx_environment_network * update_kx_user * update_kx_volume Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListKxEnvironments finspace / Paginator / ListKxEnvironments ListKxEnvironments ****************** class finspace.Paginator.ListKxEnvironments paginator = client.get_paginator('list_kx_environments') paginate(**kwargs) Creates an iterator that will paginate through responses from "finspace.Client.list_kx_environments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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', 'attachmentNetworkAclConfiguration': [ { 'ruleNumber': 123, 'protocol': 'string', 'ruleAction': 'allow'|'deny', 'portRange': { 'from': 123, 'to': 123 }, 'icmpTypeCode': { 'type': 123, 'code': 123 }, 'cidrBlock': '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. * **attachmentNetworkAclConfiguration** *(list) --* The rules that define how you manage the outbound traffic from kdb network to your internal network. * *(dict) --* 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. * **ruleNumber** *(integer) --* The rule number for the entry. For example *100*. All the network ACL entries are processed in ascending order by rule number. * **protocol** *(string) --* The protocol number. A value of *-1* means all the protocols. * **ruleAction** *(string) --* Indicates whether to allow or deny the traffic that matches the rule. * **portRange** *(dict) --* The range of ports the rule applies to. * **from** *(integer) --* The first port in the range. * **to** *(integer) --* The last port in the range. * **icmpTypeCode** *(dict) --* Defines the ICMP protocol that consists of the ICMP type and code. * **type** *(integer) --* The ICMP type. A value of *-1* means all types. * **code** *(integer) --* The ICMP code. A value of *-1* means all codes for the specified ICMP type. * **cidrBlock** *(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 specify "100.68.0.18/18", we modify it to "100.68.0.0/18". * **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 to resume pagination. finspace / Client / get_environment get_environment *************** finspace.Client.get_environment(**kwargs) Returns the FinSpace environment object. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.get_environment( environmentId='string' ) Parameters: **environmentId** (*string*) -- **[REQUIRED]** The identifier of the FinSpace environment. Return type: dict Returns: **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) --* **Exceptions** * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.AccessDeniedException" finspace / Client / get_paginator get_paginator ************* finspace.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. finspace / Client / update_kx_volume update_kx_volume **************** finspace.Client.update_kx_volume(**kwargs) Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete. See also: AWS API Documentation **Request Syntax** response = client.update_kx_volume( environmentId='string', volumeName='string', description='string', clientToken='string', nas1Configuration={ 'type': 'SSD_1000'|'SSD_250'|'HDD_12', 'size': 123 } ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment where you created the storage volume. * **volumeName** (*string*) -- **[REQUIRED]** A unique identifier for the volume. * **description** (*string*) -- A description of the volume. * **clientToken** (*string*) -- A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. * **nas1Configuration** (*dict*) -- Specifies the configuration for the Network attached storage (NAS_1) file system volume. * **type** *(string) --* The type of the network attached storage. * **size** *(integer) --* The size of the network attached storage. For storage type "SSD_1000" and "SSD_250" you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type "HDD_12" you can select the minimum size as 6000 GB or increments of 6000 GB. Return type: dict Returns: **Response Syntax** { 'environmentId': 'string', 'volumeName': 'string', 'volumeType': 'NAS_1', 'volumeArn': 'string', 'nas1Configuration': { 'type': 'SSD_1000'|'SSD_250'|'HDD_12', 'size': 123 }, 'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED', 'description': 'string', 'statusReason': 'string', 'createdTimestamp': datetime(2015, 1, 1), 'azMode': 'SINGLE'|'MULTI', 'availabilityZoneIds': [ 'string', ], 'lastModifiedTimestamp': datetime(2015, 1, 1), 'attachedClusters': [ { 'clusterName': 'string', 'clusterType': 'HDB'|'RDB'|'GATEWAY'|'GP'|'TICKERPLANT', 'clusterStatus': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED' }, ] } **Response Structure** * *(dict) --* * **environmentId** *(string) --* A unique identifier for the kdb environment where you want to update the volume. * **volumeName** *(string) --* A unique identifier for the volume that you want to update. * **volumeType** *(string) --* The type of file system volume. Currently, FinSpace only supports "NAS_1" volume type. * **volumeArn** *(string) --* The ARN identifier of the volume. * **nas1Configuration** *(dict) --* Specifies the configuration for the Network attached storage (NAS_1) file system volume. * **type** *(string) --* The type of the network attached storage. * **size** *(integer) --* The size of the network attached storage. For storage type "SSD_1000" and "SSD_250" you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type "HDD_12" you can select the minimum size as 6000 GB or increments of 6000 GB. * **status** *(string) --* The status of the volume. * CREATING – The volume creation is in progress. * CREATE_FAILED – The volume creation has failed. * ACTIVE – The volume is active. * UPDATING – The volume is in the process of being updated. * UPDATE_FAILED – The update action failed. * UPDATED – The volume is successfully updated. * DELETING – The volume is in the process of being deleted. * DELETE_FAILED – The system failed to delete the volume. * DELETED – The volume is successfully deleted. * **description** *(string) --* The description for the volume. * **statusReason** *(string) --* The error message when a failed state occurs. * **createdTimestamp** *(datetime) --* The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **azMode** *(string) --* The number of availability zones you want to assign per volume. Currently, FinSpace only supports "SINGLE" for volumes. This places dataview in a single AZ. * **availabilityZoneIds** *(list) --* The identifier of the availability zones. * *(string) --* * **lastModifiedTimestamp** *(datetime) --* The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **attachedClusters** *(list) --* Specifies the clusters that a volume is attached to. * *(dict) --* The structure containing the metadata of the attached clusters. * **clusterName** *(string) --* A unique name for the attached cluster. * **clusterType** *(string) --* Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs. * **clusterStatus** *(string) --* The status of the attached cluster. * PENDING – The cluster is pending creation. * CREATING – The cluster creation process is in progress. * CREATE_FAILED – The cluster creation process has failed. * RUNNING – The cluster creation process is running. * UPDATING – The cluster is in the process of being updated. * DELETING – The cluster is in the process of being deleted. * DELETED – The cluster has been deleted. * DELETE_FAILED – The cluster failed to delete. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.LimitExceededException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ConflictException" * "finspace.Client.exceptions.ResourceNotFoundException" finspace / Client / create_kx_dataview create_kx_dataview ****************** finspace.Client.create_kx_dataview(**kwargs) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters. See also: AWS API Documentation **Request Syntax** response = client.create_kx_dataview( environmentId='string', databaseName='string', dataviewName='string', azMode='SINGLE'|'MULTI', availabilityZoneId='string', changesetId='string', segmentConfigurations=[ { 'dbPaths': [ 'string', ], 'volumeName': 'string', 'onDemand': True|False }, ], autoUpdate=True|False, readWrite=True|False, description='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment, where you want to create the dataview. * **databaseName** (*string*) -- **[REQUIRED]** The name of the database where you want to create a dataview. * **dataviewName** (*string*) -- **[REQUIRED]** A unique identifier for the dataview. * **azMode** (*string*) -- **[REQUIRED]** The number of availability zones you want to assign per volume. Currently, FinSpace only supports "SINGLE" for volumes. This places dataview in a single AZ. * **availabilityZoneId** (*string*) -- The identifier of the availability zones. * **changesetId** (*string*) -- A unique identifier of the changeset that you want to use to ingest data. * **segmentConfigurations** (*list*) -- The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * *(dict) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * **dbPaths** *(list) --* **[REQUIRED]** The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume. * *(string) --* * **volumeName** *(string) --* **[REQUIRED]** The name of the volume where you want to add data. * **onDemand** *(boolean) --* Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is **True**, dataviews perform minimal loading of files on the filesystem as needed. When it is set to **False**, everything is cached. The default value is **False**. * **autoUpdate** (*boolean*) -- The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false. * **readWrite** (*boolean*) -- The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews. * You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. * You cannot perform updates on a writeable dataview. Hence, "autoUpdate" must be set as **False** if "readWrite" is **True** for a dataview. * You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails. * Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the "readWrite" parameter later. * **description** (*string*) -- A description of the dataview. * **tags** (*dict*) -- A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview. * *(string) --* * *(string) --* * **clientToken** (*string*) -- **[REQUIRED]** A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'dataviewName': 'string', 'databaseName': 'string', 'environmentId': 'string', 'azMode': 'SINGLE'|'MULTI', 'availabilityZoneId': 'string', 'changesetId': 'string', 'segmentConfigurations': [ { 'dbPaths': [ 'string', ], 'volumeName': 'string', 'onDemand': True|False }, ], 'description': 'string', 'autoUpdate': True|False, 'readWrite': True|False, 'createdTimestamp': datetime(2015, 1, 1), 'lastModifiedTimestamp': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED'|'DELETING' } **Response Structure** * *(dict) --* * **dataviewName** *(string) --* A unique identifier for the dataview. * **databaseName** *(string) --* The name of the database where you want to create a dataview. * **environmentId** *(string) --* A unique identifier for the kdb environment, where you want to create the dataview. * **azMode** *(string) --* The number of availability zones you want to assign per volume. Currently, FinSpace only supports "SINGLE" for volumes. This places dataview in a single AZ. * **availabilityZoneId** *(string) --* The identifier of the availability zones. * **changesetId** *(string) --* A unique identifier for the changeset. * **segmentConfigurations** *(list) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * *(dict) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * **dbPaths** *(list) --* The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume. * *(string) --* * **volumeName** *(string) --* The name of the volume where you want to add data. * **onDemand** *(boolean) --* Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is **True**, dataviews perform minimal loading of files on the filesystem as needed. When it is set to **False**, everything is cached. The default value is **False**. * **description** *(string) --* A description of the dataview. * **autoUpdate** *(boolean) --* The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false. * **readWrite** *(boolean) --* Returns True if the dataview is created as writeable and False otherwise. * **createdTimestamp** *(datetime) --* The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **lastModifiedTimestamp** *(datetime) --* The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **status** *(string) --* The status of dataview creation. * "CREATING" – The dataview creation is in progress. * "UPDATING" – The dataview is in the process of being updated. * "ACTIVE" – The dataview is active. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.ConflictException" * "finspace.Client.exceptions.LimitExceededException" * "finspace.Client.exceptions.ResourceAlreadyExistsException" finspace / Client / create_kx_database create_kx_database ****************** finspace.Client.create_kx_database(**kwargs) Creates a new kdb database in the environment. See also: AWS API Documentation **Request Syntax** response = client.create_kx_database( environmentId='string', databaseName='string', description='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment. * **databaseName** (*string*) -- **[REQUIRED]** The name of the kdb database. * **description** (*string*) -- A description of the database. * **tags** (*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) --* * **clientToken** (*string*) -- **[REQUIRED]** A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **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. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ConflictException" * "finspace.Client.exceptions.ResourceAlreadyExistsException" * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.LimitExceededException" finspace / Client / create_kx_environment create_kx_environment ********************* finspace.Client.create_kx_environment(**kwargs) Creates a managed kdb environment for the account. See also: AWS API Documentation **Request Syntax** response = client.create_kx_environment( name='string', description='string', kmsKeyId='string', tags={ 'string': 'string' }, clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the kdb environment that you want to create. * **description** (*string*) -- A description for the kdb environment. * **kmsKeyId** (*string*) -- **[REQUIRED]** The KMS key ID to encrypt your data in the FinSpace environment. * **tags** (*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) --* * **clientToken** (*string*) -- A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **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. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.ServiceQuotaExceededException" * "finspace.Client.exceptions.LimitExceededException" * "finspace.Client.exceptions.ConflictException" finspace / Client / delete_kx_database delete_kx_database ****************** finspace.Client.delete_kx_database(**kwargs) 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** response = client.delete_kx_database( environmentId='string', databaseName='string', clientToken='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment. * **databaseName** (*string*) -- **[REQUIRED]** The name of the kdb database that you want to delete. * **clientToken** (*string*) -- **[REQUIRED]** A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.ConflictException" finspace / Client / delete_kx_dataview delete_kx_dataview ****************** finspace.Client.delete_kx_dataview(**kwargs) Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster. See also: AWS API Documentation **Request Syntax** response = client.delete_kx_dataview( environmentId='string', databaseName='string', dataviewName='string', clientToken='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment, from where you want to delete the dataview. * **databaseName** (*string*) -- **[REQUIRED]** The name of the database whose dataview you want to delete. * **dataviewName** (*string*) -- **[REQUIRED]** The name of the dataview that you want to delete. * **clientToken** (*string*) -- **[REQUIRED]** A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.ConflictException" finspace / Client / delete_kx_environment delete_kx_environment ********************* finspace.Client.delete_kx_environment(**kwargs) 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** response = client.delete_kx_environment( environmentId='string', clientToken='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment. * **clientToken** (*string*) -- A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ConflictException" finspace / Client / delete_environment delete_environment ****************** finspace.Client.delete_environment(**kwargs) Delete an FinSpace environment. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.delete_environment( environmentId='string' ) Parameters: **environmentId** (*string*) -- **[REQUIRED]** The identifier for the FinSpace environment. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.ValidationException" finspace / Client / can_paginate can_paginate ************ finspace.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. finspace / Client / create_kx_scaling_group create_kx_scaling_group *********************** finspace.Client.create_kx_scaling_group(**kwargs) Creates a new scaling group. See also: AWS API Documentation **Request Syntax** response = client.create_kx_scaling_group( clientToken='string', environmentId='string', scalingGroupName='string', hostType='string', availabilityZoneId='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- **[REQUIRED]** A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment, where you want to create the scaling group. * **scalingGroupName** (*string*) -- **[REQUIRED]** A unique identifier for the kdb scaling group. * **hostType** (*string*) -- **[REQUIRED]** The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. You can add one of the following values: * "kx.sg.large" – The host type with a configuration of 16 GiB memory and 2 vCPUs. * "kx.sg.xlarge" – The host type with a configuration of 32 GiB memory and 4 vCPUs. * "kx.sg.2xlarge" – The host type with a configuration of 64 GiB memory and 8 vCPUs. * "kx.sg.4xlarge" – The host type with a configuration of 108 GiB memory and 16 vCPUs. * "kx.sg.8xlarge" – The host type with a configuration of 216 GiB memory and 32 vCPUs. * "kx.sg.16xlarge" – The host type with a configuration of 432 GiB memory and 64 vCPUs. * "kx.sg.32xlarge" – The host type with a configuration of 864 GiB memory and 128 vCPUs. * "kx.sg1.16xlarge" – The host type with a configuration of 1949 GiB memory and 64 vCPUs. * "kx.sg1.24xlarge" – The host type with a configuration of 2948 GiB memory and 96 vCPUs. * **availabilityZoneId** (*string*) -- **[REQUIRED]** The identifier of the availability zones. * **tags** (*dict*) -- A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'environmentId': 'string', 'scalingGroupName': 'string', 'hostType': 'string', 'availabilityZoneId': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'|'DELETE_FAILED', 'lastModifiedTimestamp': datetime(2015, 1, 1), 'createdTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **environmentId** *(string) --* A unique identifier for the kdb environment, where you create the scaling group. * **scalingGroupName** *(string) --* A unique identifier for the kdb scaling group. * **hostType** *(string) --* The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. * **availabilityZoneId** *(string) --* The identifier of the availability zones. * **status** *(string) --* The status of scaling group. * CREATING – The scaling group creation is in progress. * CREATE_FAILED – The scaling group creation has failed. * ACTIVE – The scaling group is active. * UPDATING – The scaling group is in the process of being updated. * UPDATE_FAILED – The update action failed. * DELETING – The scaling group is in the process of being deleted. * DELETE_FAILED – The system failed to delete the scaling group. * DELETED – The scaling group is successfully deleted. * **lastModifiedTimestamp** *(datetime) --* The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **createdTimestamp** *(datetime) --* The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.LimitExceededException" * "finspace.Client.exceptions.ConflictException" * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.AccessDeniedException" finspace / Client / create_environment create_environment ****************** finspace.Client.create_environment(**kwargs) Create a new FinSpace environment. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.create_environment( name='string', description='string', kmsKeyId='string', tags={ 'string': 'string' }, federationMode='FEDERATED'|'LOCAL', federationParameters={ 'samlMetadataDocument': 'string', 'samlMetadataURL': 'string', 'applicationCallBackURL': 'string', 'federationURN': 'string', 'federationProviderName': 'string', 'attributeMap': { 'string': 'string' } }, superuserParameters={ 'emailAddress': 'string', 'firstName': 'string', 'lastName': 'string' }, dataBundles=[ 'string', ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the FinSpace environment to be created. * **description** (*string*) -- The description of the FinSpace environment to be created. * **kmsKeyId** (*string*) -- The KMS key id to encrypt your data in the FinSpace environment. * **tags** (*dict*) -- Add tags to your FinSpace environment. * *(string) --* * *(string) --* * **federationMode** (*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** (*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/2 005/05/identity/claims/emailaddress". Please check your SAML 2.0 compliant identity provider (IdP) documentation for details. * *(string) --* * *(string) --* * **superuserParameters** (*dict*) -- Configuration information for the superuser. * **emailAddress** *(string) --* **[REQUIRED]** The email address of the superuser. * **firstName** *(string) --* **[REQUIRED]** The first name of the superuser. * **lastName** *(string) --* **[REQUIRED]** The last name of the superuser. * **dataBundles** (*list*) -- 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. * *(string) --* The Amazon Resource Name (ARN) of the data bundle. Return type: dict Returns: **Response Syntax** { 'environmentId': 'string', 'environmentArn': 'string', 'environmentUrl': 'string' } **Response Structure** * *(dict) --* * **environmentId** *(string) --* The unique identifier for FinSpace environment that you created. * **environmentArn** *(string) --* The Amazon Resource Name (ARN) of the FinSpace environment that you created. * **environmentUrl** *(string) --* The sign-in URL for the web application of the FinSpace environment you created. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.ServiceQuotaExceededException" * "finspace.Client.exceptions.LimitExceededException" finspace / Client / update_kx_user update_kx_user ************** finspace.Client.update_kx_user(**kwargs) Updates the user details. You can only update the IAM role associated with a user. See also: AWS API Documentation **Request Syntax** response = client.update_kx_user( environmentId='string', userName='string', iamRole='string', clientToken='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment. * **userName** (*string*) -- **[REQUIRED]** A unique identifier for the user. * **iamRole** (*string*) -- **[REQUIRED]** The IAM role ARN that is associated with the user. * **clientToken** (*string*) -- A token that ensures idempotency. This token expires in 10 minutes. This field is autopopulated if not provided. Return type: dict Returns: **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. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ResourceNotFoundException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.LimitExceededException" * "finspace.Client.exceptions.ConflictException" finspace / Client / get_kx_volume get_kx_volume ************* finspace.Client.get_kx_volume(**kwargs) Retrieves the information about the volume. See also: AWS API Documentation **Request Syntax** response = client.get_kx_volume( environmentId='string', volumeName='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment, whose clusters can attach to the volume. * **volumeName** (*string*) -- **[REQUIRED]** A unique identifier for the volume. Return type: dict Returns: **Response Syntax** { 'environmentId': 'string', 'volumeName': 'string', 'volumeType': 'NAS_1', 'volumeArn': 'string', 'nas1Configuration': { 'type': 'SSD_1000'|'SSD_250'|'HDD_12', 'size': 123 }, 'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED', 'statusReason': 'string', 'createdTimestamp': datetime(2015, 1, 1), 'description': 'string', 'azMode': 'SINGLE'|'MULTI', 'availabilityZoneIds': [ 'string', ], 'lastModifiedTimestamp': datetime(2015, 1, 1), 'attachedClusters': [ { 'clusterName': 'string', 'clusterType': 'HDB'|'RDB'|'GATEWAY'|'GP'|'TICKERPLANT', 'clusterStatus': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED' }, ] } **Response Structure** * *(dict) --* * **environmentId** *(string) --* A unique identifier for the kdb environment, whose clusters can attach to the volume. * **volumeName** *(string) --* A unique identifier for the volume. * **volumeType** *(string) --* The type of file system volume. Currently, FinSpace only supports "NAS_1" volume type. * **volumeArn** *(string) --* The ARN identifier of the volume. * **nas1Configuration** *(dict) --* Specifies the configuration for the Network attached storage (NAS_1) file system volume. * **type** *(string) --* The type of the network attached storage. * **size** *(integer) --* The size of the network attached storage. For storage type "SSD_1000" and "SSD_250" you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type "HDD_12" you can select the minimum size as 6000 GB or increments of 6000 GB. * **status** *(string) --* The status of volume creation. * CREATING – The volume creation is in progress. * CREATE_FAILED – The volume creation has failed. * ACTIVE – The volume is active. * UPDATING – The volume is in the process of being updated. * UPDATE_FAILED – The update action failed. * UPDATED – The volume is successfully updated. * DELETING – The volume is in the process of being deleted. * DELETE_FAILED – The system failed to delete the volume. * DELETED – The volume is successfully deleted. * **statusReason** *(string) --* The error message when a failed state occurs. * **createdTimestamp** *(datetime) --* The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **description** *(string) --* A description of the volume. * **azMode** *(string) --* The number of availability zones you want to assign per volume. Currently, FinSpace only supports "SINGLE" for volumes. This places dataview in a single AZ. * **availabilityZoneIds** *(list) --* The identifier of the availability zones. * *(string) --* * **lastModifiedTimestamp** *(datetime) --* The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **attachedClusters** *(list) --* A list of cluster identifiers that a volume is attached to. * *(dict) --* The structure containing the metadata of the attached clusters. * **clusterName** *(string) --* A unique name for the attached cluster. * **clusterType** *(string) --* Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs. * **clusterStatus** *(string) --* The status of the attached cluster. * PENDING – The cluster is pending creation. * CREATING – The cluster creation process is in progress. * CREATE_FAILED – The cluster creation process has failed. * RUNNING – The cluster creation process is running. * UPDATING – The cluster is in the process of being updated. * DELETING – The cluster is in the process of being deleted. * DELETED – The cluster has been deleted. * DELETE_FAILED – The cluster failed to delete. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.LimitExceededException" * "finspace.Client.exceptions.ConflictException" * "finspace.Client.exceptions.ResourceNotFoundException" finspace / Client / get_kx_database get_kx_database *************** finspace.Client.get_kx_database(**kwargs) Returns database information for the specified environment ID. See also: AWS API Documentation **Request Syntax** response = client.get_kx_database( environmentId='string', databaseName='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment. * **databaseName** (*string*) -- **[REQUIRED]** The name of the kdb database. Return type: dict Returns: **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. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ResourceNotFoundException" finspace / Client / get_kx_dataview get_kx_dataview *************** finspace.Client.get_kx_dataview(**kwargs) Retrieves details of the dataview. See also: AWS API Documentation **Request Syntax** response = client.get_kx_dataview( environmentId='string', databaseName='string', dataviewName='string' ) Parameters: * **environmentId** (*string*) -- **[REQUIRED]** A unique identifier for the kdb environment, from where you want to retrieve the dataview details. * **databaseName** (*string*) -- **[REQUIRED]** The name of the database where you created the dataview. * **dataviewName** (*string*) -- **[REQUIRED]** A unique identifier for the dataview. Return type: dict Returns: **Response Syntax** { 'databaseName': 'string', 'dataviewName': 'string', 'azMode': 'SINGLE'|'MULTI', 'availabilityZoneId': 'string', 'changesetId': 'string', 'segmentConfigurations': [ { 'dbPaths': [ 'string', ], 'volumeName': 'string', 'onDemand': True|False }, ], 'activeVersions': [ { 'changesetId': 'string', 'segmentConfigurations': [ { 'dbPaths': [ 'string', ], 'volumeName': 'string', 'onDemand': True|False }, ], 'attachedClusters': [ 'string', ], 'createdTimestamp': datetime(2015, 1, 1), 'versionId': 'string' }, ], 'description': 'string', 'autoUpdate': True|False, 'readWrite': True|False, 'environmentId': 'string', 'createdTimestamp': datetime(2015, 1, 1), 'lastModifiedTimestamp': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED'|'DELETING', 'statusReason': 'string' } **Response Structure** * *(dict) --* * **databaseName** *(string) --* The name of the database where you created the dataview. * **dataviewName** *(string) --* A unique identifier for the dataview. * **azMode** *(string) --* The number of availability zones you want to assign per volume. Currently, FinSpace only supports "SINGLE" for volumes. This places dataview in a single AZ. * **availabilityZoneId** *(string) --* The identifier of the availability zones. * **changesetId** *(string) --* A unique identifier of the changeset that you want to use to ingest data. * **segmentConfigurations** *(list) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * *(dict) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * **dbPaths** *(list) --* The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume. * *(string) --* * **volumeName** *(string) --* The name of the volume where you want to add data. * **onDemand** *(boolean) --* Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is **True**, dataviews perform minimal loading of files on the filesystem as needed. When it is set to **False**, everything is cached. The default value is **False**. * **activeVersions** *(list) --* The current active changeset versions of the database on the given dataview. * *(dict) --* The active version of the dataview that is currently in use by this cluster. * **changesetId** *(string) --* A unique identifier for the changeset. * **segmentConfigurations** *(list) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * *(dict) --* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. * **dbPaths** *(list) --* The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume. * *(string) --* * **volumeName** *(string) --* The name of the volume where you want to add data. * **onDemand** *(boolean) --* Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is **True**, dataviews perform minimal loading of files on the filesystem as needed. When it is set to **False**, everything is cached. The default value is **False**. * **attachedClusters** *(list) --* The list of clusters that are currently using this dataview. * *(string) --* * **createdTimestamp** *(datetime) --* The timestamp at which the dataview version was active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **versionId** *(string) --* A unique identifier of the active version. * **description** *(string) --* A description of the dataview. * **autoUpdate** *(boolean) --* The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false. * **readWrite** *(boolean) --* Returns True if the dataview is created as writeable and False otherwise. * **environmentId** *(string) --* A unique identifier for the kdb environment, from where you want to retrieve the dataview details. * **createdTimestamp** *(datetime) --* The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **lastModifiedTimestamp** *(datetime) --* The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * **status** *(string) --* The status of dataview creation. * "CREATING" – The dataview creation is in progress. * "UPDATING" – The dataview is in the process of being updated. * "ACTIVE" – The dataview is active. * **statusReason** *(string) --* The error message when a failed state occurs. **Exceptions** * "finspace.Client.exceptions.InternalServerException" * "finspace.Client.exceptions.ValidationException" * "finspace.Client.exceptions.ThrottlingException" * "finspace.Client.exceptions.AccessDeniedException" * "finspace.Client.exceptions.ResourceNotFoundException" finspace / Client / list_environments list_environments ***************** finspace.Client.list_environments(**kwargs) A list of all of your FinSpace environments. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.list_environments( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*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 >>``<