@aws-sdk/client-databrew 3.295.0 → 3.297.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 (58) hide show
  1. package/dist-types/DataBrew.d.ts +45 -0
  2. package/dist-types/DataBrewClient.d.ts +24 -4
  3. package/dist-types/commands/BatchDeleteRecipeVersionCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateProfileJobCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateRecipeCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateRecipeJobCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateRulesetCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateScheduleCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteJobCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteRecipeVersionCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteRulesetCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteScheduleCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeJobCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeJobRunCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeProjectCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeRecipeCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeRulesetCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeScheduleCommand.d.ts +16 -0
  24. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListJobRunsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListJobsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListProjectsCommand.d.ts +16 -0
  28. package/dist-types/commands/ListRecipeVersionsCommand.d.ts +16 -0
  29. package/dist-types/commands/ListRecipesCommand.d.ts +16 -0
  30. package/dist-types/commands/ListRulesetsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListSchedulesCommand.d.ts +16 -0
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  33. package/dist-types/commands/PublishRecipeCommand.d.ts +16 -0
  34. package/dist-types/commands/SendProjectSessionActionCommand.d.ts +16 -0
  35. package/dist-types/commands/StartJobRunCommand.d.ts +16 -0
  36. package/dist-types/commands/StartProjectSessionCommand.d.ts +16 -0
  37. package/dist-types/commands/StopJobRunCommand.d.ts +16 -0
  38. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  39. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  40. package/dist-types/commands/UpdateDatasetCommand.d.ts +16 -0
  41. package/dist-types/commands/UpdateProfileJobCommand.d.ts +16 -0
  42. package/dist-types/commands/UpdateProjectCommand.d.ts +16 -0
  43. package/dist-types/commands/UpdateRecipeCommand.d.ts +16 -0
  44. package/dist-types/commands/UpdateRecipeJobCommand.d.ts +16 -0
  45. package/dist-types/commands/UpdateRulesetCommand.d.ts +16 -0
  46. package/dist-types/commands/UpdateScheduleCommand.d.ts +16 -0
  47. package/dist-types/models/DataBrewServiceException.d.ts +2 -0
  48. package/dist-types/models/models_0.d.ts +373 -0
  49. package/dist-types/pagination/Interfaces.d.ts +3 -0
  50. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  51. package/dist-types/pagination/ListJobRunsPaginator.d.ts +3 -0
  52. package/dist-types/pagination/ListJobsPaginator.d.ts +3 -0
  53. package/dist-types/pagination/ListProjectsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/ListRecipeVersionsPaginator.d.ts +3 -0
  55. package/dist-types/pagination/ListRecipesPaginator.d.ts +3 -0
  56. package/dist-types/pagination/ListRulesetsPaginator.d.ts +3 -0
  57. package/dist-types/pagination/ListSchedulesPaginator.d.ts +3 -0
  58. package/package.json +29 -29
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { DataBrewServiceException as __BaseException } from "./DataBrewServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Access to the specified resource was denied.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
13
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
15
  }
15
16
  /**
17
+ * @public
16
18
  * <p>Configuration of statistics that are allowed to be run on columns that
17
19
  * contain detected entities. When undefined, no statistics will be computed
18
20
  * on columns that contain detected entities.</p>
@@ -23,10 +25,16 @@ export interface AllowedStatistics {
23
25
  */
24
26
  Statistics: string[] | undefined;
25
27
  }
28
+ /**
29
+ * @public
30
+ */
26
31
  export declare enum AnalyticsMode {
27
32
  DISABLE = "DISABLE",
28
33
  ENABLE = "ENABLE"
29
34
  }
35
+ /**
36
+ * @public
37
+ */
30
38
  export interface BatchDeleteRecipeVersionRequest {
31
39
  /**
32
40
  * <p>The name of the recipe whose versions are to be deleted.</p>
@@ -40,6 +48,7 @@ export interface BatchDeleteRecipeVersionRequest {
40
48
  RecipeVersions: string[] | undefined;
41
49
  }
42
50
  /**
51
+ * @public
43
52
  * <p>Represents any errors encountered when attempting to delete multiple recipe
44
53
  * versions.</p>
45
54
  */
@@ -57,6 +66,9 @@ export interface RecipeVersionErrorDetail {
57
66
  */
58
67
  RecipeVersion?: string;
59
68
  }
69
+ /**
70
+ * @public
71
+ */
60
72
  export interface BatchDeleteRecipeVersionResponse {
61
73
  /**
62
74
  * <p>The name of the recipe that was modified.</p>
@@ -68,6 +80,7 @@ export interface BatchDeleteRecipeVersionResponse {
68
80
  Errors?: RecipeVersionErrorDetail[];
69
81
  }
70
82
  /**
83
+ * @public
71
84
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
72
85
  */
73
86
  export declare class ConflictException extends __BaseException {
@@ -80,6 +93,7 @@ export declare class ConflictException extends __BaseException {
80
93
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
81
94
  }
82
95
  /**
96
+ * @public
83
97
  * <p>One or more resources can't be found.</p>
84
98
  */
85
99
  export declare class ResourceNotFoundException extends __BaseException {
@@ -92,6 +106,7 @@ export declare class ResourceNotFoundException extends __BaseException {
92
106
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
93
107
  }
94
108
  /**
109
+ * @public
95
110
  * <p>The input parameters for this request failed validation.</p>
96
111
  */
97
112
  export declare class ValidationException extends __BaseException {
@@ -103,6 +118,9 @@ export declare class ValidationException extends __BaseException {
103
118
  */
104
119
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
105
120
  }
121
+ /**
122
+ * @public
123
+ */
106
124
  export declare enum InputFormat {
107
125
  CSV = "CSV",
108
126
  EXCEL = "EXCEL",
@@ -111,6 +129,7 @@ export declare enum InputFormat {
111
129
  PARQUET = "PARQUET"
112
130
  }
113
131
  /**
132
+ * @public
114
133
  * <p>Represents a set of options that define how DataBrew will read a
115
134
  * comma-separated value (CSV) file when creating a dataset from that file.</p>
116
135
  */
@@ -126,6 +145,7 @@ export interface CsvOptions {
126
145
  HeaderRow?: boolean;
127
146
  }
128
147
  /**
148
+ * @public
129
149
  * <p>Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when
130
150
  * creating a dataset from that file.</p>
131
151
  */
@@ -146,6 +166,7 @@ export interface ExcelOptions {
146
166
  HeaderRow?: boolean;
147
167
  }
148
168
  /**
169
+ * @public
149
170
  * <p>Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.</p>
150
171
  */
151
172
  export interface JsonOptions {
@@ -156,6 +177,7 @@ export interface JsonOptions {
156
177
  MultiLine?: boolean;
157
178
  }
158
179
  /**
180
+ * @public
159
181
  * <p>Represents a set of options that define the structure of either comma-separated value (CSV),
160
182
  * Excel, or JSON input.</p>
161
183
  */
@@ -174,6 +196,7 @@ export interface FormatOptions {
174
196
  Csv?: CsvOptions;
175
197
  }
176
198
  /**
199
+ * @public
177
200
  * <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read
178
201
  * input data, or write output from a job.</p>
179
202
  */
@@ -192,6 +215,7 @@ export interface S3Location {
192
215
  BucketOwner?: string;
193
216
  }
194
217
  /**
218
+ * @public
195
219
  * <p>Connection information for dataset input files stored in a database.</p>
196
220
  */
197
221
  export interface DatabaseInputDefinition {
@@ -216,6 +240,7 @@ export interface DatabaseInputDefinition {
216
240
  QueryString?: string;
217
241
  }
218
242
  /**
243
+ * @public
219
244
  * <p>Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew
220
245
  * dataset. </p>
221
246
  */
@@ -240,6 +265,7 @@ export interface DataCatalogInputDefinition {
240
265
  TempDirectory?: S3Location;
241
266
  }
242
267
  /**
268
+ * @public
243
269
  * <p>Contains additional resource information needed for specific datasets.</p>
244
270
  */
245
271
  export interface Metadata {
@@ -250,6 +276,7 @@ export interface Metadata {
250
276
  SourceArn?: string;
251
277
  }
252
278
  /**
279
+ * @public
253
280
  * <p>Represents information on how DataBrew can find data, in either the Glue Data Catalog or
254
281
  * Amazon S3.</p>
255
282
  */
@@ -271,14 +298,21 @@ export interface Input {
271
298
  */
272
299
  Metadata?: Metadata;
273
300
  }
301
+ /**
302
+ * @public
303
+ */
274
304
  export declare enum Order {
275
305
  ASCENDING = "ASCENDING",
276
306
  DESCENDING = "DESCENDING"
277
307
  }
308
+ /**
309
+ * @public
310
+ */
278
311
  export declare enum OrderedBy {
279
312
  LAST_MODIFIED_DATE = "LAST_MODIFIED_DATE"
280
313
  }
281
314
  /**
315
+ * @public
282
316
  * <p>Represents a limit imposed on number of Amazon S3 files that should be selected for a
283
317
  * dataset from a connected Amazon S3 path.</p>
284
318
  */
@@ -300,6 +334,7 @@ export interface FilesLimit {
300
334
  Order?: Order | string;
301
335
  }
302
336
  /**
337
+ * @public
303
338
  * <p>Represents a structure for defining parameter conditions. Supported conditions are described
304
339
  * here: <a href="https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets">Supported
305
340
  * conditions for dynamic datasets</a> in the
@@ -318,6 +353,7 @@ export interface FilterExpression {
318
353
  ValuesMap: Record<string, string> | undefined;
319
354
  }
320
355
  /**
356
+ * @public
321
357
  * <p>Represents additional options for correct interpretation of datetime parameters used in
322
358
  * the Amazon S3 path of a dataset.</p>
323
359
  */
@@ -339,12 +375,16 @@ export interface DatetimeOptions {
339
375
  */
340
376
  LocaleCode?: string;
341
377
  }
378
+ /**
379
+ * @public
380
+ */
342
381
  export declare enum ParameterType {
343
382
  Datetime = "Datetime",
344
383
  Number = "Number",
345
384
  String = "String"
346
385
  }
347
386
  /**
387
+ * @public
348
388
  * <p>Represents a dataset parameter that defines type and conditions for a parameter in the
349
389
  * Amazon S3 path of the dataset.</p>
350
390
  */
@@ -372,6 +412,7 @@ export interface DatasetParameter {
372
412
  Filter?: FilterExpression;
373
413
  }
374
414
  /**
415
+ * @public
375
416
  * <p>Represents a set of options that define how DataBrew selects files for a given Amazon S3
376
417
  * path in a dataset.</p>
377
418
  */
@@ -390,6 +431,9 @@ export interface PathOptions {
390
431
  */
391
432
  Parameters?: Record<string, DatasetParameter>;
392
433
  }
434
+ /**
435
+ * @public
436
+ */
393
437
  export interface CreateDatasetRequest {
394
438
  /**
395
439
  * <p>The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z,
@@ -419,6 +463,9 @@ export interface CreateDatasetRequest {
419
463
  */
420
464
  Tags?: Record<string, string>;
421
465
  }
466
+ /**
467
+ * @public
468
+ */
422
469
  export interface CreateDatasetResponse {
423
470
  /**
424
471
  * <p>The name of the dataset that you created.</p>
@@ -426,6 +473,7 @@ export interface CreateDatasetResponse {
426
473
  Name: string | undefined;
427
474
  }
428
475
  /**
476
+ * @public
429
477
  * <p>A service quota is exceeded.</p>
430
478
  */
431
479
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -438,6 +486,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
438
486
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
439
487
  }
440
488
  /**
489
+ * @public
441
490
  * <p>Selector of a column from a dataset for profile job configuration.
442
491
  * One selector includes either a column name or a regular expression.</p>
443
492
  */
@@ -452,6 +501,7 @@ export interface ColumnSelector {
452
501
  Name?: string;
453
502
  }
454
503
  /**
504
+ * @public
455
505
  * <p>Override of a particular evaluation for a profile job. </p>
456
506
  */
457
507
  export interface StatisticOverride {
@@ -465,6 +515,7 @@ export interface StatisticOverride {
465
515
  Parameters: Record<string, string> | undefined;
466
516
  }
467
517
  /**
518
+ * @public
468
519
  * <p>Configuration of evaluations for a profile job. This configuration can be used to select
469
520
  * evaluations and override the parameters of selected evaluations.
470
521
  * </p>
@@ -481,6 +532,7 @@ export interface StatisticsConfiguration {
481
532
  Overrides?: StatisticOverride[];
482
533
  }
483
534
  /**
535
+ * @public
484
536
  * <p>Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select
485
537
  * evaluations and override parameters of evaluations for particular columns.
486
538
  * </p>
@@ -500,6 +552,7 @@ export interface ColumnStatisticsConfiguration {
500
552
  Statistics: StatisticsConfiguration | undefined;
501
553
  }
502
554
  /**
555
+ * @public
503
556
  * <p>Configuration of entity detection for a profile job. When undefined, entity
504
557
  * detection is disabled.</p>
505
558
  */
@@ -577,6 +630,7 @@ export interface EntityDetectorConfiguration {
577
630
  AllowedStatistics?: AllowedStatistics[];
578
631
  }
579
632
  /**
633
+ * @public
580
634
  * <p>Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default
581
635
  * parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all
582
636
  * supported columns.
@@ -609,15 +663,22 @@ export interface ProfileConfiguration {
609
663
  */
610
664
  EntityDetectorConfiguration?: EntityDetectorConfiguration;
611
665
  }
666
+ /**
667
+ * @public
668
+ */
612
669
  export declare enum EncryptionMode {
613
670
  SSEKMS = "SSE-KMS",
614
671
  SSES3 = "SSE-S3"
615
672
  }
673
+ /**
674
+ * @public
675
+ */
616
676
  export declare enum SampleMode {
617
677
  CUSTOM_ROWS = "CUSTOM_ROWS",
618
678
  FULL_DATASET = "FULL_DATASET"
619
679
  }
620
680
  /**
681
+ * @public
621
682
  * <p>A sample configuration for profile jobs only, which determines the number of rows on which the
622
683
  * profile job is run. If a <code>JobSample</code> value isn't provided, the
623
684
  * default is used. The default value is CUSTOM_ROWS for the mode parameter and
@@ -646,14 +707,21 @@ export interface JobSample {
646
707
  */
647
708
  Size?: number;
648
709
  }
710
+ /**
711
+ * @public
712
+ */
649
713
  export declare enum LogSubscription {
650
714
  DISABLE = "DISABLE",
651
715
  ENABLE = "ENABLE"
652
716
  }
717
+ /**
718
+ * @public
719
+ */
653
720
  export declare enum ValidationMode {
654
721
  CHECK_ALL = "CHECK_ALL"
655
722
  }
656
723
  /**
724
+ * @public
657
725
  * <p>Configuration for data quality validation. Used to select the Rulesets and Validation Mode
658
726
  * to be used in the profile job. When ValidationConfiguration is null, the profile
659
727
  * job will run without data quality validation.</p>
@@ -671,6 +739,9 @@ export interface ValidationConfiguration {
671
739
  */
672
740
  ValidationMode?: ValidationMode | string;
673
741
  }
742
+ /**
743
+ * @public
744
+ */
674
745
  export interface CreateProfileJobRequest {
675
746
  /**
676
747
  * <p>The name of the dataset that this job is to act upon.</p>
@@ -751,18 +822,25 @@ export interface CreateProfileJobRequest {
751
822
  */
752
823
  JobSample?: JobSample;
753
824
  }
825
+ /**
826
+ * @public
827
+ */
754
828
  export interface CreateProfileJobResponse {
755
829
  /**
756
830
  * <p>The name of the job that was created.</p>
757
831
  */
758
832
  Name: string | undefined;
759
833
  }
834
+ /**
835
+ * @public
836
+ */
760
837
  export declare enum SampleType {
761
838
  FIRST_N = "FIRST_N",
762
839
  LAST_N = "LAST_N",
763
840
  RANDOM = "RANDOM"
764
841
  }
765
842
  /**
843
+ * @public
766
844
  * <p>Represents the sample size and sampling type for DataBrew to use for interactive data
767
845
  * analysis.</p>
768
846
  */
@@ -776,6 +854,9 @@ export interface Sample {
776
854
  */
777
855
  Type: SampleType | string | undefined;
778
856
  }
857
+ /**
858
+ * @public
859
+ */
779
860
  export interface CreateProjectRequest {
780
861
  /**
781
862
  * <p>The name of an existing dataset to associate this project with.</p>
@@ -805,6 +886,9 @@ export interface CreateProjectRequest {
805
886
  */
806
887
  Tags?: Record<string, string>;
807
888
  }
889
+ /**
890
+ * @public
891
+ */
808
892
  export interface CreateProjectResponse {
809
893
  /**
810
894
  * <p>The name of the project that you created.</p>
@@ -812,6 +896,7 @@ export interface CreateProjectResponse {
812
896
  Name: string | undefined;
813
897
  }
814
898
  /**
899
+ * @public
815
900
  * <p>An internal service failure occurred.</p>
816
901
  */
817
902
  export declare class InternalServerException extends __BaseException {
@@ -824,6 +909,7 @@ export declare class InternalServerException extends __BaseException {
824
909
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
825
910
  }
826
911
  /**
912
+ * @public
827
913
  * <p>Represents a transformation and associated parameters that are used to apply a change
828
914
  * to a DataBrew dataset. For more information, see <a href="https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html">Recipe
829
915
  * actions reference</a>.</p>
@@ -839,6 +925,7 @@ export interface RecipeAction {
839
925
  Parameters?: Record<string, string>;
840
926
  }
841
927
  /**
928
+ * @public
842
929
  * <p>Represents an individual condition that evaluates to true or false.</p>
843
930
  * <p>Conditions are used with recipe actions. The action is only performed for column values where the
844
931
  * condition evaluates to true.</p>
@@ -863,6 +950,7 @@ export interface ConditionExpression {
863
950
  TargetColumn: string | undefined;
864
951
  }
865
952
  /**
953
+ * @public
866
954
  * <p>Represents a single step from a DataBrew recipe to be performed.</p>
867
955
  */
868
956
  export interface RecipeStep {
@@ -879,6 +967,9 @@ export interface RecipeStep {
879
967
  */
880
968
  ConditionExpressions?: ConditionExpression[];
881
969
  }
970
+ /**
971
+ * @public
972
+ */
882
973
  export interface CreateRecipeRequest {
883
974
  /**
884
975
  * <p>A description for the recipe.</p>
@@ -899,6 +990,9 @@ export interface CreateRecipeRequest {
899
990
  */
900
991
  Tags?: Record<string, string>;
901
992
  }
993
+ /**
994
+ * @public
995
+ */
902
996
  export interface CreateRecipeResponse {
903
997
  /**
904
998
  * <p>The name of the recipe that you created.</p>
@@ -906,6 +1000,7 @@ export interface CreateRecipeResponse {
906
1000
  Name: string | undefined;
907
1001
  }
908
1002
  /**
1003
+ * @public
909
1004
  * <p>Represents options that specify how and where DataBrew writes the database
910
1005
  * output generated by recipe jobs.</p>
911
1006
  */
@@ -920,10 +1015,14 @@ export interface DatabaseTableOutputOptions {
920
1015
  */
921
1016
  TableName: string | undefined;
922
1017
  }
1018
+ /**
1019
+ * @public
1020
+ */
923
1021
  export declare enum DatabaseOutputMode {
924
1022
  NEW_TABLE = "NEW_TABLE"
925
1023
  }
926
1024
  /**
1025
+ * @public
927
1026
  * <p>Represents a JDBC database output object which defines the output destination for
928
1027
  * a DataBrew recipe job to write into.</p>
929
1028
  */
@@ -944,6 +1043,7 @@ export interface DatabaseOutput {
944
1043
  DatabaseOutputMode?: DatabaseOutputMode | string;
945
1044
  }
946
1045
  /**
1046
+ * @public
947
1047
  * <p>Represents options that specify how and where DataBrew writes the Amazon S3 output
948
1048
  * generated by recipe jobs.</p>
949
1049
  */
@@ -955,6 +1055,7 @@ export interface S3TableOutputOptions {
955
1055
  Location: S3Location | undefined;
956
1056
  }
957
1057
  /**
1058
+ * @public
958
1059
  * <p>Represents options that specify how and where in the Glue Data Catalog DataBrew
959
1060
  * writes the output generated by recipe jobs.</p>
960
1061
  */
@@ -988,6 +1089,9 @@ export interface DataCatalogOutput {
988
1089
  */
989
1090
  Overwrite?: boolean;
990
1091
  }
1092
+ /**
1093
+ * @public
1094
+ */
991
1095
  export declare enum CompressionFormat {
992
1096
  BROTLI = "BROTLI",
993
1097
  BZIP2 = "BZIP2",
@@ -999,6 +1103,9 @@ export declare enum CompressionFormat {
999
1103
  ZLIB = "ZLIB",
1000
1104
  ZSTD = "ZSTD"
1001
1105
  }
1106
+ /**
1107
+ * @public
1108
+ */
1002
1109
  export declare enum OutputFormat {
1003
1110
  AVRO = "AVRO",
1004
1111
  CSV = "CSV",
@@ -1010,6 +1117,7 @@ export declare enum OutputFormat {
1010
1117
  XML = "XML"
1011
1118
  }
1012
1119
  /**
1120
+ * @public
1013
1121
  * <p>Represents a set of options that define how DataBrew will write a
1014
1122
  * comma-separated value (CSV) file.</p>
1015
1123
  */
@@ -1020,6 +1128,7 @@ export interface CsvOutputOptions {
1020
1128
  Delimiter?: string;
1021
1129
  }
1022
1130
  /**
1131
+ * @public
1023
1132
  * <p>Represents a set of options that define the structure of comma-separated (CSV) job output.</p>
1024
1133
  */
1025
1134
  export interface OutputFormatOptions {
@@ -1030,6 +1139,7 @@ export interface OutputFormatOptions {
1030
1139
  Csv?: CsvOutputOptions;
1031
1140
  }
1032
1141
  /**
1142
+ * @public
1033
1143
  * <p>Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by
1034
1144
  * recipe jobs or profile jobs.</p>
1035
1145
  */
@@ -1066,6 +1176,7 @@ export interface Output {
1066
1176
  MaxOutputFiles?: number;
1067
1177
  }
1068
1178
  /**
1179
+ * @public
1069
1180
  * <p>Represents the name and version of a DataBrew recipe.</p>
1070
1181
  */
1071
1182
  export interface RecipeReference {
@@ -1078,6 +1189,9 @@ export interface RecipeReference {
1078
1189
  */
1079
1190
  RecipeVersion?: string;
1080
1191
  }
1192
+ /**
1193
+ * @public
1194
+ */
1081
1195
  export interface CreateRecipeJobRequest {
1082
1196
  /**
1083
1197
  * <p>The name of the dataset that this job processes.</p>
@@ -1158,23 +1272,33 @@ export interface CreateRecipeJobRequest {
1158
1272
  */
1159
1273
  Timeout?: number;
1160
1274
  }
1275
+ /**
1276
+ * @public
1277
+ */
1161
1278
  export interface CreateRecipeJobResponse {
1162
1279
  /**
1163
1280
  * <p>The name of the job that you created.</p>
1164
1281
  */
1165
1282
  Name: string | undefined;
1166
1283
  }
1284
+ /**
1285
+ * @public
1286
+ */
1167
1287
  export declare enum ThresholdType {
1168
1288
  GREATER_THAN = "GREATER_THAN",
1169
1289
  GREATER_THAN_OR_EQUAL = "GREATER_THAN_OR_EQUAL",
1170
1290
  LESS_THAN = "LESS_THAN",
1171
1291
  LESS_THAN_OR_EQUAL = "LESS_THAN_OR_EQUAL"
1172
1292
  }
1293
+ /**
1294
+ * @public
1295
+ */
1173
1296
  export declare enum ThresholdUnit {
1174
1297
  COUNT = "COUNT",
1175
1298
  PERCENTAGE = "PERCENTAGE"
1176
1299
  }
1177
1300
  /**
1301
+ * @public
1178
1302
  * <p>The threshold used with a non-aggregate check expression. The non-aggregate check expression
1179
1303
  * will be applied to each row in a specific column. Then the threshold will be used to determine
1180
1304
  * whether the validation succeeds.</p>
@@ -1196,6 +1320,7 @@ export interface Threshold {
1196
1320
  Unit?: ThresholdUnit | string;
1197
1321
  }
1198
1322
  /**
1323
+ * @public
1199
1324
  * <p>Represents a single data quality requirement that should be validated in the
1200
1325
  * scope of this dataset.</p>
1201
1326
  */
@@ -1245,6 +1370,9 @@ export interface Rule {
1245
1370
  */
1246
1371
  ColumnSelectors?: ColumnSelector[];
1247
1372
  }
1373
+ /**
1374
+ * @public
1375
+ */
1248
1376
  export interface CreateRulesetRequest {
1249
1377
  /**
1250
1378
  * <p>The name of the ruleset to be created. Valid characters are alphanumeric
@@ -1270,12 +1398,18 @@ export interface CreateRulesetRequest {
1270
1398
  */
1271
1399
  Tags?: Record<string, string>;
1272
1400
  }
1401
+ /**
1402
+ * @public
1403
+ */
1273
1404
  export interface CreateRulesetResponse {
1274
1405
  /**
1275
1406
  * <p>The unique name of the created ruleset.</p>
1276
1407
  */
1277
1408
  Name: string | undefined;
1278
1409
  }
1410
+ /**
1411
+ * @public
1412
+ */
1279
1413
  export interface CreateScheduleRequest {
1280
1414
  /**
1281
1415
  * <p>The name or names of one or more jobs to be run.</p>
@@ -1298,48 +1432,72 @@ export interface CreateScheduleRequest {
1298
1432
  */
1299
1433
  Name: string | undefined;
1300
1434
  }
1435
+ /**
1436
+ * @public
1437
+ */
1301
1438
  export interface CreateScheduleResponse {
1302
1439
  /**
1303
1440
  * <p>The name of the schedule that was created.</p>
1304
1441
  */
1305
1442
  Name: string | undefined;
1306
1443
  }
1444
+ /**
1445
+ * @public
1446
+ */
1307
1447
  export interface DeleteDatasetRequest {
1308
1448
  /**
1309
1449
  * <p>The name of the dataset to be deleted.</p>
1310
1450
  */
1311
1451
  Name: string | undefined;
1312
1452
  }
1453
+ /**
1454
+ * @public
1455
+ */
1313
1456
  export interface DeleteDatasetResponse {
1314
1457
  /**
1315
1458
  * <p>The name of the dataset that you deleted.</p>
1316
1459
  */
1317
1460
  Name: string | undefined;
1318
1461
  }
1462
+ /**
1463
+ * @public
1464
+ */
1319
1465
  export interface DeleteJobRequest {
1320
1466
  /**
1321
1467
  * <p>The name of the job to be deleted.</p>
1322
1468
  */
1323
1469
  Name: string | undefined;
1324
1470
  }
1471
+ /**
1472
+ * @public
1473
+ */
1325
1474
  export interface DeleteJobResponse {
1326
1475
  /**
1327
1476
  * <p>The name of the job that you deleted.</p>
1328
1477
  */
1329
1478
  Name: string | undefined;
1330
1479
  }
1480
+ /**
1481
+ * @public
1482
+ */
1331
1483
  export interface DeleteProjectRequest {
1332
1484
  /**
1333
1485
  * <p>The name of the project to be deleted.</p>
1334
1486
  */
1335
1487
  Name: string | undefined;
1336
1488
  }
1489
+ /**
1490
+ * @public
1491
+ */
1337
1492
  export interface DeleteProjectResponse {
1338
1493
  /**
1339
1494
  * <p>The name of the project that you deleted.</p>
1340
1495
  */
1341
1496
  Name: string | undefined;
1342
1497
  }
1498
+ /**
1499
+ * @public
1500
+ */
1343
1501
  export interface DeleteRecipeVersionRequest {
1344
1502
  /**
1345
1503
  * <p>The name of the recipe.</p>
@@ -1352,6 +1510,9 @@ export interface DeleteRecipeVersionRequest {
1352
1510
  */
1353
1511
  RecipeVersion: string | undefined;
1354
1512
  }
1513
+ /**
1514
+ * @public
1515
+ */
1355
1516
  export interface DeleteRecipeVersionResponse {
1356
1517
  /**
1357
1518
  * <p>The name of the recipe that was deleted.</p>
@@ -1362,41 +1523,62 @@ export interface DeleteRecipeVersionResponse {
1362
1523
  */
1363
1524
  RecipeVersion: string | undefined;
1364
1525
  }
1526
+ /**
1527
+ * @public
1528
+ */
1365
1529
  export interface DeleteRulesetRequest {
1366
1530
  /**
1367
1531
  * <p>The name of the ruleset to be deleted.</p>
1368
1532
  */
1369
1533
  Name: string | undefined;
1370
1534
  }
1535
+ /**
1536
+ * @public
1537
+ */
1371
1538
  export interface DeleteRulesetResponse {
1372
1539
  /**
1373
1540
  * <p>The name of the deleted ruleset.</p>
1374
1541
  */
1375
1542
  Name: string | undefined;
1376
1543
  }
1544
+ /**
1545
+ * @public
1546
+ */
1377
1547
  export interface DeleteScheduleRequest {
1378
1548
  /**
1379
1549
  * <p>The name of the schedule to be deleted.</p>
1380
1550
  */
1381
1551
  Name: string | undefined;
1382
1552
  }
1553
+ /**
1554
+ * @public
1555
+ */
1383
1556
  export interface DeleteScheduleResponse {
1384
1557
  /**
1385
1558
  * <p>The name of the schedule that was deleted.</p>
1386
1559
  */
1387
1560
  Name: string | undefined;
1388
1561
  }
1562
+ /**
1563
+ * @public
1564
+ */
1389
1565
  export interface DescribeDatasetRequest {
1390
1566
  /**
1391
1567
  * <p>The name of the dataset to be described.</p>
1392
1568
  */
1393
1569
  Name: string | undefined;
1394
1570
  }
1571
+ /**
1572
+ * @public
1573
+ */
1395
1574
  export declare enum Source {
1396
1575
  DATABASE = "DATABASE",
1397
1576
  DATACATALOG = "DATA-CATALOG",
1398
1577
  S3 = "S3"
1399
1578
  }
1579
+ /**
1580
+ * @public
1581
+ */
1400
1582
  export interface DescribeDatasetResponse {
1401
1583
  /**
1402
1584
  * <p>The identifier (user name) of the user who created the dataset.</p>
@@ -1452,16 +1634,25 @@ export interface DescribeDatasetResponse {
1452
1634
  */
1453
1635
  ResourceArn?: string;
1454
1636
  }
1637
+ /**
1638
+ * @public
1639
+ */
1455
1640
  export interface DescribeJobRequest {
1456
1641
  /**
1457
1642
  * <p>The name of the job to be described.</p>
1458
1643
  */
1459
1644
  Name: string | undefined;
1460
1645
  }
1646
+ /**
1647
+ * @public
1648
+ */
1461
1649
  export declare enum JobType {
1462
1650
  PROFILE = "PROFILE",
1463
1651
  RECIPE = "RECIPE"
1464
1652
  }
1653
+ /**
1654
+ * @public
1655
+ */
1465
1656
  export interface DescribeJobResponse {
1466
1657
  /**
1467
1658
  * <p>The date and time that the job was created.</p>
@@ -1591,6 +1782,9 @@ export interface DescribeJobResponse {
1591
1782
  */
1592
1783
  JobSample?: JobSample;
1593
1784
  }
1785
+ /**
1786
+ * @public
1787
+ */
1594
1788
  export interface DescribeJobRunRequest {
1595
1789
  /**
1596
1790
  * <p>The name of the job being processed during this run.</p>
@@ -1601,6 +1795,9 @@ export interface DescribeJobRunRequest {
1601
1795
  */
1602
1796
  RunId: string | undefined;
1603
1797
  }
1798
+ /**
1799
+ * @public
1800
+ */
1604
1801
  export declare enum JobRunState {
1605
1802
  FAILED = "FAILED",
1606
1803
  RUNNING = "RUNNING",
@@ -1610,6 +1807,9 @@ export declare enum JobRunState {
1610
1807
  SUCCEEDED = "SUCCEEDED",
1611
1808
  TIMEOUT = "TIMEOUT"
1612
1809
  }
1810
+ /**
1811
+ * @public
1812
+ */
1613
1813
  export interface DescribeJobRunResponse {
1614
1814
  /**
1615
1815
  * <p>The number of times that DataBrew has attempted to run the job.</p>
@@ -1695,12 +1895,18 @@ export interface DescribeJobRunResponse {
1695
1895
  */
1696
1896
  JobSample?: JobSample;
1697
1897
  }
1898
+ /**
1899
+ * @public
1900
+ */
1698
1901
  export interface DescribeProjectRequest {
1699
1902
  /**
1700
1903
  * <p>The name of the project to be described.</p>
1701
1904
  */
1702
1905
  Name: string | undefined;
1703
1906
  }
1907
+ /**
1908
+ * @public
1909
+ */
1704
1910
  export declare enum SessionStatus {
1705
1911
  ASSIGNED = "ASSIGNED",
1706
1912
  FAILED = "FAILED",
@@ -1713,6 +1919,9 @@ export declare enum SessionStatus {
1713
1919
  TERMINATING = "TERMINATING",
1714
1920
  UPDATING = "UPDATING"
1715
1921
  }
1922
+ /**
1923
+ * @public
1924
+ */
1716
1925
  export interface DescribeProjectResponse {
1717
1926
  /**
1718
1927
  * <p>The date and time that the project was created.</p>
@@ -1787,6 +1996,9 @@ export interface DescribeProjectResponse {
1787
1996
  */
1788
1997
  OpenDate?: Date;
1789
1998
  }
1999
+ /**
2000
+ * @public
2001
+ */
1790
2002
  export interface DescribeRecipeRequest {
1791
2003
  /**
1792
2004
  * <p>The name of the recipe to be described.</p>
@@ -1798,6 +2010,9 @@ export interface DescribeRecipeRequest {
1798
2010
  */
1799
2011
  RecipeVersion?: string;
1800
2012
  }
2013
+ /**
2014
+ * @public
2015
+ */
1801
2016
  export interface DescribeRecipeResponse {
1802
2017
  /**
1803
2018
  * <p>The identifier (user name) of the user who created the recipe.</p>
@@ -1853,12 +2068,18 @@ export interface DescribeRecipeResponse {
1853
2068
  */
1854
2069
  RecipeVersion?: string;
1855
2070
  }
2071
+ /**
2072
+ * @public
2073
+ */
1856
2074
  export interface DescribeRulesetRequest {
1857
2075
  /**
1858
2076
  * <p>The name of the ruleset to be described.</p>
1859
2077
  */
1860
2078
  Name: string | undefined;
1861
2079
  }
2080
+ /**
2081
+ * @public
2082
+ */
1862
2083
  export interface DescribeRulesetResponse {
1863
2084
  /**
1864
2085
  * <p>The name of the ruleset.</p>
@@ -1903,12 +2124,18 @@ export interface DescribeRulesetResponse {
1903
2124
  */
1904
2125
  Tags?: Record<string, string>;
1905
2126
  }
2127
+ /**
2128
+ * @public
2129
+ */
1906
2130
  export interface DescribeScheduleRequest {
1907
2131
  /**
1908
2132
  * <p>The name of the schedule to be described.</p>
1909
2133
  */
1910
2134
  Name: string | undefined;
1911
2135
  }
2136
+ /**
2137
+ * @public
2138
+ */
1912
2139
  export interface DescribeScheduleResponse {
1913
2140
  /**
1914
2141
  * <p>The date and time that the schedule was created.</p>
@@ -1949,6 +2176,9 @@ export interface DescribeScheduleResponse {
1949
2176
  */
1950
2177
  Name: string | undefined;
1951
2178
  }
2179
+ /**
2180
+ * @public
2181
+ */
1952
2182
  export interface ListDatasetsRequest {
1953
2183
  /**
1954
2184
  * <p>The maximum number of results to return in this request. </p>
@@ -1960,6 +2190,7 @@ export interface ListDatasetsRequest {
1960
2190
  NextToken?: string;
1961
2191
  }
1962
2192
  /**
2193
+ * @public
1963
2194
  * <p>Represents a dataset that can be processed by DataBrew.</p>
1964
2195
  */
1965
2196
  export interface Dataset {
@@ -2018,6 +2249,9 @@ export interface Dataset {
2018
2249
  */
2019
2250
  ResourceArn?: string;
2020
2251
  }
2252
+ /**
2253
+ * @public
2254
+ */
2021
2255
  export interface ListDatasetsResponse {
2022
2256
  /**
2023
2257
  * <p>A list of datasets that are defined.</p>
@@ -2029,6 +2263,9 @@ export interface ListDatasetsResponse {
2029
2263
  */
2030
2264
  NextToken?: string;
2031
2265
  }
2266
+ /**
2267
+ * @public
2268
+ */
2032
2269
  export interface ListJobRunsRequest {
2033
2270
  /**
2034
2271
  * <p>The name of the job.</p>
@@ -2044,6 +2281,7 @@ export interface ListJobRunsRequest {
2044
2281
  NextToken?: string;
2045
2282
  }
2046
2283
  /**
2284
+ * @public
2047
2285
  * <p>Represents one run of a DataBrew job.</p>
2048
2286
  */
2049
2287
  export interface JobRun {
@@ -2126,6 +2364,9 @@ export interface JobRun {
2126
2364
  */
2127
2365
  ValidationConfigurations?: ValidationConfiguration[];
2128
2366
  }
2367
+ /**
2368
+ * @public
2369
+ */
2129
2370
  export interface ListJobRunsResponse {
2130
2371
  /**
2131
2372
  * <p>A list of job runs that have occurred for the specified job.</p>
@@ -2137,6 +2378,9 @@ export interface ListJobRunsResponse {
2137
2378
  */
2138
2379
  NextToken?: string;
2139
2380
  }
2381
+ /**
2382
+ * @public
2383
+ */
2140
2384
  export interface ListJobsRequest {
2141
2385
  /**
2142
2386
  * <p>The name of a dataset. Using this parameter indicates to return only those jobs that
@@ -2160,6 +2404,7 @@ export interface ListJobsRequest {
2160
2404
  ProjectName?: string;
2161
2405
  }
2162
2406
  /**
2407
+ * @public
2163
2408
  * <p>Represents all of the attributes of a DataBrew job.</p>
2164
2409
  */
2165
2410
  export interface Job {
@@ -2291,6 +2536,9 @@ export interface Job {
2291
2536
  */
2292
2537
  ValidationConfigurations?: ValidationConfiguration[];
2293
2538
  }
2539
+ /**
2540
+ * @public
2541
+ */
2294
2542
  export interface ListJobsResponse {
2295
2543
  /**
2296
2544
  * <p>A list of jobs that are defined.</p>
@@ -2302,6 +2550,9 @@ export interface ListJobsResponse {
2302
2550
  */
2303
2551
  NextToken?: string;
2304
2552
  }
2553
+ /**
2554
+ * @public
2555
+ */
2305
2556
  export interface ListProjectsRequest {
2306
2557
  /**
2307
2558
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
@@ -2313,6 +2564,7 @@ export interface ListProjectsRequest {
2313
2564
  MaxResults?: number;
2314
2565
  }
2315
2566
  /**
2567
+ * @public
2316
2568
  * <p>Represents all of the attributes of a DataBrew project.</p>
2317
2569
  */
2318
2570
  export interface Project {
@@ -2375,6 +2627,9 @@ export interface Project {
2375
2627
  */
2376
2628
  OpenDate?: Date;
2377
2629
  }
2630
+ /**
2631
+ * @public
2632
+ */
2378
2633
  export interface ListProjectsResponse {
2379
2634
  /**
2380
2635
  * <p>A list of projects that are defined .</p>
@@ -2386,6 +2641,9 @@ export interface ListProjectsResponse {
2386
2641
  */
2387
2642
  NextToken?: string;
2388
2643
  }
2644
+ /**
2645
+ * @public
2646
+ */
2389
2647
  export interface ListRecipesRequest {
2390
2648
  /**
2391
2649
  * <p>The maximum number of results to return in this request. </p>
@@ -2406,6 +2664,7 @@ export interface ListRecipesRequest {
2406
2664
  RecipeVersion?: string;
2407
2665
  }
2408
2666
  /**
2667
+ * @public
2409
2668
  * <p>Represents one or more actions to be performed on a DataBrew dataset.</p>
2410
2669
  */
2411
2670
  export interface Recipe {
@@ -2479,6 +2738,9 @@ export interface Recipe {
2479
2738
  */
2480
2739
  RecipeVersion?: string;
2481
2740
  }
2741
+ /**
2742
+ * @public
2743
+ */
2482
2744
  export interface ListRecipesResponse {
2483
2745
  /**
2484
2746
  * <p>A list of recipes that are defined.</p>
@@ -2490,6 +2752,9 @@ export interface ListRecipesResponse {
2490
2752
  */
2491
2753
  NextToken?: string;
2492
2754
  }
2755
+ /**
2756
+ * @public
2757
+ */
2493
2758
  export interface ListRecipeVersionsRequest {
2494
2759
  /**
2495
2760
  * <p>The maximum number of results to return in this request. </p>
@@ -2504,6 +2769,9 @@ export interface ListRecipeVersionsRequest {
2504
2769
  */
2505
2770
  Name: string | undefined;
2506
2771
  }
2772
+ /**
2773
+ * @public
2774
+ */
2507
2775
  export interface ListRecipeVersionsResponse {
2508
2776
  /**
2509
2777
  * <p>A token that you can use in a subsequent call to retrieve the next set of
@@ -2515,6 +2783,9 @@ export interface ListRecipeVersionsResponse {
2515
2783
  */
2516
2784
  Recipes: Recipe[] | undefined;
2517
2785
  }
2786
+ /**
2787
+ * @public
2788
+ */
2518
2789
  export interface ListRulesetsRequest {
2519
2790
  /**
2520
2791
  * <p>The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter
@@ -2533,6 +2804,7 @@ export interface ListRulesetsRequest {
2533
2804
  NextToken?: string;
2534
2805
  }
2535
2806
  /**
2807
+ * @public
2536
2808
  * <p>Contains metadata about the ruleset.</p>
2537
2809
  */
2538
2810
  export interface RulesetItem {
@@ -2582,6 +2854,9 @@ export interface RulesetItem {
2582
2854
  */
2583
2855
  TargetArn: string | undefined;
2584
2856
  }
2857
+ /**
2858
+ * @public
2859
+ */
2585
2860
  export interface ListRulesetsResponse {
2586
2861
  /**
2587
2862
  * <p>A list of RulesetItem. RulesetItem contains meta data of a ruleset.</p>
@@ -2593,6 +2868,9 @@ export interface ListRulesetsResponse {
2593
2868
  */
2594
2869
  NextToken?: string;
2595
2870
  }
2871
+ /**
2872
+ * @public
2873
+ */
2596
2874
  export interface ListSchedulesRequest {
2597
2875
  /**
2598
2876
  * <p>The name of the job that these schedules apply to.</p>
@@ -2608,6 +2886,7 @@ export interface ListSchedulesRequest {
2608
2886
  NextToken?: string;
2609
2887
  }
2610
2888
  /**
2889
+ * @public
2611
2890
  * <p>Represents one or more dates and times when a job is to run.</p>
2612
2891
  */
2613
2892
  export interface Schedule {
@@ -2654,6 +2933,9 @@ export interface Schedule {
2654
2933
  */
2655
2934
  Name: string | undefined;
2656
2935
  }
2936
+ /**
2937
+ * @public
2938
+ */
2657
2939
  export interface ListSchedulesResponse {
2658
2940
  /**
2659
2941
  * <p>A list of schedules that are defined.</p>
@@ -2665,6 +2947,9 @@ export interface ListSchedulesResponse {
2665
2947
  */
2666
2948
  NextToken?: string;
2667
2949
  }
2950
+ /**
2951
+ * @public
2952
+ */
2668
2953
  export interface ListTagsForResourceRequest {
2669
2954
  /**
2670
2955
  * <p>The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.
@@ -2672,12 +2957,18 @@ export interface ListTagsForResourceRequest {
2672
2957
  */
2673
2958
  ResourceArn: string | undefined;
2674
2959
  }
2960
+ /**
2961
+ * @public
2962
+ */
2675
2963
  export interface ListTagsForResourceResponse {
2676
2964
  /**
2677
2965
  * <p>A list of tags associated with the DataBrew resource.</p>
2678
2966
  */
2679
2967
  Tags?: Record<string, string>;
2680
2968
  }
2969
+ /**
2970
+ * @public
2971
+ */
2681
2972
  export interface PublishRecipeRequest {
2682
2973
  /**
2683
2974
  * <p>A description of the recipe to be published, for this version of the recipe.</p>
@@ -2688,6 +2979,9 @@ export interface PublishRecipeRequest {
2688
2979
  */
2689
2980
  Name: string | undefined;
2690
2981
  }
2982
+ /**
2983
+ * @public
2984
+ */
2691
2985
  export interface PublishRecipeResponse {
2692
2986
  /**
2693
2987
  * <p>The name of the recipe that you published.</p>
@@ -2695,6 +2989,7 @@ export interface PublishRecipeResponse {
2695
2989
  Name: string | undefined;
2696
2990
  }
2697
2991
  /**
2992
+ * @public
2698
2993
  * <p>Represents the data being transformed during an action.</p>
2699
2994
  */
2700
2995
  export interface ViewFrame {
@@ -2726,6 +3021,9 @@ export interface ViewFrame {
2726
3021
  */
2727
3022
  Analytics?: AnalyticsMode | string;
2728
3023
  }
3024
+ /**
3025
+ * @public
3026
+ */
2729
3027
  export interface SendProjectSessionActionRequest {
2730
3028
  /**
2731
3029
  * <p>If true, the result of the recipe step will be returned, but not applied.</p>
@@ -2755,6 +3053,9 @@ export interface SendProjectSessionActionRequest {
2755
3053
  */
2756
3054
  ViewFrame?: ViewFrame;
2757
3055
  }
3056
+ /**
3057
+ * @public
3058
+ */
2758
3059
  export interface SendProjectSessionActionResponse {
2759
3060
  /**
2760
3061
  * <p>A message indicating the result of performing the action.</p>
@@ -2769,18 +3070,27 @@ export interface SendProjectSessionActionResponse {
2769
3070
  */
2770
3071
  ActionId?: number;
2771
3072
  }
3073
+ /**
3074
+ * @public
3075
+ */
2772
3076
  export interface StartJobRunRequest {
2773
3077
  /**
2774
3078
  * <p>The name of the job to be run.</p>
2775
3079
  */
2776
3080
  Name: string | undefined;
2777
3081
  }
3082
+ /**
3083
+ * @public
3084
+ */
2778
3085
  export interface StartJobRunResponse {
2779
3086
  /**
2780
3087
  * <p>A system-generated identifier for this particular job run.</p>
2781
3088
  */
2782
3089
  RunId: string | undefined;
2783
3090
  }
3091
+ /**
3092
+ * @public
3093
+ */
2784
3094
  export interface StartProjectSessionRequest {
2785
3095
  /**
2786
3096
  * <p>The name of the project to act upon.</p>
@@ -2792,6 +3102,9 @@ export interface StartProjectSessionRequest {
2792
3102
  */
2793
3103
  AssumeControl?: boolean;
2794
3104
  }
3105
+ /**
3106
+ * @public
3107
+ */
2795
3108
  export interface StartProjectSessionResponse {
2796
3109
  /**
2797
3110
  * <p>The name of the project to be acted upon.</p>
@@ -2802,6 +3115,9 @@ export interface StartProjectSessionResponse {
2802
3115
  */
2803
3116
  ClientSessionId?: string;
2804
3117
  }
3118
+ /**
3119
+ * @public
3120
+ */
2805
3121
  export interface StopJobRunRequest {
2806
3122
  /**
2807
3123
  * <p>The name of the job to be stopped.</p>
@@ -2812,12 +3128,18 @@ export interface StopJobRunRequest {
2812
3128
  */
2813
3129
  RunId: string | undefined;
2814
3130
  }
3131
+ /**
3132
+ * @public
3133
+ */
2815
3134
  export interface StopJobRunResponse {
2816
3135
  /**
2817
3136
  * <p>The ID of the job run that you stopped.</p>
2818
3137
  */
2819
3138
  RunId: string | undefined;
2820
3139
  }
3140
+ /**
3141
+ * @public
3142
+ */
2821
3143
  export interface TagResourceRequest {
2822
3144
  /**
2823
3145
  * <p>The DataBrew resource to which tags should be added. The value for this parameter is
@@ -2830,8 +3152,14 @@ export interface TagResourceRequest {
2830
3152
  */
2831
3153
  Tags: Record<string, string> | undefined;
2832
3154
  }
3155
+ /**
3156
+ * @public
3157
+ */
2833
3158
  export interface TagResourceResponse {
2834
3159
  }
3160
+ /**
3161
+ * @public
3162
+ */
2835
3163
  export interface UntagResourceRequest {
2836
3164
  /**
2837
3165
  * <p>A DataBrew resource from which you want to remove a tag or tags. The value for this
@@ -2843,8 +3171,14 @@ export interface UntagResourceRequest {
2843
3171
  */
2844
3172
  TagKeys: string[] | undefined;
2845
3173
  }
3174
+ /**
3175
+ * @public
3176
+ */
2846
3177
  export interface UntagResourceResponse {
2847
3178
  }
3179
+ /**
3180
+ * @public
3181
+ */
2848
3182
  export interface UpdateDatasetRequest {
2849
3183
  /**
2850
3184
  * <p>The name of the dataset to be updated.</p>
@@ -2869,12 +3203,18 @@ export interface UpdateDatasetRequest {
2869
3203
  */
2870
3204
  PathOptions?: PathOptions;
2871
3205
  }
3206
+ /**
3207
+ * @public
3208
+ */
2872
3209
  export interface UpdateDatasetResponse {
2873
3210
  /**
2874
3211
  * <p>The name of the dataset that you updated.</p>
2875
3212
  */
2876
3213
  Name: string | undefined;
2877
3214
  }
3215
+ /**
3216
+ * @public
3217
+ */
2878
3218
  export interface UpdateProfileJobRequest {
2879
3219
  /**
2880
3220
  * <p>Configuration for profile jobs. Used to select columns, do evaluations,
@@ -2947,12 +3287,18 @@ export interface UpdateProfileJobRequest {
2947
3287
  */
2948
3288
  JobSample?: JobSample;
2949
3289
  }
3290
+ /**
3291
+ * @public
3292
+ */
2950
3293
  export interface UpdateProfileJobResponse {
2951
3294
  /**
2952
3295
  * <p>The name of the job that was updated.</p>
2953
3296
  */
2954
3297
  Name: string | undefined;
2955
3298
  }
3299
+ /**
3300
+ * @public
3301
+ */
2956
3302
  export interface UpdateProjectRequest {
2957
3303
  /**
2958
3304
  * <p>Represents the sample size and sampling type for DataBrew to use for interactive data
@@ -2968,6 +3314,9 @@ export interface UpdateProjectRequest {
2968
3314
  */
2969
3315
  Name: string | undefined;
2970
3316
  }
3317
+ /**
3318
+ * @public
3319
+ */
2971
3320
  export interface UpdateProjectResponse {
2972
3321
  /**
2973
3322
  * <p>The date and time that the project was last modified.</p>
@@ -2978,6 +3327,9 @@ export interface UpdateProjectResponse {
2978
3327
  */
2979
3328
  Name: string | undefined;
2980
3329
  }
3330
+ /**
3331
+ * @public
3332
+ */
2981
3333
  export interface UpdateRecipeRequest {
2982
3334
  /**
2983
3335
  * <p>A description of the recipe.</p>
@@ -2993,12 +3345,18 @@ export interface UpdateRecipeRequest {
2993
3345
  */
2994
3346
  Steps?: RecipeStep[];
2995
3347
  }
3348
+ /**
3349
+ * @public
3350
+ */
2996
3351
  export interface UpdateRecipeResponse {
2997
3352
  /**
2998
3353
  * <p>The name of the recipe that was updated.</p>
2999
3354
  */
3000
3355
  Name: string | undefined;
3001
3356
  }
3357
+ /**
3358
+ * @public
3359
+ */
3002
3360
  export interface UpdateRecipeJobRequest {
3003
3361
  /**
3004
3362
  * <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the
@@ -3061,12 +3419,18 @@ export interface UpdateRecipeJobRequest {
3061
3419
  */
3062
3420
  Timeout?: number;
3063
3421
  }
3422
+ /**
3423
+ * @public
3424
+ */
3064
3425
  export interface UpdateRecipeJobResponse {
3065
3426
  /**
3066
3427
  * <p>The name of the job that you updated.</p>
3067
3428
  */
3068
3429
  Name: string | undefined;
3069
3430
  }
3431
+ /**
3432
+ * @public
3433
+ */
3070
3434
  export interface UpdateRulesetRequest {
3071
3435
  /**
3072
3436
  * <p>The name of the ruleset to be updated.</p>
@@ -3082,12 +3446,18 @@ export interface UpdateRulesetRequest {
3082
3446
  */
3083
3447
  Rules: Rule[] | undefined;
3084
3448
  }
3449
+ /**
3450
+ * @public
3451
+ */
3085
3452
  export interface UpdateRulesetResponse {
3086
3453
  /**
3087
3454
  * <p>The name of the updated ruleset.</p>
3088
3455
  */
3089
3456
  Name: string | undefined;
3090
3457
  }
3458
+ /**
3459
+ * @public
3460
+ */
3091
3461
  export interface UpdateScheduleRequest {
3092
3462
  /**
3093
3463
  * <p>The name or names of one or more jobs to be run for this schedule.</p>
@@ -3105,6 +3475,9 @@ export interface UpdateScheduleRequest {
3105
3475
  */
3106
3476
  Name: string | undefined;
3107
3477
  }
3478
+ /**
3479
+ * @public
3480
+ */
3108
3481
  export interface UpdateScheduleResponse {
3109
3482
  /**
3110
3483
  * <p>The name of the schedule that was updated.</p>