@aws-sdk/client-databrew 3.533.0 → 3.535.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 (93) hide show
  1. package/dist-types/DataBrew.d.ts +7 -1
  2. package/dist-types/DataBrewClient.d.ts +1 -1
  3. package/dist-types/commands/BatchDeleteRecipeVersionCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateProfileJobCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateProjectCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateRecipeCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateRecipeJobCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateRulesetCommand.d.ts +2 -1
  10. package/dist-types/commands/CreateScheduleCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteDatasetCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteJobCommand.d.ts +2 -1
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +2 -1
  14. package/dist-types/commands/DeleteRecipeVersionCommand.d.ts +2 -1
  15. package/dist-types/commands/DeleteRulesetCommand.d.ts +2 -1
  16. package/dist-types/commands/DeleteScheduleCommand.d.ts +2 -1
  17. package/dist-types/commands/DescribeDatasetCommand.d.ts +2 -1
  18. package/dist-types/commands/DescribeJobCommand.d.ts +2 -1
  19. package/dist-types/commands/DescribeJobRunCommand.d.ts +2 -1
  20. package/dist-types/commands/DescribeProjectCommand.d.ts +2 -1
  21. package/dist-types/commands/DescribeRecipeCommand.d.ts +2 -1
  22. package/dist-types/commands/DescribeRulesetCommand.d.ts +2 -1
  23. package/dist-types/commands/DescribeScheduleCommand.d.ts +2 -1
  24. package/dist-types/commands/ListDatasetsCommand.d.ts +2 -1
  25. package/dist-types/commands/ListJobRunsCommand.d.ts +2 -1
  26. package/dist-types/commands/ListJobsCommand.d.ts +2 -1
  27. package/dist-types/commands/ListProjectsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListRecipeVersionsCommand.d.ts +2 -1
  29. package/dist-types/commands/ListRecipesCommand.d.ts +2 -1
  30. package/dist-types/commands/ListRulesetsCommand.d.ts +2 -1
  31. package/dist-types/commands/ListSchedulesCommand.d.ts +2 -1
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  33. package/dist-types/commands/PublishRecipeCommand.d.ts +2 -1
  34. package/dist-types/commands/SendProjectSessionActionCommand.d.ts +2 -1
  35. package/dist-types/commands/StartJobRunCommand.d.ts +2 -1
  36. package/dist-types/commands/StartProjectSessionCommand.d.ts +2 -1
  37. package/dist-types/commands/StopJobRunCommand.d.ts +2 -1
  38. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  39. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  40. package/dist-types/commands/UpdateDatasetCommand.d.ts +2 -1
  41. package/dist-types/commands/UpdateProfileJobCommand.d.ts +2 -1
  42. package/dist-types/commands/UpdateProjectCommand.d.ts +2 -1
  43. package/dist-types/commands/UpdateRecipeCommand.d.ts +2 -1
  44. package/dist-types/commands/UpdateRecipeJobCommand.d.ts +2 -1
  45. package/dist-types/commands/UpdateRulesetCommand.d.ts +2 -1
  46. package/dist-types/commands/UpdateScheduleCommand.d.ts +2 -1
  47. package/dist-types/models/models_0.d.ts +568 -568
  48. package/dist-types/ts3.4/DataBrew.d.ts +6 -0
  49. package/dist-types/ts3.4/commands/BatchDeleteRecipeVersionCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/CreateProfileJobCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/CreateRecipeCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/CreateRecipeJobCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/CreateRulesetCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/CreateScheduleCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/DeleteJobCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/DeleteProjectCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/DeleteRecipeVersionCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/DeleteRulesetCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/DeleteScheduleCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/DescribeDatasetCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/DescribeJobCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/DescribeJobRunCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/DescribeProjectCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/DescribeRecipeCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/DescribeRulesetCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/DescribeScheduleCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/ListJobRunsCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +9 -0
  73. package/dist-types/ts3.4/commands/ListProjectsCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/ListRecipeVersionsCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/ListRecipesCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/ListRulesetsCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/ListSchedulesCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  79. package/dist-types/ts3.4/commands/PublishRecipeCommand.d.ts +9 -0
  80. package/dist-types/ts3.4/commands/SendProjectSessionActionCommand.d.ts +9 -0
  81. package/dist-types/ts3.4/commands/StartJobRunCommand.d.ts +9 -0
  82. package/dist-types/ts3.4/commands/StartProjectSessionCommand.d.ts +9 -0
  83. package/dist-types/ts3.4/commands/StopJobRunCommand.d.ts +9 -0
  84. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  85. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  86. package/dist-types/ts3.4/commands/UpdateDatasetCommand.d.ts +9 -0
  87. package/dist-types/ts3.4/commands/UpdateProfileJobCommand.d.ts +9 -0
  88. package/dist-types/ts3.4/commands/UpdateProjectCommand.d.ts +9 -0
  89. package/dist-types/ts3.4/commands/UpdateRecipeCommand.d.ts +9 -0
  90. package/dist-types/ts3.4/commands/UpdateRecipeJobCommand.d.ts +9 -0
  91. package/dist-types/ts3.4/commands/UpdateRulesetCommand.d.ts +9 -0
  92. package/dist-types/ts3.4/commands/UpdateScheduleCommand.d.ts +9 -0
  93. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { DataBrewServiceException as __BaseException } from "./DataBrewServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>Access to the specified resource was denied.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -14,15 +14,15 @@ export declare class AccessDeniedException extends __BaseException {
14
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
15
  }
16
16
  /**
17
- * @public
18
17
  * <p>Configuration of statistics that are allowed to be run on columns that
19
18
  * contain detected entities. When undefined, no statistics will be computed
20
19
  * on columns that contain detected entities.</p>
20
+ * @public
21
21
  */
22
22
  export interface AllowedStatistics {
23
23
  /**
24
- * @public
25
24
  * <p>One or more column statistics to allow for columns that contain detected entities.</p>
25
+ * @public
26
26
  */
27
27
  Statistics: string[] | undefined;
28
28
  }
@@ -43,37 +43,37 @@ export type AnalyticsMode = (typeof AnalyticsMode)[keyof typeof AnalyticsMode];
43
43
  */
44
44
  export interface BatchDeleteRecipeVersionRequest {
45
45
  /**
46
- * @public
47
46
  * <p>The name of the recipe whose versions are to be deleted.</p>
47
+ * @public
48
48
  */
49
49
  Name: string | undefined;
50
50
  /**
51
- * @public
52
51
  * <p>An array of version identifiers, for the recipe versions to be deleted. You can
53
52
  * specify numeric versions (<code>X.Y</code>) or <code>LATEST_WORKING</code>.
54
53
  * <code>LATEST_PUBLISHED</code> is not supported.</p>
54
+ * @public
55
55
  */
56
56
  RecipeVersions: string[] | undefined;
57
57
  }
58
58
  /**
59
- * @public
60
59
  * <p>Represents any errors encountered when attempting to delete multiple recipe
61
60
  * versions.</p>
61
+ * @public
62
62
  */
63
63
  export interface RecipeVersionErrorDetail {
64
64
  /**
65
- * @public
66
65
  * <p>The HTTP status code for the error.</p>
66
+ * @public
67
67
  */
68
68
  ErrorCode?: string;
69
69
  /**
70
- * @public
71
70
  * <p>The text of the error message.</p>
71
+ * @public
72
72
  */
73
73
  ErrorMessage?: string;
74
74
  /**
75
- * @public
76
75
  * <p>The identifier for the recipe version associated with this error.</p>
76
+ * @public
77
77
  */
78
78
  RecipeVersion?: string;
79
79
  }
@@ -82,19 +82,19 @@ export interface RecipeVersionErrorDetail {
82
82
  */
83
83
  export interface BatchDeleteRecipeVersionResponse {
84
84
  /**
85
- * @public
86
85
  * <p>The name of the recipe that was modified.</p>
86
+ * @public
87
87
  */
88
88
  Name: string | undefined;
89
89
  /**
90
- * @public
91
90
  * <p>Errors, if any, that occurred while attempting to delete the recipe versions.</p>
91
+ * @public
92
92
  */
93
93
  Errors?: RecipeVersionErrorDetail[];
94
94
  }
95
95
  /**
96
- * @public
97
96
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
97
+ * @public
98
98
  */
99
99
  export declare class ConflictException extends __BaseException {
100
100
  readonly name: "ConflictException";
@@ -106,8 +106,8 @@ export declare class ConflictException extends __BaseException {
106
106
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
107
107
  }
108
108
  /**
109
- * @public
110
109
  * <p>One or more resources can't be found.</p>
110
+ * @public
111
111
  */
112
112
  export declare class ResourceNotFoundException extends __BaseException {
113
113
  readonly name: "ResourceNotFoundException";
@@ -119,8 +119,8 @@ export declare class ResourceNotFoundException extends __BaseException {
119
119
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
120
120
  }
121
121
  /**
122
- * @public
123
122
  * <p>The input parameters for this request failed validation.</p>
123
+ * @public
124
124
  */
125
125
  export declare class ValidationException extends __BaseException {
126
126
  readonly name: "ValidationException";
@@ -147,197 +147,197 @@ export declare const InputFormat: {
147
147
  */
148
148
  export type InputFormat = (typeof InputFormat)[keyof typeof InputFormat];
149
149
  /**
150
- * @public
151
150
  * <p>Represents a set of options that define how DataBrew will read a
152
151
  * comma-separated value (CSV) file when creating a dataset from that file.</p>
152
+ * @public
153
153
  */
154
154
  export interface CsvOptions {
155
155
  /**
156
- * @public
157
156
  * <p>A single character that specifies the delimiter being used in the CSV file.</p>
157
+ * @public
158
158
  */
159
159
  Delimiter?: string;
160
160
  /**
161
- * @public
162
161
  * <p>A variable that specifies whether the first row in the file is parsed as the
163
162
  * header. If this value is false, column names are auto-generated.</p>
163
+ * @public
164
164
  */
165
165
  HeaderRow?: boolean;
166
166
  }
167
167
  /**
168
- * @public
169
168
  * <p>Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when
170
169
  * creating a dataset from that file.</p>
170
+ * @public
171
171
  */
172
172
  export interface ExcelOptions {
173
173
  /**
174
- * @public
175
174
  * <p>One or more named sheets in the Excel file that will be included in the dataset.</p>
175
+ * @public
176
176
  */
177
177
  SheetNames?: string[];
178
178
  /**
179
- * @public
180
179
  * <p>One or more sheet numbers in the Excel file that will be included in the
181
180
  * dataset.</p>
181
+ * @public
182
182
  */
183
183
  SheetIndexes?: number[];
184
184
  /**
185
- * @public
186
185
  * <p>A variable that specifies whether the first row in the file is parsed as the
187
186
  * header. If this value is false, column names are auto-generated.</p>
187
+ * @public
188
188
  */
189
189
  HeaderRow?: boolean;
190
190
  }
191
191
  /**
192
- * @public
193
192
  * <p>Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.</p>
193
+ * @public
194
194
  */
195
195
  export interface JsonOptions {
196
196
  /**
197
- * @public
198
197
  * <p>A value that specifies whether JSON input contains embedded new line
199
198
  * characters.</p>
199
+ * @public
200
200
  */
201
201
  MultiLine?: boolean;
202
202
  }
203
203
  /**
204
- * @public
205
204
  * <p>Represents a set of options that define the structure of either comma-separated value (CSV),
206
205
  * Excel, or JSON input.</p>
206
+ * @public
207
207
  */
208
208
  export interface FormatOptions {
209
209
  /**
210
- * @public
211
210
  * <p>Options that define how JSON input is to be interpreted by DataBrew.</p>
211
+ * @public
212
212
  */
213
213
  Json?: JsonOptions;
214
214
  /**
215
- * @public
216
215
  * <p>Options that define how Excel input is to be interpreted by DataBrew.</p>
216
+ * @public
217
217
  */
218
218
  Excel?: ExcelOptions;
219
219
  /**
220
- * @public
221
220
  * <p>Options that define how CSV input is to be interpreted by DataBrew.</p>
221
+ * @public
222
222
  */
223
223
  Csv?: CsvOptions;
224
224
  }
225
225
  /**
226
- * @public
227
226
  * <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read
228
227
  * input data, or write output from a job.</p>
228
+ * @public
229
229
  */
230
230
  export interface S3Location {
231
231
  /**
232
- * @public
233
232
  * <p>The Amazon S3 bucket name.</p>
233
+ * @public
234
234
  */
235
235
  Bucket: string | undefined;
236
236
  /**
237
- * @public
238
237
  * <p>The unique name of the object in the bucket.</p>
238
+ * @public
239
239
  */
240
240
  Key?: string;
241
241
  /**
242
- * @public
243
242
  * <p>The Amazon Web Services account ID of the bucket owner.</p>
243
+ * @public
244
244
  */
245
245
  BucketOwner?: string;
246
246
  }
247
247
  /**
248
- * @public
249
248
  * <p>Connection information for dataset input files stored in a database.</p>
249
+ * @public
250
250
  */
251
251
  export interface DatabaseInputDefinition {
252
252
  /**
253
- * @public
254
253
  * <p>The Glue Connection that stores the connection information for the target
255
254
  * database.</p>
255
+ * @public
256
256
  */
257
257
  GlueConnectionName: string | undefined;
258
258
  /**
259
- * @public
260
259
  * <p>The table within the target database.</p>
260
+ * @public
261
261
  */
262
262
  DatabaseTableName?: string;
263
263
  /**
264
- * @public
265
264
  * <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read
266
265
  * input data, or write output from a job.</p>
266
+ * @public
267
267
  */
268
268
  TempDirectory?: S3Location;
269
269
  /**
270
- * @public
271
270
  * <p>Custom SQL to run against the provided Glue connection. This SQL will be used as
272
271
  * the input for DataBrew projects and jobs.</p>
272
+ * @public
273
273
  */
274
274
  QueryString?: string;
275
275
  }
276
276
  /**
277
- * @public
278
277
  * <p>Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew
279
278
  * dataset. </p>
279
+ * @public
280
280
  */
281
281
  export interface DataCatalogInputDefinition {
282
282
  /**
283
- * @public
284
283
  * <p>The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the
285
284
  * data.</p>
285
+ * @public
286
286
  */
287
287
  CatalogId?: string;
288
288
  /**
289
- * @public
290
289
  * <p>The name of a database in the Data Catalog.</p>
290
+ * @public
291
291
  */
292
292
  DatabaseName: string | undefined;
293
293
  /**
294
- * @public
295
294
  * <p>The name of a database table in the Data Catalog. This table corresponds to a DataBrew
296
295
  * dataset.</p>
296
+ * @public
297
297
  */
298
298
  TableName: string | undefined;
299
299
  /**
300
- * @public
301
300
  * <p>Represents an Amazon location where DataBrew can store intermediate results.</p>
301
+ * @public
302
302
  */
303
303
  TempDirectory?: S3Location;
304
304
  }
305
305
  /**
306
- * @public
307
306
  * <p>Contains additional resource information needed for specific datasets.</p>
307
+ * @public
308
308
  */
309
309
  export interface Metadata {
310
310
  /**
311
- * @public
312
311
  * <p>The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew
313
312
  * only supports ARNs from Amazon AppFlow.</p>
313
+ * @public
314
314
  */
315
315
  SourceArn?: string;
316
316
  }
317
317
  /**
318
- * @public
319
318
  * <p>Represents information on how DataBrew can find data, in either the Glue Data Catalog or
320
319
  * Amazon S3.</p>
320
+ * @public
321
321
  */
322
322
  export interface Input {
323
323
  /**
324
- * @public
325
324
  * <p>The Amazon S3 location where the data is stored.</p>
325
+ * @public
326
326
  */
327
327
  S3InputDefinition?: S3Location;
328
328
  /**
329
- * @public
330
329
  * <p>The Glue Data Catalog parameters for the data.</p>
330
+ * @public
331
331
  */
332
332
  DataCatalogInputDefinition?: DataCatalogInputDefinition;
333
333
  /**
334
- * @public
335
334
  * <p>Connection information for dataset input files stored in a database.</p>
335
+ * @public
336
336
  */
337
337
  DatabaseInputDefinition?: DatabaseInputDefinition;
338
338
  /**
339
- * @public
340
339
  * <p>Contains additional resource information needed for specific datasets.</p>
340
+ * @public
341
341
  */
342
342
  Metadata?: Metadata;
343
343
  }
@@ -365,74 +365,74 @@ export declare const OrderedBy: {
365
365
  */
366
366
  export type OrderedBy = (typeof OrderedBy)[keyof typeof OrderedBy];
367
367
  /**
368
- * @public
369
368
  * <p>Represents a limit imposed on number of Amazon S3 files that should be selected for a
370
369
  * dataset from a connected Amazon S3 path.</p>
370
+ * @public
371
371
  */
372
372
  export interface FilesLimit {
373
373
  /**
374
- * @public
375
374
  * <p>The number of Amazon S3 files to select.</p>
375
+ * @public
376
376
  */
377
377
  MaxFiles: number | undefined;
378
378
  /**
379
- * @public
380
379
  * <p>A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as
381
380
  * a sorting criteria. Currently it's the only allowed value.</p>
381
+ * @public
382
382
  */
383
383
  OrderedBy?: OrderedBy;
384
384
  /**
385
- * @public
386
385
  * <p>A criteria to use for Amazon S3 files sorting before their selection. By
387
386
  * default uses DESCENDING order, i.e. most recent files are selected first. Another
388
387
  * possible value is ASCENDING.</p>
388
+ * @public
389
389
  */
390
390
  Order?: Order;
391
391
  }
392
392
  /**
393
- * @public
394
393
  * <p>Represents a structure for defining parameter conditions. Supported conditions are described
395
394
  * here: <a href="https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets">Supported
396
395
  * conditions for dynamic datasets</a> in the
397
396
  * <i>Glue DataBrew Developer Guide</i>.</p>
397
+ * @public
398
398
  */
399
399
  export interface FilterExpression {
400
400
  /**
401
- * @public
402
401
  * <p>The expression which includes condition names followed by substitution variables, possibly grouped
403
402
  * and combined with other conditions. For example, "(starts_with :prefix1 or starts_with :prefix2) and
404
403
  * (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol.</p>
404
+ * @public
405
405
  */
406
406
  Expression: string | undefined;
407
407
  /**
408
- * @public
409
408
  * <p>The map of substitution variable names to their values used in this filter expression.</p>
409
+ * @public
410
410
  */
411
411
  ValuesMap: Record<string, string> | undefined;
412
412
  }
413
413
  /**
414
- * @public
415
414
  * <p>Represents additional options for correct interpretation of datetime parameters used in
416
415
  * the Amazon S3 path of a dataset.</p>
416
+ * @public
417
417
  */
418
418
  export interface DatetimeOptions {
419
419
  /**
420
- * @public
421
420
  * <p>Required option, that defines the datetime format used for a date parameter in the
422
421
  * Amazon S3 path. Should use only supported datetime specifiers and separation characters, all
423
422
  * literal a-z or A-Z characters should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm".</p>
423
+ * @public
424
424
  */
425
425
  Format: string | undefined;
426
426
  /**
427
- * @public
428
427
  * <p>Optional value for a timezone offset of the datetime parameter value in the Amazon S3
429
428
  * path. Shouldn't be used if Format for this parameter includes timezone fields.
430
429
  * If no offset specified, UTC is assumed.</p>
430
+ * @public
431
431
  */
432
432
  TimezoneOffset?: string;
433
433
  /**
434
- * @public
435
434
  * <p>Optional value for a non-US locale code, needed for correct interpretation of some date formats.</p>
435
+ * @public
436
436
  */
437
437
  LocaleCode?: string;
438
438
  }
@@ -450,58 +450,58 @@ export declare const ParameterType: {
450
450
  */
451
451
  export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
452
452
  /**
453
- * @public
454
453
  * <p>Represents a dataset parameter that defines type and conditions for a parameter in the
455
454
  * Amazon S3 path of the dataset.</p>
455
+ * @public
456
456
  */
457
457
  export interface DatasetParameter {
458
458
  /**
459
- * @public
460
459
  * <p>The name of the parameter that is used in the dataset's Amazon S3 path.</p>
460
+ * @public
461
461
  */
462
462
  Name: string | undefined;
463
463
  /**
464
- * @public
465
464
  * <p>The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.</p>
465
+ * @public
466
466
  */
467
467
  Type: ParameterType | undefined;
468
468
  /**
469
- * @public
470
469
  * <p>Additional parameter options such as a format and a timezone. Required for datetime parameters.</p>
470
+ * @public
471
471
  */
472
472
  DatetimeOptions?: DatetimeOptions;
473
473
  /**
474
- * @public
475
474
  * <p>Optional boolean value that defines whether the captured value of this parameter
476
475
  * should be used to create a new column in a dataset.</p>
476
+ * @public
477
477
  */
478
478
  CreateColumn?: boolean;
479
479
  /**
480
- * @public
481
480
  * <p>The optional filter expression structure to apply additional matching criteria to the parameter.</p>
481
+ * @public
482
482
  */
483
483
  Filter?: FilterExpression;
484
484
  }
485
485
  /**
486
- * @public
487
486
  * <p>Represents a set of options that define how DataBrew selects files for a given Amazon S3
488
487
  * path in a dataset.</p>
488
+ * @public
489
489
  */
490
490
  export interface PathOptions {
491
491
  /**
492
- * @public
493
492
  * <p>If provided, this structure defines a date range for matching Amazon S3 objects based on their
494
493
  * LastModifiedDate attribute in Amazon S3.</p>
494
+ * @public
495
495
  */
496
496
  LastModifiedDateCondition?: FilterExpression;
497
497
  /**
498
- * @public
499
498
  * <p>If provided, this structure imposes a limit on a number of files that should be selected.</p>
499
+ * @public
500
500
  */
501
501
  FilesLimit?: FilesLimit;
502
502
  /**
503
- * @public
504
503
  * <p>A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.</p>
504
+ * @public
505
505
  */
506
506
  Parameters?: Record<string, DatasetParameter>;
507
507
  }
@@ -510,36 +510,36 @@ export interface PathOptions {
510
510
  */
511
511
  export interface CreateDatasetRequest {
512
512
  /**
513
- * @public
514
513
  * <p>The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z,
515
514
  * 0-9), hyphen (-), period (.), and space.</p>
515
+ * @public
516
516
  */
517
517
  Name: string | undefined;
518
518
  /**
519
- * @public
520
519
  * <p>The file format of a dataset that is created from an Amazon S3 file or folder.</p>
520
+ * @public
521
521
  */
522
522
  Format?: InputFormat;
523
523
  /**
524
- * @public
525
524
  * <p>Represents a set of options that define the structure of either comma-separated value (CSV),
526
525
  * Excel, or JSON input.</p>
526
+ * @public
527
527
  */
528
528
  FormatOptions?: FormatOptions;
529
529
  /**
530
- * @public
531
530
  * <p>Represents information on how DataBrew can find data, in either the Glue Data Catalog or
532
531
  * Amazon S3.</p>
532
+ * @public
533
533
  */
534
534
  Input: Input | undefined;
535
535
  /**
536
- * @public
537
536
  * <p>A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.</p>
537
+ * @public
538
538
  */
539
539
  PathOptions?: PathOptions;
540
540
  /**
541
- * @public
542
541
  * <p>Metadata tags to apply to this dataset.</p>
542
+ * @public
543
543
  */
544
544
  Tags?: Record<string, string>;
545
545
  }
@@ -548,14 +548,14 @@ export interface CreateDatasetRequest {
548
548
  */
549
549
  export interface CreateDatasetResponse {
550
550
  /**
551
- * @public
552
551
  * <p>The name of the dataset that you created.</p>
552
+ * @public
553
553
  */
554
554
  Name: string | undefined;
555
555
  }
556
556
  /**
557
- * @public
558
557
  * <p>A service quota is exceeded.</p>
558
+ * @public
559
559
  */
560
560
  export declare class ServiceQuotaExceededException extends __BaseException {
561
561
  readonly name: "ServiceQuotaExceededException";
@@ -567,87 +567,86 @@ export declare class ServiceQuotaExceededException extends __BaseException {
567
567
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
568
568
  }
569
569
  /**
570
- * @public
571
570
  * <p>Selector of a column from a dataset for profile job configuration.
572
571
  * One selector includes either a column name or a regular expression.</p>
572
+ * @public
573
573
  */
574
574
  export interface ColumnSelector {
575
575
  /**
576
- * @public
577
576
  * <p>A regular expression for selecting a column from a dataset.</p>
577
+ * @public
578
578
  */
579
579
  Regex?: string;
580
580
  /**
581
- * @public
582
581
  * <p>The name of a column from a dataset.</p>
582
+ * @public
583
583
  */
584
584
  Name?: string;
585
585
  }
586
586
  /**
587
- * @public
588
587
  * <p>Override of a particular evaluation for a profile job. </p>
588
+ * @public
589
589
  */
590
590
  export interface StatisticOverride {
591
591
  /**
592
- * @public
593
592
  * <p>The name of an evaluation</p>
593
+ * @public
594
594
  */
595
595
  Statistic: string | undefined;
596
596
  /**
597
- * @public
598
597
  * <p>A map that includes overrides of an evaluation’s parameters.</p>
598
+ * @public
599
599
  */
600
600
  Parameters: Record<string, string> | undefined;
601
601
  }
602
602
  /**
603
- * @public
604
603
  * <p>Configuration of evaluations for a profile job. This configuration can be used to select
605
604
  * evaluations and override the parameters of selected evaluations.
606
605
  * </p>
606
+ * @public
607
607
  */
608
608
  export interface StatisticsConfiguration {
609
609
  /**
610
- * @public
611
610
  * <p>List of included evaluations. When the list is undefined, all supported
612
611
  * evaluations will be included.</p>
612
+ * @public
613
613
  */
614
614
  IncludedStatistics?: string[];
615
615
  /**
616
- * @public
617
616
  * <p>List of overrides for evaluations.</p>
617
+ * @public
618
618
  */
619
619
  Overrides?: StatisticOverride[];
620
620
  }
621
621
  /**
622
- * @public
623
622
  * <p>Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select
624
623
  * evaluations and override parameters of evaluations for particular columns.
625
624
  * </p>
625
+ * @public
626
626
  */
627
627
  export interface ColumnStatisticsConfiguration {
628
628
  /**
629
- * @public
630
629
  * <p>List of column selectors. Selectors can be used to select columns from the dataset.
631
630
  * When selectors are undefined, configuration will be applied to all supported columns.
632
631
  * </p>
632
+ * @public
633
633
  */
634
634
  Selectors?: ColumnSelector[];
635
635
  /**
636
- * @public
637
636
  * <p>Configuration for evaluations. Statistics can be used to select evaluations and override
638
637
  * parameters of evaluations.
639
638
  * </p>
639
+ * @public
640
640
  */
641
641
  Statistics: StatisticsConfiguration | undefined;
642
642
  }
643
643
  /**
644
- * @public
645
644
  * <p>Configuration of entity detection for a profile job. When undefined, entity
646
645
  * detection is disabled.</p>
646
+ * @public
647
647
  */
648
648
  export interface EntityDetectorConfiguration {
649
649
  /**
650
- * @public
651
650
  * <p>Entity types to detect. Can be any of the following:</p>
652
651
  * <ul>
653
652
  * <li>
@@ -710,51 +709,52 @@ export interface EntityDetectorConfiguration {
710
709
  * </ul>
711
710
  * <p>The Entity type group USA_ALL is also supported, and includes all of the
712
711
  * above entity types except PERSON_NAME and DATE.</p>
712
+ * @public
713
713
  */
714
714
  EntityTypes: string[] | undefined;
715
715
  /**
716
- * @public
717
716
  * <p>Configuration of statistics that are allowed to be run on columns that
718
717
  * contain detected entities. When undefined, no statistics will be computed
719
718
  * on columns that contain detected entities.</p>
719
+ * @public
720
720
  */
721
721
  AllowedStatistics?: AllowedStatistics[];
722
722
  }
723
723
  /**
724
- * @public
725
724
  * <p>Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default
726
725
  * parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all
727
726
  * supported columns.
728
727
  * </p>
728
+ * @public
729
729
  */
730
730
  export interface ProfileConfiguration {
731
731
  /**
732
- * @public
733
732
  * <p>Configuration for inter-column evaluations. Configuration can be used to select evaluations and override
734
733
  * parameters of evaluations. When configuration is undefined, the profile job will run all supported
735
734
  * inter-column evaluations.
736
735
  * </p>
736
+ * @public
737
737
  */
738
738
  DatasetStatisticsConfiguration?: StatisticsConfiguration;
739
739
  /**
740
- * @public
741
740
  * <p>List of column selectors. ProfileColumns can be used to select columns from the dataset. When
742
741
  * ProfileColumns is undefined, the profile job will profile all supported columns.
743
742
  * </p>
743
+ * @public
744
744
  */
745
745
  ProfileColumns?: ColumnSelector[];
746
746
  /**
747
- * @public
748
747
  * <p>List of configurations for column evaluations. ColumnStatisticsConfigurations are used to
749
748
  * select evaluations and override parameters of evaluations for particular columns. When
750
749
  * ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns
751
750
  * and run all supported evaluations.
752
751
  * </p>
752
+ * @public
753
753
  */
754
754
  ColumnStatisticsConfigurations?: ColumnStatisticsConfiguration[];
755
755
  /**
756
- * @public
757
756
  * <p>Configuration of entity detection for a profile job. When undefined, entity detection is disabled.</p>
757
+ * @public
758
758
  */
759
759
  EntityDetectorConfiguration?: EntityDetectorConfiguration;
760
760
  }
@@ -783,15 +783,14 @@ export declare const SampleMode: {
783
783
  */
784
784
  export type SampleMode = (typeof SampleMode)[keyof typeof SampleMode];
785
785
  /**
786
- * @public
787
786
  * <p>A sample configuration for profile jobs only, which determines the number of rows on which the
788
787
  * profile job is run. If a <code>JobSample</code> value isn't provided, the
789
788
  * default is used. The default value is CUSTOM_ROWS for the mode parameter and
790
789
  * 20,000 for the size parameter.</p>
790
+ * @public
791
791
  */
792
792
  export interface JobSample {
793
793
  /**
794
- * @public
795
794
  * <p>A value that determines whether the profile job is run on the entire dataset or a
796
795
  * specified number of rows. This value must be one of the following:</p>
797
796
  * <ul>
@@ -803,14 +802,15 @@ export interface JobSample {
803
802
  * <code>Size</code> parameter.</p>
804
803
  * </li>
805
804
  * </ul>
805
+ * @public
806
806
  */
807
807
  Mode?: SampleMode;
808
808
  /**
809
- * @public
810
809
  * <p>The <code>Size</code> parameter is only required when the mode is CUSTOM_ROWS. The
811
810
  * profile job is run on the specified number of rows. The maximum value for size is
812
811
  * Long.MAX_VALUE.</p>
813
812
  * <p>Long.MAX_VALUE = 9223372036854775807</p>
813
+ * @public
814
814
  */
815
815
  Size?: number;
816
816
  }
@@ -838,23 +838,23 @@ export declare const ValidationMode: {
838
838
  */
839
839
  export type ValidationMode = (typeof ValidationMode)[keyof typeof ValidationMode];
840
840
  /**
841
- * @public
842
841
  * <p>Configuration for data quality validation. Used to select the Rulesets and Validation Mode
843
842
  * to be used in the profile job. When ValidationConfiguration is null, the profile
844
843
  * job will run without data quality validation.</p>
844
+ * @public
845
845
  */
846
846
  export interface ValidationConfiguration {
847
847
  /**
848
- * @public
849
848
  * <p>The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job.
850
849
  * The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of
851
850
  * the dataset that is associated with the profile job.</p>
851
+ * @public
852
852
  */
853
853
  RulesetArn: string | undefined;
854
854
  /**
855
- * @public
856
855
  * <p>Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules
857
856
  * defined in the selected ruleset.</p>
857
+ * @public
858
858
  */
859
859
  ValidationMode?: ValidationMode;
860
860
  }
@@ -863,18 +863,17 @@ export interface ValidationConfiguration {
863
863
  */
864
864
  export interface CreateProfileJobRequest {
865
865
  /**
866
- * @public
867
866
  * <p>The name of the dataset that this job is to act upon.</p>
867
+ * @public
868
868
  */
869
869
  DatasetName: string | undefined;
870
870
  /**
871
- * @public
872
871
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the
873
872
  * job.</p>
873
+ * @public
874
874
  */
875
875
  EncryptionKeyArn?: string;
876
876
  /**
877
- * @public
878
877
  * <p>The encryption mode for the job, which can be one of the following:</p>
879
878
  * <ul>
880
879
  * <li>
@@ -887,71 +886,72 @@ export interface CreateProfileJobRequest {
887
886
  * <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p>
888
887
  * </li>
889
888
  * </ul>
889
+ * @public
890
890
  */
891
891
  EncryptionMode?: EncryptionMode;
892
892
  /**
893
- * @public
894
893
  * <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9),
895
894
  * hyphen (-), period (.), and space.</p>
895
+ * @public
896
896
  */
897
897
  Name: string | undefined;
898
898
  /**
899
- * @public
900
899
  * <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,
901
900
  * CloudWatch writes one log stream for each job run.</p>
901
+ * @public
902
902
  */
903
903
  LogSubscription?: LogSubscription;
904
904
  /**
905
- * @public
906
905
  * <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
906
+ * @public
907
907
  */
908
908
  MaxCapacity?: number;
909
909
  /**
910
- * @public
911
910
  * <p>The maximum number of times to retry the job after a job run fails.</p>
911
+ * @public
912
912
  */
913
913
  MaxRetries?: number;
914
914
  /**
915
- * @public
916
915
  * <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read
917
916
  * input data, or write output from a job.</p>
917
+ * @public
918
918
  */
919
919
  OutputLocation: S3Location | undefined;
920
920
  /**
921
- * @public
922
921
  * <p>Configuration for profile jobs. Used to select columns, do evaluations,
923
922
  * and override default parameters of evaluations. When configuration is null, the
924
923
  * profile job will run with default settings.</p>
924
+ * @public
925
925
  */
926
926
  Configuration?: ProfileConfiguration;
927
927
  /**
928
- * @public
929
928
  * <p>List of validation configurations that are applied to the profile job.</p>
929
+ * @public
930
930
  */
931
931
  ValidationConfigurations?: ValidationConfiguration[];
932
932
  /**
933
- * @public
934
933
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
935
934
  * be assumed when DataBrew runs the job.</p>
935
+ * @public
936
936
  */
937
937
  RoleArn: string | undefined;
938
938
  /**
939
- * @public
940
939
  * <p>Metadata tags to apply to this job.</p>
940
+ * @public
941
941
  */
942
942
  Tags?: Record<string, string>;
943
943
  /**
944
- * @public
945
944
  * <p>The job's timeout in minutes. A job that attempts to run longer than this timeout
946
945
  * period ends with a status of <code>TIMEOUT</code>.</p>
946
+ * @public
947
947
  */
948
948
  Timeout?: number;
949
949
  /**
950
- * @public
951
950
  * <p>Sample configuration for profile jobs only. Determines the number of rows on which the
952
951
  * profile job will be executed. If a JobSample value is not provided, the default value
953
952
  * will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the
954
953
  * size parameter.</p>
954
+ * @public
955
955
  */
956
956
  JobSample?: JobSample;
957
957
  }
@@ -960,8 +960,8 @@ export interface CreateProfileJobRequest {
960
960
  */
961
961
  export interface CreateProfileJobResponse {
962
962
  /**
963
- * @public
964
963
  * <p>The name of the job that was created.</p>
964
+ * @public
965
965
  */
966
966
  Name: string | undefined;
967
967
  }
@@ -979,19 +979,19 @@ export declare const SampleType: {
979
979
  */
980
980
  export type SampleType = (typeof SampleType)[keyof typeof SampleType];
981
981
  /**
982
- * @public
983
982
  * <p>Represents the sample size and sampling type for DataBrew to use for interactive data
984
983
  * analysis.</p>
984
+ * @public
985
985
  */
986
986
  export interface Sample {
987
987
  /**
988
- * @public
989
988
  * <p>The number of rows in the sample.</p>
989
+ * @public
990
990
  */
991
991
  Size?: number;
992
992
  /**
993
- * @public
994
993
  * <p>The way in which DataBrew obtains rows from a dataset.</p>
994
+ * @public
995
995
  */
996
996
  Type: SampleType | undefined;
997
997
  }
@@ -1000,36 +1000,36 @@ export interface Sample {
1000
1000
  */
1001
1001
  export interface CreateProjectRequest {
1002
1002
  /**
1003
- * @public
1004
1003
  * <p>The name of an existing dataset to associate this project with.</p>
1004
+ * @public
1005
1005
  */
1006
1006
  DatasetName: string | undefined;
1007
1007
  /**
1008
- * @public
1009
1008
  * <p>A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9),
1010
1009
  * hyphen (-), period (.), and space.</p>
1010
+ * @public
1011
1011
  */
1012
1012
  Name: string | undefined;
1013
1013
  /**
1014
- * @public
1015
1014
  * <p>The name of an existing recipe to associate with the project.</p>
1015
+ * @public
1016
1016
  */
1017
1017
  RecipeName: string | undefined;
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>Represents the sample size and sampling type for DataBrew to use for interactive data
1021
1020
  * analysis.</p>
1021
+ * @public
1022
1022
  */
1023
1023
  Sample?: Sample;
1024
1024
  /**
1025
- * @public
1026
1025
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
1027
1026
  * be assumed for this request.</p>
1027
+ * @public
1028
1028
  */
1029
1029
  RoleArn: string | undefined;
1030
1030
  /**
1031
- * @public
1032
1031
  * <p>Metadata tags to apply to this project.</p>
1032
+ * @public
1033
1033
  */
1034
1034
  Tags?: Record<string, string>;
1035
1035
  }
@@ -1038,14 +1038,14 @@ export interface CreateProjectRequest {
1038
1038
  */
1039
1039
  export interface CreateProjectResponse {
1040
1040
  /**
1041
- * @public
1042
1041
  * <p>The name of the project that you created.</p>
1042
+ * @public
1043
1043
  */
1044
1044
  Name: string | undefined;
1045
1045
  }
1046
1046
  /**
1047
- * @public
1048
1047
  * <p>An internal service failure occurred.</p>
1048
+ * @public
1049
1049
  */
1050
1050
  export declare class InternalServerException extends __BaseException {
1051
1051
  readonly name: "InternalServerException";
@@ -1057,68 +1057,68 @@ export declare class InternalServerException extends __BaseException {
1057
1057
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
1058
1058
  }
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>Represents a transformation and associated parameters that are used to apply a change
1062
1061
  * to a DataBrew dataset. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html">Recipe
1063
1062
  * actions reference</a>.</p>
1063
+ * @public
1064
1064
  */
1065
1065
  export interface RecipeAction {
1066
1066
  /**
1067
- * @public
1068
1067
  * <p>The name of a valid DataBrew transformation to be performed on the data.</p>
1068
+ * @public
1069
1069
  */
1070
1070
  Operation: string | undefined;
1071
1071
  /**
1072
- * @public
1073
1072
  * <p>Contextual parameters for the transformation.</p>
1073
+ * @public
1074
1074
  */
1075
1075
  Parameters?: Record<string, string>;
1076
1076
  }
1077
1077
  /**
1078
- * @public
1079
1078
  * <p>Represents an individual condition that evaluates to true or false.</p>
1080
1079
  * <p>Conditions are used with recipe actions. The action is only performed for column values where the
1081
1080
  * condition evaluates to true.</p>
1082
1081
  * <p>If a recipe requires more than one condition, then the recipe must specify multiple
1083
1082
  * <code>ConditionExpression</code> elements. Each condition is applied to the rows in a dataset first, before
1084
1083
  * the recipe action is performed.</p>
1084
+ * @public
1085
1085
  */
1086
1086
  export interface ConditionExpression {
1087
1087
  /**
1088
- * @public
1089
1088
  * <p>A specific condition to apply to a recipe action. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure">Recipe
1090
1089
  * structure</a> in the <i>Glue DataBrew Developer
1091
1090
  * Guide</i>.</p>
1091
+ * @public
1092
1092
  */
1093
1093
  Condition: string | undefined;
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>A value that the condition must evaluate to for the condition to succeed.</p>
1096
+ * @public
1097
1097
  */
1098
1098
  Value?: string;
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>A column to apply this condition to.</p>
1101
+ * @public
1102
1102
  */
1103
1103
  TargetColumn: string | undefined;
1104
1104
  }
1105
1105
  /**
1106
- * @public
1107
1106
  * <p>Represents a single step from a DataBrew recipe to be performed.</p>
1107
+ * @public
1108
1108
  */
1109
1109
  export interface RecipeStep {
1110
1110
  /**
1111
- * @public
1112
1111
  * <p>The particular action to be performed in the recipe step.</p>
1112
+ * @public
1113
1113
  */
1114
1114
  Action: RecipeAction | undefined;
1115
1115
  /**
1116
- * @public
1117
1116
  * <p>One or more conditions that must be met for the recipe step to succeed.</p>
1118
1117
  * <note>
1119
1118
  * <p>All of the conditions in the array must be met. In other words, all of the
1120
1119
  * conditions must be combined using a logical AND operation.</p>
1121
1120
  * </note>
1121
+ * @public
1122
1122
  */
1123
1123
  ConditionExpressions?: ConditionExpression[];
1124
1124
  }
@@ -1127,25 +1127,25 @@ export interface RecipeStep {
1127
1127
  */
1128
1128
  export interface CreateRecipeRequest {
1129
1129
  /**
1130
- * @public
1131
1130
  * <p>A description for the recipe.</p>
1131
+ * @public
1132
1132
  */
1133
1133
  Description?: string;
1134
1134
  /**
1135
- * @public
1136
1135
  * <p>A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9),
1137
1136
  * hyphen (-), period (.), and space.</p>
1137
+ * @public
1138
1138
  */
1139
1139
  Name: string | undefined;
1140
1140
  /**
1141
- * @public
1142
1141
  * <p>An array containing the steps to be performed by the recipe. Each recipe step consists
1143
1142
  * of one recipe action and (optionally) an array of condition expressions.</p>
1143
+ * @public
1144
1144
  */
1145
1145
  Steps: RecipeStep[] | undefined;
1146
1146
  /**
1147
- * @public
1148
1147
  * <p>Metadata tags to apply to this recipe.</p>
1148
+ * @public
1149
1149
  */
1150
1150
  Tags?: Record<string, string>;
1151
1151
  }
@@ -1154,26 +1154,26 @@ export interface CreateRecipeRequest {
1154
1154
  */
1155
1155
  export interface CreateRecipeResponse {
1156
1156
  /**
1157
- * @public
1158
1157
  * <p>The name of the recipe that you created.</p>
1158
+ * @public
1159
1159
  */
1160
1160
  Name: string | undefined;
1161
1161
  }
1162
1162
  /**
1163
- * @public
1164
1163
  * <p>Represents options that specify how and where DataBrew writes the database
1165
1164
  * output generated by recipe jobs.</p>
1165
+ * @public
1166
1166
  */
1167
1167
  export interface DatabaseTableOutputOptions {
1168
1168
  /**
1169
- * @public
1170
1169
  * <p>Represents an Amazon S3 location (bucket name and object key) where DataBrew can store
1171
1170
  * intermediate results.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  TempDirectory?: S3Location;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>A prefix for the name of a table DataBrew will create in the database.</p>
1176
+ * @public
1177
1177
  */
1178
1178
  TableName: string | undefined;
1179
1179
  }
@@ -1189,80 +1189,80 @@ export declare const DatabaseOutputMode: {
1189
1189
  */
1190
1190
  export type DatabaseOutputMode = (typeof DatabaseOutputMode)[keyof typeof DatabaseOutputMode];
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>Represents a JDBC database output object which defines the output destination for
1194
1193
  * a DataBrew recipe job to write into.</p>
1194
+ * @public
1195
1195
  */
1196
1196
  export interface DatabaseOutput {
1197
1197
  /**
1198
- * @public
1199
1198
  * <p>The Glue connection that stores the connection information for the
1200
1199
  * target database.</p>
1200
+ * @public
1201
1201
  */
1202
1202
  GlueConnectionName: string | undefined;
1203
1203
  /**
1204
- * @public
1205
1204
  * <p>Represents options that specify how and where DataBrew writes the database output
1206
1205
  * generated by recipe jobs.</p>
1206
+ * @public
1207
1207
  */
1208
1208
  DatabaseOptions: DatabaseTableOutputOptions | undefined;
1209
1209
  /**
1210
- * @public
1211
1210
  * <p>The output mode to write into the database. Currently supported option: NEW_TABLE.</p>
1211
+ * @public
1212
1212
  */
1213
1213
  DatabaseOutputMode?: DatabaseOutputMode;
1214
1214
  }
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>Represents options that specify how and where DataBrew writes the Amazon S3 output
1218
1217
  * generated by recipe jobs.</p>
1218
+ * @public
1219
1219
  */
1220
1220
  export interface S3TableOutputOptions {
1221
1221
  /**
1222
- * @public
1223
1222
  * <p>Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output
1224
1223
  * from a job.</p>
1224
+ * @public
1225
1225
  */
1226
1226
  Location: S3Location | undefined;
1227
1227
  }
1228
1228
  /**
1229
- * @public
1230
1229
  * <p>Represents options that specify how and where in the Glue Data Catalog DataBrew
1231
1230
  * writes the output generated by recipe jobs.</p>
1231
+ * @public
1232
1232
  */
1233
1233
  export interface DataCatalogOutput {
1234
1234
  /**
1235
- * @public
1236
1235
  * <p>The unique identifier of the Amazon Web Services account that holds the Data Catalog that
1237
1236
  * stores the data.</p>
1237
+ * @public
1238
1238
  */
1239
1239
  CatalogId?: string;
1240
1240
  /**
1241
- * @public
1242
1241
  * <p>The name of a database in the Data Catalog.</p>
1242
+ * @public
1243
1243
  */
1244
1244
  DatabaseName: string | undefined;
1245
1245
  /**
1246
- * @public
1247
1246
  * <p>The name of a table in the Data Catalog.</p>
1247
+ * @public
1248
1248
  */
1249
1249
  TableName: string | undefined;
1250
1250
  /**
1251
- * @public
1252
1251
  * <p>Represents options that specify how and where DataBrew writes the Amazon S3
1253
1252
  * output generated by recipe jobs.</p>
1253
+ * @public
1254
1254
  */
1255
1255
  S3Options?: S3TableOutputOptions;
1256
1256
  /**
1257
- * @public
1258
1257
  * <p>Represents options that specify how and where DataBrew writes the database output
1259
1258
  * generated by recipe jobs.</p>
1259
+ * @public
1260
1260
  */
1261
1261
  DatabaseOptions?: DatabaseTableOutputOptions;
1262
1262
  /**
1263
- * @public
1264
1263
  * <p>A value that, if true, means that any data in the location specified for output
1265
1264
  * is overwritten with new output. Not supported with DatabaseOptions.</p>
1265
+ * @public
1266
1266
  */
1267
1267
  Overwrite?: boolean;
1268
1268
  }
@@ -1304,86 +1304,86 @@ export declare const OutputFormat: {
1304
1304
  */
1305
1305
  export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
1306
1306
  /**
1307
- * @public
1308
1307
  * <p>Represents a set of options that define how DataBrew will write a
1309
1308
  * comma-separated value (CSV) file.</p>
1309
+ * @public
1310
1310
  */
1311
1311
  export interface CsvOutputOptions {
1312
1312
  /**
1313
- * @public
1314
1313
  * <p>A single character that specifies the delimiter used to create CSV job output.</p>
1314
+ * @public
1315
1315
  */
1316
1316
  Delimiter?: string;
1317
1317
  }
1318
1318
  /**
1319
- * @public
1320
1319
  * <p>Represents a set of options that define the structure of comma-separated (CSV) job output.</p>
1320
+ * @public
1321
1321
  */
1322
1322
  export interface OutputFormatOptions {
1323
1323
  /**
1324
- * @public
1325
1324
  * <p>Represents a set of options that define the structure of comma-separated value (CSV)
1326
1325
  * job output.</p>
1326
+ * @public
1327
1327
  */
1328
1328
  Csv?: CsvOutputOptions;
1329
1329
  }
1330
1330
  /**
1331
- * @public
1332
1331
  * <p>Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by
1333
1332
  * recipe jobs or profile jobs.</p>
1333
+ * @public
1334
1334
  */
1335
1335
  export interface Output {
1336
1336
  /**
1337
- * @public
1338
1337
  * <p>The compression algorithm used to compress the output text of the job.</p>
1338
+ * @public
1339
1339
  */
1340
1340
  CompressionFormat?: CompressionFormat;
1341
1341
  /**
1342
- * @public
1343
1342
  * <p>The data format of the output of the job.</p>
1343
+ * @public
1344
1344
  */
1345
1345
  Format?: OutputFormat;
1346
1346
  /**
1347
- * @public
1348
1347
  * <p>The names of one or more partition columns for the output of the job.</p>
1348
+ * @public
1349
1349
  */
1350
1350
  PartitionColumns?: string[];
1351
1351
  /**
1352
- * @public
1353
1352
  * <p>The location in Amazon S3 where the job writes its output.</p>
1353
+ * @public
1354
1354
  */
1355
1355
  Location: S3Location | undefined;
1356
1356
  /**
1357
- * @public
1358
1357
  * <p>A value that, if true, means that any data in the location specified for output is
1359
1358
  * overwritten with new output.</p>
1359
+ * @public
1360
1360
  */
1361
1361
  Overwrite?: boolean;
1362
1362
  /**
1363
- * @public
1364
1363
  * <p>Represents options that define how DataBrew formats job output files.</p>
1364
+ * @public
1365
1365
  */
1366
1366
  FormatOptions?: OutputFormatOptions;
1367
1367
  /**
1368
- * @public
1369
1368
  * <p>Maximum number of files to be generated by the job and written to the output folder. For output partitioned
1370
1369
  * by column(s), the MaxOutputFiles value is the maximum number of files per partition.</p>
1370
+ * @public
1371
1371
  */
1372
1372
  MaxOutputFiles?: number;
1373
1373
  }
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>Represents the name and version of a DataBrew recipe.</p>
1376
+ * @public
1377
1377
  */
1378
1378
  export interface RecipeReference {
1379
1379
  /**
1380
- * @public
1381
1380
  * <p>The name of the recipe.</p>
1381
+ * @public
1382
1382
  */
1383
1383
  Name: string | undefined;
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>The identifier for the version for the recipe. </p>
1386
+ * @public
1387
1387
  */
1388
1388
  RecipeVersion?: string;
1389
1389
  }
@@ -1392,18 +1392,17 @@ export interface RecipeReference {
1392
1392
  */
1393
1393
  export interface CreateRecipeJobRequest {
1394
1394
  /**
1395
- * @public
1396
1395
  * <p>The name of the dataset that this job processes.</p>
1396
+ * @public
1397
1397
  */
1398
1398
  DatasetName?: string;
1399
1399
  /**
1400
- * @public
1401
1400
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the
1402
1401
  * job.</p>
1402
+ * @public
1403
1403
  */
1404
1404
  EncryptionKeyArn?: string;
1405
1405
  /**
1406
- * @public
1407
1406
  * <p>The encryption mode for the job, which can be one of the following:</p>
1408
1407
  * <ul>
1409
1408
  * <li>
@@ -1415,73 +1414,74 @@ export interface CreateRecipeJobRequest {
1415
1414
  * <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p>
1416
1415
  * </li>
1417
1416
  * </ul>
1417
+ * @public
1418
1418
  */
1419
1419
  EncryptionMode?: EncryptionMode;
1420
1420
  /**
1421
- * @public
1422
1421
  * <p>A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen
1423
1422
  * (-), period (.), and space.</p>
1423
+ * @public
1424
1424
  */
1425
1425
  Name: string | undefined;
1426
1426
  /**
1427
- * @public
1428
1427
  * <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,
1429
1428
  * CloudWatch writes one log stream for each job run.</p>
1429
+ * @public
1430
1430
  */
1431
1431
  LogSubscription?: LogSubscription;
1432
1432
  /**
1433
- * @public
1434
1433
  * <p>The maximum number of nodes that DataBrew can consume when the job processes
1435
1434
  * data.</p>
1435
+ * @public
1436
1436
  */
1437
1437
  MaxCapacity?: number;
1438
1438
  /**
1439
- * @public
1440
1439
  * <p>The maximum number of times to retry the job after a job run fails.</p>
1440
+ * @public
1441
1441
  */
1442
1442
  MaxRetries?: number;
1443
1443
  /**
1444
- * @public
1445
1444
  * <p>One or more artifacts that represent the output from running the job.</p>
1445
+ * @public
1446
1446
  */
1447
1447
  Outputs?: Output[];
1448
1448
  /**
1449
- * @public
1450
1449
  * <p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>
1450
+ * @public
1451
1451
  */
1452
1452
  DataCatalogOutputs?: DataCatalogOutput[];
1453
1453
  /**
1454
- * @public
1455
1454
  * <p>Represents a list of JDBC database output objects which defines the output destination for
1456
1455
  * a DataBrew recipe job to write to. </p>
1456
+ * @public
1457
1457
  */
1458
1458
  DatabaseOutputs?: DatabaseOutput[];
1459
1459
  /**
1460
- * @public
1461
1460
  * <p>Either the name of an existing project, or a combination of a recipe and a dataset to
1462
1461
  * associate with the recipe.</p>
1462
+ * @public
1463
1463
  */
1464
1464
  ProjectName?: string;
1465
1465
  /**
1466
- * @public
1467
1466
  * <p>Represents the name and version of a DataBrew recipe.</p>
1467
+ * @public
1468
1468
  */
1469
1469
  RecipeReference?: RecipeReference;
1470
1470
  /**
1471
- * @public
1472
1471
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
1473
1472
  * be assumed when DataBrew runs the job.</p>
1473
+ * @public
1474
1474
  */
1475
1475
  RoleArn: string | undefined;
1476
1476
  /**
1477
- * @public
1478
1477
  * <p>Metadata tags to apply to this job.</p>
1478
+ * @public
1479
1479
  */
1480
1480
  Tags?: Record<string, string>;
1481
1481
  /**
1482
- * @public
1483
1482
  * <p>The job's timeout in minutes. A job that attempts to run longer than this timeout
1484
1483
  * period ends with a status of <code>TIMEOUT</code>.</p>
1484
+ * @public
1485
1485
  */
1486
1486
  Timeout?: number;
1487
1487
  }
@@ -1490,8 +1490,8 @@ export interface CreateRecipeJobRequest {
1490
1490
  */
1491
1491
  export interface CreateRecipeJobResponse {
1492
1492
  /**
1493
- * @public
1494
1493
  * <p>The name of the job that you created.</p>
1494
+ * @public
1495
1495
  */
1496
1496
  Name: string | undefined;
1497
1497
  }
@@ -1522,50 +1522,49 @@ export declare const ThresholdUnit: {
1522
1522
  */
1523
1523
  export type ThresholdUnit = (typeof ThresholdUnit)[keyof typeof ThresholdUnit];
1524
1524
  /**
1525
- * @public
1526
1525
  * <p>The threshold used with a non-aggregate check expression. The non-aggregate check expression
1527
1526
  * will be applied to each row in a specific column. Then the threshold will be used to determine
1528
1527
  * whether the validation succeeds.</p>
1528
+ * @public
1529
1529
  */
1530
1530
  export interface Threshold {
1531
1531
  /**
1532
- * @public
1533
1532
  * <p>The value of a threshold.</p>
1533
+ * @public
1534
1534
  */
1535
1535
  Value: number | undefined;
1536
1536
  /**
1537
- * @public
1538
1537
  * <p>The type of a threshold. Used for comparison of an actual count of rows that satisfy the
1539
1538
  * rule to the threshold value.</p>
1539
+ * @public
1540
1540
  */
1541
1541
  Type?: ThresholdType;
1542
1542
  /**
1543
- * @public
1544
1543
  * <p>Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size
1545
1544
  * used for validation.</p>
1545
+ * @public
1546
1546
  */
1547
1547
  Unit?: ThresholdUnit;
1548
1548
  }
1549
1549
  /**
1550
- * @public
1551
1550
  * <p>Represents a single data quality requirement that should be validated in the
1552
1551
  * scope of this dataset.</p>
1552
+ * @public
1553
1553
  */
1554
1554
  export interface Rule {
1555
1555
  /**
1556
- * @public
1557
1556
  * <p>The name of the rule.</p>
1557
+ * @public
1558
1558
  */
1559
1559
  Name: string | undefined;
1560
1560
  /**
1561
- * @public
1562
1561
  * <p>A value that specifies whether the rule is disabled. Once a rule is
1563
1562
  * disabled, a profile job will not validate it during a job run. Default
1564
1563
  * value is false.</p>
1564
+ * @public
1565
1565
  */
1566
1566
  Disabled?: boolean;
1567
1567
  /**
1568
- * @public
1569
1568
  * <p>The expression which includes column references, condition names followed by variable
1570
1569
  * references, possibly grouped and combined with other conditions. For example,
1571
1570
  * <code>(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1
@@ -1578,28 +1577,29 @@ export interface Rule {
1578
1577
  * condition, for example, <code>is_between :val1 and :val2</code>.</p>
1579
1578
  * <p>For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/profile.data-quality-available-checks.html">Available checks</a>
1580
1579
  * </p>
1580
+ * @public
1581
1581
  */
1582
1582
  CheckExpression: string | undefined;
1583
1583
  /**
1584
- * @public
1585
1584
  * <p>The map of substitution variable names to their values used in a check
1586
1585
  * expression. Variable names should start with a ':' (colon). Variable values can either
1587
1586
  * be actual values or column names. To differentiate between the two, column names
1588
1587
  * should be enclosed in backticks, for example, <code>":col1": "`Column A`".</code>
1589
1588
  * </p>
1589
+ * @public
1590
1590
  */
1591
1591
  SubstitutionMap?: Record<string, string>;
1592
1592
  /**
1593
- * @public
1594
1593
  * <p>The threshold used with a non-aggregate check expression. Non-aggregate check expressions
1595
1594
  * will be applied to each row in a specific column, and the threshold will be used to determine
1596
1595
  * whether the validation succeeds.</p>
1596
+ * @public
1597
1597
  */
1598
1598
  Threshold?: Threshold;
1599
1599
  /**
1600
- * @public
1601
1600
  * <p>List of column selectors. Selectors can be used to select columns using a name or regular
1602
1601
  * expression from the dataset. Rule will be applied to selected columns.</p>
1602
+ * @public
1603
1603
  */
1604
1604
  ColumnSelectors?: ColumnSelector[];
1605
1605
  }
@@ -1608,31 +1608,31 @@ export interface Rule {
1608
1608
  */
1609
1609
  export interface CreateRulesetRequest {
1610
1610
  /**
1611
- * @public
1612
1611
  * <p>The name of the ruleset to be created. Valid characters are alphanumeric
1613
1612
  * (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
1613
+ * @public
1614
1614
  */
1615
1615
  Name: string | undefined;
1616
1616
  /**
1617
- * @public
1618
1617
  * <p>The description of the ruleset.</p>
1618
+ * @public
1619
1619
  */
1620
1620
  Description?: string;
1621
1621
  /**
1622
- * @public
1623
1622
  * <p>The Amazon Resource Name (ARN) of a resource (dataset) that the
1624
1623
  * ruleset is associated with.</p>
1624
+ * @public
1625
1625
  */
1626
1626
  TargetArn: string | undefined;
1627
1627
  /**
1628
- * @public
1629
1628
  * <p>A list of rules that are defined with the ruleset. A rule includes
1630
1629
  * one or more checks to be validated on a DataBrew dataset.</p>
1630
+ * @public
1631
1631
  */
1632
1632
  Rules: Rule[] | undefined;
1633
1633
  /**
1634
- * @public
1635
1634
  * <p>Metadata tags to apply to the ruleset.</p>
1635
+ * @public
1636
1636
  */
1637
1637
  Tags?: Record<string, string>;
1638
1638
  }
@@ -1641,8 +1641,8 @@ export interface CreateRulesetRequest {
1641
1641
  */
1642
1642
  export interface CreateRulesetResponse {
1643
1643
  /**
1644
- * @public
1645
1644
  * <p>The unique name of the created ruleset.</p>
1645
+ * @public
1646
1646
  */
1647
1647
  Name: string | undefined;
1648
1648
  }
@@ -1651,27 +1651,27 @@ export interface CreateRulesetResponse {
1651
1651
  */
1652
1652
  export interface CreateScheduleRequest {
1653
1653
  /**
1654
- * @public
1655
1654
  * <p>The name or names of one or more jobs to be run.</p>
1655
+ * @public
1656
1656
  */
1657
1657
  JobNames?: string[];
1658
1658
  /**
1659
- * @public
1660
1659
  * <p>The date or dates and time or times when the jobs are to be run. For more information,
1661
1660
  * see <a href="https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html">Cron
1662
1661
  * expressions</a> in the <i>Glue DataBrew Developer
1663
1662
  * Guide</i>.</p>
1663
+ * @public
1664
1664
  */
1665
1665
  CronExpression: string | undefined;
1666
1666
  /**
1667
- * @public
1668
1667
  * <p>Metadata tags to apply to this schedule.</p>
1668
+ * @public
1669
1669
  */
1670
1670
  Tags?: Record<string, string>;
1671
1671
  /**
1672
- * @public
1673
1672
  * <p>A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9),
1674
1673
  * hyphen (-), period (.), and space.</p>
1674
+ * @public
1675
1675
  */
1676
1676
  Name: string | undefined;
1677
1677
  }
@@ -1680,8 +1680,8 @@ export interface CreateScheduleRequest {
1680
1680
  */
1681
1681
  export interface CreateScheduleResponse {
1682
1682
  /**
1683
- * @public
1684
1683
  * <p>The name of the schedule that was created.</p>
1684
+ * @public
1685
1685
  */
1686
1686
  Name: string | undefined;
1687
1687
  }
@@ -1690,8 +1690,8 @@ export interface CreateScheduleResponse {
1690
1690
  */
1691
1691
  export interface DeleteDatasetRequest {
1692
1692
  /**
1693
- * @public
1694
1693
  * <p>The name of the dataset to be deleted.</p>
1694
+ * @public
1695
1695
  */
1696
1696
  Name: string | undefined;
1697
1697
  }
@@ -1700,8 +1700,8 @@ export interface DeleteDatasetRequest {
1700
1700
  */
1701
1701
  export interface DeleteDatasetResponse {
1702
1702
  /**
1703
- * @public
1704
1703
  * <p>The name of the dataset that you deleted.</p>
1704
+ * @public
1705
1705
  */
1706
1706
  Name: string | undefined;
1707
1707
  }
@@ -1710,8 +1710,8 @@ export interface DeleteDatasetResponse {
1710
1710
  */
1711
1711
  export interface DeleteJobRequest {
1712
1712
  /**
1713
- * @public
1714
1713
  * <p>The name of the job to be deleted.</p>
1714
+ * @public
1715
1715
  */
1716
1716
  Name: string | undefined;
1717
1717
  }
@@ -1720,8 +1720,8 @@ export interface DeleteJobRequest {
1720
1720
  */
1721
1721
  export interface DeleteJobResponse {
1722
1722
  /**
1723
- * @public
1724
1723
  * <p>The name of the job that you deleted.</p>
1724
+ * @public
1725
1725
  */
1726
1726
  Name: string | undefined;
1727
1727
  }
@@ -1730,8 +1730,8 @@ export interface DeleteJobResponse {
1730
1730
  */
1731
1731
  export interface DeleteProjectRequest {
1732
1732
  /**
1733
- * @public
1734
1733
  * <p>The name of the project to be deleted.</p>
1734
+ * @public
1735
1735
  */
1736
1736
  Name: string | undefined;
1737
1737
  }
@@ -1740,8 +1740,8 @@ export interface DeleteProjectRequest {
1740
1740
  */
1741
1741
  export interface DeleteProjectResponse {
1742
1742
  /**
1743
- * @public
1744
1743
  * <p>The name of the project that you deleted.</p>
1744
+ * @public
1745
1745
  */
1746
1746
  Name: string | undefined;
1747
1747
  }
@@ -1750,15 +1750,15 @@ export interface DeleteProjectResponse {
1750
1750
  */
1751
1751
  export interface DeleteRecipeVersionRequest {
1752
1752
  /**
1753
- * @public
1754
1753
  * <p>The name of the recipe.</p>
1754
+ * @public
1755
1755
  */
1756
1756
  Name: string | undefined;
1757
1757
  /**
1758
- * @public
1759
1758
  * <p>The version of the recipe to be deleted. You can specify a numeric versions
1760
1759
  * (<code>X.Y</code>) or <code>LATEST_WORKING</code>. <code>LATEST_PUBLISHED</code> is
1761
1760
  * not supported.</p>
1761
+ * @public
1762
1762
  */
1763
1763
  RecipeVersion: string | undefined;
1764
1764
  }
@@ -1767,13 +1767,13 @@ export interface DeleteRecipeVersionRequest {
1767
1767
  */
1768
1768
  export interface DeleteRecipeVersionResponse {
1769
1769
  /**
1770
- * @public
1771
1770
  * <p>The name of the recipe that was deleted.</p>
1771
+ * @public
1772
1772
  */
1773
1773
  Name: string | undefined;
1774
1774
  /**
1775
- * @public
1776
1775
  * <p>The version of the recipe that was deleted.</p>
1776
+ * @public
1777
1777
  */
1778
1778
  RecipeVersion: string | undefined;
1779
1779
  }
@@ -1782,8 +1782,8 @@ export interface DeleteRecipeVersionResponse {
1782
1782
  */
1783
1783
  export interface DeleteRulesetRequest {
1784
1784
  /**
1785
- * @public
1786
1785
  * <p>The name of the ruleset to be deleted.</p>
1786
+ * @public
1787
1787
  */
1788
1788
  Name: string | undefined;
1789
1789
  }
@@ -1792,8 +1792,8 @@ export interface DeleteRulesetRequest {
1792
1792
  */
1793
1793
  export interface DeleteRulesetResponse {
1794
1794
  /**
1795
- * @public
1796
1795
  * <p>The name of the deleted ruleset.</p>
1796
+ * @public
1797
1797
  */
1798
1798
  Name: string | undefined;
1799
1799
  }
@@ -1802,8 +1802,8 @@ export interface DeleteRulesetResponse {
1802
1802
  */
1803
1803
  export interface DeleteScheduleRequest {
1804
1804
  /**
1805
- * @public
1806
1805
  * <p>The name of the schedule to be deleted.</p>
1806
+ * @public
1807
1807
  */
1808
1808
  Name: string | undefined;
1809
1809
  }
@@ -1812,8 +1812,8 @@ export interface DeleteScheduleRequest {
1812
1812
  */
1813
1813
  export interface DeleteScheduleResponse {
1814
1814
  /**
1815
- * @public
1816
1815
  * <p>The name of the schedule that was deleted.</p>
1816
+ * @public
1817
1817
  */
1818
1818
  Name: string | undefined;
1819
1819
  }
@@ -1822,8 +1822,8 @@ export interface DeleteScheduleResponse {
1822
1822
  */
1823
1823
  export interface DescribeDatasetRequest {
1824
1824
  /**
1825
- * @public
1826
1825
  * <p>The name of the dataset to be described.</p>
1826
+ * @public
1827
1827
  */
1828
1828
  Name: string | undefined;
1829
1829
  }
@@ -1845,68 +1845,68 @@ export type Source = (typeof Source)[keyof typeof Source];
1845
1845
  */
1846
1846
  export interface DescribeDatasetResponse {
1847
1847
  /**
1848
- * @public
1849
1848
  * <p>The identifier (user name) of the user who created the dataset.</p>
1849
+ * @public
1850
1850
  */
1851
1851
  CreatedBy?: string;
1852
1852
  /**
1853
- * @public
1854
1853
  * <p>The date and time that the dataset was created.</p>
1854
+ * @public
1855
1855
  */
1856
1856
  CreateDate?: Date;
1857
1857
  /**
1858
- * @public
1859
1858
  * <p>The name of the dataset.</p>
1859
+ * @public
1860
1860
  */
1861
1861
  Name: string | undefined;
1862
1862
  /**
1863
- * @public
1864
1863
  * <p>The file format of a dataset that is created from an Amazon S3 file
1865
1864
  * or folder.</p>
1865
+ * @public
1866
1866
  */
1867
1867
  Format?: InputFormat;
1868
1868
  /**
1869
- * @public
1870
1869
  * <p>Represents a set of options that define the structure of either comma-separated value (CSV),
1871
1870
  * Excel, or JSON input.</p>
1871
+ * @public
1872
1872
  */
1873
1873
  FormatOptions?: FormatOptions;
1874
1874
  /**
1875
- * @public
1876
1875
  * <p>Represents information on how DataBrew can find data, in either the Glue Data Catalog or
1877
1876
  * Amazon S3.</p>
1877
+ * @public
1878
1878
  */
1879
1879
  Input: Input | undefined;
1880
1880
  /**
1881
- * @public
1882
1881
  * <p>The date and time that the dataset was last modified.</p>
1882
+ * @public
1883
1883
  */
1884
1884
  LastModifiedDate?: Date;
1885
1885
  /**
1886
- * @public
1887
1886
  * <p>The identifier (user name) of the user who last modified the dataset.</p>
1887
+ * @public
1888
1888
  */
1889
1889
  LastModifiedBy?: string;
1890
1890
  /**
1891
- * @public
1892
1891
  * <p>The location of the data for this dataset, Amazon S3 or the
1893
1892
  * Glue Data Catalog.</p>
1893
+ * @public
1894
1894
  */
1895
1895
  Source?: Source;
1896
1896
  /**
1897
- * @public
1898
1897
  * <p>A set of options that defines how DataBrew interprets an Amazon S3
1899
1898
  * path of the dataset.</p>
1899
+ * @public
1900
1900
  */
1901
1901
  PathOptions?: PathOptions;
1902
1902
  /**
1903
- * @public
1904
1903
  * <p>Metadata tags associated with this dataset.</p>
1904
+ * @public
1905
1905
  */
1906
1906
  Tags?: Record<string, string>;
1907
1907
  /**
1908
- * @public
1909
1908
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
1909
+ * @public
1910
1910
  */
1911
1911
  ResourceArn?: string;
1912
1912
  }
@@ -1915,8 +1915,8 @@ export interface DescribeDatasetResponse {
1915
1915
  */
1916
1916
  export interface DescribeJobRequest {
1917
1917
  /**
1918
- * @public
1919
1918
  * <p>The name of the job to be described.</p>
1919
+ * @public
1920
1920
  */
1921
1921
  Name: string | undefined;
1922
1922
  }
@@ -1937,28 +1937,27 @@ export type JobType = (typeof JobType)[keyof typeof JobType];
1937
1937
  */
1938
1938
  export interface DescribeJobResponse {
1939
1939
  /**
1940
- * @public
1941
1940
  * <p>The date and time that the job was created.</p>
1941
+ * @public
1942
1942
  */
1943
1943
  CreateDate?: Date;
1944
1944
  /**
1945
- * @public
1946
1945
  * <p>The identifier (user name) of the user associated with the creation of the job.</p>
1946
+ * @public
1947
1947
  */
1948
1948
  CreatedBy?: string;
1949
1949
  /**
1950
- * @public
1951
1950
  * <p>The dataset that the job acts upon.</p>
1951
+ * @public
1952
1952
  */
1953
1953
  DatasetName?: string;
1954
1954
  /**
1955
- * @public
1956
1955
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the
1957
1956
  * job.</p>
1957
+ * @public
1958
1958
  */
1959
1959
  EncryptionKeyArn?: string;
1960
1960
  /**
1961
- * @public
1962
1961
  * <p>The encryption mode for the job, which can be one of the following:</p>
1963
1962
  * <ul>
1964
1963
  * <li>
@@ -1971,15 +1970,15 @@ export interface DescribeJobResponse {
1971
1970
  * S3.</p>
1972
1971
  * </li>
1973
1972
  * </ul>
1973
+ * @public
1974
1974
  */
1975
1975
  EncryptionMode?: EncryptionMode;
1976
1976
  /**
1977
- * @public
1978
1977
  * <p>The name of the job.</p>
1978
+ * @public
1979
1979
  */
1980
1980
  Name: string | undefined;
1981
1981
  /**
1982
- * @public
1983
1982
  * <p>The job type, which must be one of the following:</p>
1984
1983
  * <ul>
1985
1984
  * <li>
@@ -1993,98 +1992,99 @@ export interface DescribeJobResponse {
1993
1992
  * dataset.</p>
1994
1993
  * </li>
1995
1994
  * </ul>
1995
+ * @public
1996
1996
  */
1997
1997
  Type?: JobType;
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>The identifier (user name) of the user who last modified the job.</p>
2000
+ * @public
2001
2001
  */
2002
2002
  LastModifiedBy?: string;
2003
2003
  /**
2004
- * @public
2005
2004
  * <p>The date and time that the job was last modified.</p>
2005
+ * @public
2006
2006
  */
2007
2007
  LastModifiedDate?: Date;
2008
2008
  /**
2009
- * @public
2010
2009
  * <p>Indicates whether Amazon CloudWatch logging is enabled for this job.</p>
2010
+ * @public
2011
2011
  */
2012
2012
  LogSubscription?: LogSubscription;
2013
2013
  /**
2014
- * @public
2015
2014
  * <p>The maximum number of compute nodes that DataBrew can consume when the job processes
2016
2015
  * data.</p>
2016
+ * @public
2017
2017
  */
2018
2018
  MaxCapacity?: number;
2019
2019
  /**
2020
- * @public
2021
2020
  * <p>The maximum number of times to retry the job after a job run fails.</p>
2021
+ * @public
2022
2022
  */
2023
2023
  MaxRetries?: number;
2024
2024
  /**
2025
- * @public
2026
2025
  * <p>One or more artifacts that represent the output from running the job.</p>
2026
+ * @public
2027
2027
  */
2028
2028
  Outputs?: Output[];
2029
2029
  /**
2030
- * @public
2031
2030
  * <p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>
2031
+ * @public
2032
2032
  */
2033
2033
  DataCatalogOutputs?: DataCatalogOutput[];
2034
2034
  /**
2035
- * @public
2036
2035
  * <p>Represents a list of JDBC database output objects which defines the output
2037
2036
  * destination for a DataBrew recipe job to write into.</p>
2037
+ * @public
2038
2038
  */
2039
2039
  DatabaseOutputs?: DatabaseOutput[];
2040
2040
  /**
2041
- * @public
2042
2041
  * <p>The DataBrew project associated with this job.</p>
2042
+ * @public
2043
2043
  */
2044
2044
  ProjectName?: string;
2045
2045
  /**
2046
- * @public
2047
2046
  * <p>Configuration for profile jobs. Used to select columns, do evaluations,
2048
2047
  * and override default parameters of evaluations. When configuration is null, the
2049
2048
  * profile job will run with default settings.</p>
2049
+ * @public
2050
2050
  */
2051
2051
  ProfileConfiguration?: ProfileConfiguration;
2052
2052
  /**
2053
- * @public
2054
2053
  * <p>List of validation configurations that are applied to the profile job.</p>
2054
+ * @public
2055
2055
  */
2056
2056
  ValidationConfigurations?: ValidationConfiguration[];
2057
2057
  /**
2058
- * @public
2059
2058
  * <p>Represents the name and version of a DataBrew recipe.</p>
2059
+ * @public
2060
2060
  */
2061
2061
  RecipeReference?: RecipeReference;
2062
2062
  /**
2063
- * @public
2064
2063
  * <p>The Amazon Resource Name (ARN) of the job.</p>
2064
+ * @public
2065
2065
  */
2066
2066
  ResourceArn?: string;
2067
2067
  /**
2068
- * @public
2069
2068
  * <p>The ARN of the Identity and Access Management (IAM) role to be assumed when
2070
2069
  * DataBrew runs the job.</p>
2070
+ * @public
2071
2071
  */
2072
2072
  RoleArn?: string;
2073
2073
  /**
2074
- * @public
2075
2074
  * <p>Metadata tags associated with this job.</p>
2075
+ * @public
2076
2076
  */
2077
2077
  Tags?: Record<string, string>;
2078
2078
  /**
2079
- * @public
2080
2079
  * <p>The job's timeout in minutes. A job that attempts to run longer than this timeout
2081
2080
  * period ends with a status of <code>TIMEOUT</code>.</p>
2081
+ * @public
2082
2082
  */
2083
2083
  Timeout?: number;
2084
2084
  /**
2085
- * @public
2086
2085
  * <p>Sample configuration for profile jobs only. Determines the number of rows on which the
2087
2086
  * profile job will be executed.</p>
2087
+ * @public
2088
2088
  */
2089
2089
  JobSample?: JobSample;
2090
2090
  }
@@ -2093,13 +2093,13 @@ export interface DescribeJobResponse {
2093
2093
  */
2094
2094
  export interface DescribeJobRunRequest {
2095
2095
  /**
2096
- * @public
2097
2096
  * <p>The name of the job being processed during this run.</p>
2097
+ * @public
2098
2098
  */
2099
2099
  Name: string | undefined;
2100
2100
  /**
2101
- * @public
2102
2101
  * <p>The unique identifier of the job run.</p>
2102
+ * @public
2103
2103
  */
2104
2104
  RunId: string | undefined;
2105
2105
  }
@@ -2125,105 +2125,105 @@ export type JobRunState = (typeof JobRunState)[keyof typeof JobRunState];
2125
2125
  */
2126
2126
  export interface DescribeJobRunResponse {
2127
2127
  /**
2128
- * @public
2129
2128
  * <p>The number of times that DataBrew has attempted to run the job.</p>
2129
+ * @public
2130
2130
  */
2131
2131
  Attempt?: number;
2132
2132
  /**
2133
- * @public
2134
2133
  * <p>The date and time when the job completed processing.</p>
2134
+ * @public
2135
2135
  */
2136
2136
  CompletedOn?: Date;
2137
2137
  /**
2138
- * @public
2139
2138
  * <p>The name of the dataset for the job to process.</p>
2139
+ * @public
2140
2140
  */
2141
2141
  DatasetName?: string;
2142
2142
  /**
2143
- * @public
2144
2143
  * <p>A message indicating an error (if any) that was encountered when the job ran.</p>
2144
+ * @public
2145
2145
  */
2146
2146
  ErrorMessage?: string;
2147
2147
  /**
2148
- * @public
2149
2148
  * <p>The amount of time, in seconds, during which the job run consumed resources.</p>
2149
+ * @public
2150
2150
  */
2151
2151
  ExecutionTime?: number;
2152
2152
  /**
2153
- * @public
2154
2153
  * <p>The name of the job being processed during this run.</p>
2154
+ * @public
2155
2155
  */
2156
2156
  JobName: string | undefined;
2157
2157
  /**
2158
- * @public
2159
2158
  * <p>Configuration for profile jobs. Used to select columns, do evaluations,
2160
2159
  * and override default parameters of evaluations. When configuration is null, the
2161
2160
  * profile job will run with default settings.</p>
2161
+ * @public
2162
2162
  */
2163
2163
  ProfileConfiguration?: ProfileConfiguration;
2164
2164
  /**
2165
- * @public
2166
2165
  * <p>List of validation configurations that are applied to the profile job.</p>
2166
+ * @public
2167
2167
  */
2168
2168
  ValidationConfigurations?: ValidationConfiguration[];
2169
2169
  /**
2170
- * @public
2171
2170
  * <p>The unique identifier of the job run.</p>
2171
+ * @public
2172
2172
  */
2173
2173
  RunId?: string;
2174
2174
  /**
2175
- * @public
2176
2175
  * <p>The current state of the job run entity itself.</p>
2176
+ * @public
2177
2177
  */
2178
2178
  State?: JobRunState;
2179
2179
  /**
2180
- * @public
2181
2180
  * <p>The current status of Amazon CloudWatch logging for the job run.</p>
2181
+ * @public
2182
2182
  */
2183
2183
  LogSubscription?: LogSubscription;
2184
2184
  /**
2185
- * @public
2186
2185
  * <p>The name of an Amazon CloudWatch log group, where the job writes diagnostic messages
2187
2186
  * when it runs.</p>
2187
+ * @public
2188
2188
  */
2189
2189
  LogGroupName?: string;
2190
2190
  /**
2191
- * @public
2192
2191
  * <p>One or more output artifacts from a job run.</p>
2192
+ * @public
2193
2193
  */
2194
2194
  Outputs?: Output[];
2195
2195
  /**
2196
- * @public
2197
2196
  * <p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>
2197
+ * @public
2198
2198
  */
2199
2199
  DataCatalogOutputs?: DataCatalogOutput[];
2200
2200
  /**
2201
- * @public
2202
2201
  * <p>Represents a list of JDBC database output objects which defines the output
2203
2202
  * destination for a DataBrew recipe job to write into.</p>
2203
+ * @public
2204
2204
  */
2205
2205
  DatabaseOutputs?: DatabaseOutput[];
2206
2206
  /**
2207
- * @public
2208
2207
  * <p>Represents the name and version of a DataBrew recipe.</p>
2208
+ * @public
2209
2209
  */
2210
2210
  RecipeReference?: RecipeReference;
2211
2211
  /**
2212
- * @public
2213
2212
  * <p>The Amazon Resource Name (ARN) of the user who started the job run.</p>
2213
+ * @public
2214
2214
  */
2215
2215
  StartedBy?: string;
2216
2216
  /**
2217
- * @public
2218
2217
  * <p>The date and time when the job run began.</p>
2218
+ * @public
2219
2219
  */
2220
2220
  StartedOn?: Date;
2221
2221
  /**
2222
- * @public
2223
2222
  * <p>Sample configuration for profile jobs only. Determines the number of rows on which the
2224
2223
  * profile job will be executed. If a JobSample value is not provided, the default value
2225
2224
  * will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the
2226
2225
  * size parameter.</p>
2226
+ * @public
2227
2227
  */
2228
2228
  JobSample?: JobSample;
2229
2229
  }
@@ -2232,8 +2232,8 @@ export interface DescribeJobRunResponse {
2232
2232
  */
2233
2233
  export interface DescribeProjectRequest {
2234
2234
  /**
2235
- * @public
2236
2235
  * <p>The name of the project to be described.</p>
2236
+ * @public
2237
2237
  */
2238
2238
  Name: string | undefined;
2239
2239
  }
@@ -2262,64 +2262,63 @@ export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus];
2262
2262
  */
2263
2263
  export interface DescribeProjectResponse {
2264
2264
  /**
2265
- * @public
2266
2265
  * <p>The date and time that the project was created.</p>
2266
+ * @public
2267
2267
  */
2268
2268
  CreateDate?: Date;
2269
2269
  /**
2270
- * @public
2271
2270
  * <p>The identifier (user name) of the user who created the project.</p>
2271
+ * @public
2272
2272
  */
2273
2273
  CreatedBy?: string;
2274
2274
  /**
2275
- * @public
2276
2275
  * <p>The dataset associated with the project.</p>
2276
+ * @public
2277
2277
  */
2278
2278
  DatasetName?: string;
2279
2279
  /**
2280
- * @public
2281
2280
  * <p>The date and time that the project was last modified.</p>
2281
+ * @public
2282
2282
  */
2283
2283
  LastModifiedDate?: Date;
2284
2284
  /**
2285
- * @public
2286
2285
  * <p>The identifier (user name) of the user who last modified the project.</p>
2286
+ * @public
2287
2287
  */
2288
2288
  LastModifiedBy?: string;
2289
2289
  /**
2290
- * @public
2291
2290
  * <p>The name of the project.</p>
2291
+ * @public
2292
2292
  */
2293
2293
  Name: string | undefined;
2294
2294
  /**
2295
- * @public
2296
2295
  * <p>The recipe associated with this job.</p>
2296
+ * @public
2297
2297
  */
2298
2298
  RecipeName?: string;
2299
2299
  /**
2300
- * @public
2301
2300
  * <p>The Amazon Resource Name (ARN) of the project.</p>
2301
+ * @public
2302
2302
  */
2303
2303
  ResourceArn?: string;
2304
2304
  /**
2305
- * @public
2306
2305
  * <p>Represents the sample size and sampling type for DataBrew to use for interactive data
2307
2306
  * analysis.</p>
2307
+ * @public
2308
2308
  */
2309
2309
  Sample?: Sample;
2310
2310
  /**
2311
- * @public
2312
2311
  * <p>The ARN of the Identity and Access Management (IAM) role to be assumed when
2313
2312
  * DataBrew runs the job.</p>
2313
+ * @public
2314
2314
  */
2315
2315
  RoleArn?: string;
2316
2316
  /**
2317
- * @public
2318
2317
  * <p>Metadata tags associated with this project.</p>
2318
+ * @public
2319
2319
  */
2320
2320
  Tags?: Record<string, string>;
2321
2321
  /**
2322
- * @public
2323
2322
  * <p>Describes the current state of the session:</p>
2324
2323
  * <ul>
2325
2324
  * <li>
@@ -2335,16 +2334,17 @@ export interface DescribeProjectResponse {
2335
2334
  * <code>ASSIGNED</code> - the session is ready for use.</p>
2336
2335
  * </li>
2337
2336
  * </ul>
2337
+ * @public
2338
2338
  */
2339
2339
  SessionStatus?: SessionStatus;
2340
2340
  /**
2341
- * @public
2342
2341
  * <p>The identifier (user name) of the user that opened the project for use. </p>
2342
+ * @public
2343
2343
  */
2344
2344
  OpenedBy?: string;
2345
2345
  /**
2346
- * @public
2347
2346
  * <p>The date and time when the project was opened. </p>
2347
+ * @public
2348
2348
  */
2349
2349
  OpenDate?: Date;
2350
2350
  }
@@ -2353,14 +2353,14 @@ export interface DescribeProjectResponse {
2353
2353
  */
2354
2354
  export interface DescribeRecipeRequest {
2355
2355
  /**
2356
- * @public
2357
2356
  * <p>The name of the recipe to be described.</p>
2357
+ * @public
2358
2358
  */
2359
2359
  Name: string | undefined;
2360
2360
  /**
2361
- * @public
2362
2361
  * <p>The recipe version identifier. If this parameter isn't specified, then the latest
2363
2362
  * published version is returned.</p>
2363
+ * @public
2364
2364
  */
2365
2365
  RecipeVersion?: string;
2366
2366
  }
@@ -2369,69 +2369,69 @@ export interface DescribeRecipeRequest {
2369
2369
  */
2370
2370
  export interface DescribeRecipeResponse {
2371
2371
  /**
2372
- * @public
2373
2372
  * <p>The identifier (user name) of the user who created the recipe.</p>
2373
+ * @public
2374
2374
  */
2375
2375
  CreatedBy?: string;
2376
2376
  /**
2377
- * @public
2378
2377
  * <p>The date and time that the recipe was created.</p>
2378
+ * @public
2379
2379
  */
2380
2380
  CreateDate?: Date;
2381
2381
  /**
2382
- * @public
2383
2382
  * <p>The identifier (user name) of the user who last modified the recipe.</p>
2383
+ * @public
2384
2384
  */
2385
2385
  LastModifiedBy?: string;
2386
2386
  /**
2387
- * @public
2388
2387
  * <p>The date and time that the recipe was last modified.</p>
2388
+ * @public
2389
2389
  */
2390
2390
  LastModifiedDate?: Date;
2391
2391
  /**
2392
- * @public
2393
2392
  * <p>The name of the project associated with this recipe.</p>
2393
+ * @public
2394
2394
  */
2395
2395
  ProjectName?: string;
2396
2396
  /**
2397
- * @public
2398
2397
  * <p>The identifier (user name) of the user who last published the recipe.</p>
2398
+ * @public
2399
2399
  */
2400
2400
  PublishedBy?: string;
2401
2401
  /**
2402
- * @public
2403
2402
  * <p>The date and time when the recipe was last published.</p>
2403
+ * @public
2404
2404
  */
2405
2405
  PublishedDate?: Date;
2406
2406
  /**
2407
- * @public
2408
2407
  * <p>The description of the recipe.</p>
2408
+ * @public
2409
2409
  */
2410
2410
  Description?: string;
2411
2411
  /**
2412
- * @public
2413
2412
  * <p>The name of the recipe.</p>
2413
+ * @public
2414
2414
  */
2415
2415
  Name: string | undefined;
2416
2416
  /**
2417
- * @public
2418
2417
  * <p>One or more steps to be performed by the recipe. Each step consists of an action, and
2419
2418
  * the conditions under which the action should succeed.</p>
2419
+ * @public
2420
2420
  */
2421
2421
  Steps?: RecipeStep[];
2422
2422
  /**
2423
- * @public
2424
2423
  * <p>Metadata tags associated with this project.</p>
2424
+ * @public
2425
2425
  */
2426
2426
  Tags?: Record<string, string>;
2427
2427
  /**
2428
- * @public
2429
2428
  * <p>The ARN of the recipe.</p>
2429
+ * @public
2430
2430
  */
2431
2431
  ResourceArn?: string;
2432
2432
  /**
2433
- * @public
2434
2433
  * <p>The recipe version identifier.</p>
2434
+ * @public
2435
2435
  */
2436
2436
  RecipeVersion?: string;
2437
2437
  }
@@ -2440,8 +2440,8 @@ export interface DescribeRecipeResponse {
2440
2440
  */
2441
2441
  export interface DescribeRulesetRequest {
2442
2442
  /**
2443
- * @public
2444
2443
  * <p>The name of the ruleset to be described.</p>
2444
+ * @public
2445
2445
  */
2446
2446
  Name: string | undefined;
2447
2447
  }
@@ -2450,55 +2450,55 @@ export interface DescribeRulesetRequest {
2450
2450
  */
2451
2451
  export interface DescribeRulesetResponse {
2452
2452
  /**
2453
- * @public
2454
2453
  * <p>The name of the ruleset.</p>
2454
+ * @public
2455
2455
  */
2456
2456
  Name: string | undefined;
2457
2457
  /**
2458
- * @public
2459
2458
  * <p>The description of the ruleset.</p>
2459
+ * @public
2460
2460
  */
2461
2461
  Description?: string;
2462
2462
  /**
2463
- * @public
2464
2463
  * <p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
2465
2464
  * associated with.</p>
2465
+ * @public
2466
2466
  */
2467
2467
  TargetArn?: string;
2468
2468
  /**
2469
- * @public
2470
2469
  * <p>A list of rules that are defined with the ruleset. A rule includes one
2471
2470
  * or more checks to be validated on a DataBrew dataset.</p>
2471
+ * @public
2472
2472
  */
2473
2473
  Rules?: Rule[];
2474
2474
  /**
2475
- * @public
2476
2475
  * <p>The date and time that the ruleset was created.</p>
2476
+ * @public
2477
2477
  */
2478
2478
  CreateDate?: Date;
2479
2479
  /**
2480
- * @public
2481
2480
  * <p>The Amazon Resource Name (ARN) of the user who created the ruleset.</p>
2481
+ * @public
2482
2482
  */
2483
2483
  CreatedBy?: string;
2484
2484
  /**
2485
- * @public
2486
2485
  * <p>The Amazon Resource Name (ARN) of the user who last modified the ruleset.</p>
2486
+ * @public
2487
2487
  */
2488
2488
  LastModifiedBy?: string;
2489
2489
  /**
2490
- * @public
2491
2490
  * <p>The modification date and time of the ruleset.</p>
2491
+ * @public
2492
2492
  */
2493
2493
  LastModifiedDate?: Date;
2494
2494
  /**
2495
- * @public
2496
2495
  * <p>The Amazon Resource Name (ARN) for the ruleset.</p>
2496
+ * @public
2497
2497
  */
2498
2498
  ResourceArn?: string;
2499
2499
  /**
2500
- * @public
2501
2500
  * <p>Metadata tags that have been applied to the ruleset.</p>
2501
+ * @public
2502
2502
  */
2503
2503
  Tags?: Record<string, string>;
2504
2504
  }
@@ -2507,8 +2507,8 @@ export interface DescribeRulesetResponse {
2507
2507
  */
2508
2508
  export interface DescribeScheduleRequest {
2509
2509
  /**
2510
- * @public
2511
2510
  * <p>The name of the schedule to be described.</p>
2511
+ * @public
2512
2512
  */
2513
2513
  Name: string | undefined;
2514
2514
  }
@@ -2517,50 +2517,50 @@ export interface DescribeScheduleRequest {
2517
2517
  */
2518
2518
  export interface DescribeScheduleResponse {
2519
2519
  /**
2520
- * @public
2521
2520
  * <p>The date and time that the schedule was created.</p>
2521
+ * @public
2522
2522
  */
2523
2523
  CreateDate?: Date;
2524
2524
  /**
2525
- * @public
2526
2525
  * <p>The identifier (user name) of the user who created the schedule. </p>
2526
+ * @public
2527
2527
  */
2528
2528
  CreatedBy?: string;
2529
2529
  /**
2530
- * @public
2531
2530
  * <p>The name or names of one or more jobs to be run by using the schedule.</p>
2531
+ * @public
2532
2532
  */
2533
2533
  JobNames?: string[];
2534
2534
  /**
2535
- * @public
2536
2535
  * <p>The identifier (user name) of the user who last modified the schedule.</p>
2536
+ * @public
2537
2537
  */
2538
2538
  LastModifiedBy?: string;
2539
2539
  /**
2540
- * @public
2541
2540
  * <p>The date and time that the schedule was last modified.</p>
2541
+ * @public
2542
2542
  */
2543
2543
  LastModifiedDate?: Date;
2544
2544
  /**
2545
- * @public
2546
2545
  * <p>The Amazon Resource Name (ARN) of the schedule.</p>
2546
+ * @public
2547
2547
  */
2548
2548
  ResourceArn?: string;
2549
2549
  /**
2550
- * @public
2551
2550
  * <p>The date or dates and time or times when the jobs are to be run for the schedule. For
2552
2551
  * more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html">Cron expressions</a> in the
2553
2552
  * <i>Glue DataBrew Developer Guide</i>.</p>
2553
+ * @public
2554
2554
  */
2555
2555
  CronExpression?: string;
2556
2556
  /**
2557
- * @public
2558
2557
  * <p>Metadata tags associated with this schedule.</p>
2558
+ * @public
2559
2559
  */
2560
2560
  Tags?: Record<string, string>;
2561
2561
  /**
2562
- * @public
2563
2562
  * <p>The name of the schedule.</p>
2563
+ * @public
2564
2564
  */
2565
2565
  Name: string | undefined;
2566
2566
  }
@@ -2569,86 +2569,86 @@ export interface DescribeScheduleResponse {
2569
2569
  */
2570
2570
  export interface ListDatasetsRequest {
2571
2571
  /**
2572
- * @public
2573
2572
  * <p>The maximum number of results to return in this request. </p>
2573
+ * @public
2574
2574
  */
2575
2575
  MaxResults?: number;
2576
2576
  /**
2577
- * @public
2578
2577
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
2578
+ * @public
2579
2579
  */
2580
2580
  NextToken?: string;
2581
2581
  }
2582
2582
  /**
2583
- * @public
2584
2583
  * <p>Represents a dataset that can be processed by DataBrew.</p>
2584
+ * @public
2585
2585
  */
2586
2586
  export interface Dataset {
2587
2587
  /**
2588
- * @public
2589
2588
  * <p>The ID of the Amazon Web Services account that owns the dataset.</p>
2589
+ * @public
2590
2590
  */
2591
2591
  AccountId?: string;
2592
2592
  /**
2593
- * @public
2594
2593
  * <p>The Amazon Resource Name (ARN) of the user who created the dataset.</p>
2594
+ * @public
2595
2595
  */
2596
2596
  CreatedBy?: string;
2597
2597
  /**
2598
- * @public
2599
2598
  * <p>The date and time that the dataset was created.</p>
2599
+ * @public
2600
2600
  */
2601
2601
  CreateDate?: Date;
2602
2602
  /**
2603
- * @public
2604
2603
  * <p>The unique name of the dataset.</p>
2604
+ * @public
2605
2605
  */
2606
2606
  Name: string | undefined;
2607
2607
  /**
2608
- * @public
2609
2608
  * <p>The file format of a dataset that is created from an Amazon S3 file or folder.</p>
2609
+ * @public
2610
2610
  */
2611
2611
  Format?: InputFormat;
2612
2612
  /**
2613
- * @public
2614
2613
  * <p>A set of options that define how DataBrew interprets the data in the dataset.</p>
2614
+ * @public
2615
2615
  */
2616
2616
  FormatOptions?: FormatOptions;
2617
2617
  /**
2618
- * @public
2619
2618
  * <p>Information on how DataBrew can find the dataset, in either the Glue Data Catalog
2620
2619
  * or Amazon S3.</p>
2620
+ * @public
2621
2621
  */
2622
2622
  Input: Input | undefined;
2623
2623
  /**
2624
- * @public
2625
2624
  * <p>The last modification date and time of the dataset.</p>
2625
+ * @public
2626
2626
  */
2627
2627
  LastModifiedDate?: Date;
2628
2628
  /**
2629
- * @public
2630
2629
  * <p>The Amazon Resource Name (ARN) of the user who last modified the dataset.</p>
2630
+ * @public
2631
2631
  */
2632
2632
  LastModifiedBy?: string;
2633
2633
  /**
2634
- * @public
2635
2634
  * <p>The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.</p>
2635
+ * @public
2636
2636
  */
2637
2637
  Source?: Source;
2638
2638
  /**
2639
- * @public
2640
2639
  * <p>A set of options that defines how DataBrew interprets an Amazon S3
2641
2640
  * path of the dataset.</p>
2641
+ * @public
2642
2642
  */
2643
2643
  PathOptions?: PathOptions;
2644
2644
  /**
2645
- * @public
2646
2645
  * <p>Metadata tags that have been applied to the dataset.</p>
2646
+ * @public
2647
2647
  */
2648
2648
  Tags?: Record<string, string>;
2649
2649
  /**
2650
- * @public
2651
2650
  * <p>The unique Amazon Resource Name (ARN) for the dataset.</p>
2651
+ * @public
2652
2652
  */
2653
2653
  ResourceArn?: string;
2654
2654
  }
@@ -2657,14 +2657,14 @@ export interface Dataset {
2657
2657
  */
2658
2658
  export interface ListDatasetsResponse {
2659
2659
  /**
2660
- * @public
2661
2660
  * <p>A list of datasets that are defined.</p>
2661
+ * @public
2662
2662
  */
2663
2663
  Datasets: Dataset[] | undefined;
2664
2664
  /**
2665
- * @public
2666
2665
  * <p>A token that you can use in a subsequent call to retrieve the next set of
2667
2666
  * results.</p>
2667
+ * @public
2668
2668
  */
2669
2669
  NextToken?: string;
2670
2670
  }
@@ -2673,120 +2673,120 @@ export interface ListDatasetsResponse {
2673
2673
  */
2674
2674
  export interface ListJobRunsRequest {
2675
2675
  /**
2676
- * @public
2677
2676
  * <p>The name of the job.</p>
2677
+ * @public
2678
2678
  */
2679
2679
  Name: string | undefined;
2680
2680
  /**
2681
- * @public
2682
2681
  * <p>The maximum number of results to return in this request. </p>
2682
+ * @public
2683
2683
  */
2684
2684
  MaxResults?: number;
2685
2685
  /**
2686
- * @public
2687
2686
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
2687
+ * @public
2688
2688
  */
2689
2689
  NextToken?: string;
2690
2690
  }
2691
2691
  /**
2692
- * @public
2693
2692
  * <p>Represents one run of a DataBrew job.</p>
2693
+ * @public
2694
2694
  */
2695
2695
  export interface JobRun {
2696
2696
  /**
2697
- * @public
2698
2697
  * <p>The number of times that DataBrew has attempted to run the job.</p>
2698
+ * @public
2699
2699
  */
2700
2700
  Attempt?: number;
2701
2701
  /**
2702
- * @public
2703
2702
  * <p>The date and time when the job completed processing.</p>
2703
+ * @public
2704
2704
  */
2705
2705
  CompletedOn?: Date;
2706
2706
  /**
2707
- * @public
2708
2707
  * <p>The name of the dataset for the job to process.</p>
2708
+ * @public
2709
2709
  */
2710
2710
  DatasetName?: string;
2711
2711
  /**
2712
- * @public
2713
2712
  * <p>A message indicating an error (if any) that was encountered when the job ran.</p>
2713
+ * @public
2714
2714
  */
2715
2715
  ErrorMessage?: string;
2716
2716
  /**
2717
- * @public
2718
2717
  * <p>The amount of time, in seconds, during which a job run consumed resources.</p>
2718
+ * @public
2719
2719
  */
2720
2720
  ExecutionTime?: number;
2721
2721
  /**
2722
- * @public
2723
2722
  * <p>The name of the job being processed during this run.</p>
2723
+ * @public
2724
2724
  */
2725
2725
  JobName?: string;
2726
2726
  /**
2727
- * @public
2728
2727
  * <p>The unique identifier of the job run.</p>
2728
+ * @public
2729
2729
  */
2730
2730
  RunId?: string;
2731
2731
  /**
2732
- * @public
2733
2732
  * <p>The current state of the job run entity itself.</p>
2733
+ * @public
2734
2734
  */
2735
2735
  State?: JobRunState;
2736
2736
  /**
2737
- * @public
2738
2737
  * <p>The current status of Amazon CloudWatch logging for the job run.</p>
2738
+ * @public
2739
2739
  */
2740
2740
  LogSubscription?: LogSubscription;
2741
2741
  /**
2742
- * @public
2743
2742
  * <p>The name of an Amazon CloudWatch log group, where the job writes diagnostic messages
2744
2743
  * when it runs.</p>
2744
+ * @public
2745
2745
  */
2746
2746
  LogGroupName?: string;
2747
2747
  /**
2748
- * @public
2749
2748
  * <p>One or more output artifacts from a job run.</p>
2749
+ * @public
2750
2750
  */
2751
2751
  Outputs?: Output[];
2752
2752
  /**
2753
- * @public
2754
2753
  * <p>One or more artifacts that represent the Glue Data Catalog output
2755
2754
  * from running the job.</p>
2755
+ * @public
2756
2756
  */
2757
2757
  DataCatalogOutputs?: DataCatalogOutput[];
2758
2758
  /**
2759
- * @public
2760
2759
  * <p>Represents a list of JDBC database output objects which defines the output
2761
2760
  * destination for a DataBrew recipe job to write into.</p>
2761
+ * @public
2762
2762
  */
2763
2763
  DatabaseOutputs?: DatabaseOutput[];
2764
2764
  /**
2765
- * @public
2766
2765
  * <p>The set of steps processed by the job.</p>
2766
+ * @public
2767
2767
  */
2768
2768
  RecipeReference?: RecipeReference;
2769
2769
  /**
2770
- * @public
2771
2770
  * <p>The Amazon Resource Name (ARN) of the user who initiated the job run. </p>
2771
+ * @public
2772
2772
  */
2773
2773
  StartedBy?: string;
2774
2774
  /**
2775
- * @public
2776
2775
  * <p>The date and time when the job run began. </p>
2776
+ * @public
2777
2777
  */
2778
2778
  StartedOn?: Date;
2779
2779
  /**
2780
- * @public
2781
2780
  * <p>A sample configuration for profile jobs only, which determines the number of rows on which the
2782
2781
  * profile job is run. If a <code>JobSample</code> value isn't provided, the default
2783
2782
  * is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the
2784
2783
  * size parameter.</p>
2784
+ * @public
2785
2785
  */
2786
2786
  JobSample?: JobSample;
2787
2787
  /**
2788
- * @public
2789
2788
  * <p>List of validation configurations that are applied to the profile job run.</p>
2789
+ * @public
2790
2790
  */
2791
2791
  ValidationConfigurations?: ValidationConfiguration[];
2792
2792
  }
@@ -2795,14 +2795,14 @@ export interface JobRun {
2795
2795
  */
2796
2796
  export interface ListJobRunsResponse {
2797
2797
  /**
2798
- * @public
2799
2798
  * <p>A list of job runs that have occurred for the specified job.</p>
2799
+ * @public
2800
2800
  */
2801
2801
  JobRuns: JobRun[] | undefined;
2802
2802
  /**
2803
- * @public
2804
2803
  * <p>A token that you can use in a subsequent call to retrieve the next set of
2805
2804
  * results.</p>
2805
+ * @public
2806
2806
  */
2807
2807
  NextToken?: string;
2808
2808
  }
@@ -2811,65 +2811,64 @@ export interface ListJobRunsResponse {
2811
2811
  */
2812
2812
  export interface ListJobsRequest {
2813
2813
  /**
2814
- * @public
2815
2814
  * <p>The name of a dataset. Using this parameter indicates to return only those jobs that
2816
2815
  * act on the specified dataset.</p>
2816
+ * @public
2817
2817
  */
2818
2818
  DatasetName?: string;
2819
2819
  /**
2820
- * @public
2821
2820
  * <p>The maximum number of results to return in this request. </p>
2821
+ * @public
2822
2822
  */
2823
2823
  MaxResults?: number;
2824
2824
  /**
2825
- * @public
2826
2825
  * <p>A token generated by DataBrew that specifies where to continue pagination if a
2827
2826
  * previous request was truncated. To get the next set of pages, pass in the NextToken
2828
2827
  * value from the response object of the previous page call. </p>
2828
+ * @public
2829
2829
  */
2830
2830
  NextToken?: string;
2831
2831
  /**
2832
- * @public
2833
2832
  * <p>The name of a project. Using this parameter indicates to return only those jobs that
2834
2833
  * are associated with the specified project.</p>
2834
+ * @public
2835
2835
  */
2836
2836
  ProjectName?: string;
2837
2837
  }
2838
2838
  /**
2839
- * @public
2840
2839
  * <p>Represents all of the attributes of a DataBrew job.</p>
2840
+ * @public
2841
2841
  */
2842
2842
  export interface Job {
2843
2843
  /**
2844
- * @public
2845
2844
  * <p>The ID of the Amazon Web Services account that owns the job.</p>
2845
+ * @public
2846
2846
  */
2847
2847
  AccountId?: string;
2848
2848
  /**
2849
- * @public
2850
2849
  * <p>The Amazon Resource Name (ARN) of the user who created the job.</p>
2850
+ * @public
2851
2851
  */
2852
2852
  CreatedBy?: string;
2853
2853
  /**
2854
- * @public
2855
2854
  * <p>The date and time that the job was created.</p>
2855
+ * @public
2856
2856
  */
2857
2857
  CreateDate?: Date;
2858
2858
  /**
2859
- * @public
2860
2859
  * <p>A dataset that the job is to process.</p>
2860
+ * @public
2861
2861
  */
2862
2862
  DatasetName?: string;
2863
2863
  /**
2864
- * @public
2865
2864
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job
2866
2865
  * output. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html">Encrypting data
2867
2866
  * written by DataBrew jobs</a>
2868
2867
  * </p>
2868
+ * @public
2869
2869
  */
2870
2870
  EncryptionKeyArn?: string;
2871
2871
  /**
2872
- * @public
2873
2872
  * <p>The encryption mode for the job, which can be one of the following:</p>
2874
2873
  * <ul>
2875
2874
  * <li>
@@ -2881,15 +2880,15 @@ export interface Job {
2881
2880
  * <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p>
2882
2881
  * </li>
2883
2882
  * </ul>
2883
+ * @public
2884
2884
  */
2885
2885
  EncryptionMode?: EncryptionMode;
2886
2886
  /**
2887
- * @public
2888
2887
  * <p>The unique name of the job.</p>
2888
+ * @public
2889
2889
  */
2890
2890
  Name: string | undefined;
2891
2891
  /**
2892
- * @public
2893
2892
  * <p>The job type of the job, which must be one of the following:</p>
2894
2893
  * <ul>
2895
2894
  * <li>
@@ -2903,92 +2902,93 @@ export interface Job {
2903
2902
  * dataset.</p>
2904
2903
  * </li>
2905
2904
  * </ul>
2905
+ * @public
2906
2906
  */
2907
2907
  Type?: JobType;
2908
2908
  /**
2909
- * @public
2910
2909
  * <p>The Amazon Resource Name (ARN) of the user who last modified the job.</p>
2910
+ * @public
2911
2911
  */
2912
2912
  LastModifiedBy?: string;
2913
2913
  /**
2914
- * @public
2915
2914
  * <p>The modification date and time of the job.</p>
2915
+ * @public
2916
2916
  */
2917
2917
  LastModifiedDate?: Date;
2918
2918
  /**
2919
- * @public
2920
2919
  * <p>The current status of Amazon CloudWatch logging for the job.</p>
2920
+ * @public
2921
2921
  */
2922
2922
  LogSubscription?: LogSubscription;
2923
2923
  /**
2924
- * @public
2925
2924
  * <p>The maximum number of nodes that can be consumed when the job processes data.</p>
2925
+ * @public
2926
2926
  */
2927
2927
  MaxCapacity?: number;
2928
2928
  /**
2929
- * @public
2930
2929
  * <p>The maximum number of times to retry the job after a job run fails.</p>
2930
+ * @public
2931
2931
  */
2932
2932
  MaxRetries?: number;
2933
2933
  /**
2934
- * @public
2935
2934
  * <p>One or more artifacts that represent output from running the job.</p>
2935
+ * @public
2936
2936
  */
2937
2937
  Outputs?: Output[];
2938
2938
  /**
2939
- * @public
2940
2939
  * <p>One or more artifacts that represent the Glue Data Catalog output
2941
2940
  * from running the job.</p>
2941
+ * @public
2942
2942
  */
2943
2943
  DataCatalogOutputs?: DataCatalogOutput[];
2944
2944
  /**
2945
- * @public
2946
2945
  * <p>Represents a list of JDBC database output objects which defines the output
2947
2946
  * destination for a DataBrew recipe job to write into.</p>
2947
+ * @public
2948
2948
  */
2949
2949
  DatabaseOutputs?: DatabaseOutput[];
2950
2950
  /**
2951
- * @public
2952
2951
  * <p>The name of the project that the job is associated with.</p>
2952
+ * @public
2953
2953
  */
2954
2954
  ProjectName?: string;
2955
2955
  /**
2956
- * @public
2957
2956
  * <p>A set of steps that the job runs.</p>
2957
+ * @public
2958
2958
  */
2959
2959
  RecipeReference?: RecipeReference;
2960
2960
  /**
2961
- * @public
2962
2961
  * <p>The unique Amazon Resource Name (ARN) for the job.</p>
2962
+ * @public
2963
2963
  */
2964
2964
  ResourceArn?: string;
2965
2965
  /**
2966
- * @public
2967
2966
  * <p>The Amazon Resource Name (ARN) of the role to be assumed for this job.</p>
2967
+ * @public
2968
2968
  */
2969
2969
  RoleArn?: string;
2970
2970
  /**
2971
- * @public
2972
2971
  * <p>The job's timeout in minutes. A job that attempts to run longer than this timeout
2973
2972
  * period ends with a status of <code>TIMEOUT</code>.</p>
2973
+ * @public
2974
2974
  */
2975
2975
  Timeout?: number;
2976
2976
  /**
2977
- * @public
2978
2977
  * <p>Metadata tags that have been applied to the job.</p>
2978
+ * @public
2979
2979
  */
2980
2980
  Tags?: Record<string, string>;
2981
2981
  /**
2982
- * @public
2983
2982
  * <p>A sample configuration for profile jobs only, which determines the number of rows on which the
2984
2983
  * profile job is run. If a <code>JobSample</code> value isn't provided, the default value
2985
2984
  * is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the
2986
2985
  * size parameter.</p>
2986
+ * @public
2987
2987
  */
2988
2988
  JobSample?: JobSample;
2989
2989
  /**
2990
- * @public
2991
2990
  * <p>List of validation configurations that are applied to the profile job.</p>
2991
+ * @public
2992
2992
  */
2993
2993
  ValidationConfigurations?: ValidationConfiguration[];
2994
2994
  }
@@ -2997,14 +2997,14 @@ export interface Job {
2997
2997
  */
2998
2998
  export interface ListJobsResponse {
2999
2999
  /**
3000
- * @public
3001
3000
  * <p>A list of jobs that are defined.</p>
3001
+ * @public
3002
3002
  */
3003
3003
  Jobs: Job[] | undefined;
3004
3004
  /**
3005
- * @public
3006
3005
  * <p>A token that you can use in a subsequent call to retrieve the next set of
3007
3006
  * results.</p>
3007
+ * @public
3008
3008
  */
3009
3009
  NextToken?: string;
3010
3010
  }
@@ -3013,91 +3013,91 @@ export interface ListJobsResponse {
3013
3013
  */
3014
3014
  export interface ListProjectsRequest {
3015
3015
  /**
3016
- * @public
3017
3016
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
3017
+ * @public
3018
3018
  */
3019
3019
  NextToken?: string;
3020
3020
  /**
3021
- * @public
3022
3021
  * <p>The maximum number of results to return in this request. </p>
3022
+ * @public
3023
3023
  */
3024
3024
  MaxResults?: number;
3025
3025
  }
3026
3026
  /**
3027
- * @public
3028
3027
  * <p>Represents all of the attributes of a DataBrew project.</p>
3028
+ * @public
3029
3029
  */
3030
3030
  export interface Project {
3031
3031
  /**
3032
- * @public
3033
3032
  * <p>The ID of the Amazon Web Services account that owns the project.</p>
3033
+ * @public
3034
3034
  */
3035
3035
  AccountId?: string;
3036
3036
  /**
3037
- * @public
3038
3037
  * <p>The date and time that the project was created.</p>
3038
+ * @public
3039
3039
  */
3040
3040
  CreateDate?: Date;
3041
3041
  /**
3042
- * @public
3043
3042
  * <p>The Amazon Resource Name (ARN) of the user who crated the project.</p>
3043
+ * @public
3044
3044
  */
3045
3045
  CreatedBy?: string;
3046
3046
  /**
3047
- * @public
3048
3047
  * <p>The dataset that the project is to act upon.</p>
3048
+ * @public
3049
3049
  */
3050
3050
  DatasetName?: string;
3051
3051
  /**
3052
- * @public
3053
3052
  * <p>The last modification date and time for the project.</p>
3053
+ * @public
3054
3054
  */
3055
3055
  LastModifiedDate?: Date;
3056
3056
  /**
3057
- * @public
3058
3057
  * <p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>
3058
+ * @public
3059
3059
  */
3060
3060
  LastModifiedBy?: string;
3061
3061
  /**
3062
- * @public
3063
3062
  * <p>The unique name of a project.</p>
3063
+ * @public
3064
3064
  */
3065
3065
  Name: string | undefined;
3066
3066
  /**
3067
- * @public
3068
3067
  * <p>The name of a recipe that will be developed during a project session.</p>
3068
+ * @public
3069
3069
  */
3070
3070
  RecipeName: string | undefined;
3071
3071
  /**
3072
- * @public
3073
3072
  * <p>The Amazon Resource Name (ARN) for the project.</p>
3073
+ * @public
3074
3074
  */
3075
3075
  ResourceArn?: string;
3076
3076
  /**
3077
- * @public
3078
3077
  * <p>The sample size and sampling type to apply to the data. If this parameter isn't
3079
3078
  * specified, then the sample consists of the first 500 rows from the dataset.</p>
3079
+ * @public
3080
3080
  */
3081
3081
  Sample?: Sample;
3082
3082
  /**
3083
- * @public
3084
3083
  * <p>Metadata tags that have been applied to the project.</p>
3084
+ * @public
3085
3085
  */
3086
3086
  Tags?: Record<string, string>;
3087
3087
  /**
3088
- * @public
3089
3088
  * <p>The Amazon Resource Name (ARN) of the role that will be assumed for this
3090
3089
  * project.</p>
3090
+ * @public
3091
3091
  */
3092
3092
  RoleArn?: string;
3093
3093
  /**
3094
- * @public
3095
3094
  * <p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>
3095
+ * @public
3096
3096
  */
3097
3097
  OpenedBy?: string;
3098
3098
  /**
3099
- * @public
3100
3099
  * <p>The date and time when the project was opened.</p>
3100
+ * @public
3101
3101
  */
3102
3102
  OpenDate?: Date;
3103
3103
  }
@@ -3106,14 +3106,14 @@ export interface Project {
3106
3106
  */
3107
3107
  export interface ListProjectsResponse {
3108
3108
  /**
3109
- * @public
3110
3109
  * <p>A list of projects that are defined .</p>
3110
+ * @public
3111
3111
  */
3112
3112
  Projects: Project[] | undefined;
3113
3113
  /**
3114
- * @public
3115
3114
  * <p>A token that you can use in a subsequent call to retrieve the next set of
3116
3115
  * results.</p>
3116
+ * @public
3117
3117
  */
3118
3118
  NextToken?: string;
3119
3119
  }
@@ -3122,93 +3122,92 @@ export interface ListProjectsResponse {
3122
3122
  */
3123
3123
  export interface ListRecipesRequest {
3124
3124
  /**
3125
- * @public
3126
3125
  * <p>The maximum number of results to return in this request. </p>
3126
+ * @public
3127
3127
  */
3128
3128
  MaxResults?: number;
3129
3129
  /**
3130
- * @public
3131
3130
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
3131
+ * @public
3132
3132
  */
3133
3133
  NextToken?: string;
3134
3134
  /**
3135
- * @public
3136
3135
  * <p>Return only those recipes with a version identifier of <code>LATEST_WORKING</code> or
3137
3136
  * <code>LATEST_PUBLISHED</code>. If <code>RecipeVersion</code> is omitted,
3138
3137
  * <code>ListRecipes</code> returns all of the <code>LATEST_PUBLISHED</code> recipe
3139
3138
  * versions.</p>
3140
3139
  * <p>Valid values: <code>LATEST_WORKING</code> | <code>LATEST_PUBLISHED</code>
3141
3140
  * </p>
3141
+ * @public
3142
3142
  */
3143
3143
  RecipeVersion?: string;
3144
3144
  }
3145
3145
  /**
3146
- * @public
3147
3146
  * <p>Represents one or more actions to be performed on a DataBrew dataset.</p>
3147
+ * @public
3148
3148
  */
3149
3149
  export interface Recipe {
3150
3150
  /**
3151
- * @public
3152
3151
  * <p>The Amazon Resource Name (ARN) of the user who created the recipe.</p>
3152
+ * @public
3153
3153
  */
3154
3154
  CreatedBy?: string;
3155
3155
  /**
3156
- * @public
3157
3156
  * <p>The date and time that the recipe was created.</p>
3157
+ * @public
3158
3158
  */
3159
3159
  CreateDate?: Date;
3160
3160
  /**
3161
- * @public
3162
3161
  * <p>The Amazon Resource Name (ARN) of the user who last modified the recipe.</p>
3162
+ * @public
3163
3163
  */
3164
3164
  LastModifiedBy?: string;
3165
3165
  /**
3166
- * @public
3167
3166
  * <p>The last modification date and time of the recipe.</p>
3167
+ * @public
3168
3168
  */
3169
3169
  LastModifiedDate?: Date;
3170
3170
  /**
3171
- * @public
3172
3171
  * <p>The name of the project that the recipe is associated with.</p>
3172
+ * @public
3173
3173
  */
3174
3174
  ProjectName?: string;
3175
3175
  /**
3176
- * @public
3177
3176
  * <p>The Amazon Resource Name (ARN) of the user who published the recipe.</p>
3177
+ * @public
3178
3178
  */
3179
3179
  PublishedBy?: string;
3180
3180
  /**
3181
- * @public
3182
3181
  * <p>The date and time when the recipe was published.</p>
3182
+ * @public
3183
3183
  */
3184
3184
  PublishedDate?: Date;
3185
3185
  /**
3186
- * @public
3187
3186
  * <p>The description of the recipe.</p>
3187
+ * @public
3188
3188
  */
3189
3189
  Description?: string;
3190
3190
  /**
3191
- * @public
3192
3191
  * <p>The unique name for the recipe.</p>
3192
+ * @public
3193
3193
  */
3194
3194
  Name: string | undefined;
3195
3195
  /**
3196
- * @public
3197
3196
  * <p>The Amazon Resource Name (ARN) for the recipe.</p>
3197
+ * @public
3198
3198
  */
3199
3199
  ResourceArn?: string;
3200
3200
  /**
3201
- * @public
3202
3201
  * <p>A list of steps that are defined by the recipe.</p>
3202
+ * @public
3203
3203
  */
3204
3204
  Steps?: RecipeStep[];
3205
3205
  /**
3206
- * @public
3207
3206
  * <p>Metadata tags that have been applied to the recipe.</p>
3207
+ * @public
3208
3208
  */
3209
3209
  Tags?: Record<string, string>;
3210
3210
  /**
3211
- * @public
3212
3211
  * <p>The identifier for the version for the recipe. Must be one of the following:</p>
3213
3212
  * <ul>
3214
3213
  * <li>
@@ -3227,6 +3226,7 @@ export interface Recipe {
3227
3226
  * <code>LATEST_PUBLISHED</code> - the most recent published version.</p>
3228
3227
  * </li>
3229
3228
  * </ul>
3229
+ * @public
3230
3230
  */
3231
3231
  RecipeVersion?: string;
3232
3232
  }
@@ -3235,14 +3235,14 @@ export interface Recipe {
3235
3235
  */
3236
3236
  export interface ListRecipesResponse {
3237
3237
  /**
3238
- * @public
3239
3238
  * <p>A list of recipes that are defined.</p>
3239
+ * @public
3240
3240
  */
3241
3241
  Recipes: Recipe[] | undefined;
3242
3242
  /**
3243
- * @public
3244
3243
  * <p>A token that you can use in a subsequent call to retrieve the next set of
3245
3244
  * results.</p>
3245
+ * @public
3246
3246
  */
3247
3247
  NextToken?: string;
3248
3248
  }
@@ -3251,18 +3251,18 @@ export interface ListRecipesResponse {
3251
3251
  */
3252
3252
  export interface ListRecipeVersionsRequest {
3253
3253
  /**
3254
- * @public
3255
3254
  * <p>The maximum number of results to return in this request. </p>
3255
+ * @public
3256
3256
  */
3257
3257
  MaxResults?: number;
3258
3258
  /**
3259
- * @public
3260
3259
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
3260
+ * @public
3261
3261
  */
3262
3262
  NextToken?: string;
3263
3263
  /**
3264
- * @public
3265
3264
  * <p>The name of the recipe for which to return version information.</p>
3265
+ * @public
3266
3266
  */
3267
3267
  Name: string | undefined;
3268
3268
  }
@@ -3271,14 +3271,14 @@ export interface ListRecipeVersionsRequest {
3271
3271
  */
3272
3272
  export interface ListRecipeVersionsResponse {
3273
3273
  /**
3274
- * @public
3275
3274
  * <p>A token that you can use in a subsequent call to retrieve the next set of
3276
3275
  * results.</p>
3276
+ * @public
3277
3277
  */
3278
3278
  NextToken?: string;
3279
3279
  /**
3280
- * @public
3281
3280
  * <p>A list of versions for the specified recipe.</p>
3281
+ * @public
3282
3282
  */
3283
3283
  Recipes: Recipe[] | undefined;
3284
3284
  }
@@ -3287,83 +3287,83 @@ export interface ListRecipeVersionsResponse {
3287
3287
  */
3288
3288
  export interface ListRulesetsRequest {
3289
3289
  /**
3290
- * @public
3291
3290
  * <p>The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter
3292
3291
  * indicates to return only those rulesets that are associated with the specified resource.</p>
3292
+ * @public
3293
3293
  */
3294
3294
  TargetArn?: string;
3295
3295
  /**
3296
- * @public
3297
3296
  * <p>The maximum number of results to return in this request.</p>
3297
+ * @public
3298
3298
  */
3299
3299
  MaxResults?: number;
3300
3300
  /**
3301
- * @public
3302
3301
  * <p>A token generated by DataBrew that specifies where to continue pagination
3303
3302
  * if a previous request was truncated. To get the next set of pages, pass in
3304
3303
  * the NextToken value from the response object of the previous page call.</p>
3304
+ * @public
3305
3305
  */
3306
3306
  NextToken?: string;
3307
3307
  }
3308
3308
  /**
3309
- * @public
3310
3309
  * <p>Contains metadata about the ruleset.</p>
3310
+ * @public
3311
3311
  */
3312
3312
  export interface RulesetItem {
3313
3313
  /**
3314
- * @public
3315
3314
  * <p>The ID of the Amazon Web Services account that owns the ruleset.</p>
3315
+ * @public
3316
3316
  */
3317
3317
  AccountId?: string;
3318
3318
  /**
3319
- * @public
3320
3319
  * <p>The Amazon Resource Name (ARN) of the user who created the ruleset.</p>
3320
+ * @public
3321
3321
  */
3322
3322
  CreatedBy?: string;
3323
3323
  /**
3324
- * @public
3325
3324
  * <p>The date and time that the ruleset was created.</p>
3325
+ * @public
3326
3326
  */
3327
3327
  CreateDate?: Date;
3328
3328
  /**
3329
- * @public
3330
3329
  * <p>The description of the ruleset.</p>
3330
+ * @public
3331
3331
  */
3332
3332
  Description?: string;
3333
3333
  /**
3334
- * @public
3335
3334
  * <p>The Amazon Resource Name (ARN) of the user who last modified the ruleset.</p>
3335
+ * @public
3336
3336
  */
3337
3337
  LastModifiedBy?: string;
3338
3338
  /**
3339
- * @public
3340
3339
  * <p>The modification date and time of the ruleset.</p>
3340
+ * @public
3341
3341
  */
3342
3342
  LastModifiedDate?: Date;
3343
3343
  /**
3344
- * @public
3345
3344
  * <p>The name of the ruleset.</p>
3345
+ * @public
3346
3346
  */
3347
3347
  Name: string | undefined;
3348
3348
  /**
3349
- * @public
3350
3349
  * <p>The Amazon Resource Name (ARN) for the ruleset.</p>
3350
+ * @public
3351
3351
  */
3352
3352
  ResourceArn?: string;
3353
3353
  /**
3354
- * @public
3355
3354
  * <p>The number of rules that are defined in the ruleset.</p>
3355
+ * @public
3356
3356
  */
3357
3357
  RuleCount?: number;
3358
3358
  /**
3359
- * @public
3360
3359
  * <p>Metadata tags that have been applied to the ruleset.</p>
3360
+ * @public
3361
3361
  */
3362
3362
  Tags?: Record<string, string>;
3363
3363
  /**
3364
- * @public
3365
3364
  * <p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
3366
3365
  * associated with.</p>
3366
+ * @public
3367
3367
  */
3368
3368
  TargetArn: string | undefined;
3369
3369
  }
@@ -3372,14 +3372,14 @@ export interface RulesetItem {
3372
3372
  */
3373
3373
  export interface ListRulesetsResponse {
3374
3374
  /**
3375
- * @public
3376
3375
  * <p>A list of RulesetItem. RulesetItem contains meta data of a ruleset.</p>
3376
+ * @public
3377
3377
  */
3378
3378
  Rulesets: RulesetItem[] | undefined;
3379
3379
  /**
3380
- * @public
3381
3380
  * <p>A token that you can use in a subsequent call to retrieve the next set of
3382
3381
  * results.</p>
3382
+ * @public
3383
3383
  */
3384
3384
  NextToken?: string;
3385
3385
  }
@@ -3388,76 +3388,76 @@ export interface ListRulesetsResponse {
3388
3388
  */
3389
3389
  export interface ListSchedulesRequest {
3390
3390
  /**
3391
- * @public
3392
3391
  * <p>The name of the job that these schedules apply to.</p>
3392
+ * @public
3393
3393
  */
3394
3394
  JobName?: string;
3395
3395
  /**
3396
- * @public
3397
3396
  * <p>The maximum number of results to return in this request. </p>
3397
+ * @public
3398
3398
  */
3399
3399
  MaxResults?: number;
3400
3400
  /**
3401
- * @public
3402
3401
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
3402
+ * @public
3403
3403
  */
3404
3404
  NextToken?: string;
3405
3405
  }
3406
3406
  /**
3407
- * @public
3408
3407
  * <p>Represents one or more dates and times when a job is to run.</p>
3408
+ * @public
3409
3409
  */
3410
3410
  export interface Schedule {
3411
3411
  /**
3412
- * @public
3413
3412
  * <p>The ID of the Amazon Web Services account that owns the schedule.</p>
3413
+ * @public
3414
3414
  */
3415
3415
  AccountId?: string;
3416
3416
  /**
3417
- * @public
3418
3417
  * <p>The Amazon Resource Name (ARN) of the user who created the schedule.</p>
3418
+ * @public
3419
3419
  */
3420
3420
  CreatedBy?: string;
3421
3421
  /**
3422
- * @public
3423
3422
  * <p>The date and time that the schedule was created.</p>
3423
+ * @public
3424
3424
  */
3425
3425
  CreateDate?: Date;
3426
3426
  /**
3427
- * @public
3428
3427
  * <p>A list of jobs to be run, according to the schedule.</p>
3428
+ * @public
3429
3429
  */
3430
3430
  JobNames?: string[];
3431
3431
  /**
3432
- * @public
3433
3432
  * <p>The Amazon Resource Name (ARN) of the user who last modified the schedule.</p>
3433
+ * @public
3434
3434
  */
3435
3435
  LastModifiedBy?: string;
3436
3436
  /**
3437
- * @public
3438
3437
  * <p>The date and time when the schedule was last modified.</p>
3438
+ * @public
3439
3439
  */
3440
3440
  LastModifiedDate?: Date;
3441
3441
  /**
3442
- * @public
3443
3442
  * <p>The Amazon Resource Name (ARN) of the schedule.</p>
3443
+ * @public
3444
3444
  */
3445
3445
  ResourceArn?: string;
3446
3446
  /**
3447
- * @public
3448
3447
  * <p>The dates and times when the job is to run. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html">Cron
3449
3448
  * expressions</a> in the <i>Glue DataBrew Developer
3450
3449
  * Guide</i>.</p>
3450
+ * @public
3451
3451
  */
3452
3452
  CronExpression?: string;
3453
3453
  /**
3454
- * @public
3455
3454
  * <p>Metadata tags that have been applied to the schedule.</p>
3455
+ * @public
3456
3456
  */
3457
3457
  Tags?: Record<string, string>;
3458
3458
  /**
3459
- * @public
3460
3459
  * <p>The name of the schedule.</p>
3460
+ * @public
3461
3461
  */
3462
3462
  Name: string | undefined;
3463
3463
  }
@@ -3466,14 +3466,14 @@ export interface Schedule {
3466
3466
  */
3467
3467
  export interface ListSchedulesResponse {
3468
3468
  /**
3469
- * @public
3470
3469
  * <p>A list of schedules that are defined.</p>
3470
+ * @public
3471
3471
  */
3472
3472
  Schedules: Schedule[] | undefined;
3473
3473
  /**
3474
- * @public
3475
3474
  * <p>A token that you can use in a subsequent call to retrieve the next set of
3476
3475
  * results.</p>
3476
+ * @public
3477
3477
  */
3478
3478
  NextToken?: string;
3479
3479
  }
@@ -3482,9 +3482,9 @@ export interface ListSchedulesResponse {
3482
3482
  */
3483
3483
  export interface ListTagsForResourceRequest {
3484
3484
  /**
3485
- * @public
3486
3485
  * <p>The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.
3487
3486
  * </p>
3487
+ * @public
3488
3488
  */
3489
3489
  ResourceArn: string | undefined;
3490
3490
  }
@@ -3493,8 +3493,8 @@ export interface ListTagsForResourceRequest {
3493
3493
  */
3494
3494
  export interface ListTagsForResourceResponse {
3495
3495
  /**
3496
- * @public
3497
3496
  * <p>A list of tags associated with the DataBrew resource.</p>
3497
+ * @public
3498
3498
  */
3499
3499
  Tags?: Record<string, string>;
3500
3500
  }
@@ -3503,13 +3503,13 @@ export interface ListTagsForResourceResponse {
3503
3503
  */
3504
3504
  export interface PublishRecipeRequest {
3505
3505
  /**
3506
- * @public
3507
3506
  * <p>A description of the recipe to be published, for this version of the recipe.</p>
3507
+ * @public
3508
3508
  */
3509
3509
  Description?: string;
3510
3510
  /**
3511
- * @public
3512
3511
  * <p>The name of the recipe to be published.</p>
3512
+ * @public
3513
3513
  */
3514
3514
  Name: string | undefined;
3515
3515
  }
@@ -3518,47 +3518,47 @@ export interface PublishRecipeRequest {
3518
3518
  */
3519
3519
  export interface PublishRecipeResponse {
3520
3520
  /**
3521
- * @public
3522
3521
  * <p>The name of the recipe that you published.</p>
3522
+ * @public
3523
3523
  */
3524
3524
  Name: string | undefined;
3525
3525
  }
3526
3526
  /**
3527
- * @public
3528
3527
  * <p>Represents the data being transformed during an action.</p>
3528
+ * @public
3529
3529
  */
3530
3530
  export interface ViewFrame {
3531
3531
  /**
3532
- * @public
3533
3532
  * <p>The starting index for the range of columns to return in the view frame.</p>
3533
+ * @public
3534
3534
  */
3535
3535
  StartColumnIndex: number | undefined;
3536
3536
  /**
3537
- * @public
3538
3537
  * <p>The number of columns to include in the view frame, beginning with the
3539
3538
  * <code>StartColumnIndex</code> value and ignoring any columns in the
3540
3539
  * <code>HiddenColumns</code> list.</p>
3540
+ * @public
3541
3541
  */
3542
3542
  ColumnRange?: number;
3543
3543
  /**
3544
- * @public
3545
3544
  * <p>A list of columns to hide in the view frame.</p>
3545
+ * @public
3546
3546
  */
3547
3547
  HiddenColumns?: string[];
3548
3548
  /**
3549
- * @public
3550
3549
  * <p>The starting index for the range of rows to return in the view frame.</p>
3550
+ * @public
3551
3551
  */
3552
3552
  StartRowIndex?: number;
3553
3553
  /**
3554
- * @public
3555
3554
  * <p>The number of rows to include in the view frame, beginning with the
3556
3555
  * <code>StartRowIndex</code> value.</p>
3556
+ * @public
3557
3557
  */
3558
3558
  RowRange?: number;
3559
3559
  /**
3560
- * @public
3561
3560
  * <p>Controls if analytics computation is enabled or disabled. Enabled by default.</p>
3561
+ * @public
3562
3562
  */
3563
3563
  Analytics?: AnalyticsMode;
3564
3564
  }
@@ -3567,36 +3567,36 @@ export interface ViewFrame {
3567
3567
  */
3568
3568
  export interface SendProjectSessionActionRequest {
3569
3569
  /**
3570
- * @public
3571
3570
  * <p>If true, the result of the recipe step will be returned, but not applied.</p>
3571
+ * @public
3572
3572
  */
3573
3573
  Preview?: boolean;
3574
3574
  /**
3575
- * @public
3576
3575
  * <p>The name of the project to apply the action to.</p>
3576
+ * @public
3577
3577
  */
3578
3578
  Name: string | undefined;
3579
3579
  /**
3580
- * @public
3581
3580
  * <p>Represents a single step from a DataBrew recipe to be performed.</p>
3581
+ * @public
3582
3582
  */
3583
3583
  RecipeStep?: RecipeStep;
3584
3584
  /**
3585
- * @public
3586
3585
  * <p>The index from which to preview a step. This index is used to preview the result of
3587
3586
  * steps that have already been applied, so that the resulting view frame is from earlier
3588
3587
  * in the view frame stack.</p>
3588
+ * @public
3589
3589
  */
3590
3590
  StepIndex?: number;
3591
3591
  /**
3592
- * @public
3593
3592
  * <p>A unique identifier for an interactive session that's currently open and ready for
3594
3593
  * work. The action will be performed on this session.</p>
3594
+ * @public
3595
3595
  */
3596
3596
  ClientSessionId?: string;
3597
3597
  /**
3598
- * @public
3599
3598
  * <p>Represents the data being transformed during an action.</p>
3599
+ * @public
3600
3600
  */
3601
3601
  ViewFrame?: ViewFrame;
3602
3602
  }
@@ -3605,18 +3605,18 @@ export interface SendProjectSessionActionRequest {
3605
3605
  */
3606
3606
  export interface SendProjectSessionActionResponse {
3607
3607
  /**
3608
- * @public
3609
3608
  * <p>A message indicating the result of performing the action.</p>
3609
+ * @public
3610
3610
  */
3611
3611
  Result?: string;
3612
3612
  /**
3613
- * @public
3614
3613
  * <p>The name of the project that was affected by the action.</p>
3614
+ * @public
3615
3615
  */
3616
3616
  Name: string | undefined;
3617
3617
  /**
3618
- * @public
3619
3618
  * <p>A unique identifier for the action that was performed.</p>
3619
+ * @public
3620
3620
  */
3621
3621
  ActionId?: number;
3622
3622
  }
@@ -3625,8 +3625,8 @@ export interface SendProjectSessionActionResponse {
3625
3625
  */
3626
3626
  export interface StartJobRunRequest {
3627
3627
  /**
3628
- * @public
3629
3628
  * <p>The name of the job to be run.</p>
3629
+ * @public
3630
3630
  */
3631
3631
  Name: string | undefined;
3632
3632
  }
@@ -3635,8 +3635,8 @@ export interface StartJobRunRequest {
3635
3635
  */
3636
3636
  export interface StartJobRunResponse {
3637
3637
  /**
3638
- * @public
3639
3638
  * <p>A system-generated identifier for this particular job run.</p>
3639
+ * @public
3640
3640
  */
3641
3641
  RunId: string | undefined;
3642
3642
  }
@@ -3645,14 +3645,14 @@ export interface StartJobRunResponse {
3645
3645
  */
3646
3646
  export interface StartProjectSessionRequest {
3647
3647
  /**
3648
- * @public
3649
3648
  * <p>The name of the project to act upon.</p>
3649
+ * @public
3650
3650
  */
3651
3651
  Name: string | undefined;
3652
3652
  /**
3653
- * @public
3654
3653
  * <p>A value that, if true, enables you to take control of a session, even if a different
3655
3654
  * client is currently accessing the project.</p>
3655
+ * @public
3656
3656
  */
3657
3657
  AssumeControl?: boolean;
3658
3658
  }
@@ -3661,13 +3661,13 @@ export interface StartProjectSessionRequest {
3661
3661
  */
3662
3662
  export interface StartProjectSessionResponse {
3663
3663
  /**
3664
- * @public
3665
3664
  * <p>The name of the project to be acted upon.</p>
3665
+ * @public
3666
3666
  */
3667
3667
  Name: string | undefined;
3668
3668
  /**
3669
- * @public
3670
3669
  * <p>A system-generated identifier for the session.</p>
3670
+ * @public
3671
3671
  */
3672
3672
  ClientSessionId?: string;
3673
3673
  }
@@ -3676,13 +3676,13 @@ export interface StartProjectSessionResponse {
3676
3676
  */
3677
3677
  export interface StopJobRunRequest {
3678
3678
  /**
3679
- * @public
3680
3679
  * <p>The name of the job to be stopped.</p>
3680
+ * @public
3681
3681
  */
3682
3682
  Name: string | undefined;
3683
3683
  /**
3684
- * @public
3685
3684
  * <p>The ID of the job run to be stopped.</p>
3685
+ * @public
3686
3686
  */
3687
3687
  RunId: string | undefined;
3688
3688
  }
@@ -3691,8 +3691,8 @@ export interface StopJobRunRequest {
3691
3691
  */
3692
3692
  export interface StopJobRunResponse {
3693
3693
  /**
3694
- * @public
3695
3694
  * <p>The ID of the job run that you stopped.</p>
3695
+ * @public
3696
3696
  */
3697
3697
  RunId: string | undefined;
3698
3698
  }
@@ -3701,15 +3701,15 @@ export interface StopJobRunResponse {
3701
3701
  */
3702
3702
  export interface TagResourceRequest {
3703
3703
  /**
3704
- * @public
3705
3704
  * <p>The DataBrew resource to which tags should be added. The value for this parameter is
3706
3705
  * an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or
3707
3706
  * a recipe.</p>
3707
+ * @public
3708
3708
  */
3709
3709
  ResourceArn: string | undefined;
3710
3710
  /**
3711
- * @public
3712
3711
  * <p>One or more tags to be assigned to the resource.</p>
3712
+ * @public
3713
3713
  */
3714
3714
  Tags: Record<string, string> | undefined;
3715
3715
  }
@@ -3723,14 +3723,14 @@ export interface TagResourceResponse {
3723
3723
  */
3724
3724
  export interface UntagResourceRequest {
3725
3725
  /**
3726
- * @public
3727
3726
  * <p>A DataBrew resource from which you want to remove a tag or tags. The value for this
3728
3727
  * parameter is an Amazon Resource Name (ARN). </p>
3728
+ * @public
3729
3729
  */
3730
3730
  ResourceArn: string | undefined;
3731
3731
  /**
3732
- * @public
3733
3732
  * <p>The tag keys (names) of one or more tags to be removed.</p>
3733
+ * @public
3734
3734
  */
3735
3735
  TagKeys: string[] | undefined;
3736
3736
  }
@@ -3744,30 +3744,30 @@ export interface UntagResourceResponse {
3744
3744
  */
3745
3745
  export interface UpdateDatasetRequest {
3746
3746
  /**
3747
- * @public
3748
3747
  * <p>The name of the dataset to be updated.</p>
3748
+ * @public
3749
3749
  */
3750
3750
  Name: string | undefined;
3751
3751
  /**
3752
- * @public
3753
3752
  * <p>The file format of a dataset that is created from an Amazon S3 file or folder.</p>
3753
+ * @public
3754
3754
  */
3755
3755
  Format?: InputFormat;
3756
3756
  /**
3757
- * @public
3758
3757
  * <p>Represents a set of options that define the structure of either comma-separated value (CSV),
3759
3758
  * Excel, or JSON input.</p>
3759
+ * @public
3760
3760
  */
3761
3761
  FormatOptions?: FormatOptions;
3762
3762
  /**
3763
- * @public
3764
3763
  * <p>Represents information on how DataBrew can find data, in either the Glue Data Catalog or
3765
3764
  * Amazon S3.</p>
3765
+ * @public
3766
3766
  */
3767
3767
  Input: Input | undefined;
3768
3768
  /**
3769
- * @public
3770
3769
  * <p>A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.</p>
3770
+ * @public
3771
3771
  */
3772
3772
  PathOptions?: PathOptions;
3773
3773
  }
@@ -3776,8 +3776,8 @@ export interface UpdateDatasetRequest {
3776
3776
  */
3777
3777
  export interface UpdateDatasetResponse {
3778
3778
  /**
3779
- * @public
3780
3779
  * <p>The name of the dataset that you updated.</p>
3780
+ * @public
3781
3781
  */
3782
3782
  Name: string | undefined;
3783
3783
  }
@@ -3786,20 +3786,19 @@ export interface UpdateDatasetResponse {
3786
3786
  */
3787
3787
  export interface UpdateProfileJobRequest {
3788
3788
  /**
3789
- * @public
3790
3789
  * <p>Configuration for profile jobs. Used to select columns, do evaluations,
3791
3790
  * and override default parameters of evaluations. When configuration is null, the
3792
3791
  * profile job will run with default settings.</p>
3792
+ * @public
3793
3793
  */
3794
3794
  Configuration?: ProfileConfiguration;
3795
3795
  /**
3796
- * @public
3797
3796
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the
3798
3797
  * job.</p>
3798
+ * @public
3799
3799
  */
3800
3800
  EncryptionKeyArn?: string;
3801
3801
  /**
3802
- * @public
3803
3802
  * <p>The encryption mode for the job, which can be one of the following:</p>
3804
3803
  * <ul>
3805
3804
  * <li>
@@ -3812,59 +3811,60 @@ export interface UpdateProfileJobRequest {
3812
3811
  * S3.</p>
3813
3812
  * </li>
3814
3813
  * </ul>
3814
+ * @public
3815
3815
  */
3816
3816
  EncryptionMode?: EncryptionMode;
3817
3817
  /**
3818
- * @public
3819
3818
  * <p>The name of the job to be updated.</p>
3819
+ * @public
3820
3820
  */
3821
3821
  Name: string | undefined;
3822
3822
  /**
3823
- * @public
3824
3823
  * <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,
3825
3824
  * CloudWatch writes one log stream for each job run.</p>
3825
+ * @public
3826
3826
  */
3827
3827
  LogSubscription?: LogSubscription;
3828
3828
  /**
3829
- * @public
3830
3829
  * <p>The maximum number of compute nodes that DataBrew can use when the job processes
3831
3830
  * data.</p>
3831
+ * @public
3832
3832
  */
3833
3833
  MaxCapacity?: number;
3834
3834
  /**
3835
- * @public
3836
3835
  * <p>The maximum number of times to retry the job after a job run fails.</p>
3836
+ * @public
3837
3837
  */
3838
3838
  MaxRetries?: number;
3839
3839
  /**
3840
- * @public
3841
3840
  * <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read
3842
3841
  * input data, or write output from a job.</p>
3842
+ * @public
3843
3843
  */
3844
3844
  OutputLocation: S3Location | undefined;
3845
3845
  /**
3846
- * @public
3847
3846
  * <p>List of validation configurations that are applied to the profile job.</p>
3847
+ * @public
3848
3848
  */
3849
3849
  ValidationConfigurations?: ValidationConfiguration[];
3850
3850
  /**
3851
- * @public
3852
3851
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
3853
3852
  * be assumed when DataBrew runs the job.</p>
3853
+ * @public
3854
3854
  */
3855
3855
  RoleArn: string | undefined;
3856
3856
  /**
3857
- * @public
3858
3857
  * <p>The job's timeout in minutes. A job that attempts to run longer than this timeout
3859
3858
  * period ends with a status of <code>TIMEOUT</code>.</p>
3859
+ * @public
3860
3860
  */
3861
3861
  Timeout?: number;
3862
3862
  /**
3863
- * @public
3864
3863
  * <p>Sample configuration for Profile Jobs only. Determines the number of rows on which the
3865
3864
  * Profile job will be executed. If a JobSample value is not provided for profile jobs, the
3866
3865
  * default value will be used. The default value is CUSTOM_ROWS for the mode parameter and
3867
3866
  * 20000 for the size parameter.</p>
3867
+ * @public
3868
3868
  */
3869
3869
  JobSample?: JobSample;
3870
3870
  }
@@ -3873,8 +3873,8 @@ export interface UpdateProfileJobRequest {
3873
3873
  */
3874
3874
  export interface UpdateProfileJobResponse {
3875
3875
  /**
3876
- * @public
3877
3876
  * <p>The name of the job that was updated.</p>
3877
+ * @public
3878
3878
  */
3879
3879
  Name: string | undefined;
3880
3880
  }
@@ -3883,19 +3883,19 @@ export interface UpdateProfileJobResponse {
3883
3883
  */
3884
3884
  export interface UpdateProjectRequest {
3885
3885
  /**
3886
- * @public
3887
3886
  * <p>Represents the sample size and sampling type for DataBrew to use for interactive data
3888
3887
  * analysis.</p>
3888
+ * @public
3889
3889
  */
3890
3890
  Sample?: Sample;
3891
3891
  /**
3892
- * @public
3893
3892
  * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.</p>
3893
+ * @public
3894
3894
  */
3895
3895
  RoleArn: string | undefined;
3896
3896
  /**
3897
- * @public
3898
3897
  * <p>The name of the project to be updated.</p>
3898
+ * @public
3899
3899
  */
3900
3900
  Name: string | undefined;
3901
3901
  }
@@ -3904,13 +3904,13 @@ export interface UpdateProjectRequest {
3904
3904
  */
3905
3905
  export interface UpdateProjectResponse {
3906
3906
  /**
3907
- * @public
3908
3907
  * <p>The date and time that the project was last modified.</p>
3908
+ * @public
3909
3909
  */
3910
3910
  LastModifiedDate?: Date;
3911
3911
  /**
3912
- * @public
3913
3912
  * <p>The name of the project that you updated.</p>
3913
+ * @public
3914
3914
  */
3915
3915
  Name: string | undefined;
3916
3916
  }
@@ -3919,19 +3919,19 @@ export interface UpdateProjectResponse {
3919
3919
  */
3920
3920
  export interface UpdateRecipeRequest {
3921
3921
  /**
3922
- * @public
3923
3922
  * <p>A description of the recipe.</p>
3923
+ * @public
3924
3924
  */
3925
3925
  Description?: string;
3926
3926
  /**
3927
- * @public
3928
3927
  * <p>The name of the recipe to be updated.</p>
3928
+ * @public
3929
3929
  */
3930
3930
  Name: string | undefined;
3931
3931
  /**
3932
- * @public
3933
3932
  * <p>One or more steps to be performed by the recipe. Each step consists of an action, and
3934
3933
  * the conditions under which the action should succeed.</p>
3934
+ * @public
3935
3935
  */
3936
3936
  Steps?: RecipeStep[];
3937
3937
  }
@@ -3940,8 +3940,8 @@ export interface UpdateRecipeRequest {
3940
3940
  */
3941
3941
  export interface UpdateRecipeResponse {
3942
3942
  /**
3943
- * @public
3944
3943
  * <p>The name of the recipe that was updated.</p>
3944
+ * @public
3945
3945
  */
3946
3946
  Name: string | undefined;
3947
3947
  }
@@ -3950,13 +3950,12 @@ export interface UpdateRecipeResponse {
3950
3950
  */
3951
3951
  export interface UpdateRecipeJobRequest {
3952
3952
  /**
3953
- * @public
3954
3953
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the
3955
3954
  * job.</p>
3955
+ * @public
3956
3956
  */
3957
3957
  EncryptionKeyArn?: string;
3958
3958
  /**
3959
- * @public
3960
3959
  * <p>The encryption mode for the job, which can be one of the following:</p>
3961
3960
  * <ul>
3962
3961
  * <li>
@@ -3968,56 +3967,57 @@ export interface UpdateRecipeJobRequest {
3968
3967
  * <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p>
3969
3968
  * </li>
3970
3969
  * </ul>
3970
+ * @public
3971
3971
  */
3972
3972
  EncryptionMode?: EncryptionMode;
3973
3973
  /**
3974
- * @public
3975
3974
  * <p>The name of the job to update.</p>
3975
+ * @public
3976
3976
  */
3977
3977
  Name: string | undefined;
3978
3978
  /**
3979
- * @public
3980
3979
  * <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,
3981
3980
  * CloudWatch writes one log stream for each job run.</p>
3981
+ * @public
3982
3982
  */
3983
3983
  LogSubscription?: LogSubscription;
3984
3984
  /**
3985
- * @public
3986
3985
  * <p>The maximum number of nodes that DataBrew can consume when the job processes
3987
3986
  * data.</p>
3987
+ * @public
3988
3988
  */
3989
3989
  MaxCapacity?: number;
3990
3990
  /**
3991
- * @public
3992
3991
  * <p>The maximum number of times to retry the job after a job run fails.</p>
3992
+ * @public
3993
3993
  */
3994
3994
  MaxRetries?: number;
3995
3995
  /**
3996
- * @public
3997
3996
  * <p>One or more artifacts that represent the output from running the job. </p>
3997
+ * @public
3998
3998
  */
3999
3999
  Outputs?: Output[];
4000
4000
  /**
4001
- * @public
4002
4001
  * <p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>
4002
+ * @public
4003
4003
  */
4004
4004
  DataCatalogOutputs?: DataCatalogOutput[];
4005
4005
  /**
4006
- * @public
4007
4006
  * <p>Represents a list of JDBC database output objects which defines the output destination for a
4008
4007
  * DataBrew recipe job to write into.</p>
4008
+ * @public
4009
4009
  */
4010
4010
  DatabaseOutputs?: DatabaseOutput[];
4011
4011
  /**
4012
- * @public
4013
4012
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
4014
4013
  * be assumed when DataBrew runs the job.</p>
4014
+ * @public
4015
4015
  */
4016
4016
  RoleArn: string | undefined;
4017
4017
  /**
4018
- * @public
4019
4018
  * <p>The job's timeout in minutes. A job that attempts to run longer than this timeout
4020
4019
  * period ends with a status of <code>TIMEOUT</code>.</p>
4020
+ * @public
4021
4021
  */
4022
4022
  Timeout?: number;
4023
4023
  }
@@ -4026,8 +4026,8 @@ export interface UpdateRecipeJobRequest {
4026
4026
  */
4027
4027
  export interface UpdateRecipeJobResponse {
4028
4028
  /**
4029
- * @public
4030
4029
  * <p>The name of the job that you updated.</p>
4030
+ * @public
4031
4031
  */
4032
4032
  Name: string | undefined;
4033
4033
  }
@@ -4036,19 +4036,19 @@ export interface UpdateRecipeJobResponse {
4036
4036
  */
4037
4037
  export interface UpdateRulesetRequest {
4038
4038
  /**
4039
- * @public
4040
4039
  * <p>The name of the ruleset to be updated.</p>
4040
+ * @public
4041
4041
  */
4042
4042
  Name: string | undefined;
4043
4043
  /**
4044
- * @public
4045
4044
  * <p>The description of the ruleset.</p>
4045
+ * @public
4046
4046
  */
4047
4047
  Description?: string;
4048
4048
  /**
4049
- * @public
4050
4049
  * <p>A list of rules that are defined with the ruleset. A rule includes one or more
4051
4050
  * checks to be validated on a DataBrew dataset.</p>
4051
+ * @public
4052
4052
  */
4053
4053
  Rules: Rule[] | undefined;
4054
4054
  }
@@ -4057,8 +4057,8 @@ export interface UpdateRulesetRequest {
4057
4057
  */
4058
4058
  export interface UpdateRulesetResponse {
4059
4059
  /**
4060
- * @public
4061
4060
  * <p>The name of the updated ruleset.</p>
4061
+ * @public
4062
4062
  */
4063
4063
  Name: string | undefined;
4064
4064
  }
@@ -4067,21 +4067,21 @@ export interface UpdateRulesetResponse {
4067
4067
  */
4068
4068
  export interface UpdateScheduleRequest {
4069
4069
  /**
4070
- * @public
4071
4070
  * <p>The name or names of one or more jobs to be run for this schedule.</p>
4071
+ * @public
4072
4072
  */
4073
4073
  JobNames?: string[];
4074
4074
  /**
4075
- * @public
4076
4075
  * <p>The date or dates and time or times when the jobs are to be run. For more information,
4077
4076
  * see <a href="https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html">Cron
4078
4077
  * expressions</a> in the <i>Glue DataBrew Developer
4079
4078
  * Guide</i>.</p>
4079
+ * @public
4080
4080
  */
4081
4081
  CronExpression: string | undefined;
4082
4082
  /**
4083
- * @public
4084
4083
  * <p>The name of the schedule to update.</p>
4084
+ * @public
4085
4085
  */
4086
4086
  Name: string | undefined;
4087
4087
  }
@@ -4090,8 +4090,8 @@ export interface UpdateScheduleRequest {
4090
4090
  */
4091
4091
  export interface UpdateScheduleResponse {
4092
4092
  /**
4093
- * @public
4094
4093
  * <p>The name of the schedule that was updated.</p>
4094
+ * @public
4095
4095
  */
4096
4096
  Name: string | undefined;
4097
4097
  }