aws-sdk 2.1389.0 → 2.1391.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.
@@ -19,6 +19,46 @@ declare class Finspace extends Service {
19
19
  * Create a new FinSpace environment.
20
20
  */
21
21
  createEnvironment(callback?: (err: AWSError, data: Finspace.Types.CreateEnvironmentResponse) => void): Request<Finspace.Types.CreateEnvironmentResponse, AWSError>;
22
+ /**
23
+ * Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
24
+ */
25
+ createKxChangeset(params: Finspace.Types.CreateKxChangesetRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxChangesetResponse) => void): Request<Finspace.Types.CreateKxChangesetResponse, AWSError>;
26
+ /**
27
+ * Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
28
+ */
29
+ createKxChangeset(callback?: (err: AWSError, data: Finspace.Types.CreateKxChangesetResponse) => void): Request<Finspace.Types.CreateKxChangesetResponse, AWSError>;
30
+ /**
31
+ * Creates a new kdb cluster.
32
+ */
33
+ createKxCluster(params: Finspace.Types.CreateKxClusterRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxClusterResponse) => void): Request<Finspace.Types.CreateKxClusterResponse, AWSError>;
34
+ /**
35
+ * Creates a new kdb cluster.
36
+ */
37
+ createKxCluster(callback?: (err: AWSError, data: Finspace.Types.CreateKxClusterResponse) => void): Request<Finspace.Types.CreateKxClusterResponse, AWSError>;
38
+ /**
39
+ * Creates a new kdb database in the environment.
40
+ */
41
+ createKxDatabase(params: Finspace.Types.CreateKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxDatabaseResponse) => void): Request<Finspace.Types.CreateKxDatabaseResponse, AWSError>;
42
+ /**
43
+ * Creates a new kdb database in the environment.
44
+ */
45
+ createKxDatabase(callback?: (err: AWSError, data: Finspace.Types.CreateKxDatabaseResponse) => void): Request<Finspace.Types.CreateKxDatabaseResponse, AWSError>;
46
+ /**
47
+ * Creates a managed kdb environment for the account.
48
+ */
49
+ createKxEnvironment(params: Finspace.Types.CreateKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxEnvironmentResponse) => void): Request<Finspace.Types.CreateKxEnvironmentResponse, AWSError>;
50
+ /**
51
+ * Creates a managed kdb environment for the account.
52
+ */
53
+ createKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.CreateKxEnvironmentResponse) => void): Request<Finspace.Types.CreateKxEnvironmentResponse, AWSError>;
54
+ /**
55
+ * Creates a user in FinSpace kdb environment with an associated IAM role.
56
+ */
57
+ createKxUser(params: Finspace.Types.CreateKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.CreateKxUserResponse) => void): Request<Finspace.Types.CreateKxUserResponse, AWSError>;
58
+ /**
59
+ * Creates a user in FinSpace kdb environment with an associated IAM role.
60
+ */
61
+ createKxUser(callback?: (err: AWSError, data: Finspace.Types.CreateKxUserResponse) => void): Request<Finspace.Types.CreateKxUserResponse, AWSError>;
22
62
  /**
23
63
  * Delete an FinSpace environment.
24
64
  */
@@ -27,6 +67,38 @@ declare class Finspace extends Service {
27
67
  * Delete an FinSpace environment.
28
68
  */
29
69
  deleteEnvironment(callback?: (err: AWSError, data: Finspace.Types.DeleteEnvironmentResponse) => void): Request<Finspace.Types.DeleteEnvironmentResponse, AWSError>;
70
+ /**
71
+ * Deletes a kdb cluster.
72
+ */
73
+ deleteKxCluster(params: Finspace.Types.DeleteKxClusterRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxClusterResponse) => void): Request<Finspace.Types.DeleteKxClusterResponse, AWSError>;
74
+ /**
75
+ * Deletes a kdb cluster.
76
+ */
77
+ deleteKxCluster(callback?: (err: AWSError, data: Finspace.Types.DeleteKxClusterResponse) => void): Request<Finspace.Types.DeleteKxClusterResponse, AWSError>;
78
+ /**
79
+ * Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
80
+ */
81
+ deleteKxDatabase(params: Finspace.Types.DeleteKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxDatabaseResponse) => void): Request<Finspace.Types.DeleteKxDatabaseResponse, AWSError>;
82
+ /**
83
+ * Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
84
+ */
85
+ deleteKxDatabase(callback?: (err: AWSError, data: Finspace.Types.DeleteKxDatabaseResponse) => void): Request<Finspace.Types.DeleteKxDatabaseResponse, AWSError>;
86
+ /**
87
+ * Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
88
+ */
89
+ deleteKxEnvironment(params: Finspace.Types.DeleteKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxEnvironmentResponse) => void): Request<Finspace.Types.DeleteKxEnvironmentResponse, AWSError>;
90
+ /**
91
+ * Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
92
+ */
93
+ deleteKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.DeleteKxEnvironmentResponse) => void): Request<Finspace.Types.DeleteKxEnvironmentResponse, AWSError>;
94
+ /**
95
+ * Deletes a user in the specified kdb environment.
96
+ */
97
+ deleteKxUser(params: Finspace.Types.DeleteKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.DeleteKxUserResponse) => void): Request<Finspace.Types.DeleteKxUserResponse, AWSError>;
98
+ /**
99
+ * Deletes a user in the specified kdb environment.
100
+ */
101
+ deleteKxUser(callback?: (err: AWSError, data: Finspace.Types.DeleteKxUserResponse) => void): Request<Finspace.Types.DeleteKxUserResponse, AWSError>;
30
102
  /**
31
103
  * Returns the FinSpace environment object.
32
104
  */
@@ -35,6 +107,54 @@ declare class Finspace extends Service {
35
107
  * Returns the FinSpace environment object.
36
108
  */
37
109
  getEnvironment(callback?: (err: AWSError, data: Finspace.Types.GetEnvironmentResponse) => void): Request<Finspace.Types.GetEnvironmentResponse, AWSError>;
110
+ /**
111
+ * Returns information about a kdb changeset.
112
+ */
113
+ getKxChangeset(params: Finspace.Types.GetKxChangesetRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxChangesetResponse) => void): Request<Finspace.Types.GetKxChangesetResponse, AWSError>;
114
+ /**
115
+ * Returns information about a kdb changeset.
116
+ */
117
+ getKxChangeset(callback?: (err: AWSError, data: Finspace.Types.GetKxChangesetResponse) => void): Request<Finspace.Types.GetKxChangesetResponse, AWSError>;
118
+ /**
119
+ * Retrieves information about a kdb cluster.
120
+ */
121
+ getKxCluster(params: Finspace.Types.GetKxClusterRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxClusterResponse) => void): Request<Finspace.Types.GetKxClusterResponse, AWSError>;
122
+ /**
123
+ * Retrieves information about a kdb cluster.
124
+ */
125
+ getKxCluster(callback?: (err: AWSError, data: Finspace.Types.GetKxClusterResponse) => void): Request<Finspace.Types.GetKxClusterResponse, AWSError>;
126
+ /**
127
+ * Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
128
+ */
129
+ getKxConnectionString(params: Finspace.Types.GetKxConnectionStringRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxConnectionStringResponse) => void): Request<Finspace.Types.GetKxConnectionStringResponse, AWSError>;
130
+ /**
131
+ * Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
132
+ */
133
+ getKxConnectionString(callback?: (err: AWSError, data: Finspace.Types.GetKxConnectionStringResponse) => void): Request<Finspace.Types.GetKxConnectionStringResponse, AWSError>;
134
+ /**
135
+ * Returns database information for the specified environment ID.
136
+ */
137
+ getKxDatabase(params: Finspace.Types.GetKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxDatabaseResponse) => void): Request<Finspace.Types.GetKxDatabaseResponse, AWSError>;
138
+ /**
139
+ * Returns database information for the specified environment ID.
140
+ */
141
+ getKxDatabase(callback?: (err: AWSError, data: Finspace.Types.GetKxDatabaseResponse) => void): Request<Finspace.Types.GetKxDatabaseResponse, AWSError>;
142
+ /**
143
+ * Retrieves all the information for the specified kdb environment.
144
+ */
145
+ getKxEnvironment(params: Finspace.Types.GetKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxEnvironmentResponse) => void): Request<Finspace.Types.GetKxEnvironmentResponse, AWSError>;
146
+ /**
147
+ * Retrieves all the information for the specified kdb environment.
148
+ */
149
+ getKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.GetKxEnvironmentResponse) => void): Request<Finspace.Types.GetKxEnvironmentResponse, AWSError>;
150
+ /**
151
+ * Retrieves information about the specified kdb user.
152
+ */
153
+ getKxUser(params: Finspace.Types.GetKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.GetKxUserResponse) => void): Request<Finspace.Types.GetKxUserResponse, AWSError>;
154
+ /**
155
+ * Retrieves information about the specified kdb user.
156
+ */
157
+ getKxUser(callback?: (err: AWSError, data: Finspace.Types.GetKxUserResponse) => void): Request<Finspace.Types.GetKxUserResponse, AWSError>;
38
158
  /**
39
159
  * A list of all of your FinSpace environments.
40
160
  */
@@ -43,6 +163,54 @@ declare class Finspace extends Service {
43
163
  * A list of all of your FinSpace environments.
44
164
  */
45
165
  listEnvironments(callback?: (err: AWSError, data: Finspace.Types.ListEnvironmentsResponse) => void): Request<Finspace.Types.ListEnvironmentsResponse, AWSError>;
166
+ /**
167
+ * Returns a list of all the changesets for a database.
168
+ */
169
+ listKxChangesets(params: Finspace.Types.ListKxChangesetsRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxChangesetsResponse) => void): Request<Finspace.Types.ListKxChangesetsResponse, AWSError>;
170
+ /**
171
+ * Returns a list of all the changesets for a database.
172
+ */
173
+ listKxChangesets(callback?: (err: AWSError, data: Finspace.Types.ListKxChangesetsResponse) => void): Request<Finspace.Types.ListKxChangesetsResponse, AWSError>;
174
+ /**
175
+ * Lists all the nodes in a kdb cluster.
176
+ */
177
+ listKxClusterNodes(params: Finspace.Types.ListKxClusterNodesRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxClusterNodesResponse) => void): Request<Finspace.Types.ListKxClusterNodesResponse, AWSError>;
178
+ /**
179
+ * Lists all the nodes in a kdb cluster.
180
+ */
181
+ listKxClusterNodes(callback?: (err: AWSError, data: Finspace.Types.ListKxClusterNodesResponse) => void): Request<Finspace.Types.ListKxClusterNodesResponse, AWSError>;
182
+ /**
183
+ * Returns a list of clusters.
184
+ */
185
+ listKxClusters(params: Finspace.Types.ListKxClustersRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxClustersResponse) => void): Request<Finspace.Types.ListKxClustersResponse, AWSError>;
186
+ /**
187
+ * Returns a list of clusters.
188
+ */
189
+ listKxClusters(callback?: (err: AWSError, data: Finspace.Types.ListKxClustersResponse) => void): Request<Finspace.Types.ListKxClustersResponse, AWSError>;
190
+ /**
191
+ * Returns a list of all the databases in the kdb environment.
192
+ */
193
+ listKxDatabases(params: Finspace.Types.ListKxDatabasesRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxDatabasesResponse) => void): Request<Finspace.Types.ListKxDatabasesResponse, AWSError>;
194
+ /**
195
+ * Returns a list of all the databases in the kdb environment.
196
+ */
197
+ listKxDatabases(callback?: (err: AWSError, data: Finspace.Types.ListKxDatabasesResponse) => void): Request<Finspace.Types.ListKxDatabasesResponse, AWSError>;
198
+ /**
199
+ * Returns a list of kdb environments created in an account.
200
+ */
201
+ listKxEnvironments(params: Finspace.Types.ListKxEnvironmentsRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxEnvironmentsResponse) => void): Request<Finspace.Types.ListKxEnvironmentsResponse, AWSError>;
202
+ /**
203
+ * Returns a list of kdb environments created in an account.
204
+ */
205
+ listKxEnvironments(callback?: (err: AWSError, data: Finspace.Types.ListKxEnvironmentsResponse) => void): Request<Finspace.Types.ListKxEnvironmentsResponse, AWSError>;
206
+ /**
207
+ * Lists all the users in a kdb environment.
208
+ */
209
+ listKxUsers(params: Finspace.Types.ListKxUsersRequest, callback?: (err: AWSError, data: Finspace.Types.ListKxUsersResponse) => void): Request<Finspace.Types.ListKxUsersResponse, AWSError>;
210
+ /**
211
+ * Lists all the users in a kdb environment.
212
+ */
213
+ listKxUsers(callback?: (err: AWSError, data: Finspace.Types.ListKxUsersResponse) => void): Request<Finspace.Types.ListKxUsersResponse, AWSError>;
46
214
  /**
47
215
  * A list of all tags for a resource.
48
216
  */
@@ -75,9 +243,125 @@ declare class Finspace extends Service {
75
243
  * Update your FinSpace environment.
76
244
  */
77
245
  updateEnvironment(callback?: (err: AWSError, data: Finspace.Types.UpdateEnvironmentResponse) => void): Request<Finspace.Types.UpdateEnvironmentResponse, AWSError>;
246
+ /**
247
+ * Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one. Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
248
+ */
249
+ updateKxClusterDatabases(params: Finspace.Types.UpdateKxClusterDatabasesRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxClusterDatabasesResponse) => void): Request<Finspace.Types.UpdateKxClusterDatabasesResponse, AWSError>;
250
+ /**
251
+ * Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one. Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
252
+ */
253
+ updateKxClusterDatabases(callback?: (err: AWSError, data: Finspace.Types.UpdateKxClusterDatabasesResponse) => void): Request<Finspace.Types.UpdateKxClusterDatabasesResponse, AWSError>;
254
+ /**
255
+ * Updates information for the given kdb database.
256
+ */
257
+ updateKxDatabase(params: Finspace.Types.UpdateKxDatabaseRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxDatabaseResponse) => void): Request<Finspace.Types.UpdateKxDatabaseResponse, AWSError>;
258
+ /**
259
+ * Updates information for the given kdb database.
260
+ */
261
+ updateKxDatabase(callback?: (err: AWSError, data: Finspace.Types.UpdateKxDatabaseResponse) => void): Request<Finspace.Types.UpdateKxDatabaseResponse, AWSError>;
262
+ /**
263
+ * Updates information for the given kdb environment.
264
+ */
265
+ updateKxEnvironment(params: Finspace.Types.UpdateKxEnvironmentRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentResponse, AWSError>;
266
+ /**
267
+ * Updates information for the given kdb environment.
268
+ */
269
+ updateKxEnvironment(callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentResponse, AWSError>;
270
+ /**
271
+ * Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
272
+ */
273
+ updateKxEnvironmentNetwork(params: Finspace.Types.UpdateKxEnvironmentNetworkRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentNetworkResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentNetworkResponse, AWSError>;
274
+ /**
275
+ * Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
276
+ */
277
+ updateKxEnvironmentNetwork(callback?: (err: AWSError, data: Finspace.Types.UpdateKxEnvironmentNetworkResponse) => void): Request<Finspace.Types.UpdateKxEnvironmentNetworkResponse, AWSError>;
278
+ /**
279
+ * Updates the user details. You can only update the IAM role associated with a user.
280
+ */
281
+ updateKxUser(params: Finspace.Types.UpdateKxUserRequest, callback?: (err: AWSError, data: Finspace.Types.UpdateKxUserResponse) => void): Request<Finspace.Types.UpdateKxUserResponse, AWSError>;
282
+ /**
283
+ * Updates the user details. You can only update the IAM role associated with a user.
284
+ */
285
+ updateKxUser(callback?: (err: AWSError, data: Finspace.Types.UpdateKxUserResponse) => void): Request<Finspace.Types.UpdateKxUserResponse, AWSError>;
78
286
  }
79
287
  declare namespace Finspace {
80
- export type AttributeMap = {[key: string]: url};
288
+ export type AttributeMap = {[key: string]: FederationAttributeValue};
289
+ export interface AutoScalingConfiguration {
290
+ /**
291
+ * The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
292
+ */
293
+ minNodeCount?: NodeCount;
294
+ /**
295
+ * The highest number of nodes to scale. This value cannot be greater than 5.
296
+ */
297
+ maxNodeCount?: NodeCount;
298
+ /**
299
+ * The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.
300
+ */
301
+ autoScalingMetric?: AutoScalingMetric;
302
+ /**
303
+ * The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.
304
+ */
305
+ metricTarget?: AutoScalingMetricTarget;
306
+ /**
307
+ * The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
308
+ */
309
+ scaleInCooldownSeconds?: CooldownTime;
310
+ /**
311
+ * The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
312
+ */
313
+ scaleOutCooldownSeconds?: CooldownTime;
314
+ }
315
+ export type AutoScalingMetric = "CPU_UTILIZATION_PERCENTAGE"|string;
316
+ export type AutoScalingMetricTarget = number;
317
+ export type AvailabilityZoneId = string;
318
+ export type AvailabilityZoneIds = AvailabilityZoneId[];
319
+ export type BoxedInteger = number;
320
+ export interface CapacityConfiguration {
321
+ /**
322
+ * The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance. You can only specify one of the following values: kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs. kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs. kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs. kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs. kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs. kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs. kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.
323
+ */
324
+ nodeType?: NodeType;
325
+ /**
326
+ * The number of instances running in a cluster.
327
+ */
328
+ nodeCount?: NodeCount;
329
+ }
330
+ export interface ChangeRequest {
331
+ /**
332
+ * Defines the type of change request. A changeType can have the following values: PUT – Adds or updates files in a database. DELETE – Deletes files in a database.
333
+ */
334
+ changeType: ChangeType;
335
+ /**
336
+ * Defines the S3 path of the source file that is required to add or update files in a database.
337
+ */
338
+ s3Path?: S3Path;
339
+ /**
340
+ * Defines the path within the database directory.
341
+ */
342
+ dbPath: DbPath;
343
+ }
344
+ export type ChangeRequests = ChangeRequest[];
345
+ export type ChangeType = "PUT"|"DELETE"|string;
346
+ export type ChangesetId = string;
347
+ export type ChangesetStatus = "PENDING"|"PROCESSING"|"FAILED"|"COMPLETED"|string;
348
+ export type ClientToken = string;
349
+ export type ClientTokenString = string;
350
+ export interface CodeConfiguration {
351
+ /**
352
+ * A unique name for the S3 bucket.
353
+ */
354
+ s3Bucket?: S3Bucket;
355
+ /**
356
+ * 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.
357
+ */
358
+ s3Key?: S3Key;
359
+ /**
360
+ * The version of an S3 object.
361
+ */
362
+ s3ObjectVersion?: S3ObjectVersion;
363
+ }
364
+ export type CooldownTime = number;
81
365
  export interface CreateEnvironmentRequest {
82
366
  /**
83
367
  * The name of the FinSpace environment to be created.
@@ -122,207 +406,1418 @@ declare namespace Finspace {
122
406
  */
123
407
  environmentArn?: EnvironmentArn;
124
408
  /**
125
- * The sign-in url for the web application of the FinSpace environment you created.
409
+ * The sign-in URL for the web application of the FinSpace environment you created.
126
410
  */
127
411
  environmentUrl?: url;
128
412
  }
129
- export type DataBundleArn = string;
130
- export type DataBundleArns = DataBundleArn[];
131
- export interface DeleteEnvironmentRequest {
132
- /**
133
- * The identifier for the FinSpace environment.
134
- */
135
- environmentId: IdType;
136
- }
137
- export interface DeleteEnvironmentResponse {
138
- }
139
- export type Description = string;
140
- export type EmailId = string;
141
- export interface Environment {
413
+ export interface CreateKxChangesetRequest {
142
414
  /**
143
- * The name of the FinSpace environment.
415
+ * A unique identifier of the kdb environment.
144
416
  */
145
- name?: EnvironmentName;
417
+ environmentId: EnvironmentId;
146
418
  /**
147
- * The identifier of the FinSpace environment.
419
+ * The name of the kdb database.
148
420
  */
149
- environmentId?: IdType;
421
+ databaseName: DatabaseName;
150
422
  /**
151
- * The ID of the AWS account in which the FinSpace environment is created.
423
+ * A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values: PUT – Adds or updates files in a database. DELETE – Deletes files in a database. All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type. Here is an example of how you can use the change request object: [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ] In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.
152
424
  */
153
- awsAccountId?: IdType;
425
+ changeRequests: ChangeRequests;
154
426
  /**
155
- * The current status of creation of the FinSpace environment.
427
+ * A token that ensures idempotency. This token expires in 10 minutes.
156
428
  */
157
- status?: EnvironmentStatus;
429
+ clientToken: ClientTokenString;
430
+ }
431
+ export interface CreateKxChangesetResponse {
158
432
  /**
159
- * The sign-in url for the web application of your FinSpace environment.
433
+ * A unique identifier for the changeset.
160
434
  */
161
- environmentUrl?: url;
435
+ changesetId?: ChangesetId;
162
436
  /**
163
- * The description of the FinSpace environment.
437
+ * The name of the kdb database.
164
438
  */
165
- description?: Description;
439
+ databaseName?: DatabaseName;
166
440
  /**
167
- * The Amazon Resource Name (ARN) of your FinSpace environment.
441
+ * A unique identifier for the kdb environment.
168
442
  */
169
- environmentArn?: EnvironmentArn;
443
+ environmentId?: EnvironmentId;
170
444
  /**
171
- * The url of the integrated FinSpace notebook environment in your web application.
445
+ * A list of change requests.
172
446
  */
173
- sageMakerStudioDomainUrl?: SmsDomainUrl;
447
+ changeRequests?: ChangeRequests;
174
448
  /**
175
- * The KMS key id used to encrypt in the FinSpace environment.
449
+ * 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.
176
450
  */
177
- kmsKeyId?: KmsKeyId;
451
+ createdTimestamp?: Timestamp;
178
452
  /**
179
- * The AWS account ID of the dedicated service account associated with your FinSpace environment.
453
+ * 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.
180
454
  */
181
- dedicatedServiceAccountId?: IdType;
455
+ lastModifiedTimestamp?: Timestamp;
182
456
  /**
183
- * The authentication mode for the environment.
457
+ * Status of the changeset creation process. Pending – Changeset creation is pending. Processing – Changeset creation is running. Failed – Changeset creation has failed. Complete – Changeset creation has succeeded.
184
458
  */
185
- federationMode?: FederationMode;
459
+ status?: ChangesetStatus;
186
460
  /**
187
- * Configuration information when authentication mode is FEDERATED.
461
+ * The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
188
462
  */
189
- federationParameters?: FederationParameters;
463
+ errorInfo?: ErrorInfo;
190
464
  }
191
- export type EnvironmentArn = string;
192
- export type EnvironmentList = Environment[];
193
- export type EnvironmentName = string;
194
- export type EnvironmentStatus = "CREATE_REQUESTED"|"CREATING"|"CREATED"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"FAILED_CREATION"|"RETRY_DELETION"|"FAILED_DELETION"|"SUSPENDED"|string;
195
- export type FederationAttributeKey = string;
196
- export type FederationMode = "FEDERATED"|"LOCAL"|string;
197
- export interface FederationParameters {
465
+ export interface CreateKxClusterRequest {
198
466
  /**
199
- * SAML 2.0 Metadata document from identity provider (IdP).
467
+ * A token that ensures idempotency. This token expires in 10 minutes.
200
468
  */
201
- samlMetadataDocument?: SamlMetadataDocument;
469
+ clientToken?: ClientToken;
202
470
  /**
203
- * Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
471
+ * A unique identifier for the kdb environment.
204
472
  */
205
- samlMetadataURL?: url;
473
+ environmentId: KxEnvironmentId;
206
474
  /**
207
- * The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
475
+ * A unique name for the cluster that you want to create.
208
476
  */
209
- applicationCallBackURL?: url;
477
+ clusterName: KxClusterName;
210
478
  /**
211
- * The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
479
+ * Specifies the type of KDB database that is being created. The following types are available: HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
212
480
  */
213
- federationURN?: urn;
481
+ clusterType: KxClusterType;
214
482
  /**
215
- * Name of the identity provider (IdP).
483
+ * A list of databases that will be available for querying.
216
484
  */
217
- federationProviderName?: FederationProviderName;
485
+ databases?: KxDatabaseConfigurations;
218
486
  /**
219
- * SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
487
+ * 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.
220
488
  */
221
- attributeMap?: AttributeMap;
222
- }
223
- export type FederationProviderName = string;
224
- export interface GetEnvironmentRequest {
489
+ cacheStorageConfigurations?: KxCacheStorageConfigurations;
225
490
  /**
226
- * The identifier of the FinSpace environment.
491
+ * The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
227
492
  */
228
- environmentId: IdType;
229
- }
230
- export interface GetEnvironmentResponse {
493
+ autoScalingConfiguration?: AutoScalingConfiguration;
231
494
  /**
232
- * The name of the FinSpace environment.
495
+ * A description of the cluster.
233
496
  */
234
- environment?: Environment;
235
- }
236
- export type IdType = string;
237
- export type KmsKeyId = string;
238
- export interface ListEnvironmentsRequest {
497
+ clusterDescription?: KxClusterDescription;
239
498
  /**
240
- * A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextToken value from the response object of the previous page call.
499
+ * 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.
241
500
  */
242
- nextToken?: PaginationToken;
501
+ capacityConfiguration: CapacityConfiguration;
243
502
  /**
244
- * The maximum number of results to return in this request.
503
+ * The version of FinSpace managed kdb to run.
245
504
  */
246
- maxResults?: ResultLimit;
247
- }
248
- export interface ListEnvironmentsResponse {
505
+ releaseLabel: ReleaseLabel;
249
506
  /**
250
- * A list of all of your FinSpace environments.
507
+ * Configuration details about the network where the Privatelink endpoint of the cluster resides.
251
508
  */
252
- environments?: EnvironmentList;
509
+ vpcConfiguration?: VpcConfiguration;
253
510
  /**
254
- * A token that you can use in a subsequent call to retrieve the next set of results.
511
+ * Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.
255
512
  */
256
- nextToken?: PaginationToken;
257
- }
258
- export interface ListTagsForResourceRequest {
513
+ initializationScript?: InitializationScriptFilePath;
259
514
  /**
260
- * The Amazon Resource Name of the resource.
515
+ * Defines the key-value pairs to make them available inside the cluster.
261
516
  */
262
- resourceArn: EnvironmentArn;
263
- }
264
- export interface ListTagsForResourceResponse {
517
+ commandLineArguments?: KxCommandLineArguments;
265
518
  /**
266
- * A list of all tags for a resource.
519
+ * 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.
267
520
  */
268
- tags?: TagMap;
269
- }
270
- export type NameString = string;
271
- export type PaginationToken = string;
272
- export type ResultLimit = number;
273
- export type SamlMetadataDocument = string;
274
- export type SmsDomainUrl = string;
275
- export interface SuperuserParameters {
521
+ code?: CodeConfiguration;
276
522
  /**
277
- * The email address of the superuser.
523
+ * 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.
278
524
  */
279
- emailAddress: EmailId;
525
+ executionRole?: ExecutionRoleArn;
280
526
  /**
281
- * The first name of the superuser.
527
+ * The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
282
528
  */
283
- firstName: NameString;
529
+ savedownStorageConfiguration?: KxSavedownStorageConfiguration;
284
530
  /**
285
- * The last name of the superuser.
531
+ * The number of availability zones you want to assign per cluster. This can be one of the following SINGLE – Assigns one availability zone per cluster. MULTI – Assigns all the availability zones per cluster.
286
532
  */
287
- lastName: NameString;
288
- }
289
- export type TagKey = string;
290
- export type TagKeyList = TagKey[];
291
- export type TagMap = {[key: string]: TagValue};
292
- export interface TagResourceRequest {
533
+ azMode: KxAzMode;
293
534
  /**
294
- * The Amazon Resource Name (ARN) for the resource.
535
+ * The availability zone identifiers for the requested regions.
295
536
  */
296
- resourceArn: EnvironmentArn;
537
+ availabilityZoneId?: AvailabilityZoneId;
297
538
  /**
298
- * One or more tags to be assigned to the resource.
539
+ * A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
299
540
  */
300
- tags: TagMap;
301
- }
302
- export interface TagResourceResponse {
541
+ tags?: TagMap;
303
542
  }
304
- export type TagValue = string;
305
- export interface UntagResourceRequest {
543
+ export interface CreateKxClusterResponse {
306
544
  /**
307
- * A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
545
+ * A unique identifier for the kdb environment.
308
546
  */
309
- resourceArn: EnvironmentArn;
547
+ environmentId?: KxEnvironmentId;
310
548
  /**
311
- * The tag keys (names) of one or more tags to be removed.
549
+ * The status of cluster creation. PENDING – The cluster is pending creation. CREATING – The cluster creation process is in progress. CREATE_FAILED – The cluster creation process has failed. RUNNING – The cluster creation process is running. UPDATING – The cluster is in the process of being updated. DELETING The cluster is in the process of being deleted. DELETED – The cluster has been deleted. DELETE_FAILED – The cluster failed to delete.
312
550
  */
313
- tagKeys: TagKeyList;
314
- }
315
- export interface UntagResourceResponse {
316
- }
317
- export interface UpdateEnvironmentRequest {
551
+ status?: KxClusterStatus;
318
552
  /**
319
- * The identifier of the FinSpace environment.
553
+ * The error message when a failed state occurs.
320
554
  */
321
- environmentId: IdType;
555
+ statusReason?: KxClusterStatusReason;
322
556
  /**
323
- * The name of the environment.
557
+ * A unique name for the cluster.
324
558
  */
325
- name?: EnvironmentName;
559
+ clusterName?: KxClusterName;
560
+ /**
561
+ * Specifies the type of KDB database that is being created. The following types are available: HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
562
+ */
563
+ clusterType?: KxClusterType;
564
+ /**
565
+ * A list of databases that will be available for querying.
566
+ */
567
+ databases?: KxDatabaseConfigurations;
568
+ /**
569
+ * 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.
570
+ */
571
+ cacheStorageConfigurations?: KxCacheStorageConfigurations;
572
+ /**
573
+ * The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
574
+ */
575
+ autoScalingConfiguration?: AutoScalingConfiguration;
576
+ /**
577
+ * A description of the cluster.
578
+ */
579
+ clusterDescription?: KxClusterDescription;
580
+ /**
581
+ * 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.
582
+ */
583
+ capacityConfiguration?: CapacityConfiguration;
584
+ /**
585
+ * A version of the FinSpace managed kdb to run.
586
+ */
587
+ releaseLabel?: ReleaseLabel;
588
+ /**
589
+ * Configuration details about the network where the Privatelink endpoint of the cluster resides.
590
+ */
591
+ vpcConfiguration?: VpcConfiguration;
592
+ /**
593
+ * Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.
594
+ */
595
+ initializationScript?: InitializationScriptFilePath;
596
+ /**
597
+ * Defines the key-value pairs to make them available inside the cluster.
598
+ */
599
+ commandLineArguments?: KxCommandLineArguments;
600
+ /**
601
+ * 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.
602
+ */
603
+ code?: CodeConfiguration;
604
+ /**
605
+ * 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.
606
+ */
607
+ executionRole?: ExecutionRoleArn;
608
+ /**
609
+ * 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.
610
+ */
611
+ lastModifiedTimestamp?: Timestamp;
612
+ /**
613
+ * The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
614
+ */
615
+ savedownStorageConfiguration?: KxSavedownStorageConfiguration;
616
+ /**
617
+ * The number of availability zones you want to assign per cluster. This can be one of the following SINGLE – Assigns one availability zone per cluster. MULTI – Assigns all the availability zones per cluster.
618
+ */
619
+ azMode?: KxAzMode;
620
+ /**
621
+ * The availability zone identifiers for the requested regions.
622
+ */
623
+ availabilityZoneId?: AvailabilityZoneId;
624
+ /**
625
+ * 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.
626
+ */
627
+ createdTimestamp?: Timestamp;
628
+ }
629
+ export interface CreateKxDatabaseRequest {
630
+ /**
631
+ * A unique identifier for the kdb environment.
632
+ */
633
+ environmentId: EnvironmentId;
634
+ /**
635
+ * The name of the kdb database.
636
+ */
637
+ databaseName: DatabaseName;
638
+ /**
639
+ * A description of the database.
640
+ */
641
+ description?: Description;
642
+ /**
643
+ * A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
644
+ */
645
+ tags?: TagMap;
646
+ /**
647
+ * A token that ensures idempotency. This token expires in 10 minutes.
648
+ */
649
+ clientToken: ClientTokenString;
650
+ }
651
+ export interface CreateKxDatabaseResponse {
652
+ /**
653
+ * The name of the kdb database.
654
+ */
655
+ databaseName?: DatabaseName;
656
+ /**
657
+ * The ARN identifier of the database.
658
+ */
659
+ databaseArn?: DatabaseArn;
660
+ /**
661
+ * A unique identifier for the kdb environment.
662
+ */
663
+ environmentId?: EnvironmentId;
664
+ /**
665
+ * A description of the database.
666
+ */
667
+ description?: Description;
668
+ /**
669
+ * 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.
670
+ */
671
+ createdTimestamp?: Timestamp;
672
+ /**
673
+ * 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.
674
+ */
675
+ lastModifiedTimestamp?: Timestamp;
676
+ }
677
+ export interface CreateKxEnvironmentRequest {
678
+ /**
679
+ * The name of the kdb environment that you want to create.
680
+ */
681
+ name: KxEnvironmentName;
682
+ /**
683
+ * A description for the kdb environment.
684
+ */
685
+ description?: Description;
686
+ /**
687
+ * The KMS key ID to encrypt your data in the FinSpace environment.
688
+ */
689
+ kmsKeyId: KmsKeyARN;
690
+ /**
691
+ * A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
692
+ */
693
+ tags?: TagMap;
694
+ /**
695
+ * A token that ensures idempotency. This token expires in 10 minutes.
696
+ */
697
+ clientToken?: ClientToken;
698
+ }
699
+ export interface CreateKxEnvironmentResponse {
700
+ /**
701
+ * The name of the kdb environment.
702
+ */
703
+ name?: KxEnvironmentName;
704
+ /**
705
+ * The status of the kdb environment.
706
+ */
707
+ status?: EnvironmentStatus;
708
+ /**
709
+ * A unique identifier for the kdb environment.
710
+ */
711
+ environmentId?: IdType;
712
+ /**
713
+ * A description for the kdb environment.
714
+ */
715
+ description?: Description;
716
+ /**
717
+ * The ARN identifier of the environment.
718
+ */
719
+ environmentArn?: EnvironmentArn;
720
+ /**
721
+ * The KMS key ID to encrypt your data in the FinSpace environment.
722
+ */
723
+ kmsKeyId?: KmsKeyId;
724
+ /**
725
+ * The timestamp at which the kdb environment was created in FinSpace.
726
+ */
727
+ creationTimestamp?: Timestamp;
728
+ }
729
+ export interface CreateKxUserRequest {
730
+ /**
731
+ * A unique identifier for the kdb environment where you want to create a user.
732
+ */
733
+ environmentId: IdType;
734
+ /**
735
+ * A unique identifier for the user.
736
+ */
737
+ userName: KxUserNameString;
738
+ /**
739
+ * The IAM role ARN that will be associated with the user.
740
+ */
741
+ iamRole: RoleArn;
742
+ /**
743
+ * A list of key-value pairs to label the user. You can add up to 50 tags to a user.
744
+ */
745
+ tags?: TagMap;
746
+ /**
747
+ * A token that ensures idempotency. This token expires in 10 minutes.
748
+ */
749
+ clientToken?: ClientToken;
750
+ }
751
+ export interface CreateKxUserResponse {
752
+ /**
753
+ * A unique identifier for the user.
754
+ */
755
+ userName?: KxUserNameString;
756
+ /**
757
+ * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
758
+ */
759
+ userArn?: KxUserArn;
760
+ /**
761
+ * A unique identifier for the kdb environment.
762
+ */
763
+ environmentId?: IdType;
764
+ /**
765
+ * The IAM role ARN that will be associated with the user.
766
+ */
767
+ iamRole?: RoleArn;
768
+ }
769
+ export type CustomDNSConfiguration = CustomDNSServer[];
770
+ export interface CustomDNSServer {
771
+ /**
772
+ * The name of the DNS server.
773
+ */
774
+ customDNSServerName: ValidHostname;
775
+ /**
776
+ * The IP address of the DNS server.
777
+ */
778
+ customDNSServerIP: ValidIPAddress;
779
+ }
780
+ export type DataBundleArn = string;
781
+ export type DataBundleArns = DataBundleArn[];
782
+ export type DatabaseArn = string;
783
+ export type DatabaseName = string;
784
+ export type DbPath = string;
785
+ export type DbPaths = DbPath[];
786
+ export interface DeleteEnvironmentRequest {
787
+ /**
788
+ * The identifier for the FinSpace environment.
789
+ */
790
+ environmentId: IdType;
791
+ }
792
+ export interface DeleteEnvironmentResponse {
793
+ }
794
+ export interface DeleteKxClusterRequest {
795
+ /**
796
+ * A unique identifier for the kdb environment.
797
+ */
798
+ environmentId: KxEnvironmentId;
799
+ /**
800
+ * The name of the cluster that you want to delete.
801
+ */
802
+ clusterName: KxClusterName;
803
+ /**
804
+ * A token that ensures idempotency. This token expires in 10 minutes.
805
+ */
806
+ clientToken?: ClientTokenString;
807
+ }
808
+ export interface DeleteKxClusterResponse {
809
+ }
810
+ export interface DeleteKxDatabaseRequest {
811
+ /**
812
+ * A unique identifier for the kdb environment.
813
+ */
814
+ environmentId: EnvironmentId;
815
+ /**
816
+ * The name of the kdb database that you want to delete.
817
+ */
818
+ databaseName: DatabaseName;
819
+ /**
820
+ * A token that ensures idempotency. This token expires in 10 minutes.
821
+ */
822
+ clientToken: ClientTokenString;
823
+ }
824
+ export interface DeleteKxDatabaseResponse {
825
+ }
826
+ export interface DeleteKxEnvironmentRequest {
827
+ /**
828
+ * A unique identifier for the kdb environment.
829
+ */
830
+ environmentId: IdType;
831
+ }
832
+ export interface DeleteKxEnvironmentResponse {
833
+ }
834
+ export interface DeleteKxUserRequest {
835
+ /**
836
+ * A unique identifier for the user that you want to delete.
837
+ */
838
+ userName: KxUserNameString;
839
+ /**
840
+ * A unique identifier for the kdb environment.
841
+ */
842
+ environmentId: IdType;
843
+ }
844
+ export interface DeleteKxUserResponse {
845
+ }
846
+ export type Description = string;
847
+ export type EmailId = string;
848
+ export interface Environment {
849
+ /**
850
+ * The name of the FinSpace environment.
851
+ */
852
+ name?: EnvironmentName;
853
+ /**
854
+ * The identifier of the FinSpace environment.
855
+ */
856
+ environmentId?: IdType;
857
+ /**
858
+ * The ID of the AWS account in which the FinSpace environment is created.
859
+ */
860
+ awsAccountId?: IdType;
861
+ /**
862
+ * The current status of creation of the FinSpace environment.
863
+ */
864
+ status?: EnvironmentStatus;
865
+ /**
866
+ * The sign-in URL for the web application of your FinSpace environment.
867
+ */
868
+ environmentUrl?: url;
869
+ /**
870
+ * The description of the FinSpace environment.
871
+ */
872
+ description?: Description;
873
+ /**
874
+ * The Amazon Resource Name (ARN) of your FinSpace environment.
875
+ */
876
+ environmentArn?: EnvironmentArn;
877
+ /**
878
+ * The URL of the integrated FinSpace notebook environment in your web application.
879
+ */
880
+ sageMakerStudioDomainUrl?: SmsDomainUrl;
881
+ /**
882
+ * The KMS key id used to encrypt in the FinSpace environment.
883
+ */
884
+ kmsKeyId?: KmsKeyId;
885
+ /**
886
+ * The AWS account ID of the dedicated service account associated with your FinSpace environment.
887
+ */
888
+ dedicatedServiceAccountId?: IdType;
889
+ /**
890
+ * The authentication mode for the environment.
891
+ */
892
+ federationMode?: FederationMode;
893
+ /**
894
+ * Configuration information when authentication mode is FEDERATED.
895
+ */
896
+ federationParameters?: FederationParameters;
897
+ }
898
+ export type EnvironmentArn = string;
899
+ export type EnvironmentErrorMessage = string;
900
+ export type EnvironmentId = string;
901
+ export type EnvironmentList = Environment[];
902
+ export type EnvironmentName = string;
903
+ export type EnvironmentStatus = "CREATE_REQUESTED"|"CREATING"|"CREATED"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"FAILED_CREATION"|"RETRY_DELETION"|"FAILED_DELETION"|"UPDATE_NETWORK_REQUESTED"|"UPDATING_NETWORK"|"FAILED_UPDATING_NETWORK"|"SUSPENDED"|string;
904
+ export type ErrorDetails = "The inputs to this request are invalid."|"Service limits have been exceeded."|"Missing required permission to perform this request."|"One or more inputs to this request were not found."|"The system temporarily lacks sufficient resources to process the request."|"An internal error has occurred."|"Cancelled"|"A user recoverable error has occurred"|string;
905
+ export interface ErrorInfo {
906
+ /**
907
+ * Specifies the error message that appears if a flow fails.
908
+ */
909
+ errorMessage?: ErrorMessage;
910
+ /**
911
+ * Specifies the type of error.
912
+ */
913
+ errorType?: ErrorDetails;
914
+ }
915
+ export type ErrorMessage = string;
916
+ export type ExecutionRoleArn = string;
917
+ export type FederationAttributeKey = string;
918
+ export type FederationAttributeValue = string;
919
+ export type FederationMode = "FEDERATED"|"LOCAL"|string;
920
+ export interface FederationParameters {
921
+ /**
922
+ * SAML 2.0 Metadata document from identity provider (IdP).
923
+ */
924
+ samlMetadataDocument?: SamlMetadataDocument;
925
+ /**
926
+ * Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
927
+ */
928
+ samlMetadataURL?: url;
929
+ /**
930
+ * The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
931
+ */
932
+ applicationCallBackURL?: url;
933
+ /**
934
+ * The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
935
+ */
936
+ federationURN?: urn;
937
+ /**
938
+ * Name of the identity provider (IdP).
939
+ */
940
+ federationProviderName?: FederationProviderName;
941
+ /**
942
+ * SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
943
+ */
944
+ attributeMap?: AttributeMap;
945
+ }
946
+ export type FederationProviderName = string;
947
+ export type FinSpaceTaggableArn = string;
948
+ export interface GetEnvironmentRequest {
949
+ /**
950
+ * The identifier of the FinSpace environment.
951
+ */
952
+ environmentId: IdType;
953
+ }
954
+ export interface GetEnvironmentResponse {
955
+ /**
956
+ * The name of the FinSpace environment.
957
+ */
958
+ environment?: Environment;
959
+ }
960
+ export interface GetKxChangesetRequest {
961
+ /**
962
+ * A unique identifier for the kdb environment.
963
+ */
964
+ environmentId: EnvironmentId;
965
+ /**
966
+ * The name of the kdb database.
967
+ */
968
+ databaseName: DatabaseName;
969
+ /**
970
+ * A unique identifier of the changeset for which you want to retrieve data.
971
+ */
972
+ changesetId: ChangesetId;
973
+ }
974
+ export interface GetKxChangesetResponse {
975
+ /**
976
+ * A unique identifier for the changeset.
977
+ */
978
+ changesetId?: ChangesetId;
979
+ /**
980
+ * The name of the kdb database.
981
+ */
982
+ databaseName?: DatabaseName;
983
+ /**
984
+ * A unique identifier for the kdb environment.
985
+ */
986
+ environmentId?: EnvironmentId;
987
+ /**
988
+ * A list of change request objects that are run in order.
989
+ */
990
+ changeRequests?: ChangeRequests;
991
+ /**
992
+ * 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.
993
+ */
994
+ createdTimestamp?: Timestamp;
995
+ /**
996
+ * Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
997
+ */
998
+ activeFromTimestamp?: Timestamp;
999
+ /**
1000
+ * 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.
1001
+ */
1002
+ lastModifiedTimestamp?: Timestamp;
1003
+ /**
1004
+ * Status of the changeset creation process. Pending – Changeset creation is pending. Processing – Changeset creation is running. Failed – Changeset creation has failed. Complete – Changeset creation has succeeded.
1005
+ */
1006
+ status?: ChangesetStatus;
1007
+ /**
1008
+ * Provides details in the event of a failed flow, including the error type and the related error message.
1009
+ */
1010
+ errorInfo?: ErrorInfo;
1011
+ }
1012
+ export interface GetKxClusterRequest {
1013
+ /**
1014
+ * A unique identifier for the kdb environment.
1015
+ */
1016
+ environmentId: KxEnvironmentId;
1017
+ /**
1018
+ * The name of the cluster that you want to retrieve.
1019
+ */
1020
+ clusterName: KxClusterName;
1021
+ }
1022
+ export interface GetKxClusterResponse {
1023
+ /**
1024
+ * The status of cluster creation. PENDING – The cluster is pending creation. CREATING – The cluster creation process is in progress. CREATE_FAILED – The cluster creation process has failed. RUNNING – The cluster creation process is running. UPDATING – The cluster is in the process of being updated. DELETING – The cluster is in the process of being deleted. DELETED – The cluster has been deleted. DELETE_FAILED – The cluster failed to delete.
1025
+ */
1026
+ status?: KxClusterStatus;
1027
+ /**
1028
+ * The error message when a failed state occurs.
1029
+ */
1030
+ statusReason?: KxClusterStatusReason;
1031
+ /**
1032
+ * A unique name for the cluster.
1033
+ */
1034
+ clusterName?: KxClusterName;
1035
+ /**
1036
+ * Specifies the type of KDB database that is being created. The following types are available: HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
1037
+ */
1038
+ clusterType?: KxClusterType;
1039
+ /**
1040
+ * A list of databases mounted on the cluster.
1041
+ */
1042
+ databases?: KxDatabaseConfigurations;
1043
+ /**
1044
+ * 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.
1045
+ */
1046
+ cacheStorageConfigurations?: KxCacheStorageConfigurations;
1047
+ /**
1048
+ * The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
1049
+ */
1050
+ autoScalingConfiguration?: AutoScalingConfiguration;
1051
+ /**
1052
+ * A description of the cluster.
1053
+ */
1054
+ clusterDescription?: KxClusterDescription;
1055
+ /**
1056
+ * 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.
1057
+ */
1058
+ capacityConfiguration?: CapacityConfiguration;
1059
+ /**
1060
+ * The version of FinSpace managed kdb to run.
1061
+ */
1062
+ releaseLabel?: ReleaseLabel;
1063
+ /**
1064
+ * Configuration details about the network where the Privatelink endpoint of the cluster resides.
1065
+ */
1066
+ vpcConfiguration?: VpcConfiguration;
1067
+ /**
1068
+ * Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.
1069
+ */
1070
+ initializationScript?: InitializationScriptFilePath;
1071
+ /**
1072
+ * Defines key-value pairs to make them available inside the cluster.
1073
+ */
1074
+ commandLineArguments?: KxCommandLineArguments;
1075
+ /**
1076
+ * 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.
1077
+ */
1078
+ code?: CodeConfiguration;
1079
+ /**
1080
+ * 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.
1081
+ */
1082
+ executionRole?: ExecutionRoleArn;
1083
+ /**
1084
+ * 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.
1085
+ */
1086
+ lastModifiedTimestamp?: Timestamp;
1087
+ /**
1088
+ * The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
1089
+ */
1090
+ savedownStorageConfiguration?: KxSavedownStorageConfiguration;
1091
+ /**
1092
+ * The number of availability zones you want to assign per cluster. This can be one of the following SINGLE – Assigns one availability zone per cluster. MULTI – Assigns all the availability zones per cluster.
1093
+ */
1094
+ azMode?: KxAzMode;
1095
+ /**
1096
+ * The availability zone identifiers for the requested regions.
1097
+ */
1098
+ availabilityZoneId?: AvailabilityZoneId;
1099
+ /**
1100
+ * 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.
1101
+ */
1102
+ createdTimestamp?: Timestamp;
1103
+ }
1104
+ export interface GetKxConnectionStringRequest {
1105
+ /**
1106
+ * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
1107
+ */
1108
+ userArn: KxUserArn;
1109
+ /**
1110
+ * A unique identifier for the kdb environment.
1111
+ */
1112
+ environmentId: IdType;
1113
+ /**
1114
+ * A name of the kdb cluster.
1115
+ */
1116
+ clusterName: KxClusterName;
1117
+ }
1118
+ export interface GetKxConnectionStringResponse {
1119
+ /**
1120
+ * The signed connection string that you can use to connect to clusters.
1121
+ */
1122
+ signedConnectionString?: SignedKxConnectionString;
1123
+ }
1124
+ export interface GetKxDatabaseRequest {
1125
+ /**
1126
+ * A unique identifier for the kdb environment.
1127
+ */
1128
+ environmentId: EnvironmentId;
1129
+ /**
1130
+ * The name of the kdb database.
1131
+ */
1132
+ databaseName: DatabaseName;
1133
+ }
1134
+ export interface GetKxDatabaseResponse {
1135
+ /**
1136
+ * The name of the kdb database for which the information is retrieved.
1137
+ */
1138
+ databaseName?: DatabaseName;
1139
+ /**
1140
+ * The ARN identifier of the database.
1141
+ */
1142
+ databaseArn?: DatabaseArn;
1143
+ /**
1144
+ * A unique identifier for the kdb environment.
1145
+ */
1146
+ environmentId?: EnvironmentId;
1147
+ /**
1148
+ * A description of the database.
1149
+ */
1150
+ description?: Description;
1151
+ /**
1152
+ * 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.
1153
+ */
1154
+ createdTimestamp?: Timestamp;
1155
+ /**
1156
+ * 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.
1157
+ */
1158
+ lastModifiedTimestamp?: Timestamp;
1159
+ /**
1160
+ * A unique identifier for the changeset.
1161
+ */
1162
+ lastCompletedChangesetId?: ChangesetId;
1163
+ /**
1164
+ * The total number of bytes in the database.
1165
+ */
1166
+ numBytes?: numBytes;
1167
+ /**
1168
+ * The total number of changesets in the database.
1169
+ */
1170
+ numChangesets?: numChangesets;
1171
+ /**
1172
+ * The total number of files in the database.
1173
+ */
1174
+ numFiles?: numFiles;
1175
+ }
1176
+ export interface GetKxEnvironmentRequest {
1177
+ /**
1178
+ * A unique identifier for the kdb environment.
1179
+ */
1180
+ environmentId: IdType;
1181
+ }
1182
+ export interface GetKxEnvironmentResponse {
1183
+ /**
1184
+ * The name of the kdb environment.
1185
+ */
1186
+ name?: KxEnvironmentName;
1187
+ /**
1188
+ * A unique identifier for the kdb environment.
1189
+ */
1190
+ environmentId?: IdType;
1191
+ /**
1192
+ * The unique identifier of the AWS account that is used to create the kdb environment.
1193
+ */
1194
+ awsAccountId?: IdType;
1195
+ /**
1196
+ * The status of the kdb environment.
1197
+ */
1198
+ status?: EnvironmentStatus;
1199
+ /**
1200
+ * The status of the network configuration.
1201
+ */
1202
+ tgwStatus?: tgwStatus;
1203
+ /**
1204
+ * The status of DNS configuration.
1205
+ */
1206
+ dnsStatus?: dnsStatus;
1207
+ /**
1208
+ * Specifies the error message that appears if a flow fails.
1209
+ */
1210
+ errorMessage?: EnvironmentErrorMessage;
1211
+ /**
1212
+ * A description for the kdb environment.
1213
+ */
1214
+ description?: Description;
1215
+ /**
1216
+ * The ARN identifier of the environment.
1217
+ */
1218
+ environmentArn?: EnvironmentArn;
1219
+ /**
1220
+ * The KMS key ID to encrypt your data in the FinSpace environment.
1221
+ */
1222
+ kmsKeyId?: KmsKeyId;
1223
+ /**
1224
+ * A unique identifier for the AWS environment infrastructure account.
1225
+ */
1226
+ dedicatedServiceAccountId?: IdType;
1227
+ transitGatewayConfiguration?: TransitGatewayConfiguration;
1228
+ /**
1229
+ * A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
1230
+ */
1231
+ customDNSConfiguration?: CustomDNSConfiguration;
1232
+ /**
1233
+ * The timestamp at which the kdb environment was created in FinSpace.
1234
+ */
1235
+ creationTimestamp?: Timestamp;
1236
+ /**
1237
+ * The timestamp at which the kdb environment was updated.
1238
+ */
1239
+ updateTimestamp?: Timestamp;
1240
+ /**
1241
+ * The identifier of the availability zones where subnets for the environment are created.
1242
+ */
1243
+ availabilityZoneIds?: AvailabilityZoneIds;
1244
+ /**
1245
+ * The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
1246
+ */
1247
+ certificateAuthorityArn?: stringValueLength1to255;
1248
+ }
1249
+ export interface GetKxUserRequest {
1250
+ /**
1251
+ * A unique identifier for the user.
1252
+ */
1253
+ userName: KxUserNameString;
1254
+ /**
1255
+ * A unique identifier for the kdb environment.
1256
+ */
1257
+ environmentId: IdType;
1258
+ }
1259
+ export interface GetKxUserResponse {
1260
+ /**
1261
+ * A unique identifier for the user.
1262
+ */
1263
+ userName?: IdType;
1264
+ /**
1265
+ * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
1266
+ */
1267
+ userArn?: KxUserArn;
1268
+ /**
1269
+ * A unique identifier for the kdb environment.
1270
+ */
1271
+ environmentId?: IdType;
1272
+ /**
1273
+ * The IAM role ARN that is associated with the user.
1274
+ */
1275
+ iamRole?: RoleArn;
1276
+ }
1277
+ export type IPAddressType = "IP_V4"|string;
1278
+ export type IdType = string;
1279
+ export type InitializationScriptFilePath = string;
1280
+ export type KmsKeyARN = string;
1281
+ export type KmsKeyId = string;
1282
+ export type KxAzMode = "SINGLE"|"MULTI"|string;
1283
+ export interface KxCacheStorageConfiguration {
1284
+ /**
1285
+ * The type of cache storage . The valid values are: CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
1286
+ */
1287
+ type: KxCacheStorageType;
1288
+ /**
1289
+ * The size of cache in Gigabytes.
1290
+ */
1291
+ size: KxCacheStorageSize;
1292
+ }
1293
+ export type KxCacheStorageConfigurations = KxCacheStorageConfiguration[];
1294
+ export type KxCacheStorageSize = number;
1295
+ export type KxCacheStorageType = string;
1296
+ export interface KxChangesetListEntry {
1297
+ /**
1298
+ * A unique identifier for the changeset.
1299
+ */
1300
+ changesetId?: ChangesetId;
1301
+ /**
1302
+ * 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.
1303
+ */
1304
+ createdTimestamp?: Timestamp;
1305
+ /**
1306
+ * Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
1307
+ */
1308
+ activeFromTimestamp?: Timestamp;
1309
+ /**
1310
+ * The timestamp at which the changeset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
1311
+ */
1312
+ lastModifiedTimestamp?: Timestamp;
1313
+ /**
1314
+ * Status of the changeset. Pending – Changeset creation is pending. Processing – Changeset creation is running. Failed – Changeset creation has failed. Complete – Changeset creation has succeeded.
1315
+ */
1316
+ status?: ChangesetStatus;
1317
+ }
1318
+ export type KxChangesets = KxChangesetListEntry[];
1319
+ export interface KxCluster {
1320
+ /**
1321
+ * The status of a cluster. PENDING – The cluster is pending creation. CREATING –The cluster creation process is in progress. CREATE_FAILED– The cluster creation process has failed. RUNNING – The cluster creation process is running. UPDATING – The cluster is in the process of being updated. DELETING – The cluster is in the process of being deleted. DELETED – The cluster has been deleted. DELETE_FAILED – The cluster failed to delete.
1322
+ */
1323
+ status?: KxClusterStatus;
1324
+ /**
1325
+ * The error message when a failed state occurs.
1326
+ */
1327
+ statusReason?: KxClusterStatusReason;
1328
+ /**
1329
+ * A unique name for the cluster.
1330
+ */
1331
+ clusterName?: KxClusterName;
1332
+ /**
1333
+ * Specifies the type of KDB database that is being created. The following types are available: HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
1334
+ */
1335
+ clusterType?: KxClusterType;
1336
+ /**
1337
+ * A description of the cluster.
1338
+ */
1339
+ clusterDescription?: KxClusterDescription;
1340
+ /**
1341
+ * A version of the FinSpace managed kdb to run.
1342
+ */
1343
+ releaseLabel?: ReleaseLabel;
1344
+ /**
1345
+ * Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.
1346
+ */
1347
+ initializationScript?: InitializationScriptFilePath;
1348
+ /**
1349
+ * 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.
1350
+ */
1351
+ executionRole?: ExecutionRoleArn;
1352
+ /**
1353
+ * The number of availability zones assigned per cluster. This can be one of the following SINGLE – Assigns one availability zone per cluster. MULTI – Assigns all the availability zones per cluster.
1354
+ */
1355
+ azMode?: KxAzMode;
1356
+ /**
1357
+ * The availability zone identifiers for the requested regions.
1358
+ */
1359
+ availabilityZoneId?: AvailabilityZoneId;
1360
+ /**
1361
+ * 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.
1362
+ */
1363
+ lastModifiedTimestamp?: Timestamp;
1364
+ /**
1365
+ * 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.
1366
+ */
1367
+ createdTimestamp?: Timestamp;
1368
+ }
1369
+ export type KxClusterDescription = string;
1370
+ export type KxClusterName = string;
1371
+ export type KxClusterNodeIdString = string;
1372
+ export type KxClusterStatus = "PENDING"|"CREATING"|"CREATE_FAILED"|"RUNNING"|"UPDATING"|"DELETING"|"DELETED"|"DELETE_FAILED"|string;
1373
+ export type KxClusterStatusReason = string;
1374
+ export type KxClusterType = "HDB"|"RDB"|"GATEWAY"|string;
1375
+ export type KxClusters = KxCluster[];
1376
+ export interface KxCommandLineArgument {
1377
+ /**
1378
+ * The name of the key.
1379
+ */
1380
+ key?: KxCommandLineArgumentKey;
1381
+ /**
1382
+ * The value of the key.
1383
+ */
1384
+ value?: KxCommandLineArgumentValue;
1385
+ }
1386
+ export type KxCommandLineArgumentKey = string;
1387
+ export type KxCommandLineArgumentValue = string;
1388
+ export type KxCommandLineArguments = KxCommandLineArgument[];
1389
+ export interface KxDatabaseCacheConfiguration {
1390
+ /**
1391
+ * The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are: CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
1392
+ */
1393
+ cacheType: KxCacheStorageType;
1394
+ /**
1395
+ * Specifies the portions of database that will be loaded into the cache for access.
1396
+ */
1397
+ dbPaths: DbPaths;
1398
+ }
1399
+ export type KxDatabaseCacheConfigurations = KxDatabaseCacheConfiguration[];
1400
+ export interface KxDatabaseConfiguration {
1401
+ /**
1402
+ * The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
1403
+ */
1404
+ databaseName: DatabaseName;
1405
+ /**
1406
+ * Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
1407
+ */
1408
+ cacheConfigurations?: KxDatabaseCacheConfigurations;
1409
+ /**
1410
+ * A unique identifier of the changeset that is associated with the cluster.
1411
+ */
1412
+ changesetId?: ChangesetId;
1413
+ }
1414
+ export type KxDatabaseConfigurations = KxDatabaseConfiguration[];
1415
+ export interface KxDatabaseListEntry {
1416
+ /**
1417
+ * The name of the kdb database.
1418
+ */
1419
+ databaseName?: DatabaseName;
1420
+ /**
1421
+ * 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.
1422
+ */
1423
+ createdTimestamp?: Timestamp;
1424
+ /**
1425
+ * 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.
1426
+ */
1427
+ lastModifiedTimestamp?: Timestamp;
1428
+ }
1429
+ export type KxDatabases = KxDatabaseListEntry[];
1430
+ export interface KxEnvironment {
1431
+ /**
1432
+ * The name of the kdb environment.
1433
+ */
1434
+ name?: KxEnvironmentName;
1435
+ /**
1436
+ * A unique identifier for the kdb environment.
1437
+ */
1438
+ environmentId?: IdType;
1439
+ /**
1440
+ * The unique identifier of the AWS account in which you create the kdb environment.
1441
+ */
1442
+ awsAccountId?: IdType;
1443
+ /**
1444
+ * The status of the environment creation. CREATE_REQUESTED – Environment creation has been requested. CREATING – Environment is in the process of being created. FAILED_CREATION – Environment creation has failed. CREATED – Environment is successfully created and is currently active. DELETE REQUESTED – Environment deletion has been requested. DELETING – Environment is in the process of being deleted. RETRY_DELETION – Initial environment deletion failed, system is reattempting delete. DELETED – Environment has been deleted. FAILED_DELETION – Environment deletion has failed.
1445
+ */
1446
+ status?: EnvironmentStatus;
1447
+ /**
1448
+ * The status of the network configuration.
1449
+ */
1450
+ tgwStatus?: tgwStatus;
1451
+ /**
1452
+ * The status of DNS configuration.
1453
+ */
1454
+ dnsStatus?: dnsStatus;
1455
+ /**
1456
+ * Specifies the error message that appears if a flow fails.
1457
+ */
1458
+ errorMessage?: EnvironmentErrorMessage;
1459
+ /**
1460
+ * A description of the kdb environment.
1461
+ */
1462
+ description?: Description;
1463
+ /**
1464
+ * The Amazon Resource Name (ARN) of your kdb environment.
1465
+ */
1466
+ environmentArn?: EnvironmentArn;
1467
+ /**
1468
+ * The unique identifier of the KMS key.
1469
+ */
1470
+ kmsKeyId?: KmsKeyId;
1471
+ /**
1472
+ * A unique identifier for the AWS environment infrastructure account.
1473
+ */
1474
+ dedicatedServiceAccountId?: IdType;
1475
+ /**
1476
+ * Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
1477
+ */
1478
+ transitGatewayConfiguration?: TransitGatewayConfiguration;
1479
+ /**
1480
+ * A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
1481
+ */
1482
+ customDNSConfiguration?: CustomDNSConfiguration;
1483
+ /**
1484
+ * 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.
1485
+ */
1486
+ creationTimestamp?: Timestamp;
1487
+ /**
1488
+ * 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.
1489
+ */
1490
+ updateTimestamp?: Timestamp;
1491
+ /**
1492
+ * The identifier of the availability zones where subnets for the environment are created.
1493
+ */
1494
+ availabilityZoneIds?: AvailabilityZoneIds;
1495
+ /**
1496
+ * The Amazon Resource Name (ARN) of the certificate authority:
1497
+ */
1498
+ certificateAuthorityArn?: stringValueLength1to255;
1499
+ }
1500
+ export type KxEnvironmentId = string;
1501
+ export type KxEnvironmentList = KxEnvironment[];
1502
+ export type KxEnvironmentName = string;
1503
+ export interface KxNode {
1504
+ /**
1505
+ * A unique identifier for the node.
1506
+ */
1507
+ nodeId?: KxClusterNodeIdString;
1508
+ /**
1509
+ * The identifier of the availability zones where subnets for the environment are created.
1510
+ */
1511
+ availabilityZoneId?: AvailabilityZoneId;
1512
+ /**
1513
+ * 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.
1514
+ */
1515
+ launchTime?: Timestamp;
1516
+ }
1517
+ export type KxNodeSummaries = KxNode[];
1518
+ export interface KxSavedownStorageConfiguration {
1519
+ /**
1520
+ * The type of writeable storage space for temporarily storing your savedown data. The valid values are: SDS01 – This type represents 3000 IOPS and io2 ebs volume type.
1521
+ */
1522
+ type: KxSavedownStorageType;
1523
+ /**
1524
+ * The size of temporary storage in bytes.
1525
+ */
1526
+ size: KxSavedownStorageSize;
1527
+ }
1528
+ export type KxSavedownStorageSize = number;
1529
+ export type KxSavedownStorageType = "SDS01"|string;
1530
+ export interface KxUser {
1531
+ /**
1532
+ * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
1533
+ */
1534
+ userArn?: KxUserArn;
1535
+ /**
1536
+ * A unique identifier for the user.
1537
+ */
1538
+ userName?: KxUserNameString;
1539
+ /**
1540
+ * The IAM role ARN that is associated with the user.
1541
+ */
1542
+ iamRole?: RoleArn;
1543
+ /**
1544
+ * The timestamp at which the kdb user was created.
1545
+ */
1546
+ createTimestamp?: Timestamp;
1547
+ /**
1548
+ * The timestamp at which the kdb user was updated.
1549
+ */
1550
+ updateTimestamp?: Timestamp;
1551
+ }
1552
+ export type KxUserArn = string;
1553
+ export type KxUserList = KxUser[];
1554
+ export type KxUserNameString = string;
1555
+ export interface ListEnvironmentsRequest {
1556
+ /**
1557
+ * A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the response object of the previous page call.
1558
+ */
1559
+ nextToken?: PaginationToken;
1560
+ /**
1561
+ * The maximum number of results to return in this request.
1562
+ */
1563
+ maxResults?: ResultLimit;
1564
+ }
1565
+ export interface ListEnvironmentsResponse {
1566
+ /**
1567
+ * A list of all of your FinSpace environments.
1568
+ */
1569
+ environments?: EnvironmentList;
1570
+ /**
1571
+ * A token that you can use in a subsequent call to retrieve the next set of results.
1572
+ */
1573
+ nextToken?: PaginationToken;
1574
+ }
1575
+ export interface ListKxChangesetsRequest {
1576
+ /**
1577
+ * A unique identifier for the kdb environment.
1578
+ */
1579
+ environmentId: EnvironmentId;
1580
+ /**
1581
+ * The name of the kdb database.
1582
+ */
1583
+ databaseName: DatabaseName;
1584
+ /**
1585
+ * A token that indicates where a results page should begin.
1586
+ */
1587
+ nextToken?: PaginationToken;
1588
+ /**
1589
+ * The maximum number of results to return in this request.
1590
+ */
1591
+ maxResults?: MaxResults;
1592
+ }
1593
+ export interface ListKxChangesetsResponse {
1594
+ /**
1595
+ * A list of changesets for a database.
1596
+ */
1597
+ kxChangesets?: KxChangesets;
1598
+ /**
1599
+ * A token that indicates where a results page should begin.
1600
+ */
1601
+ nextToken?: PaginationToken;
1602
+ }
1603
+ export interface ListKxClusterNodesRequest {
1604
+ /**
1605
+ * A unique identifier for the kdb environment.
1606
+ */
1607
+ environmentId: KxEnvironmentId;
1608
+ /**
1609
+ * A unique name for the cluster.
1610
+ */
1611
+ clusterName: KxClusterName;
1612
+ /**
1613
+ * A token that indicates where a results page should begin.
1614
+ */
1615
+ nextToken?: PaginationToken;
1616
+ /**
1617
+ * The maximum number of results to return in this request.
1618
+ */
1619
+ maxResults?: ResultLimit;
1620
+ }
1621
+ export interface ListKxClusterNodesResponse {
1622
+ /**
1623
+ * A list of nodes associated with the cluster.
1624
+ */
1625
+ nodes?: KxNodeSummaries;
1626
+ /**
1627
+ * A token that indicates where a results page should begin.
1628
+ */
1629
+ nextToken?: PaginationToken;
1630
+ }
1631
+ export interface ListKxClustersRequest {
1632
+ /**
1633
+ * A unique identifier for the kdb environment.
1634
+ */
1635
+ environmentId: KxEnvironmentId;
1636
+ /**
1637
+ * Specifies the type of KDB database that is being created. The following types are available: HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
1638
+ */
1639
+ clusterType?: KxClusterType;
1640
+ /**
1641
+ * The maximum number of results to return in this request.
1642
+ */
1643
+ maxResults?: MaxResults;
1644
+ /**
1645
+ * A token that indicates where a results page should begin.
1646
+ */
1647
+ nextToken?: PaginationToken;
1648
+ }
1649
+ export interface ListKxClustersResponse {
1650
+ /**
1651
+ * Lists the cluster details.
1652
+ */
1653
+ kxClusterSummaries?: KxClusters;
1654
+ /**
1655
+ * A token that indicates where a results page should begin.
1656
+ */
1657
+ nextToken?: PaginationToken;
1658
+ }
1659
+ export interface ListKxDatabasesRequest {
1660
+ /**
1661
+ * A unique identifier for the kdb environment.
1662
+ */
1663
+ environmentId: EnvironmentId;
1664
+ /**
1665
+ * A token that indicates where a results page should begin.
1666
+ */
1667
+ nextToken?: PaginationToken;
1668
+ /**
1669
+ * The maximum number of results to return in this request.
1670
+ */
1671
+ maxResults?: MaxResults;
1672
+ }
1673
+ export interface ListKxDatabasesResponse {
1674
+ /**
1675
+ * A list of databases in the kdb environment.
1676
+ */
1677
+ kxDatabases?: KxDatabases;
1678
+ /**
1679
+ * A token that indicates where a results page should begin.
1680
+ */
1681
+ nextToken?: PaginationToken;
1682
+ }
1683
+ export interface ListKxEnvironmentsRequest {
1684
+ /**
1685
+ * A token that indicates where a results page should begin.
1686
+ */
1687
+ nextToken?: PaginationToken;
1688
+ /**
1689
+ * The maximum number of results to return in this request.
1690
+ */
1691
+ maxResults?: BoxedInteger;
1692
+ }
1693
+ export interface ListKxEnvironmentsResponse {
1694
+ /**
1695
+ * A list of environments in an account.
1696
+ */
1697
+ environments?: KxEnvironmentList;
1698
+ /**
1699
+ * A token that indicates where a results page should begin.
1700
+ */
1701
+ nextToken?: PaginationToken;
1702
+ }
1703
+ export interface ListKxUsersRequest {
1704
+ /**
1705
+ * A unique identifier for the kdb environment.
1706
+ */
1707
+ environmentId: IdType;
1708
+ /**
1709
+ * A token that indicates where a results page should begin.
1710
+ */
1711
+ nextToken?: PaginationToken;
1712
+ /**
1713
+ * The maximum number of results to return in this request.
1714
+ */
1715
+ maxResults?: ResultLimit;
1716
+ }
1717
+ export interface ListKxUsersResponse {
1718
+ /**
1719
+ * A list of users in a kdb environment.
1720
+ */
1721
+ users?: KxUserList;
1722
+ /**
1723
+ * A token that indicates where a results page should begin.
1724
+ */
1725
+ nextToken?: PaginationToken;
1726
+ }
1727
+ export interface ListTagsForResourceRequest {
1728
+ /**
1729
+ * The Amazon Resource Name of the resource.
1730
+ */
1731
+ resourceArn: FinSpaceTaggableArn;
1732
+ }
1733
+ export interface ListTagsForResourceResponse {
1734
+ /**
1735
+ * A list of all tags for a resource.
1736
+ */
1737
+ tags?: TagMap;
1738
+ }
1739
+ export type MaxResults = number;
1740
+ export type NameString = string;
1741
+ export type NodeCount = number;
1742
+ export type NodeType = string;
1743
+ export type PaginationToken = string;
1744
+ export type ReleaseLabel = string;
1745
+ export type ResultLimit = number;
1746
+ export type RoleArn = string;
1747
+ export type S3Bucket = string;
1748
+ export type S3Key = string;
1749
+ export type S3ObjectVersion = string;
1750
+ export type S3Path = string;
1751
+ export type SamlMetadataDocument = string;
1752
+ export type SecurityGroupIdList = SecurityGroupIdString[];
1753
+ export type SecurityGroupIdString = string;
1754
+ export type SignedKxConnectionString = string;
1755
+ export type SmsDomainUrl = string;
1756
+ export type SubnetIdList = SubnetIdString[];
1757
+ export type SubnetIdString = string;
1758
+ export interface SuperuserParameters {
1759
+ /**
1760
+ * The email address of the superuser.
1761
+ */
1762
+ emailAddress: EmailId;
1763
+ /**
1764
+ * The first name of the superuser.
1765
+ */
1766
+ firstName: NameString;
1767
+ /**
1768
+ * The last name of the superuser.
1769
+ */
1770
+ lastName: NameString;
1771
+ }
1772
+ export type TagKey = string;
1773
+ export type TagKeyList = TagKey[];
1774
+ export type TagMap = {[key: string]: TagValue};
1775
+ export interface TagResourceRequest {
1776
+ /**
1777
+ * The Amazon Resource Name (ARN) for the resource.
1778
+ */
1779
+ resourceArn: FinSpaceTaggableArn;
1780
+ /**
1781
+ * One or more tags to be assigned to the resource.
1782
+ */
1783
+ tags: TagMap;
1784
+ }
1785
+ export interface TagResourceResponse {
1786
+ }
1787
+ export type TagValue = string;
1788
+ export type Timestamp = Date;
1789
+ export interface TransitGatewayConfiguration {
1790
+ /**
1791
+ * The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
1792
+ */
1793
+ transitGatewayID: TransitGatewayID;
1794
+ /**
1795
+ * 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.
1796
+ */
1797
+ routableCIDRSpace: ValidCIDRSpace;
1798
+ }
1799
+ export type TransitGatewayID = string;
1800
+ export interface UntagResourceRequest {
1801
+ /**
1802
+ * A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
1803
+ */
1804
+ resourceArn: FinSpaceTaggableArn;
1805
+ /**
1806
+ * The tag keys (names) of one or more tags to be removed.
1807
+ */
1808
+ tagKeys: TagKeyList;
1809
+ }
1810
+ export interface UntagResourceResponse {
1811
+ }
1812
+ export interface UpdateEnvironmentRequest {
1813
+ /**
1814
+ * The identifier of the FinSpace environment.
1815
+ */
1816
+ environmentId: IdType;
1817
+ /**
1818
+ * The name of the environment.
1819
+ */
1820
+ name?: EnvironmentName;
326
1821
  /**
327
1822
  * The description of the environment.
328
1823
  */
@@ -339,6 +1834,288 @@ declare namespace Finspace {
339
1834
  */
340
1835
  environment?: Environment;
341
1836
  }
1837
+ export interface UpdateKxClusterDatabasesRequest {
1838
+ /**
1839
+ * The unique identifier of a kdb environment.
1840
+ */
1841
+ environmentId: KxEnvironmentId;
1842
+ /**
1843
+ * A unique name for the cluster that you want to modify.
1844
+ */
1845
+ clusterName: KxClusterName;
1846
+ /**
1847
+ * A token that ensures idempotency. This token expires in 10 minutes.
1848
+ */
1849
+ clientToken?: ClientTokenString;
1850
+ /**
1851
+ * The structure of databases mounted on the cluster.
1852
+ */
1853
+ databases: KxDatabaseConfigurations;
1854
+ }
1855
+ export interface UpdateKxClusterDatabasesResponse {
1856
+ }
1857
+ export interface UpdateKxDatabaseRequest {
1858
+ /**
1859
+ * A unique identifier for the kdb environment.
1860
+ */
1861
+ environmentId: EnvironmentId;
1862
+ /**
1863
+ * The name of the kdb database.
1864
+ */
1865
+ databaseName: DatabaseName;
1866
+ /**
1867
+ * A description of the database.
1868
+ */
1869
+ description?: Description;
1870
+ /**
1871
+ * A token that ensures idempotency. This token expires in 10 minutes.
1872
+ */
1873
+ clientToken: ClientTokenString;
1874
+ }
1875
+ export interface UpdateKxDatabaseResponse {
1876
+ /**
1877
+ * The name of the kdb database.
1878
+ */
1879
+ databaseName?: DatabaseName;
1880
+ /**
1881
+ * A unique identifier for the kdb environment.
1882
+ */
1883
+ environmentId?: EnvironmentId;
1884
+ /**
1885
+ * A description of the database.
1886
+ */
1887
+ description?: Description;
1888
+ /**
1889
+ * 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.
1890
+ */
1891
+ lastModifiedTimestamp?: Timestamp;
1892
+ }
1893
+ export interface UpdateKxEnvironmentNetworkRequest {
1894
+ /**
1895
+ * A unique identifier for the kdb environment.
1896
+ */
1897
+ environmentId: IdType;
1898
+ /**
1899
+ * Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
1900
+ */
1901
+ transitGatewayConfiguration?: TransitGatewayConfiguration;
1902
+ /**
1903
+ * A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
1904
+ */
1905
+ customDNSConfiguration?: CustomDNSConfiguration;
1906
+ /**
1907
+ * A token that ensures idempotency. This token expires in 10 minutes.
1908
+ */
1909
+ clientToken?: ClientToken;
1910
+ }
1911
+ export interface UpdateKxEnvironmentNetworkResponse {
1912
+ /**
1913
+ * The name of the kdb environment.
1914
+ */
1915
+ name?: KxEnvironmentName;
1916
+ /**
1917
+ * A unique identifier for the kdb environment.
1918
+ */
1919
+ environmentId?: IdType;
1920
+ /**
1921
+ * The unique identifier of the AWS account that is used to create the kdb environment.
1922
+ */
1923
+ awsAccountId?: IdType;
1924
+ /**
1925
+ * The status of the kdb environment.
1926
+ */
1927
+ status?: EnvironmentStatus;
1928
+ /**
1929
+ * The status of the network configuration.
1930
+ */
1931
+ tgwStatus?: tgwStatus;
1932
+ /**
1933
+ * The status of DNS configuration.
1934
+ */
1935
+ dnsStatus?: dnsStatus;
1936
+ /**
1937
+ * Specifies the error message that appears if a flow fails.
1938
+ */
1939
+ errorMessage?: EnvironmentErrorMessage;
1940
+ /**
1941
+ * The description of the environment.
1942
+ */
1943
+ description?: Description;
1944
+ /**
1945
+ * The ARN identifier of the environment.
1946
+ */
1947
+ environmentArn?: EnvironmentArn;
1948
+ /**
1949
+ * The KMS key ID to encrypt your data in the FinSpace environment.
1950
+ */
1951
+ kmsKeyId?: KmsKeyId;
1952
+ /**
1953
+ * A unique identifier for the AWS environment infrastructure account.
1954
+ */
1955
+ dedicatedServiceAccountId?: IdType;
1956
+ transitGatewayConfiguration?: TransitGatewayConfiguration;
1957
+ /**
1958
+ * A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
1959
+ */
1960
+ customDNSConfiguration?: CustomDNSConfiguration;
1961
+ /**
1962
+ * The timestamp at which the kdb environment was created in FinSpace.
1963
+ */
1964
+ creationTimestamp?: Timestamp;
1965
+ /**
1966
+ * The timestamp at which the kdb environment was updated.
1967
+ */
1968
+ updateTimestamp?: Timestamp;
1969
+ /**
1970
+ * The identifier of the availability zones where subnets for the environment are created.
1971
+ */
1972
+ availabilityZoneIds?: AvailabilityZoneIds;
1973
+ }
1974
+ export interface UpdateKxEnvironmentRequest {
1975
+ /**
1976
+ * A unique identifier for the kdb environment.
1977
+ */
1978
+ environmentId: IdType;
1979
+ /**
1980
+ * The name of the kdb environment.
1981
+ */
1982
+ name?: KxEnvironmentName;
1983
+ /**
1984
+ * A description of the kdb environment.
1985
+ */
1986
+ description?: Description;
1987
+ /**
1988
+ * A token that ensures idempotency. This token expires in 10 minutes.
1989
+ */
1990
+ clientToken?: ClientToken;
1991
+ }
1992
+ export interface UpdateKxEnvironmentResponse {
1993
+ /**
1994
+ * The name of the kdb environment.
1995
+ */
1996
+ name?: KxEnvironmentName;
1997
+ /**
1998
+ * A unique identifier for the kdb environment.
1999
+ */
2000
+ environmentId?: IdType;
2001
+ /**
2002
+ * The unique identifier of the AWS account that is used to create the kdb environment.
2003
+ */
2004
+ awsAccountId?: IdType;
2005
+ /**
2006
+ * The status of the kdb environment.
2007
+ */
2008
+ status?: EnvironmentStatus;
2009
+ /**
2010
+ * The status of the network configuration.
2011
+ */
2012
+ tgwStatus?: tgwStatus;
2013
+ /**
2014
+ * The status of DNS configuration.
2015
+ */
2016
+ dnsStatus?: dnsStatus;
2017
+ /**
2018
+ * Specifies the error message that appears if a flow fails.
2019
+ */
2020
+ errorMessage?: EnvironmentErrorMessage;
2021
+ /**
2022
+ * The description of the environment.
2023
+ */
2024
+ description?: Description;
2025
+ /**
2026
+ * The ARN identifier of the environment.
2027
+ */
2028
+ environmentArn?: EnvironmentArn;
2029
+ /**
2030
+ * The KMS key ID to encrypt your data in the FinSpace environment.
2031
+ */
2032
+ kmsKeyId?: KmsKeyId;
2033
+ /**
2034
+ * A unique identifier for the AWS environment infrastructure account.
2035
+ */
2036
+ dedicatedServiceAccountId?: IdType;
2037
+ transitGatewayConfiguration?: TransitGatewayConfiguration;
2038
+ /**
2039
+ * A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
2040
+ */
2041
+ customDNSConfiguration?: CustomDNSConfiguration;
2042
+ /**
2043
+ * The timestamp at which the kdb environment was created in FinSpace.
2044
+ */
2045
+ creationTimestamp?: Timestamp;
2046
+ /**
2047
+ * The timestamp at which the kdb environment was updated.
2048
+ */
2049
+ updateTimestamp?: Timestamp;
2050
+ /**
2051
+ * The identifier of the availability zones where subnets for the environment are created.
2052
+ */
2053
+ availabilityZoneIds?: AvailabilityZoneIds;
2054
+ }
2055
+ export interface UpdateKxUserRequest {
2056
+ /**
2057
+ * A unique identifier for the kdb environment.
2058
+ */
2059
+ environmentId: IdType;
2060
+ /**
2061
+ * A unique identifier for the user.
2062
+ */
2063
+ userName: KxUserNameString;
2064
+ /**
2065
+ * The IAM role ARN that is associated with the user.
2066
+ */
2067
+ iamRole: RoleArn;
2068
+ /**
2069
+ * A token that ensures idempotency. This token expires in 10 minutes.
2070
+ */
2071
+ clientToken?: ClientToken;
2072
+ }
2073
+ export interface UpdateKxUserResponse {
2074
+ /**
2075
+ * A unique identifier for the user.
2076
+ */
2077
+ userName?: KxUserNameString;
2078
+ /**
2079
+ * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
2080
+ */
2081
+ userArn?: KxUserArn;
2082
+ /**
2083
+ * A unique identifier for the kdb environment.
2084
+ */
2085
+ environmentId?: IdType;
2086
+ /**
2087
+ * The IAM role ARN that is associated with the user.
2088
+ */
2089
+ iamRole?: RoleArn;
2090
+ }
2091
+ export type ValidCIDRSpace = string;
2092
+ export type ValidHostname = string;
2093
+ export type ValidIPAddress = string;
2094
+ export interface VpcConfiguration {
2095
+ /**
2096
+ * The identifier of the VPC endpoint.
2097
+ */
2098
+ vpcId?: VpcIdString;
2099
+ /**
2100
+ * The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
2101
+ */
2102
+ securityGroupIds?: SecurityGroupIdList;
2103
+ /**
2104
+ * The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
2105
+ */
2106
+ subnetIds?: SubnetIdList;
2107
+ /**
2108
+ * The IP address type for cluster network configuration parameters. The following type is available: IP_V4 – IP address version 4
2109
+ */
2110
+ ipAddressType?: IPAddressType;
2111
+ }
2112
+ export type VpcIdString = string;
2113
+ export type dnsStatus = "NONE"|"UPDATE_REQUESTED"|"UPDATING"|"FAILED_UPDATE"|"SUCCESSFULLY_UPDATED"|string;
2114
+ export type numBytes = number;
2115
+ export type numChangesets = number;
2116
+ export type numFiles = number;
2117
+ export type stringValueLength1to255 = string;
2118
+ export type tgwStatus = "NONE"|"UPDATE_REQUESTED"|"UPDATING"|"FAILED_UPDATE"|"SUCCESSFULLY_UPDATED"|string;
342
2119
  export type url = string;
343
2120
  export type urn = string;
344
2121
  /**