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