@aws-sdk/client-finspace 3.466.0 → 3.470.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/README.md +112 -0
  2. package/dist-cjs/Finspace.js +28 -0
  3. package/dist-cjs/commands/CreateKxDataviewCommand.js +51 -0
  4. package/dist-cjs/commands/CreateKxScalingGroupCommand.js +51 -0
  5. package/dist-cjs/commands/CreateKxVolumeCommand.js +51 -0
  6. package/dist-cjs/commands/DeleteKxDataviewCommand.js +51 -0
  7. package/dist-cjs/commands/DeleteKxScalingGroupCommand.js +51 -0
  8. package/dist-cjs/commands/DeleteKxVolumeCommand.js +51 -0
  9. package/dist-cjs/commands/GetKxDataviewCommand.js +51 -0
  10. package/dist-cjs/commands/GetKxScalingGroupCommand.js +51 -0
  11. package/dist-cjs/commands/GetKxVolumeCommand.js +51 -0
  12. package/dist-cjs/commands/ListKxDataviewsCommand.js +51 -0
  13. package/dist-cjs/commands/ListKxScalingGroupsCommand.js +51 -0
  14. package/dist-cjs/commands/ListKxVolumesCommand.js +51 -0
  15. package/dist-cjs/commands/UpdateKxDataviewCommand.js +51 -0
  16. package/dist-cjs/commands/UpdateKxVolumeCommand.js +51 -0
  17. package/dist-cjs/commands/index.js +14 -0
  18. package/dist-cjs/models/models_0.js +39 -1
  19. package/dist-cjs/pagination/ListKxDataviewsPaginator.js +29 -0
  20. package/dist-cjs/pagination/ListKxScalingGroupsPaginator.js +29 -0
  21. package/dist-cjs/pagination/index.js +2 -0
  22. package/dist-cjs/protocols/Aws_restJson1.js +1477 -207
  23. package/dist-es/Finspace.js +28 -0
  24. package/dist-es/commands/CreateKxDataviewCommand.js +47 -0
  25. package/dist-es/commands/CreateKxScalingGroupCommand.js +47 -0
  26. package/dist-es/commands/CreateKxVolumeCommand.js +47 -0
  27. package/dist-es/commands/DeleteKxDataviewCommand.js +47 -0
  28. package/dist-es/commands/DeleteKxScalingGroupCommand.js +47 -0
  29. package/dist-es/commands/DeleteKxVolumeCommand.js +47 -0
  30. package/dist-es/commands/GetKxDataviewCommand.js +47 -0
  31. package/dist-es/commands/GetKxScalingGroupCommand.js +47 -0
  32. package/dist-es/commands/GetKxVolumeCommand.js +47 -0
  33. package/dist-es/commands/ListKxDataviewsCommand.js +47 -0
  34. package/dist-es/commands/ListKxScalingGroupsCommand.js +47 -0
  35. package/dist-es/commands/ListKxVolumesCommand.js +47 -0
  36. package/dist-es/commands/UpdateKxDataviewCommand.js +47 -0
  37. package/dist-es/commands/UpdateKxVolumeCommand.js +47 -0
  38. package/dist-es/commands/index.js +14 -0
  39. package/dist-es/models/models_0.js +38 -0
  40. package/dist-es/pagination/ListKxDataviewsPaginator.js +25 -0
  41. package/dist-es/pagination/ListKxScalingGroupsPaginator.js +25 -0
  42. package/dist-es/pagination/index.js +2 -0
  43. package/dist-es/protocols/Aws_restJson1.js +1397 -155
  44. package/dist-types/Finspace.d.ts +98 -0
  45. package/dist-types/FinspaceClient.d.ts +16 -2
  46. package/dist-types/commands/CreateKxClusterCommand.d.ts +68 -6
  47. package/dist-types/commands/CreateKxDataviewCommand.d.ts +136 -0
  48. package/dist-types/commands/CreateKxScalingGroupCommand.d.ts +108 -0
  49. package/dist-types/commands/CreateKxVolumeCommand.d.ts +129 -0
  50. package/dist-types/commands/DeleteKxDataviewCommand.d.ts +94 -0
  51. package/dist-types/commands/DeleteKxEnvironmentCommand.d.ts +4 -0
  52. package/dist-types/commands/DeleteKxScalingGroupCommand.d.ts +96 -0
  53. package/dist-types/commands/DeleteKxUserCommand.d.ts +4 -0
  54. package/dist-types/commands/DeleteKxVolumeCommand.d.ts +98 -0
  55. package/dist-types/commands/GetKxClusterCommand.d.ts +37 -3
  56. package/dist-types/commands/GetKxDataviewCommand.d.ts +130 -0
  57. package/dist-types/commands/GetKxEnvironmentCommand.d.ts +3 -0
  58. package/dist-types/commands/GetKxScalingGroupCommand.d.ts +107 -0
  59. package/dist-types/commands/GetKxVolumeCommand.d.ts +120 -0
  60. package/dist-types/commands/ListEnvironmentsCommand.d.ts +3 -0
  61. package/dist-types/commands/ListKxClustersCommand.d.ts +8 -2
  62. package/dist-types/commands/ListKxDataviewsCommand.d.ts +135 -0
  63. package/dist-types/commands/ListKxEnvironmentsCommand.d.ts +3 -0
  64. package/dist-types/commands/ListKxScalingGroupsCommand.d.ts +112 -0
  65. package/dist-types/commands/ListKxVolumesCommand.d.ts +115 -0
  66. package/dist-types/commands/UpdateKxClusterDatabasesCommand.d.ts +15 -0
  67. package/dist-types/commands/UpdateKxDataviewCommand.d.ts +145 -0
  68. package/dist-types/commands/UpdateKxVolumeCommand.d.ts +128 -0
  69. package/dist-types/commands/index.d.ts +14 -0
  70. package/dist-types/models/models_0.d.ts +2214 -214
  71. package/dist-types/pagination/ListKxDataviewsPaginator.d.ts +7 -0
  72. package/dist-types/pagination/ListKxScalingGroupsPaginator.d.ts +7 -0
  73. package/dist-types/pagination/index.d.ts +2 -0
  74. package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
  75. package/dist-types/ts3.4/Finspace.d.ts +238 -0
  76. package/dist-types/ts3.4/FinspaceClient.d.ts +86 -2
  77. package/dist-types/ts3.4/commands/CreateKxDataviewCommand.d.ts +38 -0
  78. package/dist-types/ts3.4/commands/CreateKxScalingGroupCommand.d.ts +42 -0
  79. package/dist-types/ts3.4/commands/CreateKxVolumeCommand.d.ts +38 -0
  80. package/dist-types/ts3.4/commands/DeleteKxDataviewCommand.d.ts +38 -0
  81. package/dist-types/ts3.4/commands/DeleteKxScalingGroupCommand.d.ts +42 -0
  82. package/dist-types/ts3.4/commands/DeleteKxVolumeCommand.d.ts +38 -0
  83. package/dist-types/ts3.4/commands/GetKxDataviewCommand.d.ts +38 -0
  84. package/dist-types/ts3.4/commands/GetKxScalingGroupCommand.d.ts +39 -0
  85. package/dist-types/ts3.4/commands/GetKxVolumeCommand.d.ts +35 -0
  86. package/dist-types/ts3.4/commands/ListKxDataviewsCommand.d.ts +38 -0
  87. package/dist-types/ts3.4/commands/ListKxScalingGroupsCommand.d.ts +39 -0
  88. package/dist-types/ts3.4/commands/ListKxVolumesCommand.d.ts +38 -0
  89. package/dist-types/ts3.4/commands/UpdateKxDataviewCommand.d.ts +38 -0
  90. package/dist-types/ts3.4/commands/UpdateKxVolumeCommand.d.ts +38 -0
  91. package/dist-types/ts3.4/commands/index.d.ts +14 -0
  92. package/dist-types/ts3.4/models/models_0.d.ts +360 -4
  93. package/dist-types/ts3.4/pagination/ListKxDataviewsPaginator.d.ts +11 -0
  94. package/dist-types/ts3.4/pagination/ListKxScalingGroupsPaginator.d.ts +11 -0
  95. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  96. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
  97. package/package.json +34 -34
@@ -633,6 +633,7 @@ export declare const KxClusterType: {
633
633
  readonly GP: "GP";
634
634
  readonly HDB: "HDB";
635
635
  readonly RDB: "RDB";
636
+ readonly TICKERPLANT: "TICKERPLANT";
636
637
  };
637
638
  /**
638
639
  * @public
@@ -695,6 +696,65 @@ export interface KxDatabaseCacheConfiguration {
695
696
  * <p>Specifies the portions of database that will be loaded into the cache for access.</p>
696
697
  */
697
698
  dbPaths: string[] | undefined;
699
+ /**
700
+ * @public
701
+ * <p>
702
+ * The name of the dataview to be used for caching historical data on disk.
703
+ *
704
+ * </p>
705
+ */
706
+ dataviewName?: string;
707
+ }
708
+ /**
709
+ * @public
710
+ * <p>
711
+ * 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. </p>
712
+ */
713
+ export interface KxDataviewSegmentConfiguration {
714
+ /**
715
+ * @public
716
+ * <p>
717
+ * 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.</p>
718
+ */
719
+ dbPaths: string[] | undefined;
720
+ /**
721
+ * @public
722
+ * <p>
723
+ * The name of the volume where you want to add data. </p>
724
+ */
725
+ volumeName: string | undefined;
726
+ }
727
+ /**
728
+ * @public
729
+ * <p>
730
+ * The structure that stores the configuration details of a dataview.</p>
731
+ */
732
+ export interface KxDataviewConfiguration {
733
+ /**
734
+ * @public
735
+ * <p>
736
+ * The unique identifier of the dataview.</p>
737
+ */
738
+ dataviewName?: string;
739
+ /**
740
+ * @public
741
+ * <p>
742
+ * The version of the dataview corresponding to a given changeset.
743
+ *
744
+ * </p>
745
+ */
746
+ dataviewVersionId?: string;
747
+ /**
748
+ * @public
749
+ * <p>A unique identifier for the changeset.</p>
750
+ */
751
+ changesetId?: string;
752
+ /**
753
+ * @public
754
+ * <p>
755
+ * The db path and volume configuration for the segmented database.</p>
756
+ */
757
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
698
758
  }
699
759
  /**
700
760
  * @public
@@ -716,6 +776,22 @@ export interface KxDatabaseConfiguration {
716
776
  * <p>A unique identifier of the changeset that is associated with the cluster.</p>
717
777
  */
718
778
  changesetId?: string;
779
+ /**
780
+ * @public
781
+ * <p>
782
+ * The name of the dataview to be used for caching historical data on disk.
783
+ *
784
+ * </p>
785
+ */
786
+ dataviewName?: string;
787
+ /**
788
+ * @public
789
+ * <p>
790
+ * The configuration of the dataview to be used with specified cluster.
791
+ *
792
+ * </p>
793
+ */
794
+ dataviewConfiguration?: KxDataviewConfiguration;
719
795
  }
720
796
  /**
721
797
  * @public
@@ -742,12 +818,79 @@ export interface KxSavedownStorageConfiguration {
742
818
  * </li>
743
819
  * </ul>
744
820
  */
745
- type: KxSavedownStorageType | undefined;
821
+ type?: KxSavedownStorageType;
746
822
  /**
747
823
  * @public
748
824
  * <p>The size of temporary storage in gibibytes.</p>
749
825
  */
750
- size: number | undefined;
826
+ size?: number;
827
+ /**
828
+ * @public
829
+ * <p>
830
+ * The name of the kdb volume that you want to use as writeable save-down storage for clusters.
831
+ *
832
+ * </p>
833
+ */
834
+ volumeName?: string;
835
+ }
836
+ /**
837
+ * @public
838
+ * <p>The structure that stores the capacity configuration details of a scaling group.</p>
839
+ */
840
+ export interface KxScalingGroupConfiguration {
841
+ /**
842
+ * @public
843
+ * <p>A unique identifier for the kdb scaling group. </p>
844
+ */
845
+ scalingGroupName: string | undefined;
846
+ /**
847
+ * @public
848
+ * <p>
849
+ * An optional hard limit on the amount of memory a kdb cluster can use.
850
+ *
851
+ * </p>
852
+ */
853
+ memoryLimit?: number;
854
+ /**
855
+ * @public
856
+ * <p>
857
+ * A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.
858
+ *
859
+ * </p>
860
+ */
861
+ memoryReservation: number | undefined;
862
+ /**
863
+ * @public
864
+ * <p>
865
+ * The number of kdb cluster nodes.
866
+ *
867
+ * </p>
868
+ */
869
+ nodeCount: number | undefined;
870
+ /**
871
+ * @public
872
+ * <p>
873
+ * The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
874
+ *
875
+ * </p>
876
+ */
877
+ cpu?: number;
878
+ }
879
+ /**
880
+ * @public
881
+ * <p>
882
+ * A configuration to store the Tickerplant logs. It consists of
883
+ * a list of volumes that will be mounted to your cluster. For the cluster type <code>Tickerplant</code>, the location of the TP volume on the cluster will be available by using the global variable <code>.aws.tp_log_path</code>.
884
+ * </p>
885
+ */
886
+ export interface TickerplantLogConfiguration {
887
+ /**
888
+ * @public
889
+ * <p>
890
+ * The name of the volumes for tickerplant logs.
891
+ * </p>
892
+ */
893
+ tickerplantLogVolumes?: string[];
751
894
  }
752
895
  /**
753
896
  * @public
@@ -826,9 +969,20 @@ export interface CreateKxClusterRequest {
826
969
  * <li>
827
970
  * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
828
971
  * </li>
972
+ * <li>
973
+ * <p>Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.</p>
974
+ * </li>
829
975
  * </ul>
830
976
  */
831
977
  clusterType: KxClusterType | undefined;
978
+ /**
979
+ * @public
980
+ * <p>
981
+ * A configuration to store Tickerplant logs. It consists of
982
+ * a list of volumes that will be mounted to your cluster. For the cluster type <code>Tickerplant</code>, the location of the TP volume on the cluster will be available by using the global variable <code>.aws.tp_log_path</code>.
983
+ * </p>
984
+ */
985
+ tickerplantLogConfiguration?: TickerplantLogConfiguration;
832
986
  /**
833
987
  * @public
834
988
  * <p>A list of databases that will be available for querying.</p>
@@ -853,7 +1007,7 @@ export interface CreateKxClusterRequest {
853
1007
  * @public
854
1008
  * <p>A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.</p>
855
1009
  */
856
- capacityConfiguration: CapacityConfiguration | undefined;
1010
+ capacityConfiguration?: CapacityConfiguration;
857
1011
  /**
858
1012
  * @public
859
1013
  * <p>The version of FinSpace managed kdb to run.</p>
@@ -863,7 +1017,7 @@ export interface CreateKxClusterRequest {
863
1017
  * @public
864
1018
  * <p>Configuration details about the network where the Privatelink endpoint of the cluster resides.</p>
865
1019
  */
866
- vpcConfiguration?: VpcConfiguration;
1020
+ vpcConfiguration: VpcConfiguration | undefined;
867
1021
  /**
868
1022
  * @public
869
1023
  * <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within
@@ -917,6 +1071,11 @@ export interface CreateKxClusterRequest {
917
1071
  * <p>A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.</p>
918
1072
  */
919
1073
  tags?: Record<string, string>;
1074
+ /**
1075
+ * @public
1076
+ * <p>The structure that stores the configuration details of a scaling group.</p>
1077
+ */
1078
+ scalingGroupConfiguration?: KxScalingGroupConfiguration;
920
1079
  }
921
1080
  /**
922
1081
  * @public
@@ -936,6 +1095,36 @@ export declare const KxClusterStatus: {
936
1095
  * @public
937
1096
  */
938
1097
  export type KxClusterStatus = (typeof KxClusterStatus)[keyof typeof KxClusterStatus];
1098
+ /**
1099
+ * @public
1100
+ * @enum
1101
+ */
1102
+ export declare const VolumeType: {
1103
+ readonly NAS_1: "NAS_1";
1104
+ };
1105
+ /**
1106
+ * @public
1107
+ */
1108
+ export type VolumeType = (typeof VolumeType)[keyof typeof VolumeType];
1109
+ /**
1110
+ * @public
1111
+ * <p>
1112
+ * The structure that consists of name and type of volume.</p>
1113
+ */
1114
+ export interface Volume {
1115
+ /**
1116
+ * @public
1117
+ * <p>A unique identifier for the volume.</p>
1118
+ */
1119
+ volumeName?: string;
1120
+ /**
1121
+ * @public
1122
+ * <p>
1123
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.
1124
+ * </p>
1125
+ */
1126
+ volumeType?: VolumeType;
1127
+ }
939
1128
  /**
940
1129
  * @public
941
1130
  */
@@ -1002,9 +1191,27 @@ export interface CreateKxClusterResponse {
1002
1191
  * <li>
1003
1192
  * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
1004
1193
  * </li>
1194
+ * <li>
1195
+ * <p>Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.</p>
1196
+ * </li>
1005
1197
  * </ul>
1006
1198
  */
1007
1199
  clusterType?: KxClusterType;
1200
+ /**
1201
+ * @public
1202
+ * <p>
1203
+ * A configuration to store the Tickerplant logs. It consists of
1204
+ * a list of volumes that will be mounted to your cluster. For the cluster type <code>Tickerplant</code>, the location of the TP volume on the cluster will be available by using the global variable <code>.aws.tp_log_path</code>.
1205
+ * </p>
1206
+ */
1207
+ tickerplantLogConfiguration?: TickerplantLogConfiguration;
1208
+ /**
1209
+ * @public
1210
+ * <p>
1211
+ * A list of volumes mounted on the cluster.
1212
+ * </p>
1213
+ */
1214
+ volumes?: Volume[];
1008
1215
  /**
1009
1216
  * @public
1010
1217
  * <p>A list of databases that will be available for querying.</p>
@@ -1102,6 +1309,11 @@ export interface CreateKxClusterResponse {
1102
1309
  * <p>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.</p>
1103
1310
  */
1104
1311
  createdTimestamp?: Date;
1312
+ /**
1313
+ * @public
1314
+ * <p>The structure that stores the configuration details of a scaling group.</p>
1315
+ */
1316
+ scalingGroupConfiguration?: KxScalingGroupConfiguration;
1105
1317
  }
1106
1318
  /**
1107
1319
  * @public
@@ -1183,25 +1395,73 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1183
1395
  /**
1184
1396
  * @public
1185
1397
  */
1186
- export interface CreateKxEnvironmentRequest {
1398
+ export interface CreateKxDataviewRequest {
1187
1399
  /**
1188
1400
  * @public
1189
- * <p>The name of the kdb environment that you want to create.</p>
1401
+ * <p>A unique identifier for the kdb environment, where you want to create the dataview. </p>
1190
1402
  */
1191
- name: string | undefined;
1403
+ environmentId: string | undefined;
1192
1404
  /**
1193
1405
  * @public
1194
- * <p>A description for the kdb environment.</p>
1406
+ * <p>
1407
+ * The name of the database where you want to create a dataview.
1408
+ * </p>
1195
1409
  */
1196
- description?: string;
1410
+ databaseName: string | undefined;
1197
1411
  /**
1198
1412
  * @public
1199
- * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1413
+ * <p>A unique identifier for the dataview.</p>
1200
1414
  */
1201
- kmsKeyId: string | undefined;
1415
+ dataviewName: string | undefined;
1202
1416
  /**
1203
1417
  * @public
1204
- * <p>A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.</p>
1418
+ * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
1419
+ * <ul>
1420
+ * <li>
1421
+ * <p>
1422
+ * <code>SINGLE</code> – Assigns one availability zone per cluster.</p>
1423
+ * </li>
1424
+ * <li>
1425
+ * <p>
1426
+ * <code>MULTI</code> – Assigns all the availability zones per cluster.</p>
1427
+ * </li>
1428
+ * </ul>
1429
+ */
1430
+ azMode: KxAzMode | undefined;
1431
+ /**
1432
+ * @public
1433
+ * <p>
1434
+ * The identifier of the availability zones.
1435
+ * </p>
1436
+ */
1437
+ availabilityZoneId?: string;
1438
+ /**
1439
+ * @public
1440
+ * <p>
1441
+ * A unique identifier of the changeset that you want to use to ingest data. </p>
1442
+ */
1443
+ changesetId?: string;
1444
+ /**
1445
+ * @public
1446
+ * <p>
1447
+ * 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. </p>
1448
+ */
1449
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
1450
+ /**
1451
+ * @public
1452
+ * <p>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.</p>
1453
+ */
1454
+ autoUpdate?: boolean;
1455
+ /**
1456
+ * @public
1457
+ * <p>A description of the dataview.</p>
1458
+ */
1459
+ description?: string;
1460
+ /**
1461
+ * @public
1462
+ * <p>
1463
+ * A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
1464
+ * </p>
1205
1465
  */
1206
1466
  tags?: Record<string, string>;
1207
1467
  /**
@@ -1214,94 +1474,361 @@ export interface CreateKxEnvironmentRequest {
1214
1474
  * @public
1215
1475
  * @enum
1216
1476
  */
1217
- export declare const EnvironmentStatus: {
1218
- readonly CREATED: "CREATED";
1219
- readonly CREATE_REQUESTED: "CREATE_REQUESTED";
1477
+ export declare const KxDataviewStatus: {
1478
+ readonly ACTIVE: "ACTIVE";
1220
1479
  readonly CREATING: "CREATING";
1221
- readonly DELETED: "DELETED";
1222
- readonly DELETE_REQUESTED: "DELETE_REQUESTED";
1223
1480
  readonly DELETING: "DELETING";
1224
- readonly FAILED_CREATION: "FAILED_CREATION";
1225
- readonly FAILED_DELETION: "FAILED_DELETION";
1226
- readonly FAILED_UPDATING_NETWORK: "FAILED_UPDATING_NETWORK";
1227
- readonly RETRY_DELETION: "RETRY_DELETION";
1228
- readonly SUSPENDED: "SUSPENDED";
1229
- readonly UPDATE_NETWORK_REQUESTED: "UPDATE_NETWORK_REQUESTED";
1230
- readonly UPDATING_NETWORK: "UPDATING_NETWORK";
1481
+ readonly FAILED: "FAILED";
1482
+ readonly UPDATING: "UPDATING";
1231
1483
  };
1232
1484
  /**
1233
1485
  * @public
1234
1486
  */
1235
- export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof EnvironmentStatus];
1487
+ export type KxDataviewStatus = (typeof KxDataviewStatus)[keyof typeof KxDataviewStatus];
1236
1488
  /**
1237
1489
  * @public
1238
1490
  */
1239
- export interface CreateKxEnvironmentResponse {
1491
+ export interface CreateKxDataviewResponse {
1240
1492
  /**
1241
1493
  * @public
1242
- * <p>The name of the kdb environment.</p>
1494
+ * <p>A unique identifier for the dataview.</p>
1243
1495
  */
1244
- name?: string;
1496
+ dataviewName?: string;
1245
1497
  /**
1246
1498
  * @public
1247
- * <p>The status of the kdb environment.</p>
1499
+ * <p>The name of the database where you want to create a dataview.</p>
1248
1500
  */
1249
- status?: EnvironmentStatus;
1501
+ databaseName?: string;
1250
1502
  /**
1251
1503
  * @public
1252
- * <p>A unique identifier for the kdb environment.</p>
1504
+ * <p>A unique identifier for the kdb environment, where you want to create the dataview. </p>
1253
1505
  */
1254
1506
  environmentId?: string;
1255
1507
  /**
1256
1508
  * @public
1257
- * <p>A description for the kdb environment.</p>
1509
+ * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
1510
+ * <ul>
1511
+ * <li>
1512
+ * <p>
1513
+ * <code>SINGLE</code> – Assigns one availability zone per cluster.</p>
1514
+ * </li>
1515
+ * <li>
1516
+ * <p>
1517
+ * <code>MULTI</code> – Assigns all the availability zones per cluster.</p>
1518
+ * </li>
1519
+ * </ul>
1258
1520
  */
1259
- description?: string;
1521
+ azMode?: KxAzMode;
1260
1522
  /**
1261
1523
  * @public
1262
- * <p>The ARN identifier of the environment.</p>
1524
+ * <p>
1525
+ * The identifier of the availability zones.
1526
+ * </p>
1263
1527
  */
1264
- environmentArn?: string;
1528
+ availabilityZoneId?: string;
1265
1529
  /**
1266
1530
  * @public
1267
- * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1531
+ * <p>A unique identifier for the changeset.</p>
1268
1532
  */
1269
- kmsKeyId?: string;
1533
+ changesetId?: string;
1270
1534
  /**
1271
1535
  * @public
1272
- * <p>The timestamp at which the kdb environment was created in FinSpace.</p>
1536
+ * <p>
1537
+ * 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. </p>
1273
1538
  */
1274
- creationTimestamp?: Date;
1275
- }
1276
- /**
1277
- * @public
1278
- */
1279
- export interface CreateKxUserRequest {
1539
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
1280
1540
  /**
1281
1541
  * @public
1282
- * <p>A unique identifier for the kdb environment where you want to create a user.</p>
1542
+ * <p>A description of the dataview.</p>
1283
1543
  */
1284
- environmentId: string | undefined;
1544
+ description?: string;
1285
1545
  /**
1286
1546
  * @public
1287
- * <p>A unique identifier for the user.</p>
1547
+ * <p>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.</p>
1288
1548
  */
1289
- userName: string | undefined;
1549
+ autoUpdate?: boolean;
1290
1550
  /**
1291
1551
  * @public
1292
- * <p>The IAM role ARN that will be associated with the user.</p>
1552
+ * <p>
1553
+ * 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.</p>
1293
1554
  */
1294
- iamRole: string | undefined;
1555
+ createdTimestamp?: Date;
1295
1556
  /**
1296
1557
  * @public
1297
- * <p>A list of key-value pairs to label the user. You can add up to 50 tags to a user.</p>
1558
+ * <p>
1559
+ * 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. </p>
1298
1560
  */
1299
- tags?: Record<string, string>;
1561
+ lastModifiedTimestamp?: Date;
1300
1562
  /**
1301
1563
  * @public
1302
- * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1303
- */
1304
- clientToken?: string;
1564
+ * <p>
1565
+ * The status of dataview creation.</p>
1566
+ * <ul>
1567
+ * <li>
1568
+ * <p>
1569
+ * <code>CREATING</code> – The dataview creation is in progress.</p>
1570
+ * </li>
1571
+ * <li>
1572
+ * <p>
1573
+ * <code>UPDATING</code> – The dataview is in the process of being updated.</p>
1574
+ * </li>
1575
+ * <li>
1576
+ * <p>
1577
+ * <code>ACTIVE</code> – The dataview is active.</p>
1578
+ * </li>
1579
+ * </ul>
1580
+ */
1581
+ status?: KxDataviewStatus;
1582
+ }
1583
+ /**
1584
+ * @public
1585
+ */
1586
+ export interface CreateKxEnvironmentRequest {
1587
+ /**
1588
+ * @public
1589
+ * <p>The name of the kdb environment that you want to create.</p>
1590
+ */
1591
+ name: string | undefined;
1592
+ /**
1593
+ * @public
1594
+ * <p>A description for the kdb environment.</p>
1595
+ */
1596
+ description?: string;
1597
+ /**
1598
+ * @public
1599
+ * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1600
+ */
1601
+ kmsKeyId: string | undefined;
1602
+ /**
1603
+ * @public
1604
+ * <p>A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.</p>
1605
+ */
1606
+ tags?: Record<string, string>;
1607
+ /**
1608
+ * @public
1609
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1610
+ */
1611
+ clientToken?: string;
1612
+ }
1613
+ /**
1614
+ * @public
1615
+ * @enum
1616
+ */
1617
+ export declare const EnvironmentStatus: {
1618
+ readonly CREATED: "CREATED";
1619
+ readonly CREATE_REQUESTED: "CREATE_REQUESTED";
1620
+ readonly CREATING: "CREATING";
1621
+ readonly DELETED: "DELETED";
1622
+ readonly DELETE_REQUESTED: "DELETE_REQUESTED";
1623
+ readonly DELETING: "DELETING";
1624
+ readonly FAILED_CREATION: "FAILED_CREATION";
1625
+ readonly FAILED_DELETION: "FAILED_DELETION";
1626
+ readonly FAILED_UPDATING_NETWORK: "FAILED_UPDATING_NETWORK";
1627
+ readonly RETRY_DELETION: "RETRY_DELETION";
1628
+ readonly SUSPENDED: "SUSPENDED";
1629
+ readonly UPDATE_NETWORK_REQUESTED: "UPDATE_NETWORK_REQUESTED";
1630
+ readonly UPDATING_NETWORK: "UPDATING_NETWORK";
1631
+ };
1632
+ /**
1633
+ * @public
1634
+ */
1635
+ export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof EnvironmentStatus];
1636
+ /**
1637
+ * @public
1638
+ */
1639
+ export interface CreateKxEnvironmentResponse {
1640
+ /**
1641
+ * @public
1642
+ * <p>The name of the kdb environment.</p>
1643
+ */
1644
+ name?: string;
1645
+ /**
1646
+ * @public
1647
+ * <p>The status of the kdb environment.</p>
1648
+ */
1649
+ status?: EnvironmentStatus;
1650
+ /**
1651
+ * @public
1652
+ * <p>A unique identifier for the kdb environment.</p>
1653
+ */
1654
+ environmentId?: string;
1655
+ /**
1656
+ * @public
1657
+ * <p>A description for the kdb environment.</p>
1658
+ */
1659
+ description?: string;
1660
+ /**
1661
+ * @public
1662
+ * <p>The ARN identifier of the environment.</p>
1663
+ */
1664
+ environmentArn?: string;
1665
+ /**
1666
+ * @public
1667
+ * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1668
+ */
1669
+ kmsKeyId?: string;
1670
+ /**
1671
+ * @public
1672
+ * <p>The timestamp at which the kdb environment was created in FinSpace.</p>
1673
+ */
1674
+ creationTimestamp?: Date;
1675
+ }
1676
+ /**
1677
+ * @public
1678
+ */
1679
+ export interface CreateKxScalingGroupRequest {
1680
+ /**
1681
+ * @public
1682
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1683
+ */
1684
+ clientToken?: string;
1685
+ /**
1686
+ * @public
1687
+ * <p>A unique identifier for the kdb environment, where you want to create the scaling group. </p>
1688
+ */
1689
+ environmentId: string | undefined;
1690
+ /**
1691
+ * @public
1692
+ * <p>A unique identifier for the kdb scaling group. </p>
1693
+ */
1694
+ scalingGroupName: string | undefined;
1695
+ /**
1696
+ * @public
1697
+ * <p>
1698
+ * The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
1699
+ *
1700
+ * </p>
1701
+ */
1702
+ hostType: string | undefined;
1703
+ /**
1704
+ * @public
1705
+ * <p>The identifier of the availability zones.</p>
1706
+ */
1707
+ availabilityZoneId: string | undefined;
1708
+ /**
1709
+ * @public
1710
+ * <p>
1711
+ * A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.
1712
+ * </p>
1713
+ */
1714
+ tags?: Record<string, string>;
1715
+ }
1716
+ /**
1717
+ * @public
1718
+ * @enum
1719
+ */
1720
+ export declare const KxScalingGroupStatus: {
1721
+ readonly ACTIVE: "ACTIVE";
1722
+ readonly CREATE_FAILED: "CREATE_FAILED";
1723
+ readonly CREATING: "CREATING";
1724
+ readonly DELETED: "DELETED";
1725
+ readonly DELETE_FAILED: "DELETE_FAILED";
1726
+ readonly DELETING: "DELETING";
1727
+ };
1728
+ /**
1729
+ * @public
1730
+ */
1731
+ export type KxScalingGroupStatus = (typeof KxScalingGroupStatus)[keyof typeof KxScalingGroupStatus];
1732
+ /**
1733
+ * @public
1734
+ */
1735
+ export interface CreateKxScalingGroupResponse {
1736
+ /**
1737
+ * @public
1738
+ * <p>A unique identifier for the kdb environment, where you create the scaling group. </p>
1739
+ */
1740
+ environmentId?: string;
1741
+ /**
1742
+ * @public
1743
+ * <p>A unique identifier for the kdb scaling group. </p>
1744
+ */
1745
+ scalingGroupName?: string;
1746
+ /**
1747
+ * @public
1748
+ * <p>
1749
+ * The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
1750
+ *
1751
+ * </p>
1752
+ */
1753
+ hostType?: string;
1754
+ /**
1755
+ * @public
1756
+ * <p>The identifier of the availability zones.</p>
1757
+ */
1758
+ availabilityZoneId?: string;
1759
+ /**
1760
+ * @public
1761
+ * <p>The status of scaling group.</p>
1762
+ * <ul>
1763
+ * <li>
1764
+ * <p>CREATING – The scaling group creation is in progress.</p>
1765
+ * </li>
1766
+ * <li>
1767
+ * <p>CREATE_FAILED – The scaling group creation has failed.</p>
1768
+ * </li>
1769
+ * <li>
1770
+ * <p>ACTIVE – The scaling group is active.</p>
1771
+ * </li>
1772
+ * <li>
1773
+ * <p>UPDATING – The scaling group is in the process of being updated.</p>
1774
+ * </li>
1775
+ * <li>
1776
+ * <p>UPDATE_FAILED – The update action failed.</p>
1777
+ * </li>
1778
+ * <li>
1779
+ * <p>DELETING – The scaling group is in the process of being deleted.</p>
1780
+ * </li>
1781
+ * <li>
1782
+ * <p>DELETE_FAILED – The system failed to delete the scaling group.</p>
1783
+ * </li>
1784
+ * <li>
1785
+ * <p>DELETED – The scaling group is successfully deleted.</p>
1786
+ * </li>
1787
+ * </ul>
1788
+ */
1789
+ status?: KxScalingGroupStatus;
1790
+ /**
1791
+ * @public
1792
+ * <p>
1793
+ * 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. </p>
1794
+ */
1795
+ lastModifiedTimestamp?: Date;
1796
+ /**
1797
+ * @public
1798
+ * <p>
1799
+ * 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.</p>
1800
+ */
1801
+ createdTimestamp?: Date;
1802
+ }
1803
+ /**
1804
+ * @public
1805
+ */
1806
+ export interface CreateKxUserRequest {
1807
+ /**
1808
+ * @public
1809
+ * <p>A unique identifier for the kdb environment where you want to create a user.</p>
1810
+ */
1811
+ environmentId: string | undefined;
1812
+ /**
1813
+ * @public
1814
+ * <p>A unique identifier for the user.</p>
1815
+ */
1816
+ userName: string | undefined;
1817
+ /**
1818
+ * @public
1819
+ * <p>The IAM role ARN that will be associated with the user.</p>
1820
+ */
1821
+ iamRole: string | undefined;
1822
+ /**
1823
+ * @public
1824
+ * <p>A list of key-value pairs to label the user. You can add up to 50 tags to a user.</p>
1825
+ */
1826
+ tags?: Record<string, string>;
1827
+ /**
1828
+ * @public
1829
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1830
+ */
1831
+ clientToken?: string;
1305
1832
  }
1306
1833
  /**
1307
1834
  * @public
@@ -1309,26 +1836,243 @@ export interface CreateKxUserRequest {
1309
1836
  export interface CreateKxUserResponse {
1310
1837
  /**
1311
1838
  * @public
1312
- * <p>A unique identifier for the user.</p>
1839
+ * <p>A unique identifier for the user.</p>
1840
+ */
1841
+ userName?: string;
1842
+ /**
1843
+ * @public
1844
+ * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
1845
+ * how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
1846
+ * <i>IAM User Guide</i>. </p>
1847
+ */
1848
+ userArn?: string;
1849
+ /**
1850
+ * @public
1851
+ * <p>A unique identifier for the kdb environment.</p>
1852
+ */
1853
+ environmentId?: string;
1854
+ /**
1855
+ * @public
1856
+ * <p>The IAM role ARN that will be associated with the user.</p>
1857
+ */
1858
+ iamRole?: string;
1859
+ }
1860
+ /**
1861
+ * @public
1862
+ * @enum
1863
+ */
1864
+ export declare const KxNAS1Type: {
1865
+ readonly HDD_12: "HDD_12";
1866
+ readonly SSD_1000: "SSD_1000";
1867
+ readonly SSD_250: "SSD_250";
1868
+ };
1869
+ /**
1870
+ * @public
1871
+ */
1872
+ export type KxNAS1Type = (typeof KxNAS1Type)[keyof typeof KxNAS1Type];
1873
+ /**
1874
+ * @public
1875
+ * <p>
1876
+ * The structure containing the size and type of the network attached storage (NAS_1) file system volume.
1877
+ * </p>
1878
+ */
1879
+ export interface KxNAS1Configuration {
1880
+ /**
1881
+ * @public
1882
+ * <p>
1883
+ * The type of the network attached storage.
1884
+ * </p>
1885
+ */
1886
+ type?: KxNAS1Type;
1887
+ /**
1888
+ * @public
1889
+ * <p>
1890
+ * The size of the network attached storage.</p>
1891
+ */
1892
+ size?: number;
1893
+ }
1894
+ /**
1895
+ * @public
1896
+ * @enum
1897
+ */
1898
+ export declare const KxVolumeType: {
1899
+ readonly NAS_1: "NAS_1";
1900
+ };
1901
+ /**
1902
+ * @public
1903
+ */
1904
+ export type KxVolumeType = (typeof KxVolumeType)[keyof typeof KxVolumeType];
1905
+ /**
1906
+ * @public
1907
+ */
1908
+ export interface CreateKxVolumeRequest {
1909
+ /**
1910
+ * @public
1911
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1912
+ */
1913
+ clientToken?: string;
1914
+ /**
1915
+ * @public
1916
+ * <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
1917
+ */
1918
+ environmentId: string | undefined;
1919
+ /**
1920
+ * @public
1921
+ * <p>
1922
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type. When you select <code>NAS_1</code> volume type, you must also provide <code>nas1Configuration</code>.
1923
+ * </p>
1924
+ */
1925
+ volumeType: KxVolumeType | undefined;
1926
+ /**
1927
+ * @public
1928
+ * <p>A unique identifier for the volume.</p>
1929
+ */
1930
+ volumeName: string | undefined;
1931
+ /**
1932
+ * @public
1933
+ * <p>
1934
+ * A description of the volume.
1935
+ * </p>
1936
+ */
1937
+ description?: string;
1938
+ /**
1939
+ * @public
1940
+ * <p> Specifies the configuration for the Network attached storage (NAS_1) file system volume. This
1941
+ * parameter is required when you choose <code>volumeType</code> as
1942
+ * <i>NAS_1</i>.</p>
1943
+ */
1944
+ nas1Configuration?: KxNAS1Configuration;
1945
+ /**
1946
+ * @public
1947
+ * <p>The number of availability zones you want to assign per cluster. Currently, FinSpace only support <code>SINGLE</code> for volumes.</p>
1948
+ */
1949
+ azMode: KxAzMode | undefined;
1950
+ /**
1951
+ * @public
1952
+ * <p>The identifier of the availability zones.</p>
1953
+ */
1954
+ availabilityZoneIds: string[] | undefined;
1955
+ /**
1956
+ * @public
1957
+ * <p>
1958
+ * A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.
1959
+ * </p>
1960
+ */
1961
+ tags?: Record<string, string>;
1962
+ }
1963
+ /**
1964
+ * @public
1965
+ * @enum
1966
+ */
1967
+ export declare const KxVolumeStatus: {
1968
+ readonly ACTIVE: "ACTIVE";
1969
+ readonly CREATE_FAILED: "CREATE_FAILED";
1970
+ readonly CREATING: "CREATING";
1971
+ readonly DELETED: "DELETED";
1972
+ readonly DELETE_FAILED: "DELETE_FAILED";
1973
+ readonly DELETING: "DELETING";
1974
+ readonly UPDATED: "UPDATED";
1975
+ readonly UPDATE_FAILED: "UPDATE_FAILED";
1976
+ readonly UPDATING: "UPDATING";
1977
+ };
1978
+ /**
1979
+ * @public
1980
+ */
1981
+ export type KxVolumeStatus = (typeof KxVolumeStatus)[keyof typeof KxVolumeStatus];
1982
+ /**
1983
+ * @public
1984
+ */
1985
+ export interface CreateKxVolumeResponse {
1986
+ /**
1987
+ * @public
1988
+ * <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
1989
+ */
1990
+ environmentId?: string;
1991
+ /**
1992
+ * @public
1993
+ * <p>A unique identifier for the volume.</p>
1994
+ */
1995
+ volumeName?: string;
1996
+ /**
1997
+ * @public
1998
+ * <p>
1999
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.
2000
+ * </p>
2001
+ */
2002
+ volumeType?: KxVolumeType;
2003
+ /**
2004
+ * @public
2005
+ * <p>
2006
+ * The ARN identifier of the volume.
2007
+ * </p>
2008
+ */
2009
+ volumeArn?: string;
2010
+ /**
2011
+ * @public
2012
+ * <p> Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>
2013
+ */
2014
+ nas1Configuration?: KxNAS1Configuration;
2015
+ /**
2016
+ * @public
2017
+ * <p>The status of volume creation.</p>
2018
+ * <ul>
2019
+ * <li>
2020
+ * <p>CREATING – The volume creation is in progress.</p>
2021
+ * </li>
2022
+ * <li>
2023
+ * <p>CREATE_FAILED – The volume creation has failed.</p>
2024
+ * </li>
2025
+ * <li>
2026
+ * <p>ACTIVE – The volume is active.</p>
2027
+ * </li>
2028
+ * <li>
2029
+ * <p>UPDATING – The volume is in the process of being updated.</p>
2030
+ * </li>
2031
+ * <li>
2032
+ * <p>UPDATE_FAILED – The update action failed.</p>
2033
+ * </li>
2034
+ * <li>
2035
+ * <p>UPDATED – The volume is successfully updated.</p>
2036
+ * </li>
2037
+ * <li>
2038
+ * <p>DELETING – The volume is in the process of being deleted.</p>
2039
+ * </li>
2040
+ * <li>
2041
+ * <p>DELETE_FAILED – The system failed to delete the volume.</p>
2042
+ * </li>
2043
+ * <li>
2044
+ * <p>DELETED – The volume is successfully deleted.</p>
2045
+ * </li>
2046
+ * </ul>
1313
2047
  */
1314
- userName?: string;
2048
+ status?: KxVolumeStatus;
1315
2049
  /**
1316
2050
  * @public
1317
- * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
1318
- * how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
1319
- * <i>IAM User Guide</i>. </p>
2051
+ * <p>The error message when a failed state occurs. </p>
1320
2052
  */
1321
- userArn?: string;
2053
+ statusReason?: string;
1322
2054
  /**
1323
2055
  * @public
1324
- * <p>A unique identifier for the kdb environment.</p>
2056
+ * <p>The number of availability zones you want to assign per cluster. Currently, FinSpace only support <code>SINGLE</code> for volumes.</p>
1325
2057
  */
1326
- environmentId?: string;
2058
+ azMode?: KxAzMode;
1327
2059
  /**
1328
2060
  * @public
1329
- * <p>The IAM role ARN that will be associated with the user.</p>
2061
+ * <p>
2062
+ * A description of the volume.
2063
+ * </p>
1330
2064
  */
1331
- iamRole?: string;
2065
+ description?: string;
2066
+ /**
2067
+ * @public
2068
+ * <p>The identifier of the availability zones.</p>
2069
+ */
2070
+ availabilityZoneIds?: string[];
2071
+ /**
2072
+ * @public
2073
+ * <p>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.</p>
2074
+ */
2075
+ createdTimestamp?: Date;
1332
2076
  }
1333
2077
  /**
1334
2078
  * @public
@@ -1395,6 +2139,36 @@ export interface DeleteKxDatabaseRequest {
1395
2139
  */
1396
2140
  export interface DeleteKxDatabaseResponse {
1397
2141
  }
2142
+ /**
2143
+ * @public
2144
+ */
2145
+ export interface DeleteKxDataviewRequest {
2146
+ /**
2147
+ * @public
2148
+ * <p>A unique identifier for the kdb environment, from where you want to delete the dataview. </p>
2149
+ */
2150
+ environmentId: string | undefined;
2151
+ /**
2152
+ * @public
2153
+ * <p>The name of the database whose dataview you want to delete.</p>
2154
+ */
2155
+ databaseName: string | undefined;
2156
+ /**
2157
+ * @public
2158
+ * <p>The name of the dataview that you want to delete.</p>
2159
+ */
2160
+ dataviewName: string | undefined;
2161
+ /**
2162
+ * @public
2163
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2164
+ */
2165
+ clientToken?: string;
2166
+ }
2167
+ /**
2168
+ * @public
2169
+ */
2170
+ export interface DeleteKxDataviewResponse {
2171
+ }
1398
2172
  /**
1399
2173
  * @public
1400
2174
  */
@@ -1404,12 +2178,42 @@ export interface DeleteKxEnvironmentRequest {
1404
2178
  * <p>A unique identifier for the kdb environment.</p>
1405
2179
  */
1406
2180
  environmentId: string | undefined;
2181
+ /**
2182
+ * @public
2183
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2184
+ */
2185
+ clientToken?: string;
1407
2186
  }
1408
2187
  /**
1409
2188
  * @public
1410
2189
  */
1411
2190
  export interface DeleteKxEnvironmentResponse {
1412
2191
  }
2192
+ /**
2193
+ * @public
2194
+ */
2195
+ export interface DeleteKxScalingGroupRequest {
2196
+ /**
2197
+ * @public
2198
+ * <p>A unique identifier for the kdb environment, from where you want to delete the dataview. </p>
2199
+ */
2200
+ environmentId: string | undefined;
2201
+ /**
2202
+ * @public
2203
+ * <p>A unique identifier for the kdb scaling group. </p>
2204
+ */
2205
+ scalingGroupName: string | undefined;
2206
+ /**
2207
+ * @public
2208
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2209
+ */
2210
+ clientToken?: string;
2211
+ }
2212
+ /**
2213
+ * @public
2214
+ */
2215
+ export interface DeleteKxScalingGroupResponse {
2216
+ }
1413
2217
  /**
1414
2218
  * @public
1415
2219
  */
@@ -1424,12 +2228,44 @@ export interface DeleteKxUserRequest {
1424
2228
  * <p>A unique identifier for the kdb environment.</p>
1425
2229
  */
1426
2230
  environmentId: string | undefined;
2231
+ /**
2232
+ * @public
2233
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2234
+ */
2235
+ clientToken?: string;
1427
2236
  }
1428
2237
  /**
1429
2238
  * @public
1430
2239
  */
1431
2240
  export interface DeleteKxUserResponse {
1432
2241
  }
2242
+ /**
2243
+ * @public
2244
+ */
2245
+ export interface DeleteKxVolumeRequest {
2246
+ /**
2247
+ * @public
2248
+ * <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
2249
+ */
2250
+ environmentId: string | undefined;
2251
+ /**
2252
+ * @public
2253
+ * <p>
2254
+ * The name of the volume that you want to delete.
2255
+ * </p>
2256
+ */
2257
+ volumeName: string | undefined;
2258
+ /**
2259
+ * @public
2260
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2261
+ */
2262
+ clientToken?: string;
2263
+ }
2264
+ /**
2265
+ * @public
2266
+ */
2267
+ export interface DeleteKxVolumeResponse {
2268
+ }
1433
2269
  /**
1434
2270
  * @public
1435
2271
  */
@@ -1679,9 +2515,27 @@ export interface GetKxClusterResponse {
1679
2515
  * <li>
1680
2516
  * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
1681
2517
  * </li>
2518
+ * <li>
2519
+ * <p>Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.</p>
2520
+ * </li>
1682
2521
  * </ul>
1683
2522
  */
1684
2523
  clusterType?: KxClusterType;
2524
+ /**
2525
+ * @public
2526
+ * <p>
2527
+ * A configuration to store the Tickerplant logs. It consists of
2528
+ * a list of volumes that will be mounted to your cluster. For the cluster type <code>Tickerplant</code>, the location of the TP volume on the cluster will be available by using the global variable <code>.aws.tp_log_path</code>.
2529
+ * </p>
2530
+ */
2531
+ tickerplantLogConfiguration?: TickerplantLogConfiguration;
2532
+ /**
2533
+ * @public
2534
+ * <p>
2535
+ * A list of volumes attached to the cluster.
2536
+ * </p>
2537
+ */
2538
+ volumes?: Volume[];
1685
2539
  /**
1686
2540
  * @public
1687
2541
  * <p> A list of databases mounted on the cluster.</p>
@@ -1779,6 +2633,11 @@ export interface GetKxClusterResponse {
1779
2633
  * <p>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.</p>
1780
2634
  */
1781
2635
  createdTimestamp?: Date;
2636
+ /**
2637
+ * @public
2638
+ * <p>The structure that stores the capacity configuration details of a scaling group.</p>
2639
+ */
2640
+ scalingGroupConfiguration?: KxScalingGroupConfiguration;
1782
2641
  }
1783
2642
  /**
1784
2643
  * @public
@@ -1853,34 +2712,207 @@ export interface GetKxDatabaseResponse {
1853
2712
  description?: string;
1854
2713
  /**
1855
2714
  * @public
1856
- * <p>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.</p>
2715
+ * <p>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.</p>
2716
+ */
2717
+ createdTimestamp?: Date;
2718
+ /**
2719
+ * @public
2720
+ * <p>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.</p>
2721
+ */
2722
+ lastModifiedTimestamp?: Date;
2723
+ /**
2724
+ * @public
2725
+ * <p>A unique identifier for the changeset.</p>
2726
+ */
2727
+ lastCompletedChangesetId?: string;
2728
+ /**
2729
+ * @public
2730
+ * <p>The total number of bytes in the database.</p>
2731
+ */
2732
+ numBytes?: number;
2733
+ /**
2734
+ * @public
2735
+ * <p>The total number of changesets in the database.</p>
2736
+ */
2737
+ numChangesets?: number;
2738
+ /**
2739
+ * @public
2740
+ * <p>The total number of files in the database.</p>
2741
+ */
2742
+ numFiles?: number;
2743
+ }
2744
+ /**
2745
+ * @public
2746
+ */
2747
+ export interface GetKxDataviewRequest {
2748
+ /**
2749
+ * @public
2750
+ * <p>A unique identifier for the kdb environment, from where you want to retrieve the dataview details.</p>
2751
+ */
2752
+ environmentId: string | undefined;
2753
+ /**
2754
+ * @public
2755
+ * <p>
2756
+ * The name of the database where you created the dataview.</p>
2757
+ */
2758
+ databaseName: string | undefined;
2759
+ /**
2760
+ * @public
2761
+ * <p>A unique identifier for the dataview.</p>
2762
+ */
2763
+ dataviewName: string | undefined;
2764
+ }
2765
+ /**
2766
+ * @public
2767
+ * <p>
2768
+ * The active version of the dataview that is currently in use by this cluster.
2769
+ *
2770
+ * </p>
2771
+ */
2772
+ export interface KxDataviewActiveVersion {
2773
+ /**
2774
+ * @public
2775
+ * <p>A unique identifier for the changeset.</p>
2776
+ */
2777
+ changesetId?: string;
2778
+ /**
2779
+ * @public
2780
+ * <p>
2781
+ * 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. </p>
2782
+ */
2783
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
2784
+ /**
2785
+ * @public
2786
+ * <p>
2787
+ * The list of clusters that are currently using this dataview.
2788
+ *
2789
+ * </p>
2790
+ */
2791
+ attachedClusters?: string[];
2792
+ /**
2793
+ * @public
2794
+ * <p>
2795
+ * 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.</p>
2796
+ */
2797
+ createdTimestamp?: Date;
2798
+ /**
2799
+ * @public
2800
+ * <p>
2801
+ * A unique identifier of the active version.</p>
2802
+ */
2803
+ versionId?: string;
2804
+ }
2805
+ /**
2806
+ * @public
2807
+ */
2808
+ export interface GetKxDataviewResponse {
2809
+ /**
2810
+ * @public
2811
+ * <p>
2812
+ * The name of the database where you created the dataview.</p>
2813
+ */
2814
+ databaseName?: string;
2815
+ /**
2816
+ * @public
2817
+ * <p>A unique identifier for the dataview.</p>
2818
+ */
2819
+ dataviewName?: string;
2820
+ /**
2821
+ * @public
2822
+ * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
2823
+ * <ul>
2824
+ * <li>
2825
+ * <p>
2826
+ * <code>SINGLE</code> – Assigns one availability zone per cluster.</p>
2827
+ * </li>
2828
+ * <li>
2829
+ * <p>
2830
+ * <code>MULTI</code> – Assigns all the availability zones per cluster.</p>
2831
+ * </li>
2832
+ * </ul>
2833
+ */
2834
+ azMode?: KxAzMode;
2835
+ /**
2836
+ * @public
2837
+ * <p>
2838
+ * The identifier of the availability zones.
2839
+ * </p>
2840
+ */
2841
+ availabilityZoneId?: string;
2842
+ /**
2843
+ * @public
2844
+ * <p>
2845
+ * A unique identifier of the changeset that you want to use to ingest data. </p>
2846
+ */
2847
+ changesetId?: string;
2848
+ /**
2849
+ * @public
2850
+ * <p>
2851
+ * 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. </p>
2852
+ */
2853
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
2854
+ /**
2855
+ * @public
2856
+ * <p>
2857
+ * The current active changeset versions of the database on the given dataview.
2858
+ *
2859
+ * </p>
2860
+ */
2861
+ activeVersions?: KxDataviewActiveVersion[];
2862
+ /**
2863
+ * @public
2864
+ * <p>A description of the dataview.</p>
2865
+ */
2866
+ description?: string;
2867
+ /**
2868
+ * @public
2869
+ * <p>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.</p>
1857
2870
  */
1858
- createdTimestamp?: Date;
2871
+ autoUpdate?: boolean;
1859
2872
  /**
1860
2873
  * @public
1861
- * <p>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.</p>
2874
+ * <p>A unique identifier for the kdb environment, from where you want to retrieve the dataview details.</p>
1862
2875
  */
1863
- lastModifiedTimestamp?: Date;
2876
+ environmentId?: string;
1864
2877
  /**
1865
2878
  * @public
1866
- * <p>A unique identifier for the changeset.</p>
2879
+ * <p>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.</p>
1867
2880
  */
1868
- lastCompletedChangesetId?: string;
2881
+ createdTimestamp?: Date;
1869
2882
  /**
1870
2883
  * @public
1871
- * <p>The total number of bytes in the database.</p>
2884
+ * <p>
2885
+ * 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.
2886
+ * </p>
1872
2887
  */
1873
- numBytes?: number;
2888
+ lastModifiedTimestamp?: Date;
1874
2889
  /**
1875
2890
  * @public
1876
- * <p>The total number of changesets in the database.</p>
2891
+ * <p>
2892
+ * The status of dataview creation.</p>
2893
+ * <ul>
2894
+ * <li>
2895
+ * <p>
2896
+ * <code>CREATING</code> – The dataview creation is in progress.</p>
2897
+ * </li>
2898
+ * <li>
2899
+ * <p>
2900
+ * <code>UPDATING</code> – The dataview is in the process of being updated.</p>
2901
+ * </li>
2902
+ * <li>
2903
+ * <p>
2904
+ * <code>ACTIVE</code> – The dataview is active.</p>
2905
+ * </li>
2906
+ * </ul>
1877
2907
  */
1878
- numChangesets?: number;
2908
+ status?: KxDataviewStatus;
1879
2909
  /**
1880
2910
  * @public
1881
- * <p>The total number of files in the database.</p>
2911
+ * <p>
2912
+ * The error message when a failed state occurs.
2913
+ * </p>
1882
2914
  */
1883
- numFiles?: number;
2915
+ statusReason?: string;
1884
2916
  }
1885
2917
  /**
1886
2918
  * @public
@@ -2096,110 +3128,386 @@ export interface GetKxEnvironmentResponse {
2096
3128
  * @public
2097
3129
  * <p>The status of the network configuration.</p>
2098
3130
  */
2099
- tgwStatus?: TgwStatus;
3131
+ tgwStatus?: TgwStatus;
3132
+ /**
3133
+ * @public
3134
+ * <p>The status of DNS configuration.</p>
3135
+ */
3136
+ dnsStatus?: DnsStatus;
3137
+ /**
3138
+ * @public
3139
+ * <p>Specifies the error message that appears if a flow fails.</p>
3140
+ */
3141
+ errorMessage?: string;
3142
+ /**
3143
+ * @public
3144
+ * <p>A description for the kdb environment.</p>
3145
+ */
3146
+ description?: string;
3147
+ /**
3148
+ * @public
3149
+ * <p>The ARN identifier of the environment.</p>
3150
+ */
3151
+ environmentArn?: string;
3152
+ /**
3153
+ * @public
3154
+ * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
3155
+ */
3156
+ kmsKeyId?: string;
3157
+ /**
3158
+ * @public
3159
+ * <p>A unique identifier for the AWS environment infrastructure account.</p>
3160
+ */
3161
+ dedicatedServiceAccountId?: string;
3162
+ /**
3163
+ * @public
3164
+ * <p>The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.</p>
3165
+ */
3166
+ transitGatewayConfiguration?: TransitGatewayConfiguration;
3167
+ /**
3168
+ * @public
3169
+ * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
3170
+ */
3171
+ customDNSConfiguration?: CustomDNSServer[];
3172
+ /**
3173
+ * @public
3174
+ * <p>The timestamp at which the kdb environment was created in FinSpace. </p>
3175
+ */
3176
+ creationTimestamp?: Date;
3177
+ /**
3178
+ * @public
3179
+ * <p>The timestamp at which the kdb environment was updated. </p>
3180
+ */
3181
+ updateTimestamp?: Date;
3182
+ /**
3183
+ * @public
3184
+ * <p>The identifier of the availability zones where subnets for the environment are created.</p>
3185
+ */
3186
+ availabilityZoneIds?: string[];
3187
+ /**
3188
+ * @public
3189
+ * <p>The Amazon Resource Name (ARN) of the certificate authority of the
3190
+ * kdb environment.</p>
3191
+ */
3192
+ certificateAuthorityArn?: string;
3193
+ }
3194
+ /**
3195
+ * @public
3196
+ */
3197
+ export interface GetKxScalingGroupRequest {
3198
+ /**
3199
+ * @public
3200
+ * <p>A unique identifier for the kdb environment. </p>
3201
+ */
3202
+ environmentId: string | undefined;
3203
+ /**
3204
+ * @public
3205
+ * <p>A unique identifier for the kdb scaling group. </p>
3206
+ */
3207
+ scalingGroupName: string | undefined;
3208
+ }
3209
+ /**
3210
+ * @public
3211
+ */
3212
+ export interface GetKxScalingGroupResponse {
3213
+ /**
3214
+ * @public
3215
+ * <p>A unique identifier for the kdb scaling group. </p>
3216
+ */
3217
+ scalingGroupName?: string;
3218
+ /**
3219
+ * @public
3220
+ * <p>
3221
+ * The ARN identifier for the scaling group.
3222
+ * </p>
3223
+ */
3224
+ scalingGroupArn?: string;
3225
+ /**
3226
+ * @public
3227
+ * <p>
3228
+ * The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
3229
+ *
3230
+ * </p>
3231
+ */
3232
+ hostType?: string;
3233
+ /**
3234
+ * @public
3235
+ * <p>
3236
+ * The list of Managed kdb clusters that are currently active in the given scaling group.
3237
+ *
3238
+ * </p>
3239
+ */
3240
+ clusters?: string[];
3241
+ /**
3242
+ * @public
3243
+ * <p>The identifier of the availability zones.</p>
3244
+ */
3245
+ availabilityZoneId?: string;
3246
+ /**
3247
+ * @public
3248
+ * <p>The status of scaling group.</p>
3249
+ * <ul>
3250
+ * <li>
3251
+ * <p>CREATING – The scaling group creation is in progress.</p>
3252
+ * </li>
3253
+ * <li>
3254
+ * <p>CREATE_FAILED – The scaling group creation has failed.</p>
3255
+ * </li>
3256
+ * <li>
3257
+ * <p>ACTIVE – The scaling group is active.</p>
3258
+ * </li>
3259
+ * <li>
3260
+ * <p>UPDATING – The scaling group is in the process of being updated.</p>
3261
+ * </li>
3262
+ * <li>
3263
+ * <p>UPDATE_FAILED – The update action failed.</p>
3264
+ * </li>
3265
+ * <li>
3266
+ * <p>DELETING – The scaling group is in the process of being deleted.</p>
3267
+ * </li>
3268
+ * <li>
3269
+ * <p>DELETE_FAILED – The system failed to delete the scaling group.</p>
3270
+ * </li>
3271
+ * <li>
3272
+ * <p>DELETED – The scaling group is successfully deleted.</p>
3273
+ * </li>
3274
+ * </ul>
3275
+ */
3276
+ status?: KxScalingGroupStatus;
3277
+ /**
3278
+ * @public
3279
+ * <p>
3280
+ * The error message when a failed state occurs.
3281
+ * </p>
3282
+ */
3283
+ statusReason?: string;
3284
+ /**
3285
+ * @public
3286
+ * <p>
3287
+ * 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.
3288
+ * </p>
3289
+ */
3290
+ lastModifiedTimestamp?: Date;
3291
+ /**
3292
+ * @public
3293
+ * <p>
3294
+ * 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.</p>
3295
+ */
3296
+ createdTimestamp?: Date;
3297
+ }
3298
+ /**
3299
+ * @public
3300
+ */
3301
+ export interface GetKxUserRequest {
3302
+ /**
3303
+ * @public
3304
+ * <p>A unique identifier for the user.</p>
3305
+ */
3306
+ userName: string | undefined;
3307
+ /**
3308
+ * @public
3309
+ * <p>A unique identifier for the kdb environment.</p>
3310
+ */
3311
+ environmentId: string | undefined;
3312
+ }
3313
+ /**
3314
+ * @public
3315
+ */
3316
+ export interface GetKxUserResponse {
3317
+ /**
3318
+ * @public
3319
+ * <p>A unique identifier for the user.</p>
3320
+ */
3321
+ userName?: string;
3322
+ /**
3323
+ * @public
3324
+ * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
3325
+ * how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
3326
+ * <i>IAM User Guide</i>. </p>
3327
+ */
3328
+ userArn?: string;
3329
+ /**
3330
+ * @public
3331
+ * <p>A unique identifier for the kdb environment.</p>
3332
+ */
3333
+ environmentId?: string;
3334
+ /**
3335
+ * @public
3336
+ * <p>The IAM role ARN that is associated with the user.</p>
3337
+ */
3338
+ iamRole?: string;
3339
+ }
3340
+ /**
3341
+ * @public
3342
+ */
3343
+ export interface GetKxVolumeRequest {
3344
+ /**
3345
+ * @public
3346
+ * <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
3347
+ */
3348
+ environmentId: string | undefined;
3349
+ /**
3350
+ * @public
3351
+ * <p>A unique identifier for the volume.</p>
3352
+ */
3353
+ volumeName: string | undefined;
3354
+ }
3355
+ /**
3356
+ * @public
3357
+ * <p>The structure containing the metadata of the attached clusters.</p>
3358
+ */
3359
+ export interface KxAttachedCluster {
3360
+ /**
3361
+ * @public
3362
+ * <p>A unique name for the attached cluster.</p>
3363
+ */
3364
+ clusterName?: string;
3365
+ /**
3366
+ * @public
3367
+ * <p>Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.</p>
3368
+ */
3369
+ clusterType?: KxClusterType;
3370
+ /**
3371
+ * @public
3372
+ * <p>The status of the attached cluster.</p>
3373
+ * <ul>
3374
+ * <li>
3375
+ * <p>PENDING – The cluster is pending creation.</p>
3376
+ * </li>
3377
+ * <li>
3378
+ * <p>CREATING – The cluster creation process is in progress.</p>
3379
+ * </li>
3380
+ * <li>
3381
+ * <p>CREATE_FAILED – The cluster creation process has failed.</p>
3382
+ * </li>
3383
+ * <li>
3384
+ * <p>RUNNING – The cluster creation process is running.</p>
3385
+ * </li>
3386
+ * <li>
3387
+ * <p>UPDATING – The cluster is in the process of being updated.</p>
3388
+ * </li>
3389
+ * <li>
3390
+ * <p>DELETING – The cluster is in the process of being deleted.</p>
3391
+ * </li>
3392
+ * <li>
3393
+ * <p>DELETED – The cluster has been deleted.</p>
3394
+ * </li>
3395
+ * <li>
3396
+ * <p>DELETE_FAILED – The cluster failed to delete.</p>
3397
+ * </li>
3398
+ * </ul>
3399
+ */
3400
+ clusterStatus?: KxClusterStatus;
3401
+ }
3402
+ /**
3403
+ * @public
3404
+ */
3405
+ export interface GetKxVolumeResponse {
2100
3406
  /**
2101
3407
  * @public
2102
- * <p>The status of DNS configuration.</p>
3408
+ * <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
2103
3409
  */
2104
- dnsStatus?: DnsStatus;
3410
+ environmentId?: string;
2105
3411
  /**
2106
3412
  * @public
2107
- * <p>Specifies the error message that appears if a flow fails.</p>
3413
+ * <p>
3414
+ * A unique identifier for the volume.</p>
2108
3415
  */
2109
- errorMessage?: string;
3416
+ volumeName?: string;
2110
3417
  /**
2111
3418
  * @public
2112
- * <p>A description for the kdb environment.</p>
3419
+ * <p>
3420
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.
3421
+ * </p>
2113
3422
  */
2114
- description?: string;
3423
+ volumeType?: KxVolumeType;
2115
3424
  /**
2116
3425
  * @public
2117
- * <p>The ARN identifier of the environment.</p>
3426
+ * <p>
3427
+ * The ARN identifier of the volume.
3428
+ * </p>
2118
3429
  */
2119
- environmentArn?: string;
3430
+ volumeArn?: string;
2120
3431
  /**
2121
3432
  * @public
2122
- * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
3433
+ * <p> Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>
2123
3434
  */
2124
- kmsKeyId?: string;
3435
+ nas1Configuration?: KxNAS1Configuration;
2125
3436
  /**
2126
3437
  * @public
2127
- * <p>A unique identifier for the AWS environment infrastructure account.</p>
3438
+ * <p>The status of volume creation.</p>
3439
+ * <ul>
3440
+ * <li>
3441
+ * <p>CREATING – The volume creation is in progress.</p>
3442
+ * </li>
3443
+ * <li>
3444
+ * <p>CREATE_FAILED – The volume creation has failed.</p>
3445
+ * </li>
3446
+ * <li>
3447
+ * <p>ACTIVE – The volume is active.</p>
3448
+ * </li>
3449
+ * <li>
3450
+ * <p>UPDATING – The volume is in the process of being updated.</p>
3451
+ * </li>
3452
+ * <li>
3453
+ * <p>UPDATE_FAILED – The update action failed.</p>
3454
+ * </li>
3455
+ * <li>
3456
+ * <p>UPDATED – The volume is successfully updated.</p>
3457
+ * </li>
3458
+ * <li>
3459
+ * <p>DELETING – The volume is in the process of being deleted.</p>
3460
+ * </li>
3461
+ * <li>
3462
+ * <p>DELETE_FAILED – The system failed to delete the volume.</p>
3463
+ * </li>
3464
+ * <li>
3465
+ * <p>DELETED – The volume is successfully deleted.</p>
3466
+ * </li>
3467
+ * </ul>
2128
3468
  */
2129
- dedicatedServiceAccountId?: string;
3469
+ status?: KxVolumeStatus;
2130
3470
  /**
2131
3471
  * @public
2132
- * <p>The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.</p>
3472
+ * <p>The error message when a failed state occurs. </p>
2133
3473
  */
2134
- transitGatewayConfiguration?: TransitGatewayConfiguration;
3474
+ statusReason?: string;
2135
3475
  /**
2136
3476
  * @public
2137
- * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
3477
+ * <p>
3478
+ * 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.
3479
+ * </p>
2138
3480
  */
2139
- customDNSConfiguration?: CustomDNSServer[];
3481
+ createdTimestamp?: Date;
2140
3482
  /**
2141
3483
  * @public
2142
- * <p>The timestamp at which the kdb environment was created in FinSpace. </p>
3484
+ * <p>
3485
+ * A description of the volume.
3486
+ * </p>
2143
3487
  */
2144
- creationTimestamp?: Date;
3488
+ description?: string;
2145
3489
  /**
2146
3490
  * @public
2147
- * <p>The timestamp at which the kdb environment was updated. </p>
3491
+ * <p>The number of availability zones you want to assign per cluster. Currently, FinSpace only support <code>SINGLE</code> for volumes.</p>
2148
3492
  */
2149
- updateTimestamp?: Date;
3493
+ azMode?: KxAzMode;
2150
3494
  /**
2151
3495
  * @public
2152
- * <p>The identifier of the availability zones where subnets for the environment are created.</p>
3496
+ * <p>The identifier of the availability zones.</p>
2153
3497
  */
2154
3498
  availabilityZoneIds?: string[];
2155
3499
  /**
2156
3500
  * @public
2157
- * <p>The Amazon Resource Name (ARN) of the certificate authority of the
2158
- * kdb environment.</p>
2159
- */
2160
- certificateAuthorityArn?: string;
2161
- }
2162
- /**
2163
- * @public
2164
- */
2165
- export interface GetKxUserRequest {
2166
- /**
2167
- * @public
2168
- * <p>A unique identifier for the user.</p>
2169
- */
2170
- userName: string | undefined;
2171
- /**
2172
- * @public
2173
- * <p>A unique identifier for the kdb environment.</p>
2174
- */
2175
- environmentId: string | undefined;
2176
- }
2177
- /**
2178
- * @public
2179
- */
2180
- export interface GetKxUserResponse {
2181
- /**
2182
- * @public
2183
- * <p>A unique identifier for the user.</p>
2184
- */
2185
- userName?: string;
2186
- /**
2187
- * @public
2188
- * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
2189
- * how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
2190
- * <i>IAM User Guide</i>. </p>
2191
- */
2192
- userArn?: string;
2193
- /**
2194
- * @public
2195
- * <p>A unique identifier for the kdb environment.</p>
3501
+ * <p>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.</p>
2196
3502
  */
2197
- environmentId?: string;
3503
+ lastModifiedTimestamp?: Date;
2198
3504
  /**
2199
3505
  * @public
2200
- * <p>The IAM role ARN that is associated with the user.</p>
3506
+ * <p>
3507
+ * A list of cluster identifiers that a volume is attached to.
3508
+ * </p>
2201
3509
  */
2202
- iamRole?: string;
3510
+ attachedClusters?: KxAttachedCluster[];
2203
3511
  }
2204
3512
  /**
2205
3513
  * @public
@@ -2408,6 +3716,9 @@ export interface ListKxClustersRequest {
2408
3716
  * <li>
2409
3717
  * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
2410
3718
  * </li>
3719
+ * <li>
3720
+ * <p>Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.</p>
3721
+ * </li>
2411
3722
  * </ul>
2412
3723
  */
2413
3724
  clusterType?: KxClusterType;
@@ -2484,6 +3795,9 @@ export interface KxCluster {
2484
3795
  * <li>
2485
3796
  * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
2486
3797
  * </li>
3798
+ * <li>
3799
+ * <p>Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.</p>
3800
+ * </li>
2487
3801
  * </ul>
2488
3802
  */
2489
3803
  clusterType?: KxClusterType;
@@ -2497,6 +3811,13 @@ export interface KxCluster {
2497
3811
  * <p>A version of the FinSpace managed kdb to run.</p>
2498
3812
  */
2499
3813
  releaseLabel?: string;
3814
+ /**
3815
+ * @public
3816
+ * <p>
3817
+ * A list of volumes attached to the cluster.
3818
+ * </p>
3819
+ */
3820
+ volumes?: Volume[];
2500
3821
  /**
2501
3822
  * @public
2502
3823
  * <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within
@@ -2504,17 +3825,174 @@ export interface KxCluster {
2504
3825
  * the cluster. It must include the file name itself. For example,
2505
3826
  * <code>somedir/init.q</code>.</p>
2506
3827
  */
2507
- initializationScript?: string;
3828
+ initializationScript?: string;
3829
+ /**
3830
+ * @public
3831
+ * <p>
3832
+ * 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.
3833
+ * </p>
3834
+ */
3835
+ executionRole?: string;
3836
+ /**
3837
+ * @public
3838
+ * <p>The number of availability zones assigned per cluster. This can be one of the following:</p>
3839
+ * <ul>
3840
+ * <li>
3841
+ * <p>
3842
+ * <code>SINGLE</code> – Assigns one availability zone per cluster.</p>
3843
+ * </li>
3844
+ * <li>
3845
+ * <p>
3846
+ * <code>MULTI</code> – Assigns all the availability zones per cluster.</p>
3847
+ * </li>
3848
+ * </ul>
3849
+ */
3850
+ azMode?: KxAzMode;
3851
+ /**
3852
+ * @public
3853
+ * <p>
3854
+ * The availability zone identifiers for the requested regions.
3855
+ * </p>
3856
+ */
3857
+ availabilityZoneId?: string;
3858
+ /**
3859
+ * @public
3860
+ * <p>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.</p>
3861
+ */
3862
+ lastModifiedTimestamp?: Date;
3863
+ /**
3864
+ * @public
3865
+ * <p>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.</p>
3866
+ */
3867
+ createdTimestamp?: Date;
3868
+ }
3869
+ /**
3870
+ * @public
3871
+ */
3872
+ export interface ListKxClustersResponse {
3873
+ /**
3874
+ * @public
3875
+ * <p>Lists the cluster details.</p>
3876
+ */
3877
+ kxClusterSummaries?: KxCluster[];
3878
+ /**
3879
+ * @public
3880
+ * <p>A token that indicates where a results page should begin.</p>
3881
+ */
3882
+ nextToken?: string;
3883
+ }
3884
+ /**
3885
+ * @public
3886
+ */
3887
+ export interface ListKxDatabasesRequest {
3888
+ /**
3889
+ * @public
3890
+ * <p>A unique identifier for the kdb environment.</p>
3891
+ */
3892
+ environmentId: string | undefined;
3893
+ /**
3894
+ * @public
3895
+ * <p>A token that indicates where a results page should begin.</p>
3896
+ */
3897
+ nextToken?: string;
3898
+ /**
3899
+ * @public
3900
+ * <p>The maximum number of results to return in this request.</p>
3901
+ */
3902
+ maxResults?: number;
3903
+ }
3904
+ /**
3905
+ * @public
3906
+ * <p>Details about a FinSpace managed kdb database</p>
3907
+ */
3908
+ export interface KxDatabaseListEntry {
3909
+ /**
3910
+ * @public
3911
+ * <p>The name of the kdb database.</p>
3912
+ */
3913
+ databaseName?: string;
3914
+ /**
3915
+ * @public
3916
+ * <p>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.</p>
3917
+ */
3918
+ createdTimestamp?: Date;
3919
+ /**
3920
+ * @public
3921
+ * <p>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.</p>
3922
+ */
3923
+ lastModifiedTimestamp?: Date;
3924
+ }
3925
+ /**
3926
+ * @public
3927
+ */
3928
+ export interface ListKxDatabasesResponse {
3929
+ /**
3930
+ * @public
3931
+ * <p>A list of databases in the kdb environment.</p>
3932
+ */
3933
+ kxDatabases?: KxDatabaseListEntry[];
3934
+ /**
3935
+ * @public
3936
+ * <p>A token that indicates where a results page should begin.</p>
3937
+ */
3938
+ nextToken?: string;
3939
+ }
3940
+ /**
3941
+ * @public
3942
+ */
3943
+ export interface ListKxDataviewsRequest {
3944
+ /**
3945
+ * @public
3946
+ * <p>A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.</p>
3947
+ */
3948
+ environmentId: string | undefined;
3949
+ /**
3950
+ * @public
3951
+ * <p>
3952
+ * The name of the database where the dataviews were created.</p>
3953
+ */
3954
+ databaseName: string | undefined;
3955
+ /**
3956
+ * @public
3957
+ * <p>
3958
+ * A token that indicates where a results page should begin.
3959
+ * </p>
3960
+ */
3961
+ nextToken?: string;
3962
+ /**
3963
+ * @public
3964
+ * <p>The maximum number of results to return in this request.</p>
3965
+ */
3966
+ maxResults?: number;
3967
+ }
3968
+ /**
3969
+ * @public
3970
+ * <p>
3971
+ * A collection of kdb dataview entries.
3972
+ *
3973
+ * </p>
3974
+ */
3975
+ export interface KxDataviewListEntry {
3976
+ /**
3977
+ * @public
3978
+ * <p>A unique identifier for the kdb environment.</p>
3979
+ */
3980
+ environmentId?: string;
3981
+ /**
3982
+ * @public
3983
+ * <p>
3984
+ * A unique identifier of the database.</p>
3985
+ */
3986
+ databaseName?: string;
2508
3987
  /**
2509
3988
  * @public
2510
3989
  * <p>
2511
- * 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.
2512
- * </p>
3990
+ * A unique identifier of the dataview.</p>
2513
3991
  */
2514
- executionRole?: string;
3992
+ dataviewName?: string;
2515
3993
  /**
2516
3994
  * @public
2517
- * <p>The number of availability zones assigned per cluster. This can be one of the following:</p>
3995
+ * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
2518
3996
  * <ul>
2519
3997
  * <li>
2520
3998
  * <p>
@@ -2530,89 +4008,84 @@ export interface KxCluster {
2530
4008
  /**
2531
4009
  * @public
2532
4010
  * <p>
2533
- * The availability zone identifiers for the requested regions.
2534
- * </p>
4011
+ * The identifier of the availability zones.
4012
+ * </p>
2535
4013
  */
2536
4014
  availabilityZoneId?: string;
2537
4015
  /**
2538
4016
  * @public
2539
- * <p>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.</p>
2540
- */
2541
- lastModifiedTimestamp?: Date;
2542
- /**
2543
- * @public
2544
- * <p>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.</p>
4017
+ * <p>A unique identifier for the changeset.</p>
2545
4018
  */
2546
- createdTimestamp?: Date;
2547
- }
2548
- /**
2549
- * @public
2550
- */
2551
- export interface ListKxClustersResponse {
4019
+ changesetId?: string;
2552
4020
  /**
2553
4021
  * @public
2554
- * <p>Lists the cluster details.</p>
4022
+ * <p>
4023
+ * 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. </p>
2555
4024
  */
2556
- kxClusterSummaries?: KxCluster[];
4025
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
2557
4026
  /**
2558
4027
  * @public
2559
- * <p>A token that indicates where a results page should begin.</p>
4028
+ * <p>
4029
+ * The active changeset versions for the given dataview entry.
4030
+ *
4031
+ * </p>
2560
4032
  */
2561
- nextToken?: string;
2562
- }
2563
- /**
2564
- * @public
2565
- */
2566
- export interface ListKxDatabasesRequest {
4033
+ activeVersions?: KxDataviewActiveVersion[];
2567
4034
  /**
2568
4035
  * @public
2569
- * <p>A unique identifier for the kdb environment.</p>
4036
+ * <p>
4037
+ * The status of a given dataview entry.
4038
+ *
4039
+ * </p>
2570
4040
  */
2571
- environmentId: string | undefined;
4041
+ status?: KxDataviewStatus;
2572
4042
  /**
2573
4043
  * @public
2574
- * <p>A token that indicates where a results page should begin.</p>
4044
+ * <p>
4045
+ * A description for the dataview list entry.</p>
2575
4046
  */
2576
- nextToken?: string;
4047
+ description?: string;
2577
4048
  /**
2578
4049
  * @public
2579
- * <p>The maximum number of results to return in this request.</p>
4050
+ * <p>
4051
+ * 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.
4052
+ * </p>
2580
4053
  */
2581
- maxResults?: number;
2582
- }
2583
- /**
2584
- * @public
2585
- * <p>Details about a FinSpace managed kdb database</p>
2586
- */
2587
- export interface KxDatabaseListEntry {
4054
+ autoUpdate?: boolean;
2588
4055
  /**
2589
4056
  * @public
2590
- * <p>The name of the kdb database.</p>
4057
+ * <p>
4058
+ * The timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
2591
4059
  */
2592
- databaseName?: string;
4060
+ createdTimestamp?: Date;
2593
4061
  /**
2594
4062
  * @public
2595
- * <p>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.</p>
4063
+ * <p>The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
2596
4064
  */
2597
- createdTimestamp?: Date;
4065
+ lastModifiedTimestamp?: Date;
2598
4066
  /**
2599
4067
  * @public
2600
- * <p>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.</p>
4068
+ * <p>
4069
+ * The error message when a failed state occurs.
4070
+ * </p>
2601
4071
  */
2602
- lastModifiedTimestamp?: Date;
4072
+ statusReason?: string;
2603
4073
  }
2604
4074
  /**
2605
4075
  * @public
2606
4076
  */
2607
- export interface ListKxDatabasesResponse {
4077
+ export interface ListKxDataviewsResponse {
2608
4078
  /**
2609
4079
  * @public
2610
- * <p>A list of databases in the kdb environment.</p>
4080
+ * <p>
4081
+ * The list of kdb dataviews that are currently active for the given database.
4082
+ * </p>
2611
4083
  */
2612
- kxDatabases?: KxDatabaseListEntry[];
4084
+ kxDataviews?: KxDataviewListEntry[];
2613
4085
  /**
2614
4086
  * @public
2615
- * <p>A token that indicates where a results page should begin.</p>
4087
+ * <p>
4088
+ * A token that indicates where a results page should begin. </p>
2616
4089
  */
2617
4090
  nextToken?: string;
2618
4091
  }
@@ -2766,6 +4239,105 @@ export interface ListKxEnvironmentsResponse {
2766
4239
  */
2767
4240
  nextToken?: string;
2768
4241
  }
4242
+ /**
4243
+ * @public
4244
+ */
4245
+ export interface ListKxScalingGroupsRequest {
4246
+ /**
4247
+ * @public
4248
+ * <p>A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.</p>
4249
+ */
4250
+ environmentId: string | undefined;
4251
+ /**
4252
+ * @public
4253
+ * <p>The maximum number of results to return in this request.</p>
4254
+ */
4255
+ maxResults?: number;
4256
+ /**
4257
+ * @public
4258
+ * <p>
4259
+ * A token that indicates where a results page should begin. </p>
4260
+ */
4261
+ nextToken?: string;
4262
+ }
4263
+ /**
4264
+ * @public
4265
+ * <p>
4266
+ * A structure for storing metadata of scaling group.</p>
4267
+ */
4268
+ export interface KxScalingGroup {
4269
+ /**
4270
+ * @public
4271
+ * <p>A unique identifier for the kdb scaling group. </p>
4272
+ */
4273
+ scalingGroupName?: string;
4274
+ /**
4275
+ * @public
4276
+ * <p>
4277
+ * The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
4278
+ *
4279
+ * </p>
4280
+ */
4281
+ hostType?: string;
4282
+ /**
4283
+ * @public
4284
+ * <p>
4285
+ * The list of clusters currently active in a given scaling group.
4286
+ *
4287
+ * </p>
4288
+ */
4289
+ clusters?: string[];
4290
+ /**
4291
+ * @public
4292
+ * <p>The identifier of the availability zones.</p>
4293
+ */
4294
+ availabilityZoneId?: string;
4295
+ /**
4296
+ * @public
4297
+ * <p>
4298
+ * The status of scaling groups.
4299
+ * </p>
4300
+ */
4301
+ status?: KxScalingGroupStatus;
4302
+ /**
4303
+ * @public
4304
+ * <p>
4305
+ * The error message when a failed state occurs.
4306
+ * </p>
4307
+ */
4308
+ statusReason?: string;
4309
+ /**
4310
+ * @public
4311
+ * <p>
4312
+ * 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.
4313
+ * </p>
4314
+ */
4315
+ lastModifiedTimestamp?: Date;
4316
+ /**
4317
+ * @public
4318
+ * <p>
4319
+ * 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.
4320
+ * </p>
4321
+ */
4322
+ createdTimestamp?: Date;
4323
+ }
4324
+ /**
4325
+ * @public
4326
+ */
4327
+ export interface ListKxScalingGroupsResponse {
4328
+ /**
4329
+ * @public
4330
+ * <p>
4331
+ * A list of scaling groups available in a kdb environment.</p>
4332
+ */
4333
+ scalingGroups?: KxScalingGroup[];
4334
+ /**
4335
+ * @public
4336
+ * <p>
4337
+ * A token that indicates where a results page should begin. </p>
4338
+ */
4339
+ nextToken?: string;
4340
+ }
2769
4341
  /**
2770
4342
  * @public
2771
4343
  */
@@ -2782,52 +4354,185 @@ export interface ListKxUsersRequest {
2782
4354
  nextToken?: string;
2783
4355
  /**
2784
4356
  * @public
2785
- * <p>The maximum number of results to return in this request.</p>
4357
+ * <p>The maximum number of results to return in this request.</p>
4358
+ */
4359
+ maxResults?: number;
4360
+ }
4361
+ /**
4362
+ * @public
4363
+ * <p>A structure that stores metadata for a kdb user.</p>
4364
+ */
4365
+ export interface KxUser {
4366
+ /**
4367
+ * @public
4368
+ * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
4369
+ * how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
4370
+ * <i>IAM User Guide</i>. </p>
4371
+ */
4372
+ userArn?: string;
4373
+ /**
4374
+ * @public
4375
+ * <p>A unique identifier for the user.</p>
4376
+ */
4377
+ userName?: string;
4378
+ /**
4379
+ * @public
4380
+ * <p>The IAM role ARN that is associated with the user.</p>
4381
+ */
4382
+ iamRole?: string;
4383
+ /**
4384
+ * @public
4385
+ * <p>The timestamp at which the kdb user was created. </p>
4386
+ */
4387
+ createTimestamp?: Date;
4388
+ /**
4389
+ * @public
4390
+ * <p>The timestamp at which the kdb user was updated. </p>
4391
+ */
4392
+ updateTimestamp?: Date;
4393
+ }
4394
+ /**
4395
+ * @public
4396
+ */
4397
+ export interface ListKxUsersResponse {
4398
+ /**
4399
+ * @public
4400
+ * <p>A list of users in a kdb environment.</p>
4401
+ */
4402
+ users?: KxUser[];
4403
+ /**
4404
+ * @public
4405
+ * <p>A token that indicates where a results page should begin.</p>
4406
+ */
4407
+ nextToken?: string;
4408
+ }
4409
+ /**
4410
+ * @public
4411
+ */
4412
+ export interface ListKxVolumesRequest {
4413
+ /**
4414
+ * @public
4415
+ * <p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>
4416
+ */
4417
+ environmentId: string | undefined;
4418
+ /**
4419
+ * @public
4420
+ * <p>The maximum number of results to return in this request.</p>
4421
+ */
4422
+ maxResults?: number;
4423
+ /**
4424
+ * @public
4425
+ * <p>A token that indicates where a results page should begin.</p>
4426
+ */
4427
+ nextToken?: string;
4428
+ /**
4429
+ * @public
4430
+ * <p>
4431
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.
4432
+ * </p>
4433
+ */
4434
+ volumeType?: KxVolumeType;
4435
+ }
4436
+ /**
4437
+ * @public
4438
+ * <p>
4439
+ * The structure that contains the metadata of the volume.
4440
+ * </p>
4441
+ */
4442
+ export interface KxVolume {
4443
+ /**
4444
+ * @public
4445
+ * <p>A unique identifier for the volume.</p>
4446
+ */
4447
+ volumeName?: string;
4448
+ /**
4449
+ * @public
4450
+ * <p>
4451
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.
4452
+ * </p>
4453
+ */
4454
+ volumeType?: KxVolumeType;
4455
+ /**
4456
+ * @public
4457
+ * <p>The status of volume.</p>
4458
+ * <ul>
4459
+ * <li>
4460
+ * <p>CREATING – The volume creation is in progress.</p>
4461
+ * </li>
4462
+ * <li>
4463
+ * <p>CREATE_FAILED – The volume creation has failed.</p>
4464
+ * </li>
4465
+ * <li>
4466
+ * <p>ACTIVE – The volume is active.</p>
4467
+ * </li>
4468
+ * <li>
4469
+ * <p>UPDATING – The volume is in the process of being updated.</p>
4470
+ * </li>
4471
+ * <li>
4472
+ * <p>UPDATE_FAILED – The update action failed.</p>
4473
+ * </li>
4474
+ * <li>
4475
+ * <p>UPDATED – The volume is successfully updated.</p>
4476
+ * </li>
4477
+ * <li>
4478
+ * <p>DELETING – The volume is in the process of being deleted.</p>
4479
+ * </li>
4480
+ * <li>
4481
+ * <p>DELETE_FAILED – The system failed to delete the volume.</p>
4482
+ * </li>
4483
+ * <li>
4484
+ * <p>DELETED – The volume is successfully deleted.</p>
4485
+ * </li>
4486
+ * </ul>
4487
+ */
4488
+ status?: KxVolumeStatus;
4489
+ /**
4490
+ * @public
4491
+ * <p>
4492
+ * A description of the volume.
4493
+ * </p>
2786
4494
  */
2787
- maxResults?: number;
2788
- }
2789
- /**
2790
- * @public
2791
- * <p>A structure that stores metadata for a kdb user.</p>
2792
- */
2793
- export interface KxUser {
4495
+ description?: string;
2794
4496
  /**
2795
4497
  * @public
2796
- * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
2797
- * how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
2798
- * <i>IAM User Guide</i>. </p>
4498
+ * <p>The error message when a failed state occurs. </p>
2799
4499
  */
2800
- userArn?: string;
4500
+ statusReason?: string;
2801
4501
  /**
2802
4502
  * @public
2803
- * <p>A unique identifier for the user.</p>
4503
+ * <p>
4504
+ * The number of availability zones assigned to the volume. Currently, only <code>SINGLE</code> is supported.
4505
+ * </p>
2804
4506
  */
2805
- userName?: string;
4507
+ azMode?: KxAzMode;
2806
4508
  /**
2807
4509
  * @public
2808
- * <p>The IAM role ARN that is associated with the user.</p>
4510
+ * <p>The identifier of the availability zones.</p>
2809
4511
  */
2810
- iamRole?: string;
4512
+ availabilityZoneIds?: string[];
2811
4513
  /**
2812
4514
  * @public
2813
- * <p>The timestamp at which the kdb user was created. </p>
4515
+ * <p>
4516
+ * 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.</p>
2814
4517
  */
2815
- createTimestamp?: Date;
4518
+ createdTimestamp?: Date;
2816
4519
  /**
2817
4520
  * @public
2818
- * <p>The timestamp at which the kdb user was updated. </p>
4521
+ * <p>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.</p>
2819
4522
  */
2820
- updateTimestamp?: Date;
4523
+ lastModifiedTimestamp?: Date;
2821
4524
  }
2822
4525
  /**
2823
4526
  * @public
2824
4527
  */
2825
- export interface ListKxUsersResponse {
4528
+ export interface ListKxVolumesResponse {
2826
4529
  /**
2827
4530
  * @public
2828
- * <p>A list of users in a kdb environment.</p>
4531
+ * <p>
4532
+ * A summary of volumes.
4533
+ * </p>
2829
4534
  */
2830
- users?: KxUser[];
4535
+ kxVolumeSummaries?: KxVolume[];
2831
4536
  /**
2832
4537
  * @public
2833
4538
  * <p>A token that indicates where a results page should begin.</p>
@@ -3176,6 +4881,160 @@ export interface UpdateKxDatabaseResponse {
3176
4881
  */
3177
4882
  lastModifiedTimestamp?: Date;
3178
4883
  }
4884
+ /**
4885
+ * @public
4886
+ */
4887
+ export interface UpdateKxDataviewRequest {
4888
+ /**
4889
+ * @public
4890
+ * <p>A unique identifier for the kdb environment, where you want to update the dataview.</p>
4891
+ */
4892
+ environmentId: string | undefined;
4893
+ /**
4894
+ * @public
4895
+ * <p>
4896
+ * The name of the database.</p>
4897
+ */
4898
+ databaseName: string | undefined;
4899
+ /**
4900
+ * @public
4901
+ * <p>The name of the dataview that you want to update.</p>
4902
+ */
4903
+ dataviewName: string | undefined;
4904
+ /**
4905
+ * @public
4906
+ * <p>
4907
+ * The description for a dataview.
4908
+ * </p>
4909
+ */
4910
+ description?: string;
4911
+ /**
4912
+ * @public
4913
+ * <p>A unique identifier for the changeset.</p>
4914
+ */
4915
+ changesetId?: string;
4916
+ /**
4917
+ * @public
4918
+ * <p>
4919
+ * 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. </p>
4920
+ */
4921
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
4922
+ /**
4923
+ * @public
4924
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
4925
+ */
4926
+ clientToken?: string;
4927
+ }
4928
+ /**
4929
+ * @public
4930
+ */
4931
+ export interface UpdateKxDataviewResponse {
4932
+ /**
4933
+ * @public
4934
+ * <p>A unique identifier for the kdb environment, where you want to update the dataview.</p>
4935
+ */
4936
+ environmentId?: string;
4937
+ /**
4938
+ * @public
4939
+ * <p>
4940
+ * The name of the database.
4941
+ * </p>
4942
+ */
4943
+ databaseName?: string;
4944
+ /**
4945
+ * @public
4946
+ * <p>
4947
+ * The name of the database under which the dataview was created.
4948
+ *
4949
+ * </p>
4950
+ */
4951
+ dataviewName?: string;
4952
+ /**
4953
+ * @public
4954
+ * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
4955
+ * <ul>
4956
+ * <li>
4957
+ * <p>
4958
+ * <code>SINGLE</code> – Assigns one availability zone per cluster.</p>
4959
+ * </li>
4960
+ * <li>
4961
+ * <p>
4962
+ * <code>MULTI</code> – Assigns all the availability zones per cluster.</p>
4963
+ * </li>
4964
+ * </ul>
4965
+ */
4966
+ azMode?: KxAzMode;
4967
+ /**
4968
+ * @public
4969
+ * <p>
4970
+ * The identifier of the availability zones.
4971
+ * </p>
4972
+ */
4973
+ availabilityZoneId?: string;
4974
+ /**
4975
+ * @public
4976
+ * <p>A unique identifier for the changeset.</p>
4977
+ */
4978
+ changesetId?: string;
4979
+ /**
4980
+ * @public
4981
+ * <p>
4982
+ * 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. </p>
4983
+ */
4984
+ segmentConfigurations?: KxDataviewSegmentConfiguration[];
4985
+ /**
4986
+ * @public
4987
+ * <p>
4988
+ * The current active changeset versions of the database on the given dataview.
4989
+ *
4990
+ * </p>
4991
+ */
4992
+ activeVersions?: KxDataviewActiveVersion[];
4993
+ /**
4994
+ * @public
4995
+ * <p>
4996
+ * The status of dataview creation.</p>
4997
+ * <ul>
4998
+ * <li>
4999
+ * <p>
5000
+ * <code>CREATING</code> – The dataview creation is in progress.</p>
5001
+ * </li>
5002
+ * <li>
5003
+ * <p>
5004
+ * <code>UPDATING</code> – The dataview is in the process of being updated.</p>
5005
+ * </li>
5006
+ * <li>
5007
+ * <p>
5008
+ * <code>ACTIVE</code> – The dataview is active.</p>
5009
+ * </li>
5010
+ * </ul>
5011
+ */
5012
+ status?: KxDataviewStatus;
5013
+ /**
5014
+ * @public
5015
+ * <p>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.</p>
5016
+ */
5017
+ autoUpdate?: boolean;
5018
+ /**
5019
+ * @public
5020
+ * <p>A description of the dataview.</p>
5021
+ */
5022
+ description?: string;
5023
+ /**
5024
+ * @public
5025
+ * <p>
5026
+ * 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.
5027
+ * </p>
5028
+ */
5029
+ createdTimestamp?: Date;
5030
+ /**
5031
+ * @public
5032
+ * <p>
5033
+ * 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.
5034
+ * </p>
5035
+ */
5036
+ lastModifiedTimestamp?: Date;
5037
+ }
3179
5038
  /**
3180
5039
  * @public
3181
5040
  */
@@ -3448,6 +5307,147 @@ export interface UpdateKxUserResponse {
3448
5307
  */
3449
5308
  iamRole?: string;
3450
5309
  }
5310
+ /**
5311
+ * @public
5312
+ */
5313
+ export interface UpdateKxVolumeRequest {
5314
+ /**
5315
+ * @public
5316
+ * <p>A unique identifier for the kdb environment where you created the storage volume. </p>
5317
+ */
5318
+ environmentId: string | undefined;
5319
+ /**
5320
+ * @public
5321
+ * <p>
5322
+ * A unique identifier for the volume.</p>
5323
+ */
5324
+ volumeName: string | undefined;
5325
+ /**
5326
+ * @public
5327
+ * <p>
5328
+ * A description of the volume.
5329
+ * </p>
5330
+ */
5331
+ description?: string;
5332
+ /**
5333
+ * @public
5334
+ * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
5335
+ */
5336
+ clientToken?: string;
5337
+ /**
5338
+ * @public
5339
+ * <p> Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>
5340
+ */
5341
+ nas1Configuration?: KxNAS1Configuration;
5342
+ }
5343
+ /**
5344
+ * @public
5345
+ */
5346
+ export interface UpdateKxVolumeResponse {
5347
+ /**
5348
+ * @public
5349
+ * <p>A unique identifier for the kdb environment where you want to update the volume. </p>
5350
+ */
5351
+ environmentId?: string;
5352
+ /**
5353
+ * @public
5354
+ * <p>A unique identifier for the volume that you want to update.</p>
5355
+ */
5356
+ volumeName?: string;
5357
+ /**
5358
+ * @public
5359
+ * <p>
5360
+ * The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.
5361
+ * </p>
5362
+ */
5363
+ volumeType?: KxVolumeType;
5364
+ /**
5365
+ * @public
5366
+ * <p>
5367
+ * The ARN identifier of the volume.
5368
+ * </p>
5369
+ */
5370
+ volumeArn?: string;
5371
+ /**
5372
+ * @public
5373
+ * <p> Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>
5374
+ */
5375
+ nas1Configuration?: KxNAS1Configuration;
5376
+ /**
5377
+ * @public
5378
+ * <p>The status of the volume.</p>
5379
+ * <ul>
5380
+ * <li>
5381
+ * <p>CREATING – The volume creation is in progress.</p>
5382
+ * </li>
5383
+ * <li>
5384
+ * <p>CREATE_FAILED – The volume creation has failed.</p>
5385
+ * </li>
5386
+ * <li>
5387
+ * <p>ACTIVE – The volume is active.</p>
5388
+ * </li>
5389
+ * <li>
5390
+ * <p>UPDATING – The volume is in the process of being updated.</p>
5391
+ * </li>
5392
+ * <li>
5393
+ * <p>UPDATE_FAILED – The update action failed.</p>
5394
+ * </li>
5395
+ * <li>
5396
+ * <p>UPDATED – The volume is successfully updated.</p>
5397
+ * </li>
5398
+ * <li>
5399
+ * <p>DELETING – The volume is in the process of being deleted.</p>
5400
+ * </li>
5401
+ * <li>
5402
+ * <p>DELETE_FAILED – The system failed to delete the volume.</p>
5403
+ * </li>
5404
+ * <li>
5405
+ * <p>DELETED – The volume is successfully deleted.</p>
5406
+ * </li>
5407
+ * </ul>
5408
+ */
5409
+ status?: KxVolumeStatus;
5410
+ /**
5411
+ * @public
5412
+ * <p>
5413
+ * The description for the volume.
5414
+ * </p>
5415
+ */
5416
+ description?: string;
5417
+ /**
5418
+ * @public
5419
+ * <p>The error message when a failed state occurs. </p>
5420
+ */
5421
+ statusReason?: string;
5422
+ /**
5423
+ * @public
5424
+ * <p>
5425
+ * 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.</p>
5426
+ */
5427
+ createdTimestamp?: Date;
5428
+ /**
5429
+ * @public
5430
+ * <p>The number of availability zones you want to assign per cluster. Currently, FinSpace only support <code>SINGLE</code> for volumes.</p>
5431
+ */
5432
+ azMode?: KxAzMode;
5433
+ /**
5434
+ * @public
5435
+ * <p>The identifier of the availability zones.</p>
5436
+ */
5437
+ availabilityZoneIds?: string[];
5438
+ /**
5439
+ * @public
5440
+ * <p>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.</p>
5441
+ */
5442
+ lastModifiedTimestamp?: Date;
5443
+ /**
5444
+ * @public
5445
+ * <p>
5446
+ * Specifies the clusters that a volume is attached to.
5447
+ * </p>
5448
+ */
5449
+ attachedClusters?: KxAttachedCluster[];
5450
+ }
3451
5451
  /**
3452
5452
  * @internal
3453
5453
  */