@aws-sdk/client-finspace 3.379.1 → 3.382.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.
@@ -29,26 +29,32 @@ export type AutoScalingMetric = (typeof AutoScalingMetric)[keyof typeof AutoScal
29
29
  */
30
30
  export interface AutoScalingConfiguration {
31
31
  /**
32
+ * @public
32
33
  * <p>The lowest number of nodes to scale. This value must be at least 1 and less than the <code>maxNodeCount</code>. If the nodes in a cluster belong to multiple availability zones, then <code>minNodeCount</code> must be at least 3.</p>
33
34
  */
34
35
  minNodeCount?: number;
35
36
  /**
37
+ * @public
36
38
  * <p>The highest number of nodes to scale. This value cannot be greater than 5.</p>
37
39
  */
38
40
  maxNodeCount?: number;
39
41
  /**
42
+ * @public
40
43
  * <p> The metric your cluster will track in order to scale in and out. For example, <code>CPU_UTILIZATION_PERCENTAGE</code> is the average CPU usage across all the nodes in a cluster.</p>
41
44
  */
42
45
  autoScalingMetric?: AutoScalingMetric | string;
43
46
  /**
47
+ * @public
44
48
  * <p>The desired value of the chosen <code>autoScalingMetric</code>. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.</p>
45
49
  */
46
50
  metricTarget?: number;
47
51
  /**
52
+ * @public
48
53
  * <p>The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.</p>
49
54
  */
50
55
  scaleInCooldownSeconds?: number;
51
56
  /**
57
+ * @public
52
58
  * <p>The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.</p>
53
59
  */
54
60
  scaleOutCooldownSeconds?: number;
@@ -71,27 +77,33 @@ export type FederationMode = (typeof FederationMode)[keyof typeof FederationMode
71
77
  */
72
78
  export interface FederationParameters {
73
79
  /**
80
+ * @public
74
81
  * <p>SAML 2.0 Metadata document from identity provider (IdP).</p>
75
82
  */
76
83
  samlMetadataDocument?: string;
77
84
  /**
85
+ * @public
78
86
  * <p>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</p>
79
87
  */
80
88
  samlMetadataURL?: string;
81
89
  /**
90
+ * @public
82
91
  * <p>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration
83
92
  * (IdP).</p>
84
93
  */
85
94
  applicationCallBackURL?: string;
86
95
  /**
96
+ * @public
87
97
  * <p>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.</p>
88
98
  */
89
99
  federationURN?: string;
90
100
  /**
101
+ * @public
91
102
  * <p>Name of the identity provider (IdP).</p>
92
103
  */
93
104
  federationProviderName?: string;
94
105
  /**
106
+ * @public
95
107
  * <p>SAML attribute name and value. The name must always be <code>Email</code> and the value should be set to
96
108
  * the attribute definition in which user email is set. For example, name would be <code>Email</code> and
97
109
  * value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>.
@@ -105,14 +117,17 @@ export interface FederationParameters {
105
117
  */
106
118
  export interface SuperuserParameters {
107
119
  /**
120
+ * @public
108
121
  * <p>The email address of the superuser.</p>
109
122
  */
110
123
  emailAddress: string | undefined;
111
124
  /**
125
+ * @public
112
126
  * <p>The first name of the superuser.</p>
113
127
  */
114
128
  firstName: string | undefined;
115
129
  /**
130
+ * @public
116
131
  * <p>The last name of the superuser.</p>
117
132
  */
118
133
  lastName: string | undefined;
@@ -122,22 +137,27 @@ export interface SuperuserParameters {
122
137
  */
123
138
  export interface CreateEnvironmentRequest {
124
139
  /**
140
+ * @public
125
141
  * <p>The name of the FinSpace environment to be created.</p>
126
142
  */
127
143
  name: string | undefined;
128
144
  /**
145
+ * @public
129
146
  * <p>The description of the FinSpace environment to be created.</p>
130
147
  */
131
148
  description?: string;
132
149
  /**
150
+ * @public
133
151
  * <p>The KMS key id to encrypt your data in the FinSpace environment.</p>
134
152
  */
135
153
  kmsKeyId?: string;
136
154
  /**
155
+ * @public
137
156
  * <p>Add tags to your FinSpace environment.</p>
138
157
  */
139
158
  tags?: Record<string, string>;
140
159
  /**
160
+ * @public
141
161
  * <p>Authentication mode for the environment.</p>
142
162
  * <ul>
143
163
  * <li>
@@ -152,14 +172,17 @@ export interface CreateEnvironmentRequest {
152
172
  */
153
173
  federationMode?: FederationMode | string;
154
174
  /**
175
+ * @public
155
176
  * <p>Configuration information when authentication mode is FEDERATED.</p>
156
177
  */
157
178
  federationParameters?: FederationParameters;
158
179
  /**
180
+ * @public
159
181
  * <p>Configuration information for the superuser.</p>
160
182
  */
161
183
  superuserParameters?: SuperuserParameters;
162
184
  /**
185
+ * @public
163
186
  * <p>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</p>
164
187
  * <ul>
165
188
  * <li>
@@ -179,14 +202,17 @@ export interface CreateEnvironmentRequest {
179
202
  */
180
203
  export interface CreateEnvironmentResponse {
181
204
  /**
205
+ * @public
182
206
  * <p>The unique identifier for FinSpace environment that you created.</p>
183
207
  */
184
208
  environmentId?: string;
185
209
  /**
210
+ * @public
186
211
  * <p>The Amazon Resource Name (ARN) of the FinSpace environment that you created.</p>
187
212
  */
188
213
  environmentArn?: string;
189
214
  /**
215
+ * @public
190
216
  * <p>The sign-in URL for the web application of the FinSpace environment you created.</p>
191
217
  */
192
218
  environmentUrl?: string;
@@ -261,6 +287,7 @@ export declare class ConflictException extends __BaseException {
261
287
  readonly name: "ConflictException";
262
288
  readonly $fault: "client";
263
289
  /**
290
+ * @public
264
291
  * <p>The reason for the conflict exception.</p>
265
292
  */
266
293
  reason?: string;
@@ -287,6 +314,7 @@ export type ChangeType = (typeof ChangeType)[keyof typeof ChangeType];
287
314
  */
288
315
  export interface ChangeRequest {
289
316
  /**
317
+ * @public
290
318
  * <p>Defines the type of change request. A <code>changeType</code> can have the following values:</p>
291
319
  * <ul>
292
320
  * <li>
@@ -299,10 +327,12 @@ export interface ChangeRequest {
299
327
  */
300
328
  changeType: ChangeType | string | undefined;
301
329
  /**
330
+ * @public
302
331
  * <p>Defines the S3 path of the source file that is required to add or update files in a database.</p>
303
332
  */
304
333
  s3Path?: string;
305
334
  /**
335
+ * @public
306
336
  * <p>Defines the path within the database directory. </p>
307
337
  */
308
338
  dbPath: string | undefined;
@@ -312,14 +342,17 @@ export interface ChangeRequest {
312
342
  */
313
343
  export interface CreateKxChangesetRequest {
314
344
  /**
345
+ * @public
315
346
  * <p>A unique identifier of the kdb environment.</p>
316
347
  */
317
348
  environmentId: string | undefined;
318
349
  /**
350
+ * @public
319
351
  * <p>The name of the kdb database.</p>
320
352
  */
321
353
  databaseName: string | undefined;
322
354
  /**
355
+ * @public
323
356
  * <p>A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath.
324
357
  * A changeType can has the following values: </p>
325
358
  * <ul>
@@ -351,6 +384,7 @@ export interface CreateKxChangesetRequest {
351
384
  */
352
385
  changeRequests: ChangeRequest[] | undefined;
353
386
  /**
387
+ * @public
354
388
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
355
389
  */
356
390
  clientToken?: string;
@@ -379,10 +413,12 @@ export type ErrorDetails = (typeof ErrorDetails)[keyof typeof ErrorDetails];
379
413
  */
380
414
  export interface ErrorInfo {
381
415
  /**
416
+ * @public
382
417
  * <p>Specifies the error message that appears if a flow fails. </p>
383
418
  */
384
419
  errorMessage?: string;
385
420
  /**
421
+ * @public
386
422
  * <p>Specifies the type of error.</p>
387
423
  */
388
424
  errorType?: ErrorDetails | string;
@@ -406,30 +442,37 @@ export type ChangesetStatus = (typeof ChangesetStatus)[keyof typeof ChangesetSta
406
442
  */
407
443
  export interface CreateKxChangesetResponse {
408
444
  /**
445
+ * @public
409
446
  * <p>A unique identifier for the changeset.</p>
410
447
  */
411
448
  changesetId?: string;
412
449
  /**
450
+ * @public
413
451
  * <p>The name of the kdb database.</p>
414
452
  */
415
453
  databaseName?: string;
416
454
  /**
455
+ * @public
417
456
  * <p>A unique identifier for the kdb environment.</p>
418
457
  */
419
458
  environmentId?: string;
420
459
  /**
460
+ * @public
421
461
  * <p>A list of change requests.</p>
422
462
  */
423
463
  changeRequests?: ChangeRequest[];
424
464
  /**
465
+ * @public
425
466
  * <p>The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
426
467
  */
427
468
  createdTimestamp?: Date;
428
469
  /**
470
+ * @public
429
471
  * <p>The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
430
472
  */
431
473
  lastModifiedTimestamp?: Date;
432
474
  /**
475
+ * @public
433
476
  * <p>Status of the changeset creation process.</p>
434
477
  * <ul>
435
478
  * <li>
@@ -448,6 +491,7 @@ export interface CreateKxChangesetResponse {
448
491
  */
449
492
  status?: ChangesetStatus | string;
450
493
  /**
494
+ * @public
451
495
  * <p>The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.</p>
452
496
  */
453
497
  errorInfo?: ErrorInfo;
@@ -482,6 +526,7 @@ export type KxAzMode = (typeof KxAzMode)[keyof typeof KxAzMode];
482
526
  */
483
527
  export interface KxCacheStorageConfiguration {
484
528
  /**
529
+ * @public
485
530
  * <p>The type of cache storage . The valid values are: </p>
486
531
  * <ul>
487
532
  * <li>
@@ -491,6 +536,7 @@ export interface KxCacheStorageConfiguration {
491
536
  */
492
537
  type: string | undefined;
493
538
  /**
539
+ * @public
494
540
  * <p>The size of cache in Gigabytes.</p>
495
541
  */
496
542
  size: number | undefined;
@@ -501,6 +547,7 @@ export interface KxCacheStorageConfiguration {
501
547
  */
502
548
  export interface CapacityConfiguration {
503
549
  /**
550
+ * @public
504
551
  * <p>The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.</p>
505
552
  * <p>You can only specify one of the following values:</p>
506
553
  * <ul>
@@ -536,6 +583,7 @@ export interface CapacityConfiguration {
536
583
  */
537
584
  nodeType?: string;
538
585
  /**
586
+ * @public
539
587
  * <p>The number of instances running in a cluster.</p>
540
588
  */
541
589
  nodeCount?: number;
@@ -559,14 +607,17 @@ export type KxClusterType = (typeof KxClusterType)[keyof typeof KxClusterType];
559
607
  */
560
608
  export interface CodeConfiguration {
561
609
  /**
610
+ * @public
562
611
  * <p>A unique name for the S3 bucket.</p>
563
612
  */
564
613
  s3Bucket?: string;
565
614
  /**
615
+ * @public
566
616
  * <p>The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.</p>
567
617
  */
568
618
  s3Key?: string;
569
619
  /**
620
+ * @public
570
621
  * <p>The version of an S3 object.</p>
571
622
  */
572
623
  s3ObjectVersion?: string;
@@ -577,10 +628,12 @@ export interface CodeConfiguration {
577
628
  */
578
629
  export interface KxCommandLineArgument {
579
630
  /**
631
+ * @public
580
632
  * <p>The name of the key.</p>
581
633
  */
582
634
  key?: string;
583
635
  /**
636
+ * @public
584
637
  * <p>The value of the key.</p>
585
638
  */
586
639
  value?: string;
@@ -591,6 +644,7 @@ export interface KxCommandLineArgument {
591
644
  */
592
645
  export interface KxDatabaseCacheConfiguration {
593
646
  /**
647
+ * @public
594
648
  * <p>The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:</p>
595
649
  * <ul>
596
650
  * <li>
@@ -600,6 +654,7 @@ export interface KxDatabaseCacheConfiguration {
600
654
  */
601
655
  cacheType: string | undefined;
602
656
  /**
657
+ * @public
603
658
  * <p>Specifies the portions of database that will be loaded into the cache for access.</p>
604
659
  */
605
660
  dbPaths: string[] | undefined;
@@ -610,14 +665,17 @@ export interface KxDatabaseCacheConfiguration {
610
665
  */
611
666
  export interface KxDatabaseConfiguration {
612
667
  /**
668
+ * @public
613
669
  * <p>The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.</p>
614
670
  */
615
671
  databaseName: string | undefined;
616
672
  /**
673
+ * @public
617
674
  * <p>Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.</p>
618
675
  */
619
676
  cacheConfigurations?: KxDatabaseCacheConfiguration[];
620
677
  /**
678
+ * @public
621
679
  * <p>A unique identifier of the changeset that is associated with the cluster.</p>
622
680
  */
623
681
  changesetId?: string;
@@ -639,6 +697,7 @@ export type KxSavedownStorageType = (typeof KxSavedownStorageType)[keyof typeof
639
697
  */
640
698
  export interface KxSavedownStorageConfiguration {
641
699
  /**
700
+ * @public
642
701
  * <p>The type of writeable storage space for temporarily storing your savedown data. The valid values are:</p>
643
702
  * <ul>
644
703
  * <li>
@@ -648,6 +707,7 @@ export interface KxSavedownStorageConfiguration {
648
707
  */
649
708
  type: KxSavedownStorageType | string | undefined;
650
709
  /**
710
+ * @public
651
711
  * <p>The size of temporary storage in bytes.</p>
652
712
  */
653
713
  size: number | undefined;
@@ -669,18 +729,22 @@ export type IPAddressType = (typeof IPAddressType)[keyof typeof IPAddressType];
669
729
  */
670
730
  export interface VpcConfiguration {
671
731
  /**
732
+ * @public
672
733
  * <p>The identifier of the VPC endpoint.</p>
673
734
  */
674
735
  vpcId?: string;
675
736
  /**
737
+ * @public
676
738
  * <p>The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.</p>
677
739
  */
678
740
  securityGroupIds?: string[];
679
741
  /**
742
+ * @public
680
743
  * <p>The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.</p>
681
744
  */
682
745
  subnetIds?: string[];
683
746
  /**
747
+ * @public
684
748
  * <p>The IP address type for cluster network configuration parameters. The following type is available:</p>
685
749
  * <ul>
686
750
  * <li>
@@ -695,18 +759,22 @@ export interface VpcConfiguration {
695
759
  */
696
760
  export interface CreateKxClusterRequest {
697
761
  /**
762
+ * @public
698
763
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
699
764
  */
700
765
  clientToken?: string;
701
766
  /**
767
+ * @public
702
768
  * <p>A unique identifier for the kdb environment.</p>
703
769
  */
704
770
  environmentId: string | undefined;
705
771
  /**
772
+ * @public
706
773
  * <p>A unique name for the cluster that you want to create.</p>
707
774
  */
708
775
  clusterName: string | undefined;
709
776
  /**
777
+ * @public
710
778
  * <p>Specifies the type of KDB database that is being created. The following types are available: </p>
711
779
  * <ul>
712
780
  * <li>
@@ -722,34 +790,42 @@ export interface CreateKxClusterRequest {
722
790
  */
723
791
  clusterType: KxClusterType | string | undefined;
724
792
  /**
793
+ * @public
725
794
  * <p>A list of databases that will be available for querying.</p>
726
795
  */
727
796
  databases?: KxDatabaseConfiguration[];
728
797
  /**
798
+ * @public
729
799
  * <p>The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. </p>
730
800
  */
731
801
  cacheStorageConfigurations?: KxCacheStorageConfiguration[];
732
802
  /**
803
+ * @public
733
804
  * <p>The configuration based on which FinSpace will scale in or scale out nodes in your cluster.</p>
734
805
  */
735
806
  autoScalingConfiguration?: AutoScalingConfiguration;
736
807
  /**
808
+ * @public
737
809
  * <p>A description of the cluster.</p>
738
810
  */
739
811
  clusterDescription?: string;
740
812
  /**
813
+ * @public
741
814
  * <p>A structure for the metadata of a cluster. It includes information about like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.</p>
742
815
  */
743
816
  capacityConfiguration: CapacityConfiguration | undefined;
744
817
  /**
818
+ * @public
745
819
  * <p>The version of FinSpace managed kdb to run.</p>
746
820
  */
747
821
  releaseLabel: string | undefined;
748
822
  /**
823
+ * @public
749
824
  * <p>Configuration details about the network where the Privatelink endpoint of the cluster resides.</p>
750
825
  */
751
826
  vpcConfiguration?: VpcConfiguration;
752
827
  /**
828
+ * @public
753
829
  * <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within
754
830
  * <i>.zip</i> file that contains the custom code, which will be loaded on
755
831
  * the cluster. It must include the file name itself. For example,
@@ -757,22 +833,27 @@ export interface CreateKxClusterRequest {
757
833
  */
758
834
  initializationScript?: string;
759
835
  /**
836
+ * @public
760
837
  * <p>Defines the key-value pairs to make them available inside the cluster.</p>
761
838
  */
762
839
  commandLineArguments?: KxCommandLineArgument[];
763
840
  /**
841
+ * @public
764
842
  * <p>The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster. </p>
765
843
  */
766
844
  code?: CodeConfiguration;
767
845
  /**
846
+ * @public
768
847
  * <p>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.</p>
769
848
  */
770
849
  executionRole?: string;
771
850
  /**
851
+ * @public
772
852
  * <p>The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose <code>clusterType</code> as RDB. All the data written to this storage space is lost when the cluster node is restarted.</p>
773
853
  */
774
854
  savedownStorageConfiguration?: KxSavedownStorageConfiguration;
775
855
  /**
856
+ * @public
776
857
  * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
777
858
  * <ul>
778
859
  * <li>
@@ -787,10 +868,12 @@ export interface CreateKxClusterRequest {
787
868
  */
788
869
  azMode: KxAzMode | string | undefined;
789
870
  /**
871
+ * @public
790
872
  * <p>The availability zone identifiers for the requested regions.</p>
791
873
  */
792
874
  availabilityZoneId?: string;
793
875
  /**
876
+ * @public
794
877
  * <p>A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.</p>
795
878
  */
796
879
  tags?: Record<string, string>;
@@ -818,10 +901,12 @@ export type KxClusterStatus = (typeof KxClusterStatus)[keyof typeof KxClusterSta
818
901
  */
819
902
  export interface CreateKxClusterResponse {
820
903
  /**
904
+ * @public
821
905
  * <p>A unique identifier for the kdb environment.</p>
822
906
  */
823
907
  environmentId?: string;
824
908
  /**
909
+ * @public
825
910
  * <p>The status of cluster creation.</p>
826
911
  * <ul>
827
912
  * <li>
@@ -852,14 +937,17 @@ export interface CreateKxClusterResponse {
852
937
  */
853
938
  status?: KxClusterStatus | string;
854
939
  /**
940
+ * @public
855
941
  * <p>The error message when a failed state occurs. </p>
856
942
  */
857
943
  statusReason?: string;
858
944
  /**
945
+ * @public
859
946
  * <p>A unique name for the cluster.</p>
860
947
  */
861
948
  clusterName?: string;
862
949
  /**
950
+ * @public
863
951
  * <p>Specifies the type of KDB database that is being created. The following types are available: </p>
864
952
  * <ul>
865
953
  * <li>
@@ -875,34 +963,42 @@ export interface CreateKxClusterResponse {
875
963
  */
876
964
  clusterType?: KxClusterType | string;
877
965
  /**
966
+ * @public
878
967
  * <p>A list of databases that will be available for querying.</p>
879
968
  */
880
969
  databases?: KxDatabaseConfiguration[];
881
970
  /**
971
+ * @public
882
972
  * <p>The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. </p>
883
973
  */
884
974
  cacheStorageConfigurations?: KxCacheStorageConfiguration[];
885
975
  /**
976
+ * @public
886
977
  * <p>The configuration based on which FinSpace will scale in or scale out nodes in your cluster.</p>
887
978
  */
888
979
  autoScalingConfiguration?: AutoScalingConfiguration;
889
980
  /**
981
+ * @public
890
982
  * <p>A description of the cluster.</p>
891
983
  */
892
984
  clusterDescription?: string;
893
985
  /**
986
+ * @public
894
987
  * <p>A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.</p>
895
988
  */
896
989
  capacityConfiguration?: CapacityConfiguration;
897
990
  /**
991
+ * @public
898
992
  * <p>A version of the FinSpace managed kdb to run.</p>
899
993
  */
900
994
  releaseLabel?: string;
901
995
  /**
996
+ * @public
902
997
  * <p>Configuration details about the network where the Privatelink endpoint of the cluster resides.</p>
903
998
  */
904
999
  vpcConfiguration?: VpcConfiguration;
905
1000
  /**
1001
+ * @public
906
1002
  * <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within
907
1003
  * <i>.zip</i> file that contains the custom code, which will be loaded on
908
1004
  * the cluster. It must include the file name itself. For example,
@@ -910,28 +1006,34 @@ export interface CreateKxClusterResponse {
910
1006
  */
911
1007
  initializationScript?: string;
912
1008
  /**
1009
+ * @public
913
1010
  * <p>Defines the key-value pairs to make them available inside the cluster.</p>
914
1011
  */
915
1012
  commandLineArguments?: KxCommandLineArgument[];
916
1013
  /**
1014
+ * @public
917
1015
  * <p>The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster. </p>
918
1016
  */
919
1017
  code?: CodeConfiguration;
920
1018
  /**
1019
+ * @public
921
1020
  * <p>
922
1021
  * 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.
923
1022
  * </p>
924
1023
  */
925
1024
  executionRole?: string;
926
1025
  /**
1026
+ * @public
927
1027
  * <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>
928
1028
  */
929
1029
  lastModifiedTimestamp?: Date;
930
1030
  /**
1031
+ * @public
931
1032
  * <p>The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose <code>clusterType</code> as RDB. All the data written to this storage space is lost when the cluster node is restarted.</p>
932
1033
  */
933
1034
  savedownStorageConfiguration?: KxSavedownStorageConfiguration;
934
1035
  /**
1036
+ * @public
935
1037
  * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
936
1038
  * <ul>
937
1039
  * <li>
@@ -946,12 +1048,14 @@ export interface CreateKxClusterResponse {
946
1048
  */
947
1049
  azMode?: KxAzMode | string;
948
1050
  /**
1051
+ * @public
949
1052
  * <p>
950
1053
  * The availability zone identifiers for the requested regions.
951
1054
  * </p>
952
1055
  */
953
1056
  availabilityZoneId?: string;
954
1057
  /**
1058
+ * @public
955
1059
  * <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>
956
1060
  */
957
1061
  createdTimestamp?: Date;
@@ -961,22 +1065,27 @@ export interface CreateKxClusterResponse {
961
1065
  */
962
1066
  export interface CreateKxDatabaseRequest {
963
1067
  /**
1068
+ * @public
964
1069
  * <p>A unique identifier for the kdb environment.</p>
965
1070
  */
966
1071
  environmentId: string | undefined;
967
1072
  /**
1073
+ * @public
968
1074
  * <p>The name of the kdb database.</p>
969
1075
  */
970
1076
  databaseName: string | undefined;
971
1077
  /**
1078
+ * @public
972
1079
  * <p>A description of the database.</p>
973
1080
  */
974
1081
  description?: string;
975
1082
  /**
1083
+ * @public
976
1084
  * <p>A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database</p>
977
1085
  */
978
1086
  tags?: Record<string, string>;
979
1087
  /**
1088
+ * @public
980
1089
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
981
1090
  */
982
1091
  clientToken?: string;
@@ -986,26 +1095,32 @@ export interface CreateKxDatabaseRequest {
986
1095
  */
987
1096
  export interface CreateKxDatabaseResponse {
988
1097
  /**
1098
+ * @public
989
1099
  * <p>The name of the kdb database.</p>
990
1100
  */
991
1101
  databaseName?: string;
992
1102
  /**
1103
+ * @public
993
1104
  * <p>The ARN identifier of the database.</p>
994
1105
  */
995
1106
  databaseArn?: string;
996
1107
  /**
1108
+ * @public
997
1109
  * <p>A unique identifier for the kdb environment.</p>
998
1110
  */
999
1111
  environmentId?: string;
1000
1112
  /**
1113
+ * @public
1001
1114
  * <p>A description of the database.</p>
1002
1115
  */
1003
1116
  description?: string;
1004
1117
  /**
1118
+ * @public
1005
1119
  * <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>
1006
1120
  */
1007
1121
  createdTimestamp?: Date;
1008
1122
  /**
1123
+ * @public
1009
1124
  * <p>The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1010
1125
  */
1011
1126
  lastModifiedTimestamp?: Date;
@@ -1027,22 +1142,27 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1027
1142
  */
1028
1143
  export interface CreateKxEnvironmentRequest {
1029
1144
  /**
1145
+ * @public
1030
1146
  * <p>The name of the kdb environment that you want to create.</p>
1031
1147
  */
1032
1148
  name: string | undefined;
1033
1149
  /**
1150
+ * @public
1034
1151
  * <p>A description for the kdb environment.</p>
1035
1152
  */
1036
1153
  description?: string;
1037
1154
  /**
1155
+ * @public
1038
1156
  * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1039
1157
  */
1040
1158
  kmsKeyId: string | undefined;
1041
1159
  /**
1160
+ * @public
1042
1161
  * <p>A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.</p>
1043
1162
  */
1044
1163
  tags?: Record<string, string>;
1045
1164
  /**
1165
+ * @public
1046
1166
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1047
1167
  */
1048
1168
  clientToken?: string;
@@ -1075,30 +1195,37 @@ export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof Environm
1075
1195
  */
1076
1196
  export interface CreateKxEnvironmentResponse {
1077
1197
  /**
1198
+ * @public
1078
1199
  * <p>The name of the kdb environment.</p>
1079
1200
  */
1080
1201
  name?: string;
1081
1202
  /**
1203
+ * @public
1082
1204
  * <p>The status of the kdb environment.</p>
1083
1205
  */
1084
1206
  status?: EnvironmentStatus | string;
1085
1207
  /**
1208
+ * @public
1086
1209
  * <p>A unique identifier for the kdb environment.</p>
1087
1210
  */
1088
1211
  environmentId?: string;
1089
1212
  /**
1213
+ * @public
1090
1214
  * <p>A description for the kdb environment.</p>
1091
1215
  */
1092
1216
  description?: string;
1093
1217
  /**
1218
+ * @public
1094
1219
  * <p>The ARN identifier of the environment.</p>
1095
1220
  */
1096
1221
  environmentArn?: string;
1097
1222
  /**
1223
+ * @public
1098
1224
  * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1099
1225
  */
1100
1226
  kmsKeyId?: string;
1101
1227
  /**
1228
+ * @public
1102
1229
  * <p>The timestamp at which the kdb environment was created in FinSpace.</p>
1103
1230
  */
1104
1231
  creationTimestamp?: Date;
@@ -1108,22 +1235,27 @@ export interface CreateKxEnvironmentResponse {
1108
1235
  */
1109
1236
  export interface CreateKxUserRequest {
1110
1237
  /**
1238
+ * @public
1111
1239
  * <p>A unique identifier for the kdb environment where you want to create a user.</p>
1112
1240
  */
1113
1241
  environmentId: string | undefined;
1114
1242
  /**
1243
+ * @public
1115
1244
  * <p>A unique identifier for the user.</p>
1116
1245
  */
1117
1246
  userName: string | undefined;
1118
1247
  /**
1248
+ * @public
1119
1249
  * <p>The IAM role ARN that will be associated with the user.</p>
1120
1250
  */
1121
1251
  iamRole: string | undefined;
1122
1252
  /**
1253
+ * @public
1123
1254
  * <p>A list of key-value pairs to label the user. You can add up to 50 tags to a user.</p>
1124
1255
  */
1125
1256
  tags?: Record<string, string>;
1126
1257
  /**
1258
+ * @public
1127
1259
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1128
1260
  */
1129
1261
  clientToken?: string;
@@ -1133,20 +1265,24 @@ export interface CreateKxUserRequest {
1133
1265
  */
1134
1266
  export interface CreateKxUserResponse {
1135
1267
  /**
1268
+ * @public
1136
1269
  * <p>A unique identifier for the user.</p>
1137
1270
  */
1138
1271
  userName?: string;
1139
1272
  /**
1273
+ * @public
1140
1274
  * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
1141
1275
  * how to use ARNs in policies, see <a href="IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
1142
1276
  * <i>IAM User Guide</i>. </p>
1143
1277
  */
1144
1278
  userArn?: string;
1145
1279
  /**
1280
+ * @public
1146
1281
  * <p>A unique identifier for the kdb environment.</p>
1147
1282
  */
1148
1283
  environmentId?: string;
1149
1284
  /**
1285
+ * @public
1150
1286
  * <p>The IAM role ARN that will be associated with the user.</p>
1151
1287
  */
1152
1288
  iamRole?: string;
@@ -1156,6 +1292,7 @@ export interface CreateKxUserResponse {
1156
1292
  */
1157
1293
  export interface DeleteEnvironmentRequest {
1158
1294
  /**
1295
+ * @public
1159
1296
  * <p>The identifier for the FinSpace environment.</p>
1160
1297
  */
1161
1298
  environmentId: string | undefined;
@@ -1170,14 +1307,17 @@ export interface DeleteEnvironmentResponse {
1170
1307
  */
1171
1308
  export interface DeleteKxClusterRequest {
1172
1309
  /**
1310
+ * @public
1173
1311
  * <p>A unique identifier for the kdb environment.</p>
1174
1312
  */
1175
1313
  environmentId: string | undefined;
1176
1314
  /**
1315
+ * @public
1177
1316
  * <p>The name of the cluster that you want to delete.</p>
1178
1317
  */
1179
1318
  clusterName: string | undefined;
1180
1319
  /**
1320
+ * @public
1181
1321
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1182
1322
  */
1183
1323
  clientToken?: string;
@@ -1192,14 +1332,17 @@ export interface DeleteKxClusterResponse {
1192
1332
  */
1193
1333
  export interface DeleteKxDatabaseRequest {
1194
1334
  /**
1335
+ * @public
1195
1336
  * <p>A unique identifier for the kdb environment.</p>
1196
1337
  */
1197
1338
  environmentId: string | undefined;
1198
1339
  /**
1340
+ * @public
1199
1341
  * <p>The name of the kdb database that you want to delete.</p>
1200
1342
  */
1201
1343
  databaseName: string | undefined;
1202
1344
  /**
1345
+ * @public
1203
1346
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
1204
1347
  */
1205
1348
  clientToken?: string;
@@ -1214,6 +1357,7 @@ export interface DeleteKxDatabaseResponse {
1214
1357
  */
1215
1358
  export interface DeleteKxEnvironmentRequest {
1216
1359
  /**
1360
+ * @public
1217
1361
  * <p>A unique identifier for the kdb environment.</p>
1218
1362
  */
1219
1363
  environmentId: string | undefined;
@@ -1228,10 +1372,12 @@ export interface DeleteKxEnvironmentResponse {
1228
1372
  */
1229
1373
  export interface DeleteKxUserRequest {
1230
1374
  /**
1375
+ * @public
1231
1376
  * <p>A unique identifier for the user that you want to delete.</p>
1232
1377
  */
1233
1378
  userName: string | undefined;
1234
1379
  /**
1380
+ * @public
1235
1381
  * <p>A unique identifier for the kdb environment.</p>
1236
1382
  */
1237
1383
  environmentId: string | undefined;
@@ -1246,6 +1392,7 @@ export interface DeleteKxUserResponse {
1246
1392
  */
1247
1393
  export interface GetEnvironmentRequest {
1248
1394
  /**
1395
+ * @public
1249
1396
  * <p>The identifier of the FinSpace environment.</p>
1250
1397
  */
1251
1398
  environmentId: string | undefined;
@@ -1256,51 +1403,63 @@ export interface GetEnvironmentRequest {
1256
1403
  */
1257
1404
  export interface Environment {
1258
1405
  /**
1406
+ * @public
1259
1407
  * <p>The name of the FinSpace environment.</p>
1260
1408
  */
1261
1409
  name?: string;
1262
1410
  /**
1411
+ * @public
1263
1412
  * <p>The identifier of the FinSpace environment.</p>
1264
1413
  */
1265
1414
  environmentId?: string;
1266
1415
  /**
1416
+ * @public
1267
1417
  * <p>The ID of the AWS account in which the FinSpace environment is created.</p>
1268
1418
  */
1269
1419
  awsAccountId?: string;
1270
1420
  /**
1421
+ * @public
1271
1422
  * <p>The current status of creation of the FinSpace environment.</p>
1272
1423
  */
1273
1424
  status?: EnvironmentStatus | string;
1274
1425
  /**
1426
+ * @public
1275
1427
  * <p>The sign-in URL for the web application of your FinSpace environment.</p>
1276
1428
  */
1277
1429
  environmentUrl?: string;
1278
1430
  /**
1431
+ * @public
1279
1432
  * <p>The description of the FinSpace environment.</p>
1280
1433
  */
1281
1434
  description?: string;
1282
1435
  /**
1436
+ * @public
1283
1437
  * <p>The Amazon Resource Name (ARN) of your FinSpace environment.</p>
1284
1438
  */
1285
1439
  environmentArn?: string;
1286
1440
  /**
1441
+ * @public
1287
1442
  * <p>The URL of the integrated FinSpace notebook environment in your web application.</p>
1288
1443
  */
1289
1444
  sageMakerStudioDomainUrl?: string;
1290
1445
  /**
1446
+ * @public
1291
1447
  * <p>The KMS key id used to encrypt in the FinSpace environment.</p>
1292
1448
  */
1293
1449
  kmsKeyId?: string;
1294
1450
  /**
1451
+ * @public
1295
1452
  * <p>The AWS account ID of the dedicated service account associated with your FinSpace
1296
1453
  * environment.</p>
1297
1454
  */
1298
1455
  dedicatedServiceAccountId?: string;
1299
1456
  /**
1457
+ * @public
1300
1458
  * <p>The authentication mode for the environment.</p>
1301
1459
  */
1302
1460
  federationMode?: FederationMode | string;
1303
1461
  /**
1462
+ * @public
1304
1463
  * <p>Configuration information when authentication mode is FEDERATED.</p>
1305
1464
  */
1306
1465
  federationParameters?: FederationParameters;
@@ -1310,6 +1469,7 @@ export interface Environment {
1310
1469
  */
1311
1470
  export interface GetEnvironmentResponse {
1312
1471
  /**
1472
+ * @public
1313
1473
  * <p>The name of the FinSpace environment.</p>
1314
1474
  */
1315
1475
  environment?: Environment;
@@ -1319,14 +1479,17 @@ export interface GetEnvironmentResponse {
1319
1479
  */
1320
1480
  export interface GetKxChangesetRequest {
1321
1481
  /**
1482
+ * @public
1322
1483
  * <p>A unique identifier for the kdb environment.</p>
1323
1484
  */
1324
1485
  environmentId: string | undefined;
1325
1486
  /**
1487
+ * @public
1326
1488
  * <p>The name of the kdb database.</p>
1327
1489
  */
1328
1490
  databaseName: string | undefined;
1329
1491
  /**
1492
+ * @public
1330
1493
  * <p>A unique identifier of the changeset for which you want to retrieve data.</p>
1331
1494
  */
1332
1495
  changesetId: string | undefined;
@@ -1336,36 +1499,44 @@ export interface GetKxChangesetRequest {
1336
1499
  */
1337
1500
  export interface GetKxChangesetResponse {
1338
1501
  /**
1502
+ * @public
1339
1503
  * <p>A unique identifier for the changeset.</p>
1340
1504
  */
1341
1505
  changesetId?: string;
1342
1506
  /**
1507
+ * @public
1343
1508
  * <p>The name of the kdb database.</p>
1344
1509
  */
1345
1510
  databaseName?: string;
1346
1511
  /**
1512
+ * @public
1347
1513
  * <p>A unique identifier for the kdb environment.</p>
1348
1514
  */
1349
1515
  environmentId?: string;
1350
1516
  /**
1517
+ * @public
1351
1518
  * <p>A list of change request objects that are run in order.</p>
1352
1519
  */
1353
1520
  changeRequests?: ChangeRequest[];
1354
1521
  /**
1522
+ * @public
1355
1523
  * <p>The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1356
1524
  */
1357
1525
  createdTimestamp?: Date;
1358
1526
  /**
1527
+ * @public
1359
1528
  * <p>Beginning time from which the changeset is active. The value is determined as epoch time in
1360
1529
  * milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1361
1530
  * 1635768000000.</p>
1362
1531
  */
1363
1532
  activeFromTimestamp?: Date;
1364
1533
  /**
1534
+ * @public
1365
1535
  * <p>The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1366
1536
  */
1367
1537
  lastModifiedTimestamp?: Date;
1368
1538
  /**
1539
+ * @public
1369
1540
  * <p>Status of the changeset creation process.</p>
1370
1541
  * <ul>
1371
1542
  * <li>
@@ -1384,6 +1555,7 @@ export interface GetKxChangesetResponse {
1384
1555
  */
1385
1556
  status?: ChangesetStatus | string;
1386
1557
  /**
1558
+ * @public
1387
1559
  * <p>Provides details in the event of a failed flow, including the error type and the related error message.</p>
1388
1560
  */
1389
1561
  errorInfo?: ErrorInfo;
@@ -1393,10 +1565,12 @@ export interface GetKxChangesetResponse {
1393
1565
  */
1394
1566
  export interface GetKxClusterRequest {
1395
1567
  /**
1568
+ * @public
1396
1569
  * <p>A unique identifier for the kdb environment.</p>
1397
1570
  */
1398
1571
  environmentId: string | undefined;
1399
1572
  /**
1573
+ * @public
1400
1574
  * <p>The name of the cluster that you want to retrieve.</p>
1401
1575
  */
1402
1576
  clusterName: string | undefined;
@@ -1406,6 +1580,7 @@ export interface GetKxClusterRequest {
1406
1580
  */
1407
1581
  export interface GetKxClusterResponse {
1408
1582
  /**
1583
+ * @public
1409
1584
  * <p>The status of cluster creation.</p>
1410
1585
  * <ul>
1411
1586
  * <li>
@@ -1436,14 +1611,17 @@ export interface GetKxClusterResponse {
1436
1611
  */
1437
1612
  status?: KxClusterStatus | string;
1438
1613
  /**
1614
+ * @public
1439
1615
  * <p>The error message when a failed state occurs. </p>
1440
1616
  */
1441
1617
  statusReason?: string;
1442
1618
  /**
1619
+ * @public
1443
1620
  * <p>A unique name for the cluster.</p>
1444
1621
  */
1445
1622
  clusterName?: string;
1446
1623
  /**
1624
+ * @public
1447
1625
  * <p>Specifies the type of KDB database that is being created. The following types are available: </p>
1448
1626
  * <ul>
1449
1627
  * <li>
@@ -1459,34 +1637,42 @@ export interface GetKxClusterResponse {
1459
1637
  */
1460
1638
  clusterType?: KxClusterType | string;
1461
1639
  /**
1640
+ * @public
1462
1641
  * <p> A list of databases mounted on the cluster.</p>
1463
1642
  */
1464
1643
  databases?: KxDatabaseConfiguration[];
1465
1644
  /**
1645
+ * @public
1466
1646
  * <p>The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. </p>
1467
1647
  */
1468
1648
  cacheStorageConfigurations?: KxCacheStorageConfiguration[];
1469
1649
  /**
1650
+ * @public
1470
1651
  * <p>The configuration based on which FinSpace will scale in or scale out nodes in your cluster.</p>
1471
1652
  */
1472
1653
  autoScalingConfiguration?: AutoScalingConfiguration;
1473
1654
  /**
1655
+ * @public
1474
1656
  * <p>A description of the cluster.</p>
1475
1657
  */
1476
1658
  clusterDescription?: string;
1477
1659
  /**
1660
+ * @public
1478
1661
  * <p>A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, number of instances, and the port used while establishing a connection.</p>
1479
1662
  */
1480
1663
  capacityConfiguration?: CapacityConfiguration;
1481
1664
  /**
1665
+ * @public
1482
1666
  * <p>The version of FinSpace managed kdb to run.</p>
1483
1667
  */
1484
1668
  releaseLabel?: string;
1485
1669
  /**
1670
+ * @public
1486
1671
  * <p>Configuration details about the network where the Privatelink endpoint of the cluster resides.</p>
1487
1672
  */
1488
1673
  vpcConfiguration?: VpcConfiguration;
1489
1674
  /**
1675
+ * @public
1490
1676
  * <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within
1491
1677
  * <i>.zip</i> file that contains the custom code, which will be loaded on
1492
1678
  * the cluster. It must include the file name itself. For example,
@@ -1494,28 +1680,34 @@ export interface GetKxClusterResponse {
1494
1680
  */
1495
1681
  initializationScript?: string;
1496
1682
  /**
1683
+ * @public
1497
1684
  * <p>Defines key-value pairs to make them available inside the cluster.</p>
1498
1685
  */
1499
1686
  commandLineArguments?: KxCommandLineArgument[];
1500
1687
  /**
1688
+ * @public
1501
1689
  * <p>The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster. </p>
1502
1690
  */
1503
1691
  code?: CodeConfiguration;
1504
1692
  /**
1693
+ * @public
1505
1694
  * <p>
1506
1695
  * 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.
1507
1696
  * </p>
1508
1697
  */
1509
1698
  executionRole?: string;
1510
1699
  /**
1700
+ * @public
1511
1701
  * <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>
1512
1702
  */
1513
1703
  lastModifiedTimestamp?: Date;
1514
1704
  /**
1705
+ * @public
1515
1706
  * <p>The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose <code>clusterType</code> as RDB. All the data written to this storage space is lost when the cluster node is restarted.</p>
1516
1707
  */
1517
1708
  savedownStorageConfiguration?: KxSavedownStorageConfiguration;
1518
1709
  /**
1710
+ * @public
1519
1711
  * <p>The number of availability zones you want to assign per cluster. This can be one of the following </p>
1520
1712
  * <ul>
1521
1713
  * <li>
@@ -1530,12 +1722,14 @@ export interface GetKxClusterResponse {
1530
1722
  */
1531
1723
  azMode?: KxAzMode | string;
1532
1724
  /**
1725
+ * @public
1533
1726
  * <p>
1534
1727
  * The availability zone identifiers for the requested regions.
1535
1728
  * </p>
1536
1729
  */
1537
1730
  availabilityZoneId?: string;
1538
1731
  /**
1732
+ * @public
1539
1733
  * <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>
1540
1734
  */
1541
1735
  createdTimestamp?: Date;
@@ -1545,16 +1739,19 @@ export interface GetKxClusterResponse {
1545
1739
  */
1546
1740
  export interface GetKxConnectionStringRequest {
1547
1741
  /**
1742
+ * @public
1548
1743
  * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
1549
1744
  * how to use ARNs in policies, see <a href="IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
1550
1745
  * <i>IAM User Guide</i>. </p>
1551
1746
  */
1552
1747
  userArn: string | undefined;
1553
1748
  /**
1749
+ * @public
1554
1750
  * <p>A unique identifier for the kdb environment.</p>
1555
1751
  */
1556
1752
  environmentId: string | undefined;
1557
1753
  /**
1754
+ * @public
1558
1755
  * <p>A name of the kdb cluster.</p>
1559
1756
  */
1560
1757
  clusterName: string | undefined;
@@ -1564,6 +1761,7 @@ export interface GetKxConnectionStringRequest {
1564
1761
  */
1565
1762
  export interface GetKxConnectionStringResponse {
1566
1763
  /**
1764
+ * @public
1567
1765
  * <p>The signed connection string that you can use to connect to clusters.</p>
1568
1766
  */
1569
1767
  signedConnectionString?: string;
@@ -1573,10 +1771,12 @@ export interface GetKxConnectionStringResponse {
1573
1771
  */
1574
1772
  export interface GetKxDatabaseRequest {
1575
1773
  /**
1774
+ * @public
1576
1775
  * <p>A unique identifier for the kdb environment.</p>
1577
1776
  */
1578
1777
  environmentId: string | undefined;
1579
1778
  /**
1779
+ * @public
1580
1780
  * <p>The name of the kdb database.</p>
1581
1781
  */
1582
1782
  databaseName: string | undefined;
@@ -1586,42 +1786,52 @@ export interface GetKxDatabaseRequest {
1586
1786
  */
1587
1787
  export interface GetKxDatabaseResponse {
1588
1788
  /**
1789
+ * @public
1589
1790
  * <p>The name of the kdb database for which the information is retrieved.</p>
1590
1791
  */
1591
1792
  databaseName?: string;
1592
1793
  /**
1794
+ * @public
1593
1795
  * <p>The ARN identifier of the database.</p>
1594
1796
  */
1595
1797
  databaseArn?: string;
1596
1798
  /**
1799
+ * @public
1597
1800
  * <p>A unique identifier for the kdb environment.</p>
1598
1801
  */
1599
1802
  environmentId?: string;
1600
1803
  /**
1804
+ * @public
1601
1805
  * <p>A description of the database.</p>
1602
1806
  */
1603
1807
  description?: string;
1604
1808
  /**
1809
+ * @public
1605
1810
  * <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>
1606
1811
  */
1607
1812
  createdTimestamp?: Date;
1608
1813
  /**
1814
+ * @public
1609
1815
  * <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>
1610
1816
  */
1611
1817
  lastModifiedTimestamp?: Date;
1612
1818
  /**
1819
+ * @public
1613
1820
  * <p>A unique identifier for the changeset.</p>
1614
1821
  */
1615
1822
  lastCompletedChangesetId?: string;
1616
1823
  /**
1824
+ * @public
1617
1825
  * <p>The total number of bytes in the database.</p>
1618
1826
  */
1619
1827
  numBytes?: number;
1620
1828
  /**
1829
+ * @public
1621
1830
  * <p>The total number of changesets in the database.</p>
1622
1831
  */
1623
1832
  numChangesets?: number;
1624
1833
  /**
1834
+ * @public
1625
1835
  * <p>The total number of files in the database.</p>
1626
1836
  */
1627
1837
  numFiles?: number;
@@ -1631,6 +1841,7 @@ export interface GetKxDatabaseResponse {
1631
1841
  */
1632
1842
  export interface GetKxEnvironmentRequest {
1633
1843
  /**
1844
+ * @public
1634
1845
  * <p>A unique identifier for the kdb environment.</p>
1635
1846
  */
1636
1847
  environmentId: string | undefined;
@@ -1641,10 +1852,12 @@ export interface GetKxEnvironmentRequest {
1641
1852
  */
1642
1853
  export interface CustomDNSServer {
1643
1854
  /**
1855
+ * @public
1644
1856
  * <p>The name of the DNS server.</p>
1645
1857
  */
1646
1858
  customDNSServerName: string | undefined;
1647
1859
  /**
1860
+ * @public
1648
1861
  * <p>The IP address of the DNS server.</p>
1649
1862
  */
1650
1863
  customDNSServerIP: string | undefined;
@@ -1685,10 +1898,12 @@ export type TgwStatus = (typeof TgwStatus)[keyof typeof TgwStatus];
1685
1898
  */
1686
1899
  export interface TransitGatewayConfiguration {
1687
1900
  /**
1901
+ * @public
1688
1902
  * <p>The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.</p>
1689
1903
  */
1690
1904
  transitGatewayID: string | undefined;
1691
1905
  /**
1906
+ * @public
1692
1907
  * <p>The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.</p>
1693
1908
  */
1694
1909
  routableCIDRSpace: string | undefined;
@@ -1698,70 +1913,87 @@ export interface TransitGatewayConfiguration {
1698
1913
  */
1699
1914
  export interface GetKxEnvironmentResponse {
1700
1915
  /**
1916
+ * @public
1701
1917
  * <p>The name of the kdb environment.</p>
1702
1918
  */
1703
1919
  name?: string;
1704
1920
  /**
1921
+ * @public
1705
1922
  * <p>A unique identifier for the kdb environment.</p>
1706
1923
  */
1707
1924
  environmentId?: string;
1708
1925
  /**
1926
+ * @public
1709
1927
  * <p>The unique identifier of the AWS account that is used to create the kdb environment.</p>
1710
1928
  */
1711
1929
  awsAccountId?: string;
1712
1930
  /**
1931
+ * @public
1713
1932
  * <p>The status of the kdb environment.</p>
1714
1933
  */
1715
1934
  status?: EnvironmentStatus | string;
1716
1935
  /**
1936
+ * @public
1717
1937
  * <p>The status of the network configuration.</p>
1718
1938
  */
1719
1939
  tgwStatus?: TgwStatus | string;
1720
1940
  /**
1941
+ * @public
1721
1942
  * <p>The status of DNS configuration.</p>
1722
1943
  */
1723
1944
  dnsStatus?: DnsStatus | string;
1724
1945
  /**
1946
+ * @public
1725
1947
  * <p>Specifies the error message that appears if a flow fails.</p>
1726
1948
  */
1727
1949
  errorMessage?: string;
1728
1950
  /**
1951
+ * @public
1729
1952
  * <p>A description for the kdb environment.</p>
1730
1953
  */
1731
1954
  description?: string;
1732
1955
  /**
1956
+ * @public
1733
1957
  * <p>The ARN identifier of the environment.</p>
1734
1958
  */
1735
1959
  environmentArn?: string;
1736
1960
  /**
1961
+ * @public
1737
1962
  * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
1738
1963
  */
1739
1964
  kmsKeyId?: string;
1740
1965
  /**
1966
+ * @public
1741
1967
  * <p>A unique identifier for the AWS environment infrastructure account.</p>
1742
1968
  */
1743
1969
  dedicatedServiceAccountId?: string;
1744
1970
  /**
1971
+ * @public
1745
1972
  * <p>The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.</p>
1746
1973
  */
1747
1974
  transitGatewayConfiguration?: TransitGatewayConfiguration;
1748
1975
  /**
1976
+ * @public
1749
1977
  * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
1750
1978
  */
1751
1979
  customDNSConfiguration?: CustomDNSServer[];
1752
1980
  /**
1981
+ * @public
1753
1982
  * <p>The timestamp at which the kdb environment was created in FinSpace. </p>
1754
1983
  */
1755
1984
  creationTimestamp?: Date;
1756
1985
  /**
1986
+ * @public
1757
1987
  * <p>The timestamp at which the kdb environment was updated. </p>
1758
1988
  */
1759
1989
  updateTimestamp?: Date;
1760
1990
  /**
1991
+ * @public
1761
1992
  * <p>The identifier of the availability zones where subnets for the environment are created.</p>
1762
1993
  */
1763
1994
  availabilityZoneIds?: string[];
1764
1995
  /**
1996
+ * @public
1765
1997
  * <p>The Amazon Resource Name (ARN) of the certificate authority of the
1766
1998
  * kdb environment.</p>
1767
1999
  */
@@ -1772,10 +2004,12 @@ export interface GetKxEnvironmentResponse {
1772
2004
  */
1773
2005
  export interface GetKxUserRequest {
1774
2006
  /**
2007
+ * @public
1775
2008
  * <p>A unique identifier for the user.</p>
1776
2009
  */
1777
2010
  userName: string | undefined;
1778
2011
  /**
2012
+ * @public
1779
2013
  * <p>A unique identifier for the kdb environment.</p>
1780
2014
  */
1781
2015
  environmentId: string | undefined;
@@ -1785,20 +2019,24 @@ export interface GetKxUserRequest {
1785
2019
  */
1786
2020
  export interface GetKxUserResponse {
1787
2021
  /**
2022
+ * @public
1788
2023
  * <p>A unique identifier for the user.</p>
1789
2024
  */
1790
2025
  userName?: string;
1791
2026
  /**
2027
+ * @public
1792
2028
  * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
1793
2029
  * how to use ARNs in policies, see <a href="IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
1794
2030
  * <i>IAM User Guide</i>. </p>
1795
2031
  */
1796
2032
  userArn?: string;
1797
2033
  /**
2034
+ * @public
1798
2035
  * <p>A unique identifier for the kdb environment.</p>
1799
2036
  */
1800
2037
  environmentId?: string;
1801
2038
  /**
2039
+ * @public
1802
2040
  * <p>The IAM role ARN that is associated with the user.</p>
1803
2041
  */
1804
2042
  iamRole?: string;
@@ -1808,12 +2046,14 @@ export interface GetKxUserResponse {
1808
2046
  */
1809
2047
  export interface ListEnvironmentsRequest {
1810
2048
  /**
2049
+ * @public
1811
2050
  * <p>A token generated by FinSpace that specifies where to continue pagination if a previous
1812
2051
  * request was truncated. To get the next set of pages, pass in the <code>nextToken</code>nextToken value from the
1813
2052
  * response object of the previous page call.</p>
1814
2053
  */
1815
2054
  nextToken?: string;
1816
2055
  /**
2056
+ * @public
1817
2057
  * <p>The maximum number of results to return in this request.</p>
1818
2058
  */
1819
2059
  maxResults?: number;
@@ -1823,10 +2063,12 @@ export interface ListEnvironmentsRequest {
1823
2063
  */
1824
2064
  export interface ListEnvironmentsResponse {
1825
2065
  /**
2066
+ * @public
1826
2067
  * <p>A list of all of your FinSpace environments.</p>
1827
2068
  */
1828
2069
  environments?: Environment[];
1829
2070
  /**
2071
+ * @public
1830
2072
  * <p>A token that you can use in a subsequent call to retrieve the next set of
1831
2073
  * results.</p>
1832
2074
  */
@@ -1837,18 +2079,22 @@ export interface ListEnvironmentsResponse {
1837
2079
  */
1838
2080
  export interface ListKxChangesetsRequest {
1839
2081
  /**
2082
+ * @public
1840
2083
  * <p>A unique identifier for the kdb environment.</p>
1841
2084
  */
1842
2085
  environmentId: string | undefined;
1843
2086
  /**
2087
+ * @public
1844
2088
  * <p>The name of the kdb database.</p>
1845
2089
  */
1846
2090
  databaseName: string | undefined;
1847
2091
  /**
2092
+ * @public
1848
2093
  * <p>A token that indicates where a results page should begin.</p>
1849
2094
  */
1850
2095
  nextToken?: string;
1851
2096
  /**
2097
+ * @public
1852
2098
  * <p>The maximum number of results to return in this request.</p>
1853
2099
  */
1854
2100
  maxResults?: number;
@@ -1859,25 +2105,30 @@ export interface ListKxChangesetsRequest {
1859
2105
  */
1860
2106
  export interface KxChangesetListEntry {
1861
2107
  /**
2108
+ * @public
1862
2109
  * <p>A unique identifier for the changeset.</p>
1863
2110
  */
1864
2111
  changesetId?: string;
1865
2112
  /**
2113
+ * @public
1866
2114
  * <p>The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1867
2115
  */
1868
2116
  createdTimestamp?: Date;
1869
2117
  /**
2118
+ * @public
1870
2119
  * <p>Beginning time from which the changeset is active. The value is determined as epoch time in
1871
2120
  * milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1872
2121
  * 1635768000000.</p>
1873
2122
  */
1874
2123
  activeFromTimestamp?: Date;
1875
2124
  /**
2125
+ * @public
1876
2126
  * <p>The timestamp at which the changeset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1877
2127
  * 1635768000000.</p>
1878
2128
  */
1879
2129
  lastModifiedTimestamp?: Date;
1880
2130
  /**
2131
+ * @public
1881
2132
  * <p> Status of the changeset.</p>
1882
2133
  * <ul>
1883
2134
  * <li>
@@ -1901,10 +2152,12 @@ export interface KxChangesetListEntry {
1901
2152
  */
1902
2153
  export interface ListKxChangesetsResponse {
1903
2154
  /**
2155
+ * @public
1904
2156
  * <p>A list of changesets for a database.</p>
1905
2157
  */
1906
2158
  kxChangesets?: KxChangesetListEntry[];
1907
2159
  /**
2160
+ * @public
1908
2161
  * <p>A token that indicates where a results page should begin.</p>
1909
2162
  */
1910
2163
  nextToken?: string;
@@ -1914,18 +2167,22 @@ export interface ListKxChangesetsResponse {
1914
2167
  */
1915
2168
  export interface ListKxClusterNodesRequest {
1916
2169
  /**
2170
+ * @public
1917
2171
  * <p>A unique identifier for the kdb environment.</p>
1918
2172
  */
1919
2173
  environmentId: string | undefined;
1920
2174
  /**
2175
+ * @public
1921
2176
  * <p>A unique name for the cluster.</p>
1922
2177
  */
1923
2178
  clusterName: string | undefined;
1924
2179
  /**
2180
+ * @public
1925
2181
  * <p>A token that indicates where a results page should begin.</p>
1926
2182
  */
1927
2183
  nextToken?: string;
1928
2184
  /**
2185
+ * @public
1929
2186
  * <p>The maximum number of results to return in this request.</p>
1930
2187
  */
1931
2188
  maxResults?: number;
@@ -1936,14 +2193,17 @@ export interface ListKxClusterNodesRequest {
1936
2193
  */
1937
2194
  export interface KxNode {
1938
2195
  /**
2196
+ * @public
1939
2197
  * <p>A unique identifier for the node.</p>
1940
2198
  */
1941
2199
  nodeId?: string;
1942
2200
  /**
2201
+ * @public
1943
2202
  * <p>The identifier of the availability zones where subnets for the environment are created.</p>
1944
2203
  */
1945
2204
  availabilityZoneId?: string;
1946
2205
  /**
2206
+ * @public
1947
2207
  * <p>The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1948
2208
  */
1949
2209
  launchTime?: Date;
@@ -1953,10 +2213,12 @@ export interface KxNode {
1953
2213
  */
1954
2214
  export interface ListKxClusterNodesResponse {
1955
2215
  /**
2216
+ * @public
1956
2217
  * <p>A list of nodes associated with the cluster.</p>
1957
2218
  */
1958
2219
  nodes?: KxNode[];
1959
2220
  /**
2221
+ * @public
1960
2222
  * <p>A token that indicates where a results page should begin.</p>
1961
2223
  */
1962
2224
  nextToken?: string;
@@ -1966,10 +2228,12 @@ export interface ListKxClusterNodesResponse {
1966
2228
  */
1967
2229
  export interface ListKxClustersRequest {
1968
2230
  /**
2231
+ * @public
1969
2232
  * <p>A unique identifier for the kdb environment.</p>
1970
2233
  */
1971
2234
  environmentId: string | undefined;
1972
2235
  /**
2236
+ * @public
1973
2237
  * <p>Specifies the type of KDB database that is being created. The following types are available: </p>
1974
2238
  * <ul>
1975
2239
  * <li>
@@ -1985,10 +2249,12 @@ export interface ListKxClustersRequest {
1985
2249
  */
1986
2250
  clusterType?: KxClusterType | string;
1987
2251
  /**
2252
+ * @public
1988
2253
  * <p>The maximum number of results to return in this request.</p>
1989
2254
  */
1990
2255
  maxResults?: number;
1991
2256
  /**
2257
+ * @public
1992
2258
  * <p>A token that indicates where a results page should begin.</p>
1993
2259
  */
1994
2260
  nextToken?: string;
@@ -1999,6 +2265,7 @@ export interface ListKxClustersRequest {
1999
2265
  */
2000
2266
  export interface KxCluster {
2001
2267
  /**
2268
+ * @public
2002
2269
  * <p>The status of a cluster.</p>
2003
2270
  * <ul>
2004
2271
  * <li>
@@ -2029,14 +2296,17 @@ export interface KxCluster {
2029
2296
  */
2030
2297
  status?: KxClusterStatus | string;
2031
2298
  /**
2299
+ * @public
2032
2300
  * <p>The error message when a failed state occurs. </p>
2033
2301
  */
2034
2302
  statusReason?: string;
2035
2303
  /**
2304
+ * @public
2036
2305
  * <p>A unique name for the cluster.</p>
2037
2306
  */
2038
2307
  clusterName?: string;
2039
2308
  /**
2309
+ * @public
2040
2310
  * <p>Specifies the type of KDB database that is being created. The following types are available: </p>
2041
2311
  * <ul>
2042
2312
  * <li>
@@ -2052,14 +2322,17 @@ export interface KxCluster {
2052
2322
  */
2053
2323
  clusterType?: KxClusterType | string;
2054
2324
  /**
2325
+ * @public
2055
2326
  * <p>A description of the cluster.</p>
2056
2327
  */
2057
2328
  clusterDescription?: string;
2058
2329
  /**
2330
+ * @public
2059
2331
  * <p>A version of the FinSpace managed kdb to run.</p>
2060
2332
  */
2061
2333
  releaseLabel?: string;
2062
2334
  /**
2335
+ * @public
2063
2336
  * <p>Specifies a Q program that will be run at launch of a cluster. It is a relative path within
2064
2337
  * <i>.zip</i> file that contains the custom code, which will be loaded on
2065
2338
  * the cluster. It must include the file name itself. For example,
@@ -2067,12 +2340,14 @@ export interface KxCluster {
2067
2340
  */
2068
2341
  initializationScript?: string;
2069
2342
  /**
2343
+ * @public
2070
2344
  * <p>
2071
2345
  * 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.
2072
2346
  * </p>
2073
2347
  */
2074
2348
  executionRole?: string;
2075
2349
  /**
2350
+ * @public
2076
2351
  * <p>The number of availability zones assigned per cluster. This can be one of the following </p>
2077
2352
  * <ul>
2078
2353
  * <li>
@@ -2087,16 +2362,19 @@ export interface KxCluster {
2087
2362
  */
2088
2363
  azMode?: KxAzMode | string;
2089
2364
  /**
2365
+ * @public
2090
2366
  * <p>
2091
2367
  * The availability zone identifiers for the requested regions.
2092
2368
  * </p>
2093
2369
  */
2094
2370
  availabilityZoneId?: string;
2095
2371
  /**
2372
+ * @public
2096
2373
  * <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>
2097
2374
  */
2098
2375
  lastModifiedTimestamp?: Date;
2099
2376
  /**
2377
+ * @public
2100
2378
  * <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>
2101
2379
  */
2102
2380
  createdTimestamp?: Date;
@@ -2106,10 +2384,12 @@ export interface KxCluster {
2106
2384
  */
2107
2385
  export interface ListKxClustersResponse {
2108
2386
  /**
2387
+ * @public
2109
2388
  * <p>Lists the cluster details.</p>
2110
2389
  */
2111
2390
  kxClusterSummaries?: KxCluster[];
2112
2391
  /**
2392
+ * @public
2113
2393
  * <p>A token that indicates where a results page should begin.</p>
2114
2394
  */
2115
2395
  nextToken?: string;
@@ -2119,14 +2399,17 @@ export interface ListKxClustersResponse {
2119
2399
  */
2120
2400
  export interface ListKxDatabasesRequest {
2121
2401
  /**
2402
+ * @public
2122
2403
  * <p>A unique identifier for the kdb environment.</p>
2123
2404
  */
2124
2405
  environmentId: string | undefined;
2125
2406
  /**
2407
+ * @public
2126
2408
  * <p>A token that indicates where a results page should begin.</p>
2127
2409
  */
2128
2410
  nextToken?: string;
2129
2411
  /**
2412
+ * @public
2130
2413
  * <p>The maximum number of results to return in this request.</p>
2131
2414
  */
2132
2415
  maxResults?: number;
@@ -2137,14 +2420,17 @@ export interface ListKxDatabasesRequest {
2137
2420
  */
2138
2421
  export interface KxDatabaseListEntry {
2139
2422
  /**
2423
+ * @public
2140
2424
  * <p>The name of the kdb database.</p>
2141
2425
  */
2142
2426
  databaseName?: string;
2143
2427
  /**
2428
+ * @public
2144
2429
  * <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>
2145
2430
  */
2146
2431
  createdTimestamp?: Date;
2147
2432
  /**
2433
+ * @public
2148
2434
  * <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>
2149
2435
  */
2150
2436
  lastModifiedTimestamp?: Date;
@@ -2154,10 +2440,12 @@ export interface KxDatabaseListEntry {
2154
2440
  */
2155
2441
  export interface ListKxDatabasesResponse {
2156
2442
  /**
2443
+ * @public
2157
2444
  * <p>A list of databases in the kdb environment.</p>
2158
2445
  */
2159
2446
  kxDatabases?: KxDatabaseListEntry[];
2160
2447
  /**
2448
+ * @public
2161
2449
  * <p>A token that indicates where a results page should begin.</p>
2162
2450
  */
2163
2451
  nextToken?: string;
@@ -2167,10 +2455,12 @@ export interface ListKxDatabasesResponse {
2167
2455
  */
2168
2456
  export interface ListKxEnvironmentsRequest {
2169
2457
  /**
2458
+ * @public
2170
2459
  * <p>A token that indicates where a results page should begin.</p>
2171
2460
  */
2172
2461
  nextToken?: string;
2173
2462
  /**
2463
+ * @public
2174
2464
  * <p>The maximum number of results to return in this request.</p>
2175
2465
  */
2176
2466
  maxResults?: number;
@@ -2181,18 +2471,22 @@ export interface ListKxEnvironmentsRequest {
2181
2471
  */
2182
2472
  export interface KxEnvironment {
2183
2473
  /**
2474
+ * @public
2184
2475
  * <p>The name of the kdb environment.</p>
2185
2476
  */
2186
2477
  name?: string;
2187
2478
  /**
2479
+ * @public
2188
2480
  * <p>A unique identifier for the kdb environment.</p>
2189
2481
  */
2190
2482
  environmentId?: string;
2191
2483
  /**
2484
+ * @public
2192
2485
  * <p>The unique identifier of the AWS account in which you create the kdb environment.</p>
2193
2486
  */
2194
2487
  awsAccountId?: string;
2195
2488
  /**
2489
+ * @public
2196
2490
  * <p>The status of the environment creation. </p>
2197
2491
  * <ul>
2198
2492
  * <li>
@@ -2226,54 +2520,67 @@ export interface KxEnvironment {
2226
2520
  */
2227
2521
  status?: EnvironmentStatus | string;
2228
2522
  /**
2523
+ * @public
2229
2524
  * <p>The status of the network configuration.</p>
2230
2525
  */
2231
2526
  tgwStatus?: TgwStatus | string;
2232
2527
  /**
2528
+ * @public
2233
2529
  * <p>The status of DNS configuration.</p>
2234
2530
  */
2235
2531
  dnsStatus?: DnsStatus | string;
2236
2532
  /**
2533
+ * @public
2237
2534
  * <p>Specifies the error message that appears if a flow fails. </p>
2238
2535
  */
2239
2536
  errorMessage?: string;
2240
2537
  /**
2538
+ * @public
2241
2539
  * <p>A description of the kdb environment.</p>
2242
2540
  */
2243
2541
  description?: string;
2244
2542
  /**
2543
+ * @public
2245
2544
  * <p>The Amazon Resource Name (ARN) of your kdb environment.</p>
2246
2545
  */
2247
2546
  environmentArn?: string;
2248
2547
  /**
2548
+ * @public
2249
2549
  * <p>The unique identifier of the KMS key.</p>
2250
2550
  */
2251
2551
  kmsKeyId?: string;
2252
2552
  /**
2553
+ * @public
2253
2554
  * <p>A unique identifier for the AWS environment infrastructure account.</p>
2254
2555
  */
2255
2556
  dedicatedServiceAccountId?: string;
2256
2557
  /**
2558
+ * @public
2257
2559
  * <p>Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.</p>
2258
2560
  */
2259
2561
  transitGatewayConfiguration?: TransitGatewayConfiguration;
2260
2562
  /**
2563
+ * @public
2261
2564
  * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
2262
2565
  */
2263
2566
  customDNSConfiguration?: CustomDNSServer[];
2264
2567
  /**
2568
+ * @public
2265
2569
  * <p>The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
2266
2570
  */
2267
2571
  creationTimestamp?: Date;
2268
2572
  /**
2573
+ * @public
2269
2574
  * <p>The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
2270
2575
  */
2271
2576
  updateTimestamp?: Date;
2272
2577
  /**
2578
+ * @public
2273
2579
  * <p>The identifier of the availability zones where subnets for the environment are created.</p>
2274
2580
  */
2275
2581
  availabilityZoneIds?: string[];
2276
2582
  /**
2583
+ * @public
2277
2584
  * <p>The Amazon Resource Name (ARN) of the certificate authority:</p>
2278
2585
  */
2279
2586
  certificateAuthorityArn?: string;
@@ -2283,10 +2590,12 @@ export interface KxEnvironment {
2283
2590
  */
2284
2591
  export interface ListKxEnvironmentsResponse {
2285
2592
  /**
2593
+ * @public
2286
2594
  * <p>A list of environments in an account.</p>
2287
2595
  */
2288
2596
  environments?: KxEnvironment[];
2289
2597
  /**
2598
+ * @public
2290
2599
  * <p>A token that indicates where a results page should begin.</p>
2291
2600
  */
2292
2601
  nextToken?: string;
@@ -2296,14 +2605,17 @@ export interface ListKxEnvironmentsResponse {
2296
2605
  */
2297
2606
  export interface ListKxUsersRequest {
2298
2607
  /**
2608
+ * @public
2299
2609
  * <p>A unique identifier for the kdb environment.</p>
2300
2610
  */
2301
2611
  environmentId: string | undefined;
2302
2612
  /**
2613
+ * @public
2303
2614
  * <p>A token that indicates where a results page should begin.</p>
2304
2615
  */
2305
2616
  nextToken?: string;
2306
2617
  /**
2618
+ * @public
2307
2619
  * <p>The maximum number of results to return in this request.</p>
2308
2620
  */
2309
2621
  maxResults?: number;
@@ -2314,24 +2626,29 @@ export interface ListKxUsersRequest {
2314
2626
  */
2315
2627
  export interface KxUser {
2316
2628
  /**
2629
+ * @public
2317
2630
  * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
2318
2631
  * how to use ARNs in policies, see <a href="IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
2319
2632
  * <i>IAM User Guide</i>. </p>
2320
2633
  */
2321
2634
  userArn?: string;
2322
2635
  /**
2636
+ * @public
2323
2637
  * <p>A unique identifier for the user.</p>
2324
2638
  */
2325
2639
  userName?: string;
2326
2640
  /**
2641
+ * @public
2327
2642
  * <p>The IAM role ARN that is associated with the user.</p>
2328
2643
  */
2329
2644
  iamRole?: string;
2330
2645
  /**
2646
+ * @public
2331
2647
  * <p>The timestamp at which the kdb user was created. </p>
2332
2648
  */
2333
2649
  createTimestamp?: Date;
2334
2650
  /**
2651
+ * @public
2335
2652
  * <p>The timestamp at which the kdb user was updated. </p>
2336
2653
  */
2337
2654
  updateTimestamp?: Date;
@@ -2341,10 +2658,12 @@ export interface KxUser {
2341
2658
  */
2342
2659
  export interface ListKxUsersResponse {
2343
2660
  /**
2661
+ * @public
2344
2662
  * <p>A list of users in a kdb environment.</p>
2345
2663
  */
2346
2664
  users?: KxUser[];
2347
2665
  /**
2666
+ * @public
2348
2667
  * <p>A token that indicates where a results page should begin.</p>
2349
2668
  */
2350
2669
  nextToken?: string;
@@ -2366,6 +2685,7 @@ export declare class InvalidRequestException extends __BaseException {
2366
2685
  */
2367
2686
  export interface ListTagsForResourceRequest {
2368
2687
  /**
2688
+ * @public
2369
2689
  * <p>The Amazon Resource Name of the resource.</p>
2370
2690
  */
2371
2691
  resourceArn: string | undefined;
@@ -2375,6 +2695,7 @@ export interface ListTagsForResourceRequest {
2375
2695
  */
2376
2696
  export interface ListTagsForResourceResponse {
2377
2697
  /**
2698
+ * @public
2378
2699
  * <p>A list of all tags for a resource.</p>
2379
2700
  */
2380
2701
  tags?: Record<string, string>;
@@ -2384,10 +2705,12 @@ export interface ListTagsForResourceResponse {
2384
2705
  */
2385
2706
  export interface TagResourceRequest {
2386
2707
  /**
2708
+ * @public
2387
2709
  * <p>The Amazon Resource Name (ARN) for the resource.</p>
2388
2710
  */
2389
2711
  resourceArn: string | undefined;
2390
2712
  /**
2713
+ * @public
2391
2714
  * <p>One or more tags to be assigned to the resource.</p>
2392
2715
  */
2393
2716
  tags: Record<string, string> | undefined;
@@ -2402,11 +2725,13 @@ export interface TagResourceResponse {
2402
2725
  */
2403
2726
  export interface UntagResourceRequest {
2404
2727
  /**
2728
+ * @public
2405
2729
  * <p>A FinSpace resource from which you want to remove a tag or tags. The value for this
2406
2730
  * parameter is an Amazon Resource Name (ARN).</p>
2407
2731
  */
2408
2732
  resourceArn: string | undefined;
2409
2733
  /**
2734
+ * @public
2410
2735
  * <p>The tag keys (names) of one or more tags to be removed.</p>
2411
2736
  */
2412
2737
  tagKeys: string[] | undefined;
@@ -2421,18 +2746,22 @@ export interface UntagResourceResponse {
2421
2746
  */
2422
2747
  export interface UpdateEnvironmentRequest {
2423
2748
  /**
2749
+ * @public
2424
2750
  * <p>The identifier of the FinSpace environment.</p>
2425
2751
  */
2426
2752
  environmentId: string | undefined;
2427
2753
  /**
2754
+ * @public
2428
2755
  * <p>The name of the environment.</p>
2429
2756
  */
2430
2757
  name?: string;
2431
2758
  /**
2759
+ * @public
2432
2760
  * <p>The description of the environment.</p>
2433
2761
  */
2434
2762
  description?: string;
2435
2763
  /**
2764
+ * @public
2436
2765
  * <p>Authentication mode for the environment.</p>
2437
2766
  * <ul>
2438
2767
  * <li>
@@ -2447,6 +2776,7 @@ export interface UpdateEnvironmentRequest {
2447
2776
  */
2448
2777
  federationMode?: FederationMode | string;
2449
2778
  /**
2779
+ * @public
2450
2780
  * <p>Configuration information when authentication mode is FEDERATED.</p>
2451
2781
  */
2452
2782
  federationParameters?: FederationParameters;
@@ -2456,6 +2786,7 @@ export interface UpdateEnvironmentRequest {
2456
2786
  */
2457
2787
  export interface UpdateEnvironmentResponse {
2458
2788
  /**
2789
+ * @public
2459
2790
  * <p>Returns the FinSpace environment object.</p>
2460
2791
  */
2461
2792
  environment?: Environment;
@@ -2465,18 +2796,22 @@ export interface UpdateEnvironmentResponse {
2465
2796
  */
2466
2797
  export interface UpdateKxClusterDatabasesRequest {
2467
2798
  /**
2799
+ * @public
2468
2800
  * <p>The unique identifier of a kdb environment.</p>
2469
2801
  */
2470
2802
  environmentId: string | undefined;
2471
2803
  /**
2804
+ * @public
2472
2805
  * <p>A unique name for the cluster that you want to modify.</p>
2473
2806
  */
2474
2807
  clusterName: string | undefined;
2475
2808
  /**
2809
+ * @public
2476
2810
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2477
2811
  */
2478
2812
  clientToken?: string;
2479
2813
  /**
2814
+ * @public
2480
2815
  * <p> The structure of databases mounted on the cluster.</p>
2481
2816
  */
2482
2817
  databases: KxDatabaseConfiguration[] | undefined;
@@ -2491,18 +2826,22 @@ export interface UpdateKxClusterDatabasesResponse {
2491
2826
  */
2492
2827
  export interface UpdateKxDatabaseRequest {
2493
2828
  /**
2829
+ * @public
2494
2830
  * <p>A unique identifier for the kdb environment.</p>
2495
2831
  */
2496
2832
  environmentId: string | undefined;
2497
2833
  /**
2834
+ * @public
2498
2835
  * <p>The name of the kdb database.</p>
2499
2836
  */
2500
2837
  databaseName: string | undefined;
2501
2838
  /**
2839
+ * @public
2502
2840
  * <p>A description of the database.</p>
2503
2841
  */
2504
2842
  description?: string;
2505
2843
  /**
2844
+ * @public
2506
2845
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2507
2846
  */
2508
2847
  clientToken?: string;
@@ -2512,18 +2851,22 @@ export interface UpdateKxDatabaseRequest {
2512
2851
  */
2513
2852
  export interface UpdateKxDatabaseResponse {
2514
2853
  /**
2854
+ * @public
2515
2855
  * <p>The name of the kdb database.</p>
2516
2856
  */
2517
2857
  databaseName?: string;
2518
2858
  /**
2859
+ * @public
2519
2860
  * <p>A unique identifier for the kdb environment.</p>
2520
2861
  */
2521
2862
  environmentId?: string;
2522
2863
  /**
2864
+ * @public
2523
2865
  * <p>A description of the database.</p>
2524
2866
  */
2525
2867
  description?: string;
2526
2868
  /**
2869
+ * @public
2527
2870
  * <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>
2528
2871
  */
2529
2872
  lastModifiedTimestamp?: Date;
@@ -2533,18 +2876,22 @@ export interface UpdateKxDatabaseResponse {
2533
2876
  */
2534
2877
  export interface UpdateKxEnvironmentRequest {
2535
2878
  /**
2879
+ * @public
2536
2880
  * <p>A unique identifier for the kdb environment.</p>
2537
2881
  */
2538
2882
  environmentId: string | undefined;
2539
2883
  /**
2884
+ * @public
2540
2885
  * <p>The name of the kdb environment.</p>
2541
2886
  */
2542
2887
  name?: string;
2543
2888
  /**
2889
+ * @public
2544
2890
  * <p>A description of the kdb environment.</p>
2545
2891
  */
2546
2892
  description?: string;
2547
2893
  /**
2894
+ * @public
2548
2895
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2549
2896
  */
2550
2897
  clientToken?: string;
@@ -2554,66 +2901,82 @@ export interface UpdateKxEnvironmentRequest {
2554
2901
  */
2555
2902
  export interface UpdateKxEnvironmentResponse {
2556
2903
  /**
2904
+ * @public
2557
2905
  * <p>The name of the kdb environment.</p>
2558
2906
  */
2559
2907
  name?: string;
2560
2908
  /**
2909
+ * @public
2561
2910
  * <p>A unique identifier for the kdb environment.</p>
2562
2911
  */
2563
2912
  environmentId?: string;
2564
2913
  /**
2914
+ * @public
2565
2915
  * <p>The unique identifier of the AWS account that is used to create the kdb environment.</p>
2566
2916
  */
2567
2917
  awsAccountId?: string;
2568
2918
  /**
2919
+ * @public
2569
2920
  * <p>The status of the kdb environment.</p>
2570
2921
  */
2571
2922
  status?: EnvironmentStatus | string;
2572
2923
  /**
2924
+ * @public
2573
2925
  * <p>The status of the network configuration.</p>
2574
2926
  */
2575
2927
  tgwStatus?: TgwStatus | string;
2576
2928
  /**
2929
+ * @public
2577
2930
  * <p>The status of DNS configuration.</p>
2578
2931
  */
2579
2932
  dnsStatus?: DnsStatus | string;
2580
2933
  /**
2934
+ * @public
2581
2935
  * <p>Specifies the error message that appears if a flow fails.</p>
2582
2936
  */
2583
2937
  errorMessage?: string;
2584
2938
  /**
2939
+ * @public
2585
2940
  * <p>The description of the environment.</p>
2586
2941
  */
2587
2942
  description?: string;
2588
2943
  /**
2944
+ * @public
2589
2945
  * <p>The ARN identifier of the environment.</p>
2590
2946
  */
2591
2947
  environmentArn?: string;
2592
2948
  /**
2949
+ * @public
2593
2950
  * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
2594
2951
  */
2595
2952
  kmsKeyId?: string;
2596
2953
  /**
2954
+ * @public
2597
2955
  * <p>A unique identifier for the AWS environment infrastructure account.</p>
2598
2956
  */
2599
2957
  dedicatedServiceAccountId?: string;
2600
2958
  /**
2959
+ * @public
2601
2960
  * <p>The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.</p>
2602
2961
  */
2603
2962
  transitGatewayConfiguration?: TransitGatewayConfiguration;
2604
2963
  /**
2964
+ * @public
2605
2965
  * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
2606
2966
  */
2607
2967
  customDNSConfiguration?: CustomDNSServer[];
2608
2968
  /**
2969
+ * @public
2609
2970
  * <p>The timestamp at which the kdb environment was created in FinSpace. </p>
2610
2971
  */
2611
2972
  creationTimestamp?: Date;
2612
2973
  /**
2974
+ * @public
2613
2975
  * <p>The timestamp at which the kdb environment was updated. </p>
2614
2976
  */
2615
2977
  updateTimestamp?: Date;
2616
2978
  /**
2979
+ * @public
2617
2980
  * <p>The identifier of the availability zones where subnets for the environment are created.</p>
2618
2981
  */
2619
2982
  availabilityZoneIds?: string[];
@@ -2623,18 +2986,22 @@ export interface UpdateKxEnvironmentResponse {
2623
2986
  */
2624
2987
  export interface UpdateKxEnvironmentNetworkRequest {
2625
2988
  /**
2989
+ * @public
2626
2990
  * <p>A unique identifier for the kdb environment.</p>
2627
2991
  */
2628
2992
  environmentId: string | undefined;
2629
2993
  /**
2994
+ * @public
2630
2995
  * <p>Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.</p>
2631
2996
  */
2632
2997
  transitGatewayConfiguration?: TransitGatewayConfiguration;
2633
2998
  /**
2999
+ * @public
2634
3000
  * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
2635
3001
  */
2636
3002
  customDNSConfiguration?: CustomDNSServer[];
2637
3003
  /**
3004
+ * @public
2638
3005
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2639
3006
  */
2640
3007
  clientToken?: string;
@@ -2644,66 +3011,82 @@ export interface UpdateKxEnvironmentNetworkRequest {
2644
3011
  */
2645
3012
  export interface UpdateKxEnvironmentNetworkResponse {
2646
3013
  /**
3014
+ * @public
2647
3015
  * <p>The name of the kdb environment.</p>
2648
3016
  */
2649
3017
  name?: string;
2650
3018
  /**
3019
+ * @public
2651
3020
  * <p>A unique identifier for the kdb environment.</p>
2652
3021
  */
2653
3022
  environmentId?: string;
2654
3023
  /**
3024
+ * @public
2655
3025
  * <p>The unique identifier of the AWS account that is used to create the kdb environment.</p>
2656
3026
  */
2657
3027
  awsAccountId?: string;
2658
3028
  /**
3029
+ * @public
2659
3030
  * <p>The status of the kdb environment.</p>
2660
3031
  */
2661
3032
  status?: EnvironmentStatus | string;
2662
3033
  /**
3034
+ * @public
2663
3035
  * <p>The status of the network configuration.</p>
2664
3036
  */
2665
3037
  tgwStatus?: TgwStatus | string;
2666
3038
  /**
3039
+ * @public
2667
3040
  * <p>The status of DNS configuration.</p>
2668
3041
  */
2669
3042
  dnsStatus?: DnsStatus | string;
2670
3043
  /**
3044
+ * @public
2671
3045
  * <p>Specifies the error message that appears if a flow fails.</p>
2672
3046
  */
2673
3047
  errorMessage?: string;
2674
3048
  /**
3049
+ * @public
2675
3050
  * <p>The description of the environment.</p>
2676
3051
  */
2677
3052
  description?: string;
2678
3053
  /**
3054
+ * @public
2679
3055
  * <p>The ARN identifier of the environment.</p>
2680
3056
  */
2681
3057
  environmentArn?: string;
2682
3058
  /**
3059
+ * @public
2683
3060
  * <p>The KMS key ID to encrypt your data in the FinSpace environment.</p>
2684
3061
  */
2685
3062
  kmsKeyId?: string;
2686
3063
  /**
3064
+ * @public
2687
3065
  * <p>A unique identifier for the AWS environment infrastructure account.</p>
2688
3066
  */
2689
3067
  dedicatedServiceAccountId?: string;
2690
3068
  /**
3069
+ * @public
2691
3070
  * <p>The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.</p>
2692
3071
  */
2693
3072
  transitGatewayConfiguration?: TransitGatewayConfiguration;
2694
3073
  /**
3074
+ * @public
2695
3075
  * <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
2696
3076
  */
2697
3077
  customDNSConfiguration?: CustomDNSServer[];
2698
3078
  /**
3079
+ * @public
2699
3080
  * <p>The timestamp at which the kdb environment was created in FinSpace. </p>
2700
3081
  */
2701
3082
  creationTimestamp?: Date;
2702
3083
  /**
3084
+ * @public
2703
3085
  * <p>The timestamp at which the kdb environment was updated. </p>
2704
3086
  */
2705
3087
  updateTimestamp?: Date;
2706
3088
  /**
3089
+ * @public
2707
3090
  * <p>The identifier of the availability zones where subnets for the environment are created.</p>
2708
3091
  */
2709
3092
  availabilityZoneIds?: string[];
@@ -2713,18 +3096,22 @@ export interface UpdateKxEnvironmentNetworkResponse {
2713
3096
  */
2714
3097
  export interface UpdateKxUserRequest {
2715
3098
  /**
3099
+ * @public
2716
3100
  * <p>A unique identifier for the kdb environment.</p>
2717
3101
  */
2718
3102
  environmentId: string | undefined;
2719
3103
  /**
3104
+ * @public
2720
3105
  * <p>A unique identifier for the user.</p>
2721
3106
  */
2722
3107
  userName: string | undefined;
2723
3108
  /**
3109
+ * @public
2724
3110
  * <p>The IAM role ARN that is associated with the user.</p>
2725
3111
  */
2726
3112
  iamRole: string | undefined;
2727
3113
  /**
3114
+ * @public
2728
3115
  * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
2729
3116
  */
2730
3117
  clientToken?: string;
@@ -2734,20 +3121,24 @@ export interface UpdateKxUserRequest {
2734
3121
  */
2735
3122
  export interface UpdateKxUserResponse {
2736
3123
  /**
3124
+ * @public
2737
3125
  * <p>A unique identifier for the user.</p>
2738
3126
  */
2739
3127
  userName?: string;
2740
3128
  /**
3129
+ * @public
2741
3130
  * <p> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and
2742
3131
  * how to use ARNs in policies, see <a href="IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
2743
3132
  * <i>IAM User Guide</i>. </p>
2744
3133
  */
2745
3134
  userArn?: string;
2746
3135
  /**
3136
+ * @public
2747
3137
  * <p>A unique identifier for the kdb environment.</p>
2748
3138
  */
2749
3139
  environmentId?: string;
2750
3140
  /**
3141
+ * @public
2751
3142
  * <p>The IAM role ARN that is associated with the user.</p>
2752
3143
  */
2753
3144
  iamRole?: string;