@aws-sdk/client-finspace-data 3.40.0 → 3.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +1 -1
  3. package/dist-cjs/FinspaceData.js +165 -0
  4. package/dist-cjs/commands/CreateDataViewCommand.js +36 -0
  5. package/dist-cjs/commands/CreateDatasetCommand.js +36 -0
  6. package/dist-cjs/commands/DeleteDatasetCommand.js +36 -0
  7. package/dist-cjs/commands/GetChangesetCommand.js +36 -0
  8. package/dist-cjs/commands/GetDataViewCommand.js +36 -0
  9. package/dist-cjs/commands/GetDatasetCommand.js +36 -0
  10. package/dist-cjs/commands/ListChangesetsCommand.js +36 -0
  11. package/dist-cjs/commands/ListDataViewsCommand.js +36 -0
  12. package/dist-cjs/commands/ListDatasetsCommand.js +36 -0
  13. package/dist-cjs/commands/UpdateChangesetCommand.js +36 -0
  14. package/dist-cjs/commands/UpdateDatasetCommand.js +36 -0
  15. package/dist-cjs/commands/index.js +11 -0
  16. package/dist-cjs/endpoints.js +9 -0
  17. package/dist-cjs/index.js +1 -0
  18. package/dist-cjs/models/models_0.js +280 -43
  19. package/dist-cjs/pagination/Interfaces.js +2 -0
  20. package/dist-cjs/pagination/ListChangesetsPaginator.js +35 -0
  21. package/dist-cjs/pagination/ListDataViewsPaginator.js +35 -0
  22. package/dist-cjs/pagination/ListDatasetsPaginator.js +35 -0
  23. package/dist-cjs/pagination/index.js +7 -0
  24. package/dist-cjs/protocols/Aws_restJson1.js +1912 -60
  25. package/dist-es/FinspaceData.js +165 -0
  26. package/dist-es/commands/CreateDataViewCommand.js +39 -0
  27. package/dist-es/commands/CreateDatasetCommand.js +39 -0
  28. package/dist-es/commands/DeleteDatasetCommand.js +39 -0
  29. package/dist-es/commands/GetChangesetCommand.js +39 -0
  30. package/dist-es/commands/GetDataViewCommand.js +39 -0
  31. package/dist-es/commands/GetDatasetCommand.js +39 -0
  32. package/dist-es/commands/ListChangesetsCommand.js +39 -0
  33. package/dist-es/commands/ListDataViewsCommand.js +39 -0
  34. package/dist-es/commands/ListDatasetsCommand.js +39 -0
  35. package/dist-es/commands/UpdateChangesetCommand.js +39 -0
  36. package/dist-es/commands/UpdateDatasetCommand.js +39 -0
  37. package/dist-es/commands/index.js +11 -0
  38. package/dist-es/endpoints.js +9 -0
  39. package/dist-es/index.js +1 -0
  40. package/dist-es/models/models_0.js +206 -38
  41. package/dist-es/pagination/Interfaces.js +1 -0
  42. package/dist-es/pagination/ListChangesetsPaginator.js +74 -0
  43. package/dist-es/pagination/ListDataViewsPaginator.js +74 -0
  44. package/dist-es/pagination/ListDatasetsPaginator.js +74 -0
  45. package/dist-es/pagination/index.js +4 -0
  46. package/dist-es/protocols/Aws_restJson1.js +2109 -104
  47. package/dist-types/FinspaceData.d.ts +82 -5
  48. package/dist-types/FinspaceDataClient.d.ts +14 -3
  49. package/dist-types/commands/CreateChangesetCommand.d.ts +2 -2
  50. package/dist-types/commands/CreateDataViewCommand.d.ts +35 -0
  51. package/dist-types/commands/CreateDatasetCommand.d.ts +35 -0
  52. package/dist-types/commands/DeleteDatasetCommand.d.ts +35 -0
  53. package/dist-types/commands/GetChangesetCommand.d.ts +35 -0
  54. package/dist-types/commands/GetDataViewCommand.d.ts +35 -0
  55. package/dist-types/commands/GetDatasetCommand.d.ts +35 -0
  56. package/dist-types/commands/GetProgrammaticAccessCredentialsCommand.d.ts +2 -2
  57. package/dist-types/commands/GetWorkingLocationCommand.d.ts +3 -3
  58. package/dist-types/commands/ListChangesetsCommand.d.ts +35 -0
  59. package/dist-types/commands/ListDataViewsCommand.d.ts +35 -0
  60. package/dist-types/commands/ListDatasetsCommand.d.ts +35 -0
  61. package/dist-types/commands/UpdateChangesetCommand.d.ts +35 -0
  62. package/dist-types/commands/UpdateDatasetCommand.d.ts +35 -0
  63. package/dist-types/commands/index.d.ts +11 -0
  64. package/dist-types/index.d.ts +1 -0
  65. package/dist-types/models/models_0.d.ts +1438 -242
  66. package/dist-types/pagination/Interfaces.d.ts +6 -0
  67. package/dist-types/pagination/ListChangesetsPaginator.d.ts +4 -0
  68. package/dist-types/pagination/ListDataViewsPaginator.d.ts +4 -0
  69. package/dist-types/pagination/ListDatasetsPaginator.d.ts +4 -0
  70. package/dist-types/pagination/index.d.ts +4 -0
  71. package/dist-types/protocols/Aws_restJson1.d.ts +33 -0
  72. package/dist-types/ts3.4/FinspaceData.d.ts +55 -0
  73. package/dist-types/ts3.4/FinspaceDataClient.d.ts +13 -2
  74. package/dist-types/ts3.4/commands/CreateDataViewCommand.d.ts +17 -0
  75. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +17 -0
  76. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +17 -0
  77. package/dist-types/ts3.4/commands/GetChangesetCommand.d.ts +17 -0
  78. package/dist-types/ts3.4/commands/GetDataViewCommand.d.ts +17 -0
  79. package/dist-types/ts3.4/commands/GetDatasetCommand.d.ts +17 -0
  80. package/dist-types/ts3.4/commands/ListChangesetsCommand.d.ts +17 -0
  81. package/dist-types/ts3.4/commands/ListDataViewsCommand.d.ts +17 -0
  82. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +17 -0
  83. package/dist-types/ts3.4/commands/UpdateChangesetCommand.d.ts +17 -0
  84. package/dist-types/ts3.4/commands/UpdateDatasetCommand.d.ts +17 -0
  85. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  86. package/dist-types/ts3.4/index.d.ts +1 -0
  87. package/dist-types/ts3.4/models/models_0.d.ts +606 -71
  88. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  89. package/dist-types/ts3.4/pagination/ListChangesetsPaginator.d.ts +4 -0
  90. package/dist-types/ts3.4/pagination/ListDataViewsPaginator.d.ts +4 -0
  91. package/dist-types/ts3.4/pagination/ListDatasetsPaginator.d.ts +4 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  93. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +33 -0
  94. package/package.json +9 -7
@@ -13,254 +13,126 @@ export declare namespace AccessDeniedException {
13
13
  */
14
14
  const filterSensitiveLog: (obj: AccessDeniedException) => any;
15
15
  }
16
+ /**
17
+ * <p>The request conflicts with an existing resource.</p>
18
+ */
19
+ export interface ConflictException extends __SmithyException, $MetadataBearer {
20
+ name: "ConflictException";
21
+ $fault: "client";
22
+ message?: string;
23
+ }
24
+ export declare namespace ConflictException {
25
+ /**
26
+ * @internal
27
+ */
28
+ const filterSensitiveLog: (obj: ConflictException) => any;
29
+ }
16
30
  export declare enum ChangeType {
17
31
  APPEND = "APPEND",
18
32
  MODIFY = "MODIFY",
19
33
  REPLACE = "REPLACE"
20
34
  }
21
- export declare enum FormatType {
22
- CSV = "CSV",
23
- JSON = "JSON",
24
- PARQUET = "PARQUET",
25
- XML = "XML"
26
- }
27
- export declare enum SourceType {
28
- S3 = "S3"
29
- }
35
+ /**
36
+ * The request for a CreateChangeset operation.
37
+ */
30
38
  export interface CreateChangesetRequest {
31
39
  /**
32
- * <p>The unique identifier for the FinSpace dataset in which the changeset will be
33
- * created.</p>
40
+ * <p>A token used to ensure idempotency.</p>
41
+ */
42
+ clientToken?: string;
43
+ /**
44
+ * <p>The unique identifier for the FinSpace Dataset where the Changeset will be created.
45
+ * </p>
34
46
  */
35
47
  datasetId: string | undefined;
36
48
  /**
37
- * <p>Option to indicate how a changeset will be applied to a dataset.</p>
49
+ * <p>Option to indicate how a Changeset will be applied to a Dataset.</p>
38
50
  * <ul>
39
51
  * <li>
40
52
  * <p>
41
53
  * <code>REPLACE</code> - Changeset will be considered as a replacement to all prior
42
- * loaded changesets.</p>
54
+ * loaded Changesets.</p>
43
55
  * </li>
44
56
  * <li>
45
57
  * <p>
46
58
  * <code>APPEND</code> - Changeset will be considered as an addition to the end of all
47
- * prior loaded changesets.</p>
59
+ * prior loaded Changesets.</p>
48
60
  * </li>
49
- * </ul>
50
- */
51
- changeType: ChangeType | string | undefined;
52
- /**
53
- * <p>Type of the data source from which the files to create the changeset will be
54
- * sourced.</p>
55
- * <ul>
56
61
  * <li>
57
62
  * <p>
58
- * <code>S3</code> - Amazon S3.</p>
63
+ * <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p>
59
64
  * </li>
60
65
  * </ul>
61
66
  */
62
- sourceType: SourceType | string | undefined;
67
+ changeType: ChangeType | string | undefined;
63
68
  /**
64
- * <p>Source path from which the files to create the changeset will be sourced.</p>
69
+ * <p>Options that define the location of the data being ingested.</p>
65
70
  */
66
71
  sourceParams: {
67
72
  [key: string]: string;
68
73
  } | undefined;
69
74
  /**
70
- * <p>Format type of the input files being loaded into the changeset.</p>
71
- */
72
- formatType?: FormatType | string;
73
- /**
74
- * <p>Options that define the structure of the source file(s).</p>
75
- */
76
- formatParams?: {
77
- [key: string]: string;
78
- };
79
- /**
80
- * <p>Metadata tags to apply to this changeset.</p>
81
- */
82
- tags?: {
83
- [key: string]: string;
84
- };
85
- }
86
- export declare namespace CreateChangesetRequest {
87
- /**
88
- * @internal
89
- */
90
- const filterSensitiveLog: (obj: CreateChangesetRequest) => any;
91
- }
92
- export declare enum ErrorCategory {
93
- ACCESS_DENIED = "Missing_required_permission_to_perform_this_request",
94
- CANCELLED = "Cancelled",
95
- INTERNAL_SERVICE_EXCEPTION = "An_internal_error_has_occurred",
96
- RESOURCE_NOT_FOUND = "One_or_more_inputs_to_this_request_were_not_found",
97
- SERVICE_QUOTA_EXCEEDED = "Service_limits_have_been_exceeded",
98
- THROTTLING = "The_system_temporarily_lacks_sufficient_resources_to_process_the_request",
99
- USER_RECOVERABLE = "A_user_recoverable_error_has_occurred",
100
- VALIDATION = "The_inputs_to_this_request_are_invalid"
101
- }
102
- /**
103
- * <p>Error message.</p>
104
- */
105
- export interface ErrorInfo {
106
- /**
107
- * <p>The text of the error message.</p>
108
- */
109
- errorMessage?: string;
110
- /**
111
- * <p>The category of the error.</p>
75
+ * <p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>).
76
+ * </p>
77
+ * <p>
78
+ * <code>formatType</code> is a required attribute and can have the following values:
79
+ * </p>
112
80
  * <ul>
113
81
  * <li>
114
82
  * <p>
115
- * <code>VALIDATION</code> -The inputs to this request are invalid.</p>
116
- * </li>
117
- * <li>
118
- * <p>
119
- * <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please
120
- * contact AWS support to increase quotas.</p>
121
- * </li>
122
- * <li>
123
- * <p>
124
- * <code>ACCESS_DENIED</code> - Missing required permission to perform this
125
- * request.</p>
126
- * </li>
127
- * <li>
128
- * <p>
129
- * <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not
130
- * found.</p>
83
+ * <code>PARQUET</code> - Parquet source file format.</p>
131
84
  * </li>
132
85
  * <li>
133
86
  * <p>
134
- * <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process
135
- * the request.</p>
87
+ * <code>CSV</code> - CSV source file format.</p>
136
88
  * </li>
137
89
  * <li>
138
90
  * <p>
139
- * <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has
140
- * occurred.</p>
91
+ * <code>JSON</code> - JSON source file format.</p>
141
92
  * </li>
142
93
  * <li>
143
94
  * <p>
144
- * <code>CANCELLED</code> - A user recoverable error has occurred.</p>
95
+ * <code>XML</code> - XML source file format.</p>
145
96
  * </li>
146
97
  * </ul>
98
+ *
99
+ * <p>
100
+ *
101
+ * For example, you could specify the following for <code>formatParams</code>:
102
+ *
103
+ * <code>
104
+ * "formatParams":
105
+ * {
106
+ * "formatType": "CSV",
107
+ * "withHeader": "true",
108
+ * "separator": ",",
109
+ * "compression":"None"
110
+ * }
111
+ * </code>
112
+ * </p>
147
113
  */
148
- errorCategory?: ErrorCategory | string;
114
+ formatParams: {
115
+ [key: string]: string;
116
+ } | undefined;
149
117
  }
150
- export declare namespace ErrorInfo {
118
+ export declare namespace CreateChangesetRequest {
151
119
  /**
152
120
  * @internal
153
121
  */
154
- const filterSensitiveLog: (obj: ErrorInfo) => any;
155
- }
156
- export declare enum ChangesetStatus {
157
- FAILED = "FAILED",
158
- PENDING = "PENDING",
159
- RUNNING = "RUNNING",
160
- STOP_REQUESTED = "STOP_REQUESTED",
161
- SUCCESS = "SUCCESS"
122
+ const filterSensitiveLog: (obj: CreateChangesetRequest) => any;
162
123
  }
163
124
  /**
164
- * <p>A changeset is unit of data in a dataset.</p>
125
+ * The response from a CreateChangeset operation.
165
126
  */
166
- export interface ChangesetInfo {
167
- /**
168
- * <p>Unique identifier for a changeset.</p>
169
- */
170
- id?: string;
171
- /**
172
- * <p>The ARN identifier of the changeset.</p>
173
- */
174
- changesetArn?: string;
127
+ export interface CreateChangesetResponse {
175
128
  /**
176
- * <p>The unique identifier for the FinSpace dataset in which the changeset is created.</p>
129
+ * <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
177
130
  */
178
131
  datasetId?: string;
179
132
  /**
180
- * <p>Change type indicates how a changeset is applied to a dataset.</p>
181
- * <ul>
182
- * <li>
183
- * <p>
184
- * <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded
185
- * changesets.</p>
186
- * </li>
187
- * <li>
188
- * <p>
189
- * <code>APPEND</code> - Changeset is considered as an addition to the end of all prior
190
- * loaded changesets.</p>
191
- * </li>
192
- * <li>
193
- * <p>
194
- * <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior
195
- * ingested changeset.</p>
196
- * </li>
197
- * </ul>
198
- */
199
- changeType?: ChangeType | string;
200
- /**
201
- * <p>Type of the data source from which the files to create the changeset are sourced.</p>
202
- * <ul>
203
- * <li>
204
- * <p>
205
- * <code>S3</code> - Amazon S3.</p>
206
- * </li>
207
- * </ul>
208
- */
209
- sourceType?: SourceType | string;
210
- /**
211
- * <p>Source path from which the files to create the changeset are sourced.</p>
212
- */
213
- sourceParams?: {
214
- [key: string]: string;
215
- };
216
- /**
217
- * <p>Format type of the input files loaded into the changeset.</p>
218
- */
219
- formatType?: FormatType | string;
220
- /**
221
- * <p>Structure of the source file(s).</p>
222
- */
223
- formatParams?: {
224
- [key: string]: string;
225
- };
226
- /**
227
- * <p>The timestamp at which the changeset was created in FinSpace.</p>
228
- */
229
- createTimestamp?: Date;
230
- /**
231
- * <p>The status of changeset creation operation.</p>
232
- */
233
- status?: ChangesetStatus | string;
234
- /**
235
- * <p>The structure with error messages.</p>
236
- */
237
- errorInfo?: ErrorInfo;
238
- /**
239
- * <p>Tags associated with the changeset.</p>
240
- */
241
- changesetLabels?: {
242
- [key: string]: string;
243
- };
244
- /**
245
- * <p>Unique identifier of the changeset that is updated.</p>
246
- */
247
- updatesChangesetId?: string;
248
- /**
249
- * <p>Unique identifier of the changeset that is updated a changeset.</p>
250
- */
251
- updatedByChangesetId?: string;
252
- }
253
- export declare namespace ChangesetInfo {
254
- /**
255
- * @internal
256
- */
257
- const filterSensitiveLog: (obj: ChangesetInfo) => any;
258
- }
259
- export interface CreateChangesetResponse {
260
- /**
261
- * <p>Returns the changeset details.</p>
133
+ * <p>The unique identifier of the Changeset that is created.</p>
262
134
  */
263
- changeset?: ChangesetInfo;
135
+ changesetId?: string;
264
136
  }
265
137
  export declare namespace CreateChangesetResponse {
266
138
  /**
@@ -283,6 +155,20 @@ export declare namespace InternalServerException {
283
155
  */
284
156
  const filterSensitiveLog: (obj: InternalServerException) => any;
285
157
  }
158
+ /**
159
+ * <p>A limit has exceeded.</p>
160
+ */
161
+ export interface LimitExceededException extends __SmithyException, $MetadataBearer {
162
+ name: "LimitExceededException";
163
+ $fault: "client";
164
+ message?: string;
165
+ }
166
+ export declare namespace LimitExceededException {
167
+ /**
168
+ * @internal
169
+ */
170
+ const filterSensitiveLog: (obj: LimitExceededException) => any;
171
+ }
286
172
  /**
287
173
  * <p>One or more resources can't be found.</p>
288
174
  */
@@ -324,106 +210,1416 @@ export declare namespace ValidationException {
324
210
  */
325
211
  const filterSensitiveLog: (obj: ValidationException) => any;
326
212
  }
327
- export interface GetProgrammaticAccessCredentialsRequest {
213
+ export declare enum DatasetKind {
214
+ NON_TABULAR = "NON_TABULAR",
215
+ TABULAR = "TABULAR"
216
+ }
217
+ /**
218
+ * <p>A structure for Dataset owner info.</p>
219
+ */
220
+ export interface DatasetOwnerInfo {
328
221
  /**
329
- * <p>The time duration in which the credentials remain valid. </p>
222
+ * <p>Name of the Dataset owner.</p>
330
223
  */
331
- durationInMinutes?: number;
224
+ name?: string;
332
225
  /**
333
- * <p>The habanero environment identifier.</p>
226
+ * <p>Phone number for the Dataset owner.</p>
334
227
  */
335
- environmentId: string | undefined;
228
+ phoneNumber?: string;
229
+ /**
230
+ * <p>Email address for the Dataset owner.</p>
231
+ */
232
+ email?: string;
336
233
  }
337
- export declare namespace GetProgrammaticAccessCredentialsRequest {
234
+ export declare namespace DatasetOwnerInfo {
338
235
  /**
339
236
  * @internal
340
237
  */
341
- const filterSensitiveLog: (obj: GetProgrammaticAccessCredentialsRequest) => any;
238
+ const filterSensitiveLog: (obj: DatasetOwnerInfo) => any;
342
239
  }
343
240
  /**
344
- * <p>Set short term API credentials.</p>
241
+ * <p>Resource permission for a Dataset.</p>
345
242
  */
346
- export interface Credentials {
347
- /**
348
- * <p>The access key identifier.</p>
349
- */
350
- accessKeyId?: string;
351
- /**
352
- * <p>The access key.</p>
353
- */
354
- secretAccessKey?: string;
243
+ export interface ResourcePermission {
355
244
  /**
356
- * <p>The session token.</p>
245
+ * <p>Permission for a resource.</p>
357
246
  */
358
- sessionToken?: string;
247
+ permission?: string;
359
248
  }
360
- export declare namespace Credentials {
249
+ export declare namespace ResourcePermission {
361
250
  /**
362
251
  * @internal
363
252
  */
364
- const filterSensitiveLog: (obj: Credentials) => any;
253
+ const filterSensitiveLog: (obj: ResourcePermission) => any;
365
254
  }
366
- export interface GetProgrammaticAccessCredentialsResponse {
255
+ /**
256
+ * <p>Permission group parameters for Dataset permissions.</p>
257
+ */
258
+ export interface PermissionGroupParams {
367
259
  /**
368
- * <p>Returns the programmatic credentials.</p>
260
+ * <p>The unique identifier of the PermissionGroup.</p>
369
261
  */
370
- credentials?: Credentials;
262
+ permissionGroupId?: string;
371
263
  /**
372
- * <p>Returns the duration in which the credentials will remain valid.</p>
264
+ * <p>List of resource permissions.</p>
373
265
  */
374
- durationInMinutes?: number;
266
+ datasetPermissions?: ResourcePermission[];
375
267
  }
376
- export declare namespace GetProgrammaticAccessCredentialsResponse {
268
+ export declare namespace PermissionGroupParams {
377
269
  /**
378
270
  * @internal
379
271
  */
380
- const filterSensitiveLog: (obj: GetProgrammaticAccessCredentialsResponse) => any;
272
+ const filterSensitiveLog: (obj: PermissionGroupParams) => any;
381
273
  }
382
- export declare enum LocationType {
383
- INGESTION = "INGESTION",
384
- SAGEMAKER = "SAGEMAKER"
274
+ export declare enum ColumnDataType {
275
+ BIGINT = "BIGINT",
276
+ BINARY = "BINARY",
277
+ BOOLEAN = "BOOLEAN",
278
+ CHAR = "CHAR",
279
+ DATE = "DATE",
280
+ DATETIME = "DATETIME",
281
+ DOUBLE = "DOUBLE",
282
+ FLOAT = "FLOAT",
283
+ INTEGER = "INTEGER",
284
+ SMALLINT = "SMALLINT",
285
+ STRING = "STRING",
286
+ TINYINT = "TINYINT"
385
287
  }
386
- export interface GetWorkingLocationRequest {
288
+ /**
289
+ * <p>The definition of a column in a tabular Dataset.</p>
290
+ */
291
+ export interface ColumnDefinition {
387
292
  /**
388
- * <p>Specify the type of the working location.</p>
293
+ * <p>Data type of a column.</p>
389
294
  * <ul>
390
295
  * <li>
391
296
  * <p>
392
- * <code>SAGEMAKER</code> - Use the Amazon S3 location as a temporary location to store data content when
393
- * working with FinSpace Notebooks that run on SageMaker studio.</p>
394
- * </li>
395
- * <li>
297
+ * <code>STRING</code> - A String data type.</p>
396
298
  * <p>
397
- * <code>INGESTION</code> - Use the Amazon S3 location as a staging location to copy your
398
- * data content and then use the location with the changeset creation operation.</p>
299
+ * <code>CHAR</code> - A char data type.</p>
300
+ * <p>
301
+ * <code>INTEGER</code> - An integer data type.</p>
302
+ * <p>
303
+ * <code>TINYINT</code> - A tinyint data type.</p>
304
+ * <p>
305
+ * <code>SMALLINT</code> - A smallint data type.</p>
306
+ * <p>
307
+ * <code>BIGINT</code> - A bigint data type.</p>
308
+ * <p>
309
+ * <code>FLOAT</code> - A float data type.</p>
310
+ * <p>
311
+ * <code>DOUBLE</code> - A double data type.</p>
312
+ * <p>
313
+ * <code>DATE</code> - A date data type.</p>
314
+ * <p>
315
+ * <code>DATETIME</code> - A datetime data type.</p>
316
+ * <p>
317
+ * <code>BOOLEAN</code> - A boolean data type.</p>
318
+ * <p>
319
+ * <code>BINARY</code> - A binary data type.</p>
399
320
  * </li>
400
321
  * </ul>
401
322
  */
402
- locationType?: LocationType | string;
323
+ dataType?: ColumnDataType | string;
324
+ /**
325
+ * <p>Name for a column.</p>
326
+ */
327
+ columnName?: string;
328
+ /**
329
+ * <p>Description for a column.</p>
330
+ */
331
+ columnDescription?: string;
403
332
  }
404
- export declare namespace GetWorkingLocationRequest {
333
+ export declare namespace ColumnDefinition {
405
334
  /**
406
335
  * @internal
407
336
  */
408
- const filterSensitiveLog: (obj: GetWorkingLocationRequest) => any;
337
+ const filterSensitiveLog: (obj: ColumnDefinition) => any;
409
338
  }
410
- export interface GetWorkingLocationResponse {
339
+ /**
340
+ * <p>Definition for a schema on a tabular Dataset.</p>
341
+ */
342
+ export interface SchemaDefinition {
411
343
  /**
412
- * <p>Returns the Amazon S3 URI for the working location.</p>
344
+ * <p>List of column definitions.</p>
413
345
  */
414
- s3Uri?: string;
346
+ columns?: ColumnDefinition[];
415
347
  /**
416
- * <p>Returns the Amazon S3 Path for the working location.</p>
348
+ * <p>List of column names used for primary key.</p>
417
349
  */
418
- s3Path?: string;
350
+ primaryKeyColumns?: string[];
351
+ }
352
+ export declare namespace SchemaDefinition {
419
353
  /**
420
- * <p>Returns the Amazon S3 bucket name for the working location.</p>
354
+ * @internal
421
355
  */
422
- s3Bucket?: string;
356
+ const filterSensitiveLog: (obj: SchemaDefinition) => any;
423
357
  }
424
- export declare namespace GetWorkingLocationResponse {
358
+ /**
359
+ * <p>A union of schema types.</p>
360
+ */
361
+ export interface SchemaUnion {
362
+ /**
363
+ * <p>The configuration for a schema on a tabular Dataset.</p>
364
+ */
365
+ tabularSchemaConfig?: SchemaDefinition;
366
+ }
367
+ export declare namespace SchemaUnion {
425
368
  /**
426
369
  * @internal
427
370
  */
428
- const filterSensitiveLog: (obj: GetWorkingLocationResponse) => any;
371
+ const filterSensitiveLog: (obj: SchemaUnion) => any;
372
+ }
373
+ /**
374
+ * The request for a CreateDataset operation
375
+ */
376
+ export interface CreateDatasetRequest {
377
+ /**
378
+ * <p>A token used to ensure idempotency.</p>
379
+ */
380
+ clientToken?: string;
381
+ /**
382
+ * <p>Display title for a FinSpace Dataset.</p>
383
+ */
384
+ datasetTitle: string | undefined;
385
+ /**
386
+ * <p>The format in which Dataset data is structured.</p>
387
+ * <ul>
388
+ * <li>
389
+ * <p>
390
+ * <code>TABULAR</code> - Data is structured in a tabular format.</p>
391
+ * </li>
392
+ * <li>
393
+ * <p>
394
+ * <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p>
395
+ * </li>
396
+ * </ul>
397
+ */
398
+ kind: DatasetKind | string | undefined;
399
+ /**
400
+ * <p>Description of a Dataset.</p>
401
+ */
402
+ datasetDescription?: string;
403
+ /**
404
+ * <p>Contact information for a Dataset owner.</p>
405
+ */
406
+ ownerInfo?: DatasetOwnerInfo;
407
+ /**
408
+ * <p>Permission group parameters for Dataset permissions.</p>
409
+ */
410
+ permissionGroupParams: PermissionGroupParams | undefined;
411
+ /**
412
+ * <p>The unique resource identifier for a Dataset.</p>
413
+ */
414
+ alias?: string;
415
+ /**
416
+ * <p>Definition for a schema on a tabular Dataset.</p>
417
+ */
418
+ schemaDefinition?: SchemaUnion;
419
+ }
420
+ export declare namespace CreateDatasetRequest {
421
+ /**
422
+ * @internal
423
+ */
424
+ const filterSensitiveLog: (obj: CreateDatasetRequest) => any;
425
+ }
426
+ /**
427
+ * The response from a CreateDataset operation
428
+ */
429
+ export interface CreateDatasetResponse {
430
+ /**
431
+ * <p>The unique identifier for the created Dataset.</p>
432
+ */
433
+ datasetId?: string;
434
+ }
435
+ export declare namespace CreateDatasetResponse {
436
+ /**
437
+ * @internal
438
+ */
439
+ const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
440
+ }
441
+ export declare enum ExportFileFormat {
442
+ DELIMITED_TEXT = "DELIMITED_TEXT",
443
+ PARQUET = "PARQUET"
444
+ }
445
+ /**
446
+ * <p>Structure for the Dataview destination type parameters.</p>
447
+ */
448
+ export interface DataViewDestinationTypeParams {
449
+ /**
450
+ * <p>Destination type for a Dataview.</p>
451
+ * <ul>
452
+ * <li>
453
+ * <p>
454
+ * <code>GLUE_TABLE</code> - Glue table destination type.</p>
455
+ * </li>
456
+ * </ul>
457
+ */
458
+ destinationType: string | undefined;
459
+ /**
460
+ * Data View Export File Format
461
+ */
462
+ s3DestinationExportFileFormat?: ExportFileFormat | string;
463
+ s3DestinationExportFileFormatOptions?: {
464
+ [key: string]: string;
465
+ };
466
+ }
467
+ export declare namespace DataViewDestinationTypeParams {
468
+ /**
469
+ * @internal
470
+ */
471
+ const filterSensitiveLog: (obj: DataViewDestinationTypeParams) => any;
472
+ }
473
+ /**
474
+ * Request for creating a data view.
475
+ */
476
+ export interface CreateDataViewRequest {
477
+ /**
478
+ * <p>A token used to ensure idempotency.</p>
479
+ */
480
+ clientToken?: string;
481
+ /**
482
+ * <p>The unique Dataset identifier that is used to create a Dataview.</p>
483
+ */
484
+ datasetId: string | undefined;
485
+ /**
486
+ * <p>Flag to indicate Dataview should be updated automatically.</p>
487
+ */
488
+ autoUpdate?: boolean;
489
+ /**
490
+ * <p>Columns to be used for sorting the data.</p>
491
+ */
492
+ sortColumns?: string[];
493
+ /**
494
+ * <p>Ordered set of column names used to partition data.</p>
495
+ */
496
+ partitionColumns?: string[];
497
+ /**
498
+ * <p>Beginning time to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
499
+ */
500
+ asOfTimestamp?: number;
501
+ /**
502
+ * <p>Options that define the destination type for the Dataview.</p>
503
+ */
504
+ destinationTypeParams: DataViewDestinationTypeParams | undefined;
505
+ }
506
+ export declare namespace CreateDataViewRequest {
507
+ /**
508
+ * @internal
509
+ */
510
+ const filterSensitiveLog: (obj: CreateDataViewRequest) => any;
511
+ }
512
+ /**
513
+ * Response for creating a data view.
514
+ */
515
+ export interface CreateDataViewResponse {
516
+ /**
517
+ * <p>The unique identifier of the Dataset used for the Dataview.</p>
518
+ */
519
+ datasetId?: string;
520
+ /**
521
+ * <p>The unique identifier for the created Dataview.</p>
522
+ */
523
+ dataViewId?: string;
524
+ }
525
+ export declare namespace CreateDataViewResponse {
526
+ /**
527
+ * @internal
528
+ */
529
+ const filterSensitiveLog: (obj: CreateDataViewResponse) => any;
530
+ }
531
+ /**
532
+ * The request for a DeleteDataset operation.
533
+ */
534
+ export interface DeleteDatasetRequest {
535
+ /**
536
+ * <p>A token used to ensure idempotency.</p>
537
+ */
538
+ clientToken?: string;
539
+ /**
540
+ * <p>The unique identifier of the Dataset to be deleted.</p>
541
+ */
542
+ datasetId: string | undefined;
543
+ }
544
+ export declare namespace DeleteDatasetRequest {
545
+ /**
546
+ * @internal
547
+ */
548
+ const filterSensitiveLog: (obj: DeleteDatasetRequest) => any;
549
+ }
550
+ /**
551
+ * The response from an DeleteDataset operation
552
+ */
553
+ export interface DeleteDatasetResponse {
554
+ /**
555
+ * <p>The unique identifier for the deleted Dataset.</p>
556
+ */
557
+ datasetId?: string;
558
+ }
559
+ export declare namespace DeleteDatasetResponse {
560
+ /**
561
+ * @internal
562
+ */
563
+ const filterSensitiveLog: (obj: DeleteDatasetResponse) => any;
564
+ }
565
+ /**
566
+ * Request to describe a changeset.
567
+ */
568
+ export interface GetChangesetRequest {
569
+ /**
570
+ * <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
571
+ */
572
+ datasetId: string | undefined;
573
+ /**
574
+ * <p>The unique identifier of the Changeset for which to get data.</p>
575
+ */
576
+ changesetId: string | undefined;
577
+ }
578
+ export declare namespace GetChangesetRequest {
579
+ /**
580
+ * @internal
581
+ */
582
+ const filterSensitiveLog: (obj: GetChangesetRequest) => any;
583
+ }
584
+ export declare enum ErrorCategory {
585
+ ACCESS_DENIED = "ACCESS_DENIED",
586
+ CANCELLED = "CANCELLED",
587
+ INTERNAL_SERVICE_EXCEPTION = "INTERNAL_SERVICE_EXCEPTION",
588
+ RESOURCE_NOT_FOUND = "RESOURCE_NOT_FOUND",
589
+ SERVICE_QUOTA_EXCEEDED = "SERVICE_QUOTA_EXCEEDED",
590
+ THROTTLING = "THROTTLING",
591
+ USER_RECOVERABLE = "USER_RECOVERABLE",
592
+ VALIDATION = "VALIDATION"
593
+ }
594
+ /**
595
+ * <p>The structure with error messages.</p>
596
+ */
597
+ export interface ChangesetErrorInfo {
598
+ /**
599
+ * <p>The text of the error message.</p>
600
+ */
601
+ errorMessage?: string;
602
+ /**
603
+ * <p>The category of the error.</p>
604
+ * <ul>
605
+ * <li>
606
+ * <p>
607
+ * <code>VALIDATION</code> -The inputs to this request are invalid.</p>
608
+ * </li>
609
+ * <li>
610
+ * <p>
611
+ * <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please
612
+ * contact AWS support to increase quotas.</p>
613
+ * </li>
614
+ * <li>
615
+ * <p>
616
+ * <code>ACCESS_DENIED</code> - Missing required permission to perform this
617
+ * request.</p>
618
+ * </li>
619
+ * <li>
620
+ * <p>
621
+ * <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not
622
+ * found.</p>
623
+ * </li>
624
+ * <li>
625
+ * <p>
626
+ * <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process
627
+ * the request.</p>
628
+ * </li>
629
+ * <li>
630
+ * <p>
631
+ * <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has
632
+ * occurred.</p>
633
+ * </li>
634
+ * <li>
635
+ * <p>
636
+ * <code>CANCELLED</code> - Cancelled.</p>
637
+ * </li>
638
+ * <li>
639
+ * <p>
640
+ * <code>USER_RECOVERABLE</code> - A user recoverable error has occurred.</p>
641
+ * </li>
642
+ * </ul>
643
+ */
644
+ errorCategory?: ErrorCategory | string;
645
+ }
646
+ export declare namespace ChangesetErrorInfo {
647
+ /**
648
+ * @internal
649
+ */
650
+ const filterSensitiveLog: (obj: ChangesetErrorInfo) => any;
651
+ }
652
+ export declare enum IngestionStatus {
653
+ FAILED = "FAILED",
654
+ PENDING = "PENDING",
655
+ RUNNING = "RUNNING",
656
+ STOP_REQUESTED = "STOP_REQUESTED",
657
+ SUCCESS = "SUCCESS"
658
+ }
659
+ /**
660
+ * The response from a describe changeset operation
661
+ */
662
+ export interface GetChangesetResponse {
663
+ /**
664
+ * <p>The unique identifier for a Changeset.</p>
665
+ */
666
+ changesetId?: string;
667
+ /**
668
+ * <p>The ARN identifier of the Changeset.</p>
669
+ */
670
+ changesetArn?: string;
671
+ /**
672
+ * <p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>
673
+ */
674
+ datasetId?: string;
675
+ /**
676
+ * <p>Type that indicates how a Changeset is applied to a Dataset.</p>
677
+ * <ul>
678
+ * <li>
679
+ * <p>
680
+ * <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets.</p>
681
+ * </li>
682
+ * <li>
683
+ * <p>
684
+ * <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets.</p>
685
+ * </li>
686
+ * <li>
687
+ * <p>
688
+ * <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p>
689
+ * </li>
690
+ * </ul>
691
+ */
692
+ changeType?: ChangeType | string;
693
+ /**
694
+ * <p>Options that define the location of the data being ingested.</p>
695
+ */
696
+ sourceParams?: {
697
+ [key: string]: string;
698
+ };
699
+ /**
700
+ * <p>Structure of the source file(s).</p>
701
+ */
702
+ formatParams?: {
703
+ [key: string]: string;
704
+ };
705
+ /**
706
+ * <p>The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
707
+ */
708
+ createTime?: number;
709
+ /**
710
+ * <p>The status of Changeset creation operation.</p>
711
+ */
712
+ status?: IngestionStatus | string;
713
+ /**
714
+ * <p>The structure with error messages.</p>
715
+ */
716
+ errorInfo?: ChangesetErrorInfo;
717
+ /**
718
+ * <p>Time until 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.</p>
719
+ */
720
+ activeUntilTimestamp?: number;
721
+ /**
722
+ * Milliseconds since UTC epoch
723
+ */
724
+ activeFromTimestamp?: number;
725
+ /**
726
+ * <p>The unique identifier of the Changeset that is being updated.</p>
727
+ */
728
+ updatesChangesetId?: string;
729
+ /**
730
+ * <p>The unique identifier of the updated Changeset.</p>
731
+ */
732
+ updatedByChangesetId?: string;
733
+ }
734
+ export declare namespace GetChangesetResponse {
735
+ /**
736
+ * @internal
737
+ */
738
+ const filterSensitiveLog: (obj: GetChangesetResponse) => any;
739
+ }
740
+ /**
741
+ * Request for the GetDataset operation.
742
+ */
743
+ export interface GetDatasetRequest {
744
+ /**
745
+ * <p>The unique identifier for a Dataset.</p>
746
+ */
747
+ datasetId: string | undefined;
748
+ }
749
+ export declare namespace GetDatasetRequest {
750
+ /**
751
+ * @internal
752
+ */
753
+ const filterSensitiveLog: (obj: GetDatasetRequest) => any;
754
+ }
755
+ export declare enum DatasetStatus {
756
+ FAILED = "FAILED",
757
+ PENDING = "PENDING",
758
+ RUNNING = "RUNNING",
759
+ SUCCESS = "SUCCESS"
760
+ }
761
+ /**
762
+ * Response for the GetDataset operation
763
+ */
764
+ export interface GetDatasetResponse {
765
+ /**
766
+ * <p>The unique identifier for a Dataset.</p>
767
+ */
768
+ datasetId?: string;
769
+ /**
770
+ * <p>The ARN identifier of the Dataset.</p>
771
+ */
772
+ datasetArn?: string;
773
+ /**
774
+ * <p>Display title for a Dataset.</p>
775
+ */
776
+ datasetTitle?: string;
777
+ /**
778
+ * <p>The format in which Dataset data is structured.</p>
779
+ * <ul>
780
+ * <li>
781
+ * <p>
782
+ * <code>TABULAR</code> - Data is structured in a tabular format.</p>
783
+ * </li>
784
+ * <li>
785
+ * <p>
786
+ * <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p>
787
+ * </li>
788
+ * </ul>
789
+ */
790
+ kind?: DatasetKind | string;
791
+ /**
792
+ * <p>A description of the Dataset.</p>
793
+ */
794
+ datasetDescription?: string;
795
+ /**
796
+ * <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
797
+ */
798
+ createTime?: number;
799
+ /**
800
+ * <p>The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
801
+ */
802
+ lastModifiedTime?: number;
803
+ /**
804
+ * <p>Definition for a schema on a tabular Dataset.</p>
805
+ */
806
+ schemaDefinition?: SchemaUnion;
807
+ /**
808
+ * <p>The unique resource identifier for a Dataset.</p>
809
+ */
810
+ alias?: string;
811
+ /**
812
+ * <p>Status of the Dataset creation.</p>
813
+ * <ul>
814
+ * <li>
815
+ * <p>
816
+ * <code>PENDING</code> - Dataset is pending creation.</p>
817
+ * </li>
818
+ * <li>
819
+ * <p>
820
+ * <code>FAILED</code> - Dataset creation has failed.</p>
821
+ * </li>
822
+ * <li>
823
+ * <p>
824
+ * <code>SUCCESS</code> - Dataset creation has succeeded.</p>
825
+ * </li>
826
+ * <li>
827
+ * <p>
828
+ * <code>RUNNING</code> - Dataset creation is running.</p>
829
+ * </li>
830
+ * </ul>
831
+ */
832
+ status?: DatasetStatus | string;
833
+ }
834
+ export declare namespace GetDatasetResponse {
835
+ /**
836
+ * @internal
837
+ */
838
+ const filterSensitiveLog: (obj: GetDatasetResponse) => any;
839
+ }
840
+ /**
841
+ * Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
842
+ */
843
+ export interface GetDataViewRequest {
844
+ /**
845
+ * <p>The unique identifier for the Dataview.</p>
846
+ */
847
+ dataViewId: string | undefined;
848
+ /**
849
+ * <p>The unique identifier for the Dataset used in the Dataview.</p>
850
+ */
851
+ datasetId: string | undefined;
852
+ }
853
+ export declare namespace GetDataViewRequest {
854
+ /**
855
+ * @internal
856
+ */
857
+ const filterSensitiveLog: (obj: GetDataViewRequest) => any;
858
+ }
859
+ /**
860
+ * <p>The structure with error messages.</p>
861
+ */
862
+ export interface DataViewErrorInfo {
863
+ /**
864
+ * <p>The text of the error message.</p>
865
+ */
866
+ errorMessage?: string;
867
+ /**
868
+ * <p>The category of the error.</p>
869
+ * <ul>
870
+ * <li>
871
+ * <p>
872
+ * <code>VALIDATION</code> -The inputs to this request are invalid.</p>
873
+ * </li>
874
+ * <li>
875
+ * <p>
876
+ * <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please
877
+ * contact AWS support to increase quotas.</p>
878
+ * </li>
879
+ * <li>
880
+ * <p>
881
+ * <code>ACCESS_DENIED</code> - Missing required permission to perform this
882
+ * request.</p>
883
+ * </li>
884
+ * <li>
885
+ * <p>
886
+ * <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not
887
+ * found.</p>
888
+ * </li>
889
+ * <li>
890
+ * <p>
891
+ * <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process
892
+ * the request.</p>
893
+ * </li>
894
+ * <li>
895
+ * <p>
896
+ * <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has
897
+ * occurred.</p>
898
+ * </li>
899
+ * <li>
900
+ * <p>
901
+ * <code>CANCELLED</code> - Cancelled.</p>
902
+ * </li>
903
+ * <li>
904
+ * <p>
905
+ * <code>USER_RECOVERABLE</code> - A user recoverable error has occurred.</p>
906
+ * </li>
907
+ * </ul>
908
+ */
909
+ errorCategory?: ErrorCategory | string;
910
+ }
911
+ export declare namespace DataViewErrorInfo {
912
+ /**
913
+ * @internal
914
+ */
915
+ const filterSensitiveLog: (obj: DataViewErrorInfo) => any;
916
+ }
917
+ export declare enum DataViewStatus {
918
+ CANCELLED = "CANCELLED",
919
+ FAILED = "FAILED",
920
+ FAILED_CLEANUP_FAILED = "FAILED_CLEANUP_FAILED",
921
+ PENDING = "PENDING",
922
+ RUNNING = "RUNNING",
923
+ STARTING = "STARTING",
924
+ SUCCESS = "SUCCESS",
925
+ TIMEOUT = "TIMEOUT"
926
+ }
927
+ /**
928
+ * Response from retrieving a dataview, which includes details on the target database and table name
929
+ */
930
+ export interface GetDataViewResponse {
931
+ /**
932
+ * <p>Flag to indicate Dataview should be updated automatically.</p>
933
+ */
934
+ autoUpdate?: boolean;
935
+ /**
936
+ * <p>Ordered set of column names used to partition data.</p>
937
+ */
938
+ partitionColumns?: string[];
939
+ /**
940
+ * <p>The unique identifier for the Dataset used in the Dataview.</p>
941
+ */
942
+ datasetId?: string;
943
+ /**
944
+ * <p>Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
945
+ */
946
+ asOfTimestamp?: number;
947
+ /**
948
+ * <p>Information about an error that occurred for the Dataview.</p>
949
+ */
950
+ errorInfo?: DataViewErrorInfo;
951
+ /**
952
+ * <p>The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
953
+ */
954
+ lastModifiedTime?: number;
955
+ /**
956
+ * <p>The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
957
+ */
958
+ createTime?: number;
959
+ /**
960
+ * <p>Columns to be used for sorting the data.</p>
961
+ */
962
+ sortColumns?: string[];
963
+ /**
964
+ * <p>The unique identifier for the Dataview.</p>
965
+ */
966
+ dataViewId?: string;
967
+ /**
968
+ * <p>The ARN identifier of the Dataview.</p>
969
+ */
970
+ dataViewArn?: string;
971
+ /**
972
+ * <p>Options that define the destination type for the Dataview.</p>
973
+ */
974
+ destinationTypeParams?: DataViewDestinationTypeParams;
975
+ /**
976
+ * <p>The status of a Dataview creation.</p>
977
+ * <ul>
978
+ * <li>
979
+ * <p>
980
+ * <code>RUNNING</code> - Dataview creation is running.</p>
981
+ * </li>
982
+ * <li>
983
+ * <p>
984
+ * <code>STARTING</code> - Dataview creation is starting.</p>
985
+ * </li>
986
+ * <li>
987
+ * <p>
988
+ * <code>FAILED</code> - Dataview creation has failed.</p>
989
+ * </li>
990
+ * <li>
991
+ * <p>
992
+ * <code>CANCELLED</code> - Dataview creation has been cancelled.</p>
993
+ * </li>
994
+ * <li>
995
+ * <p>
996
+ * <code>TIMEOUT</code> - Dataview creation has timed out.</p>
997
+ * </li>
998
+ * <li>
999
+ * <p>
1000
+ * <code>SUCCESS</code> - Dataview creation has succeeded.</p>
1001
+ * </li>
1002
+ * <li>
1003
+ * <p>
1004
+ * <code>PENDING</code> - Dataview creation is pending.</p>
1005
+ * </li>
1006
+ * <li>
1007
+ * <p>
1008
+ * <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed.</p>
1009
+ * </li>
1010
+ * </ul>
1011
+ */
1012
+ status?: DataViewStatus | string;
1013
+ }
1014
+ export declare namespace GetDataViewResponse {
1015
+ /**
1016
+ * @internal
1017
+ */
1018
+ const filterSensitiveLog: (obj: GetDataViewResponse) => any;
1019
+ }
1020
+ /**
1021
+ * Request for GetProgrammaticAccessCredentials operation
1022
+ */
1023
+ export interface GetProgrammaticAccessCredentialsRequest {
1024
+ /**
1025
+ * <p>The time duration in which the credentials remain valid. </p>
1026
+ */
1027
+ durationInMinutes?: number;
1028
+ /**
1029
+ * <p>The FinSpace environment identifier.</p>
1030
+ */
1031
+ environmentId: string | undefined;
1032
+ }
1033
+ export declare namespace GetProgrammaticAccessCredentialsRequest {
1034
+ /**
1035
+ * @internal
1036
+ */
1037
+ const filterSensitiveLog: (obj: GetProgrammaticAccessCredentialsRequest) => any;
1038
+ }
1039
+ /**
1040
+ * <p>Short term API credentials.</p>
1041
+ */
1042
+ export interface Credentials {
1043
+ /**
1044
+ * <p>The access key identifier.</p>
1045
+ */
1046
+ accessKeyId?: string;
1047
+ /**
1048
+ * <p>The access key.</p>
1049
+ */
1050
+ secretAccessKey?: string;
1051
+ /**
1052
+ * <p>The session token.</p>
1053
+ */
1054
+ sessionToken?: string;
1055
+ }
1056
+ export declare namespace Credentials {
1057
+ /**
1058
+ * @internal
1059
+ */
1060
+ const filterSensitiveLog: (obj: Credentials) => any;
1061
+ }
1062
+ /**
1063
+ * Response for GetProgrammaticAccessCredentials operation
1064
+ */
1065
+ export interface GetProgrammaticAccessCredentialsResponse {
1066
+ /**
1067
+ * <p>Returns the programmatic credentials.</p>
1068
+ */
1069
+ credentials?: Credentials;
1070
+ /**
1071
+ * <p>Returns the duration in which the credentials will remain valid.</p>
1072
+ */
1073
+ durationInMinutes?: number;
1074
+ }
1075
+ export declare namespace GetProgrammaticAccessCredentialsResponse {
1076
+ /**
1077
+ * @internal
1078
+ */
1079
+ const filterSensitiveLog: (obj: GetProgrammaticAccessCredentialsResponse) => any;
1080
+ }
1081
+ export declare enum LocationType {
1082
+ INGESTION = "INGESTION",
1083
+ SAGEMAKER = "SAGEMAKER"
1084
+ }
1085
+ export interface GetWorkingLocationRequest {
1086
+ /**
1087
+ * <p>Specify the type of the working location.</p>
1088
+ * <ul>
1089
+ * <li>
1090
+ * <p>
1091
+ * <code>SAGEMAKER</code> - Use the Amazon S3 location as a temporary location to store data content when
1092
+ * working with FinSpace Notebooks that run on SageMaker studio.</p>
1093
+ * </li>
1094
+ * <li>
1095
+ * <p>
1096
+ * <code>INGESTION</code> - Use the Amazon S3 location as a staging location to copy your
1097
+ * data content and then use the location with the Changeset creation operation.</p>
1098
+ * </li>
1099
+ * </ul>
1100
+ */
1101
+ locationType?: LocationType | string;
1102
+ }
1103
+ export declare namespace GetWorkingLocationRequest {
1104
+ /**
1105
+ * @internal
1106
+ */
1107
+ const filterSensitiveLog: (obj: GetWorkingLocationRequest) => any;
1108
+ }
1109
+ export interface GetWorkingLocationResponse {
1110
+ /**
1111
+ * <p>Returns the Amazon S3 URI for the working location.</p>
1112
+ */
1113
+ s3Uri?: string;
1114
+ /**
1115
+ * <p>Returns the Amazon S3 Path for the working location.</p>
1116
+ */
1117
+ s3Path?: string;
1118
+ /**
1119
+ * <p>Returns the Amazon S3 bucket name for the working location.</p>
1120
+ */
1121
+ s3Bucket?: string;
1122
+ }
1123
+ export declare namespace GetWorkingLocationResponse {
1124
+ /**
1125
+ * @internal
1126
+ */
1127
+ const filterSensitiveLog: (obj: GetWorkingLocationResponse) => any;
1128
+ }
1129
+ /**
1130
+ * Request to ListChangesetsRequest. It exposes minimal query filters.
1131
+ */
1132
+ export interface ListChangesetsRequest {
1133
+ /**
1134
+ * <p>The unique identifier for the FinSpace Dataset to which the Changeset belongs.</p>
1135
+ */
1136
+ datasetId: string | undefined;
1137
+ /**
1138
+ * <p>The maximum number of results per page.</p>
1139
+ */
1140
+ maxResults?: number;
1141
+ /**
1142
+ * <p>A token indicating where a results page should begin.</p>
1143
+ */
1144
+ nextToken?: string;
1145
+ }
1146
+ export declare namespace ListChangesetsRequest {
1147
+ /**
1148
+ * @internal
1149
+ */
1150
+ const filterSensitiveLog: (obj: ListChangesetsRequest) => any;
1151
+ }
1152
+ /**
1153
+ * <p>A Changeset is unit of data in a Dataset.</p>
1154
+ */
1155
+ export interface ChangesetSummary {
1156
+ /**
1157
+ * <p>The unique identifier for a Changeset.</p>
1158
+ */
1159
+ changesetId?: string;
1160
+ /**
1161
+ * <p>The ARN identifier of the Changeset.</p>
1162
+ */
1163
+ changesetArn?: string;
1164
+ /**
1165
+ * <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
1166
+ */
1167
+ datasetId?: string;
1168
+ /**
1169
+ * <p>Type that indicates how a Changeset is applied to a Dataset.</p>
1170
+ * <ul>
1171
+ * <li>
1172
+ * <p>
1173
+ * <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded
1174
+ * Changesets.</p>
1175
+ * </li>
1176
+ * <li>
1177
+ * <p>
1178
+ * <code>APPEND</code> - Changeset is considered as an addition to the end of all prior
1179
+ * loaded Changesets.</p>
1180
+ * </li>
1181
+ * <li>
1182
+ * <p>
1183
+ * <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior
1184
+ * ingested Changeset.</p>
1185
+ * </li>
1186
+ * </ul>
1187
+ */
1188
+ changeType?: ChangeType | string;
1189
+ /**
1190
+ * <p>Options that define the location of the data being ingested.</p>
1191
+ */
1192
+ sourceParams?: {
1193
+ [key: string]: string;
1194
+ };
1195
+ /**
1196
+ * <p>Options that define the structure of the source file(s).</p>
1197
+ */
1198
+ formatParams?: {
1199
+ [key: string]: string;
1200
+ };
1201
+ /**
1202
+ * <p>The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1203
+ */
1204
+ createTime?: number;
1205
+ /**
1206
+ * <p>Status of the Changeset ingestion.</p>
1207
+ * <ul>
1208
+ * <li>
1209
+ * <p>
1210
+ * <code>PENDING</code> - Changeset is pending creation.</p>
1211
+ * </li>
1212
+ * <li>
1213
+ * <p>
1214
+ * <code>FAILED</code> - Changeset creation has failed.</p>
1215
+ * </li>
1216
+ * <li>
1217
+ * <p>
1218
+ * <code>SUCCESS</code> - Changeset creation has succeeded.</p>
1219
+ * </li>
1220
+ * <li>
1221
+ * <p>
1222
+ * <code>RUNNING</code> - Changeset creation is running.</p>
1223
+ * </li>
1224
+ * <li>
1225
+ * <p>
1226
+ * <code>STOP_REQUESTED</code> - User requested Changeset creation to stop.</p>
1227
+ * </li>
1228
+ * </ul>
1229
+ */
1230
+ status?: IngestionStatus | string;
1231
+ /**
1232
+ * <p>The structure with error messages.</p>
1233
+ */
1234
+ errorInfo?: ChangesetErrorInfo;
1235
+ /**
1236
+ * <p>Time until 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.</p>
1237
+ */
1238
+ activeUntilTimestamp?: number;
1239
+ /**
1240
+ * Milliseconds since UTC epoch
1241
+ */
1242
+ activeFromTimestamp?: number;
1243
+ /**
1244
+ * <p>The unique identifier of the Changeset that is updated.</p>
1245
+ */
1246
+ updatesChangesetId?: string;
1247
+ /**
1248
+ * <p>The unique identifier of the updated Changeset.</p>
1249
+ */
1250
+ updatedByChangesetId?: string;
1251
+ }
1252
+ export declare namespace ChangesetSummary {
1253
+ /**
1254
+ * @internal
1255
+ */
1256
+ const filterSensitiveLog: (obj: ChangesetSummary) => any;
1257
+ }
1258
+ /**
1259
+ * Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
1260
+ */
1261
+ export interface ListChangesetsResponse {
1262
+ /**
1263
+ * <p>List of Changesets found.</p>
1264
+ */
1265
+ changesets?: ChangesetSummary[];
1266
+ /**
1267
+ * <p>A token indicating where a results page should begin.</p>
1268
+ */
1269
+ nextToken?: string;
1270
+ }
1271
+ export declare namespace ListChangesetsResponse {
1272
+ /**
1273
+ * @internal
1274
+ */
1275
+ const filterSensitiveLog: (obj: ListChangesetsResponse) => any;
1276
+ }
1277
+ /**
1278
+ * Request for the ListDatasets operation.
1279
+ */
1280
+ export interface ListDatasetsRequest {
1281
+ /**
1282
+ * <p>A token indicating where a results page should begin.</p>
1283
+ */
1284
+ nextToken?: string;
1285
+ /**
1286
+ * <p>The maximum number of results per page.</p>
1287
+ */
1288
+ maxResults?: number;
1289
+ }
1290
+ export declare namespace ListDatasetsRequest {
1291
+ /**
1292
+ * @internal
1293
+ */
1294
+ const filterSensitiveLog: (obj: ListDatasetsRequest) => any;
1295
+ }
1296
+ /**
1297
+ * <p>The structure for a Dataset.</p>
1298
+ */
1299
+ export interface Dataset {
1300
+ /**
1301
+ * <p>An identifier for a Dataset.</p>
1302
+ */
1303
+ datasetId?: string;
1304
+ /**
1305
+ * <p>The ARN identifier of the Dataset.</p>
1306
+ */
1307
+ datasetArn?: string;
1308
+ /**
1309
+ * <p>Display title for a Dataset.</p>
1310
+ */
1311
+ datasetTitle?: string;
1312
+ /**
1313
+ * <p>The format in which Dataset data is structured.</p>
1314
+ * <ul>
1315
+ * <li>
1316
+ * <p>
1317
+ * <code>TABULAR</code> - Data is structured in a tabular format.</p>
1318
+ * </li>
1319
+ * <li>
1320
+ * <p>
1321
+ * <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p>
1322
+ * </li>
1323
+ * </ul>
1324
+ */
1325
+ kind?: DatasetKind | string;
1326
+ /**
1327
+ * <p>Description for a Dataset.</p>
1328
+ */
1329
+ datasetDescription?: string;
1330
+ /**
1331
+ * <p>Contact information for a Dataset owner.</p>
1332
+ */
1333
+ ownerInfo?: DatasetOwnerInfo;
1334
+ /**
1335
+ * <p>The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1336
+ */
1337
+ createTime?: number;
1338
+ /**
1339
+ * <p>The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1340
+ */
1341
+ lastModifiedTime?: number;
1342
+ /**
1343
+ * <p>Definition for a schema on a tabular Dataset.</p>
1344
+ */
1345
+ schemaDefinition?: SchemaUnion;
1346
+ /**
1347
+ * <p>The unique resource identifier for a Dataset.</p>
1348
+ */
1349
+ alias?: string;
1350
+ }
1351
+ export declare namespace Dataset {
1352
+ /**
1353
+ * @internal
1354
+ */
1355
+ const filterSensitiveLog: (obj: Dataset) => any;
1356
+ }
1357
+ /**
1358
+ * Response for the ListDatasets operation
1359
+ */
1360
+ export interface ListDatasetsResponse {
1361
+ /**
1362
+ * <p>List of Datasets.</p>
1363
+ */
1364
+ datasets?: Dataset[];
1365
+ /**
1366
+ * <p>A token indicating where a results page should begin.</p>
1367
+ */
1368
+ nextToken?: string;
1369
+ }
1370
+ export declare namespace ListDatasetsResponse {
1371
+ /**
1372
+ * @internal
1373
+ */
1374
+ const filterSensitiveLog: (obj: ListDatasetsResponse) => any;
1375
+ }
1376
+ /**
1377
+ * Request for a list data views.
1378
+ */
1379
+ export interface ListDataViewsRequest {
1380
+ /**
1381
+ * <p>The unique identifier of the Dataset for which to retrieve Dataviews.</p>
1382
+ */
1383
+ datasetId: string | undefined;
1384
+ /**
1385
+ * <p>A token indicating where a results page should begin.</p>
1386
+ */
1387
+ nextToken?: string;
1388
+ /**
1389
+ * <p>The maximum number of results per page.</p>
1390
+ */
1391
+ maxResults?: number;
1392
+ }
1393
+ export declare namespace ListDataViewsRequest {
1394
+ /**
1395
+ * @internal
1396
+ */
1397
+ const filterSensitiveLog: (obj: ListDataViewsRequest) => any;
1398
+ }
1399
+ /**
1400
+ * <p>Structure for the summary of a Dataview.</p>
1401
+ */
1402
+ export interface DataViewSummary {
1403
+ /**
1404
+ * <p>The unique identifier for the Dataview.</p>
1405
+ */
1406
+ dataViewId?: string;
1407
+ /**
1408
+ * <p>The ARN identifier of the Dataview.</p>
1409
+ */
1410
+ dataViewArn?: string;
1411
+ /**
1412
+ * <p>Th unique identifier for the Dataview Dataset.</p>
1413
+ */
1414
+ datasetId?: string;
1415
+ /**
1416
+ * <p>Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1417
+ */
1418
+ asOfTimestamp?: number;
1419
+ /**
1420
+ * <p>Ordered set of column names used to partition data.</p>
1421
+ */
1422
+ partitionColumns?: string[];
1423
+ /**
1424
+ * <p>Columns to be used for sorting the data.</p>
1425
+ */
1426
+ sortColumns?: string[];
1427
+ /**
1428
+ * <p>The status of a Dataview creation.</p>
1429
+ * <ul>
1430
+ * <li>
1431
+ * <p>
1432
+ * <code>RUNNING</code> - Dataview creation is running.</p>
1433
+ * </li>
1434
+ * <li>
1435
+ * <p>
1436
+ * <code>STARTING</code> - Dataview creation is starting.</p>
1437
+ * </li>
1438
+ * <li>
1439
+ * <p>
1440
+ * <code>FAILED</code> - Dataview creation has failed.</p>
1441
+ * </li>
1442
+ * <li>
1443
+ * <p>
1444
+ * <code>CANCELLED</code> - Dataview creation has been cancelled.</p>
1445
+ * </li>
1446
+ * <li>
1447
+ * <p>
1448
+ * <code>TIMEOUT</code> - Dataview creation has timed out.</p>
1449
+ * </li>
1450
+ * <li>
1451
+ * <p>
1452
+ * <code>SUCCESS</code> - Dataview creation has succeeded.</p>
1453
+ * </li>
1454
+ * <li>
1455
+ * <p>
1456
+ * <code>PENDING</code> - Dataview creation is pending.</p>
1457
+ * </li>
1458
+ * <li>
1459
+ * <p>
1460
+ * <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed.</p>
1461
+ * </li>
1462
+ * </ul>
1463
+ */
1464
+ status?: DataViewStatus | string;
1465
+ /**
1466
+ * <p>The structure with error messages.</p>
1467
+ */
1468
+ errorInfo?: DataViewErrorInfo;
1469
+ /**
1470
+ * <p>Information about the Dataview destination.</p>
1471
+ */
1472
+ destinationTypeProperties?: DataViewDestinationTypeParams;
1473
+ /**
1474
+ * <p>The flag to indicate Dataview should be updated automatically.</p>
1475
+ */
1476
+ autoUpdate?: boolean;
1477
+ /**
1478
+ * <p>The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1479
+ */
1480
+ createTime?: number;
1481
+ /**
1482
+ * <p>The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
1483
+ */
1484
+ lastModifiedTime?: number;
1485
+ }
1486
+ export declare namespace DataViewSummary {
1487
+ /**
1488
+ * @internal
1489
+ */
1490
+ const filterSensitiveLog: (obj: DataViewSummary) => any;
1491
+ }
1492
+ export interface ListDataViewsResponse {
1493
+ /**
1494
+ * <p>A token indicating where a results page should begin.</p>
1495
+ */
1496
+ nextToken?: string;
1497
+ /**
1498
+ * <p>A list of Dataviews.</p>
1499
+ */
1500
+ dataViews?: DataViewSummary[];
1501
+ }
1502
+ export declare namespace ListDataViewsResponse {
1503
+ /**
1504
+ * @internal
1505
+ */
1506
+ const filterSensitiveLog: (obj: ListDataViewsResponse) => any;
1507
+ }
1508
+ /**
1509
+ * Request to update an existing changeset.
1510
+ */
1511
+ export interface UpdateChangesetRequest {
1512
+ /**
1513
+ * <p>A token used to ensure idempotency.</p>
1514
+ */
1515
+ clientToken?: string;
1516
+ /**
1517
+ * <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
1518
+ */
1519
+ datasetId: string | undefined;
1520
+ /**
1521
+ * <p>The unique identifier for the Changeset to update.</p>
1522
+ */
1523
+ changesetId: string | undefined;
1524
+ /**
1525
+ * <p>Options that define the location of the data being ingested.</p>
1526
+ */
1527
+ sourceParams: {
1528
+ [key: string]: string;
1529
+ } | undefined;
1530
+ /**
1531
+ * <p>Options that define the structure of the source file(s).</p>
1532
+ */
1533
+ formatParams: {
1534
+ [key: string]: string;
1535
+ } | undefined;
1536
+ }
1537
+ export declare namespace UpdateChangesetRequest {
1538
+ /**
1539
+ * @internal
1540
+ */
1541
+ const filterSensitiveLog: (obj: UpdateChangesetRequest) => any;
1542
+ }
1543
+ /**
1544
+ * The response from a update changeset operation.
1545
+ */
1546
+ export interface UpdateChangesetResponse {
1547
+ /**
1548
+ * <p>The unique identifier for the Changeset to update.</p>
1549
+ */
1550
+ changesetId?: string;
1551
+ /**
1552
+ * <p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>
1553
+ */
1554
+ datasetId?: string;
1555
+ }
1556
+ export declare namespace UpdateChangesetResponse {
1557
+ /**
1558
+ * @internal
1559
+ */
1560
+ const filterSensitiveLog: (obj: UpdateChangesetResponse) => any;
1561
+ }
1562
+ /**
1563
+ * The request for an UpdateDataset operation
1564
+ */
1565
+ export interface UpdateDatasetRequest {
1566
+ /**
1567
+ * <p>A token used to ensure idempotency.</p>
1568
+ */
1569
+ clientToken?: string;
1570
+ /**
1571
+ * <p>The unique identifier for the Dataset to update.</p>
1572
+ */
1573
+ datasetId: string | undefined;
1574
+ /**
1575
+ * <p>A display title for the Dataset.</p>
1576
+ */
1577
+ datasetTitle: string | undefined;
1578
+ /**
1579
+ * <p>The format in which the Dataset data is structured.</p>
1580
+ * <ul>
1581
+ * <li>
1582
+ * <p>
1583
+ * <code>TABULAR</code> - Data is structured in a tabular format.</p>
1584
+ * </li>
1585
+ * <li>
1586
+ * <p>
1587
+ * <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p>
1588
+ * </li>
1589
+ * </ul>
1590
+ */
1591
+ kind: DatasetKind | string | undefined;
1592
+ /**
1593
+ * <p>A description for the Dataset.</p>
1594
+ */
1595
+ datasetDescription?: string;
1596
+ /**
1597
+ * <p>The unique resource identifier for a Dataset.</p>
1598
+ */
1599
+ alias?: string;
1600
+ /**
1601
+ * <p>Definition for a schema on a tabular Dataset.</p>
1602
+ */
1603
+ schemaDefinition?: SchemaUnion;
1604
+ }
1605
+ export declare namespace UpdateDatasetRequest {
1606
+ /**
1607
+ * @internal
1608
+ */
1609
+ const filterSensitiveLog: (obj: UpdateDatasetRequest) => any;
1610
+ }
1611
+ /**
1612
+ * The response from an UpdateDataset operation
1613
+ */
1614
+ export interface UpdateDatasetResponse {
1615
+ /**
1616
+ * <p>The unique identifier for updated Dataset.</p>
1617
+ */
1618
+ datasetId?: string;
1619
+ }
1620
+ export declare namespace UpdateDatasetResponse {
1621
+ /**
1622
+ * @internal
1623
+ */
1624
+ const filterSensitiveLog: (obj: UpdateDatasetResponse) => any;
429
1625
  }