@aws-sdk/client-databrew 3.378.0 → 3.382.0

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