@aws-sdk/client-databrew 3.42.0 → 3.46.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 (54) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/dist-cjs/DataBrew.js +75 -0
  3. package/dist-cjs/DataBrewClient.js +1 -0
  4. package/dist-cjs/commands/CreateRulesetCommand.js +36 -0
  5. package/dist-cjs/commands/DeleteRulesetCommand.js +36 -0
  6. package/dist-cjs/commands/DescribeRulesetCommand.js +36 -0
  7. package/dist-cjs/commands/ListRulesetsCommand.js +36 -0
  8. package/dist-cjs/commands/UpdateRulesetCommand.js +36 -0
  9. package/dist-cjs/commands/index.js +5 -0
  10. package/dist-cjs/endpoints.js +1 -0
  11. package/dist-cjs/models/models_0.js +130 -3
  12. package/dist-cjs/pagination/ListRulesetsPaginator.js +35 -0
  13. package/dist-cjs/pagination/index.js +1 -0
  14. package/dist-cjs/protocols/Aws_restJson1.js +727 -4
  15. package/dist-cjs/runtimeConfig.js +0 -2
  16. package/dist-es/DataBrew.js +75 -0
  17. package/dist-es/DataBrewClient.js +2 -1
  18. package/dist-es/commands/CreateRulesetCommand.js +39 -0
  19. package/dist-es/commands/DeleteRulesetCommand.js +39 -0
  20. package/dist-es/commands/DescribeRulesetCommand.js +39 -0
  21. package/dist-es/commands/ListRulesetsCommand.js +39 -0
  22. package/dist-es/commands/UpdateRulesetCommand.js +39 -0
  23. package/dist-es/commands/index.js +5 -0
  24. package/dist-es/endpoints.js +1 -0
  25. package/dist-es/models/models_0.js +92 -2
  26. package/dist-es/pagination/ListRulesetsPaginator.js +74 -0
  27. package/dist-es/pagination/index.js +1 -0
  28. package/dist-es/protocols/Aws_restJson1.js +818 -42
  29. package/dist-es/runtimeConfig.js +0 -2
  30. package/dist-types/DataBrew.d.ts +37 -0
  31. package/dist-types/DataBrewClient.d.ts +7 -2
  32. package/dist-types/commands/CreateRulesetCommand.d.ts +36 -0
  33. package/dist-types/commands/DeleteRulesetCommand.d.ts +35 -0
  34. package/dist-types/commands/DescribeRulesetCommand.d.ts +35 -0
  35. package/dist-types/commands/ListRulesetsCommand.d.ts +36 -0
  36. package/dist-types/commands/UpdateRulesetCommand.d.ts +35 -0
  37. package/dist-types/commands/index.d.ts +5 -0
  38. package/dist-types/models/models_0.d.ts +577 -17
  39. package/dist-types/pagination/ListRulesetsPaginator.d.ts +4 -0
  40. package/dist-types/pagination/index.d.ts +1 -0
  41. package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
  42. package/dist-types/ts3.4/DataBrew.d.ts +25 -0
  43. package/dist-types/ts3.4/DataBrewClient.d.ts +7 -2
  44. package/dist-types/ts3.4/commands/CreateRulesetCommand.d.ts +17 -0
  45. package/dist-types/ts3.4/commands/DeleteRulesetCommand.d.ts +17 -0
  46. package/dist-types/ts3.4/commands/DescribeRulesetCommand.d.ts +17 -0
  47. package/dist-types/ts3.4/commands/ListRulesetsCommand.d.ts +17 -0
  48. package/dist-types/ts3.4/commands/UpdateRulesetCommand.d.ts +17 -0
  49. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  50. package/dist-types/ts3.4/models/models_0.d.ts +267 -1
  51. package/dist-types/ts3.4/pagination/ListRulesetsPaginator.d.ts +4 -0
  52. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  53. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +15 -0
  54. package/package.json +36 -43
@@ -13,6 +13,27 @@ export declare namespace AccessDeniedException {
13
13
  */
14
14
  const filterSensitiveLog: (obj: AccessDeniedException) => any;
15
15
  }
16
+ /**
17
+ * <p>Configuration of statistics that are allowed to be run on columns that
18
+ * contain detected entities. When undefined, no statistics will be computed
19
+ * on columns that contain detected entities.</p>
20
+ */
21
+ export interface AllowedStatistics {
22
+ /**
23
+ * <p>One or more column statistics to allow for columns that contain detected entities.</p>
24
+ */
25
+ Statistics: string[] | undefined;
26
+ }
27
+ export declare namespace AllowedStatistics {
28
+ /**
29
+ * @internal
30
+ */
31
+ const filterSensitiveLog: (obj: AllowedStatistics) => any;
32
+ }
33
+ export declare enum AnalyticsMode {
34
+ DISABLE = "DISABLE",
35
+ ENABLE = "ENABLE"
36
+ }
16
37
  export interface BatchDeleteRecipeVersionRequest {
17
38
  /**
18
39
  * <p>The name of the recipe whose versions are to be deleted.</p>
@@ -238,12 +259,17 @@ export interface DatabaseInputDefinition {
238
259
  /**
239
260
  * <p>The table within the target database.</p>
240
261
  */
241
- DatabaseTableName: string | undefined;
262
+ DatabaseTableName?: string;
242
263
  /**
243
264
  * <p>Represents an Amazon S3 location (bucket name and object key) where DataBrew can read
244
265
  * input data, or write output from a job.</p>
245
266
  */
246
267
  TempDirectory?: S3Location;
268
+ /**
269
+ * <p>Custom SQL to run against the provided Glue connection. This SQL will be used as
270
+ * the input for DataBrew projects and jobs.</p>
271
+ */
272
+ QueryString?: string;
247
273
  }
248
274
  export declare namespace DatabaseInputDefinition {
249
275
  /**
@@ -281,6 +307,22 @@ export declare namespace DataCatalogInputDefinition {
281
307
  */
282
308
  const filterSensitiveLog: (obj: DataCatalogInputDefinition) => any;
283
309
  }
310
+ /**
311
+ * <p>Contains additional resource information needed for specific datasets.</p>
312
+ */
313
+ export interface Metadata {
314
+ /**
315
+ * <p>The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew
316
+ * only supports ARNs from Amazon AppFlow.</p>
317
+ */
318
+ SourceArn?: string;
319
+ }
320
+ export declare namespace Metadata {
321
+ /**
322
+ * @internal
323
+ */
324
+ const filterSensitiveLog: (obj: Metadata) => any;
325
+ }
284
326
  /**
285
327
  * <p>Represents information on how DataBrew can find data, in either the Glue Data Catalog or
286
328
  * Amazon S3.</p>
@@ -298,6 +340,10 @@ export interface Input {
298
340
  * <p>Connection information for dataset input files stored in a database.</p>
299
341
  */
300
342
  DatabaseInputDefinition?: DatabaseInputDefinition;
343
+ /**
344
+ * <p>Contains additional resource information needed for specific datasets.</p>
345
+ */
346
+ Metadata?: Metadata;
301
347
  }
302
348
  export declare namespace Input {
303
349
  /**
@@ -313,8 +359,8 @@ export declare enum OrderedBy {
313
359
  LAST_MODIFIED_DATE = "LAST_MODIFIED_DATE"
314
360
  }
315
361
  /**
316
- * <p>Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected
317
- * Amazon S3 path.</p>
362
+ * <p>Represents a limit imposed on number of Amazon S3 files that should be selected for a
363
+ * dataset from a connected Amazon S3 path.</p>
318
364
  */
319
365
  export interface FilesLimit {
320
366
  /**
@@ -340,7 +386,7 @@ export declare namespace FilesLimit {
340
386
  }
341
387
  /**
342
388
  * <p>Represents a structure for defining parameter conditions. Supported conditions are described
343
- * here: <a href="https://docs-aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets">Supported
389
+ * here: <a href="https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets">Supported
344
390
  * conditions for dynamic datasets</a> in the
345
391
  * <i>Glue DataBrew Developer Guide</i>.</p>
346
392
  */
@@ -521,8 +567,8 @@ export declare namespace ServiceQuotaExceededException {
521
567
  const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
522
568
  }
523
569
  /**
524
- * <p>Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular
525
- * expression.</p>
570
+ * <p>Selector of a column from a dataset for profile job configuration.
571
+ * One selector includes either a column name or a regular expression.</p>
526
572
  */
527
573
  export interface ColumnSelector {
528
574
  /**
@@ -608,6 +654,89 @@ export declare namespace ColumnStatisticsConfiguration {
608
654
  */
609
655
  const filterSensitiveLog: (obj: ColumnStatisticsConfiguration) => any;
610
656
  }
657
+ /**
658
+ * <p>Configuration of entity detection for a profile job. When undefined, entity
659
+ * detection is disabled.</p>
660
+ */
661
+ export interface EntityDetectorConfiguration {
662
+ /**
663
+ * <p>Entity types to detect. Can be any of the following:</p>
664
+ * <ul>
665
+ * <li>
666
+ * <p>USA_SSN</p>
667
+ * </li>
668
+ * <li>
669
+ * <p>EMAIL</p>
670
+ * </li>
671
+ * <li>
672
+ * <p>USA_ITIN</p>
673
+ * </li>
674
+ * <li>
675
+ * <p>USA_PASSPORT_NUMBER</p>
676
+ * </li>
677
+ * <li>
678
+ * <p>PHONE_NUMBER</p>
679
+ * </li>
680
+ * <li>
681
+ * <p>USA_DRIVING_LICENSE</p>
682
+ * </li>
683
+ * <li>
684
+ * <p>BANK_ACCOUNT</p>
685
+ * </li>
686
+ * <li>
687
+ * <p>CREDIT_CARD</p>
688
+ * </li>
689
+ * <li>
690
+ * <p>IP_ADDRESS</p>
691
+ * </li>
692
+ * <li>
693
+ * <p>MAC_ADDRESS</p>
694
+ * </li>
695
+ * <li>
696
+ * <p>USA_DEA_NUMBER</p>
697
+ * </li>
698
+ * <li>
699
+ * <p>USA_HCPCS_CODE</p>
700
+ * </li>
701
+ * <li>
702
+ * <p>USA_NATIONAL_PROVIDER_IDENTIFIER</p>
703
+ * </li>
704
+ * <li>
705
+ * <p>USA_NATIONAL_DRUG_CODE</p>
706
+ * </li>
707
+ * <li>
708
+ * <p>USA_HEALTH_INSURANCE_CLAIM_NUMBER</p>
709
+ * </li>
710
+ * <li>
711
+ * <p>USA_MEDICARE_BENEFICIARY_IDENTIFIER</p>
712
+ * </li>
713
+ * <li>
714
+ * <p>USA_CPT_CODE</p>
715
+ * </li>
716
+ * <li>
717
+ * <p>PERSON_NAME</p>
718
+ * </li>
719
+ * <li>
720
+ * <p>DATE</p>
721
+ * </li>
722
+ * </ul>
723
+ * <p>The Entity type group USA_ALL is also supported, and includes all of the
724
+ * above entity types except PERSON_NAME and DATE.</p>
725
+ */
726
+ EntityTypes: string[] | undefined;
727
+ /**
728
+ * <p>Configuration of statistics that are allowed to be run on columns that
729
+ * contain detected entities. When undefined, no statistics will be computed
730
+ * on columns that contain detected entities.</p>
731
+ */
732
+ AllowedStatistics?: AllowedStatistics[];
733
+ }
734
+ export declare namespace EntityDetectorConfiguration {
735
+ /**
736
+ * @internal
737
+ */
738
+ const filterSensitiveLog: (obj: EntityDetectorConfiguration) => any;
739
+ }
611
740
  /**
612
741
  * <p>Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default
613
742
  * parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all
@@ -636,6 +765,10 @@ export interface ProfileConfiguration {
636
765
  * </p>
637
766
  */
638
767
  ColumnStatisticsConfigurations?: ColumnStatisticsConfiguration[];
768
+ /**
769
+ * <p>Configuration of entity detection for a profile job. When undefined, entity detection is disabled.</p>
770
+ */
771
+ EntityDetectorConfiguration?: EntityDetectorConfiguration;
639
772
  }
640
773
  export declare namespace ProfileConfiguration {
641
774
  /**
@@ -690,6 +823,33 @@ export declare enum LogSubscription {
690
823
  DISABLE = "DISABLE",
691
824
  ENABLE = "ENABLE"
692
825
  }
826
+ export declare enum ValidationMode {
827
+ CHECK_ALL = "CHECK_ALL"
828
+ }
829
+ /**
830
+ * <p>Configuration for data quality validation. Used to select the Rulesets and Validation Mode
831
+ * to be used in the profile job. When ValidationConfiguration is null, the profile
832
+ * job will run without data quality validation.</p>
833
+ */
834
+ export interface ValidationConfiguration {
835
+ /**
836
+ * <p>The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job.
837
+ * The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of
838
+ * the dataset that is associated with the profile job.</p>
839
+ */
840
+ RulesetArn: string | undefined;
841
+ /**
842
+ * <p>Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules
843
+ * defined in the selected ruleset.</p>
844
+ */
845
+ ValidationMode?: ValidationMode | string;
846
+ }
847
+ export declare namespace ValidationConfiguration {
848
+ /**
849
+ * @internal
850
+ */
851
+ const filterSensitiveLog: (obj: ValidationConfiguration) => any;
852
+ }
693
853
  export interface CreateProfileJobRequest {
694
854
  /**
695
855
  * <p>The name of the dataset that this job is to act upon.</p>
@@ -744,6 +904,10 @@ export interface CreateProfileJobRequest {
744
904
  * profile job will run with default settings.</p>
745
905
  */
746
906
  Configuration?: ProfileConfiguration;
907
+ /**
908
+ * <p>List of validation configurations that are applied to the profile job.</p>
909
+ */
910
+ ValidationConfigurations?: ValidationConfiguration[];
747
911
  /**
748
912
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
749
913
  * be assumed when DataBrew runs the job.</p>
@@ -991,8 +1155,8 @@ export declare namespace CreateRecipeResponse {
991
1155
  const filterSensitiveLog: (obj: CreateRecipeResponse) => any;
992
1156
  }
993
1157
  /**
994
- * <p>Represents options that specify how and where DataBrew writes the database output generated by recipe
995
- * jobs.</p>
1158
+ * <p>Represents options that specify how and where DataBrew writes the database
1159
+ * output generated by recipe jobs.</p>
996
1160
  */
997
1161
  export interface DatabaseTableOutputOptions {
998
1162
  /**
@@ -1041,8 +1205,8 @@ export declare namespace DatabaseOutput {
1041
1205
  const filterSensitiveLog: (obj: DatabaseOutput) => any;
1042
1206
  }
1043
1207
  /**
1044
- * <p>Represents options that specify how and where DataBrew writes the Amazon S3 output generated by
1045
- * recipe jobs.</p>
1208
+ * <p>Represents options that specify how and where DataBrew writes the Amazon S3 output
1209
+ * generated by recipe jobs.</p>
1046
1210
  */
1047
1211
  export interface S3TableOutputOptions {
1048
1212
  /**
@@ -1063,7 +1227,8 @@ export declare namespace S3TableOutputOptions {
1063
1227
  */
1064
1228
  export interface DataCatalogOutput {
1065
1229
  /**
1066
- * <p>The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.</p>
1230
+ * <p>The unique identifier of the Amazon Web Services account that holds the Data Catalog that
1231
+ * stores the data.</p>
1067
1232
  */
1068
1233
  CatalogId?: string;
1069
1234
  /**
@@ -1075,8 +1240,8 @@ export interface DataCatalogOutput {
1075
1240
  */
1076
1241
  TableName: string | undefined;
1077
1242
  /**
1078
- * <p>Represents options that specify how and where DataBrew writes the Amazon S3 output generated
1079
- * by recipe jobs.</p>
1243
+ * <p>Represents options that specify how and where DataBrew writes the Amazon S3
1244
+ * output generated by recipe jobs.</p>
1080
1245
  */
1081
1246
  S3Options?: S3TableOutputOptions;
1082
1247
  /**
@@ -1305,6 +1470,145 @@ export declare namespace CreateRecipeJobResponse {
1305
1470
  */
1306
1471
  const filterSensitiveLog: (obj: CreateRecipeJobResponse) => any;
1307
1472
  }
1473
+ export declare enum ThresholdType {
1474
+ GREATER_THAN = "GREATER_THAN",
1475
+ GREATER_THAN_OR_EQUAL = "GREATER_THAN_OR_EQUAL",
1476
+ LESS_THAN = "LESS_THAN",
1477
+ LESS_THAN_OR_EQUAL = "LESS_THAN_OR_EQUAL"
1478
+ }
1479
+ export declare enum ThresholdUnit {
1480
+ COUNT = "COUNT",
1481
+ PERCENTAGE = "PERCENTAGE"
1482
+ }
1483
+ /**
1484
+ * <p>The threshold used with a non-aggregate check expression. The non-aggregate check expression
1485
+ * will be applied to each row in a specific column. Then the threshold will be used to determine
1486
+ * whether the validation succeeds.</p>
1487
+ */
1488
+ export interface Threshold {
1489
+ /**
1490
+ * <p>The value of a threshold.</p>
1491
+ */
1492
+ Value: number | undefined;
1493
+ /**
1494
+ * <p>The type of a threshold. Used for comparison of an actual count of rows that satisfy the
1495
+ * rule to the threshold value.</p>
1496
+ */
1497
+ Type?: ThresholdType | string;
1498
+ /**
1499
+ * <p>Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size
1500
+ * used for validation.</p>
1501
+ */
1502
+ Unit?: ThresholdUnit | string;
1503
+ }
1504
+ export declare namespace Threshold {
1505
+ /**
1506
+ * @internal
1507
+ */
1508
+ const filterSensitiveLog: (obj: Threshold) => any;
1509
+ }
1510
+ /**
1511
+ * <p>Represents a single data quality requirement that should be validated in the
1512
+ * scope of this dataset.</p>
1513
+ */
1514
+ export interface Rule {
1515
+ /**
1516
+ * <p>The name of the rule.</p>
1517
+ */
1518
+ Name: string | undefined;
1519
+ /**
1520
+ * <p>A value that specifies whether the rule is disabled. Once a rule is
1521
+ * disabled, a profile job will not validate it during a job run. Default
1522
+ * value is false.</p>
1523
+ */
1524
+ Disabled?: boolean;
1525
+ /**
1526
+ * <p>The expression which includes column references, condition names followed by
1527
+ * variable references, possibly grouped and combined with other conditions. For
1528
+ * example, <code>(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and
1529
+ * (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)</code>. Column and value
1530
+ * references are substitution variables that should start with the ':' symbol.
1531
+ * Depending on the context, substitution variables' values can be either an actual
1532
+ * value or a column name. These values are defined in the SubstitutionMap.
1533
+ * If a CheckExpression starts with a column reference, then ColumnSelectors in the
1534
+ * rule should be null. If ColumnSelectors has been defined, then there should be no
1535
+ * columnn reference in the left side of a condition, for example,
1536
+ * <code>is_between :val1 and :val2</code>.</p>
1537
+ */
1538
+ CheckExpression: string | undefined;
1539
+ /**
1540
+ * <p>The map of substitution variable names to their values used in a check
1541
+ * expression. Variable names should start with a ':' (colon). Variable values can either
1542
+ * be actual values or column names. To differentiate between the two, column names
1543
+ * should be enclosed in backticks, for example, <code>":col1": "`Column A`".</code>
1544
+ * </p>
1545
+ */
1546
+ SubstitutionMap?: {
1547
+ [key: string]: string;
1548
+ };
1549
+ /**
1550
+ * <p>The threshold used with a non-aggregate check expression. Non-aggregate check expressions
1551
+ * will be applied to each row in a specific column, and the threshold will be used to determine
1552
+ * whether the validation succeeds.</p>
1553
+ */
1554
+ Threshold?: Threshold;
1555
+ /**
1556
+ * <p>List of column selectors. Selectors can be used to select columns using a name or regular
1557
+ * expression from the dataset. Rule will be applied to selected columns.</p>
1558
+ */
1559
+ ColumnSelectors?: ColumnSelector[];
1560
+ }
1561
+ export declare namespace Rule {
1562
+ /**
1563
+ * @internal
1564
+ */
1565
+ const filterSensitiveLog: (obj: Rule) => any;
1566
+ }
1567
+ export interface CreateRulesetRequest {
1568
+ /**
1569
+ * <p>The name of the ruleset to be created. Valid characters are alphanumeric
1570
+ * (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
1571
+ */
1572
+ Name: string | undefined;
1573
+ /**
1574
+ * <p>The description of the ruleset.</p>
1575
+ */
1576
+ Description?: string;
1577
+ /**
1578
+ * <p>The Amazon Resource Name (ARN) of a resource (dataset) that the
1579
+ * ruleset is associated with.</p>
1580
+ */
1581
+ TargetArn: string | undefined;
1582
+ /**
1583
+ * <p>A list of rules that are defined with the ruleset. A rule includes
1584
+ * one or more checks to be validated on a DataBrew dataset.</p>
1585
+ */
1586
+ Rules: Rule[] | undefined;
1587
+ /**
1588
+ * <p>Metadata tags to apply to the ruleset.</p>
1589
+ */
1590
+ Tags?: {
1591
+ [key: string]: string;
1592
+ };
1593
+ }
1594
+ export declare namespace CreateRulesetRequest {
1595
+ /**
1596
+ * @internal
1597
+ */
1598
+ const filterSensitiveLog: (obj: CreateRulesetRequest) => any;
1599
+ }
1600
+ export interface CreateRulesetResponse {
1601
+ /**
1602
+ * <p>The unique name of the created ruleset.</p>
1603
+ */
1604
+ Name: string | undefined;
1605
+ }
1606
+ export declare namespace CreateRulesetResponse {
1607
+ /**
1608
+ * @internal
1609
+ */
1610
+ const filterSensitiveLog: (obj: CreateRulesetResponse) => any;
1611
+ }
1308
1612
  export interface CreateScheduleRequest {
1309
1613
  /**
1310
1614
  * <p>The name or names of one or more jobs to be run.</p>
@@ -1453,6 +1757,30 @@ export declare namespace DeleteRecipeVersionResponse {
1453
1757
  */
1454
1758
  const filterSensitiveLog: (obj: DeleteRecipeVersionResponse) => any;
1455
1759
  }
1760
+ export interface DeleteRulesetRequest {
1761
+ /**
1762
+ * <p>The name of the ruleset to be deleted.</p>
1763
+ */
1764
+ Name: string | undefined;
1765
+ }
1766
+ export declare namespace DeleteRulesetRequest {
1767
+ /**
1768
+ * @internal
1769
+ */
1770
+ const filterSensitiveLog: (obj: DeleteRulesetRequest) => any;
1771
+ }
1772
+ export interface DeleteRulesetResponse {
1773
+ /**
1774
+ * <p>The name of the deleted ruleset.</p>
1775
+ */
1776
+ Name: string | undefined;
1777
+ }
1778
+ export declare namespace DeleteRulesetResponse {
1779
+ /**
1780
+ * @internal
1781
+ */
1782
+ const filterSensitiveLog: (obj: DeleteRulesetResponse) => any;
1783
+ }
1456
1784
  export interface DeleteScheduleRequest {
1457
1785
  /**
1458
1786
  * <p>The name of the schedule to be deleted.</p>
@@ -1508,7 +1836,8 @@ export interface DescribeDatasetResponse {
1508
1836
  */
1509
1837
  Name: string | undefined;
1510
1838
  /**
1511
- * <p>The file format of a dataset that is created from an Amazon S3 file or folder.</p>
1839
+ * <p>The file format of a dataset that is created from an Amazon S3 file
1840
+ * or folder.</p>
1512
1841
  */
1513
1842
  Format?: InputFormat | string;
1514
1843
  /**
@@ -1530,11 +1859,13 @@ export interface DescribeDatasetResponse {
1530
1859
  */
1531
1860
  LastModifiedBy?: string;
1532
1861
  /**
1533
- * <p>The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.</p>
1862
+ * <p>The location of the data for this dataset, Amazon S3 or the
1863
+ * Glue Data Catalog.</p>
1534
1864
  */
1535
1865
  Source?: Source | string;
1536
1866
  /**
1537
- * <p>A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.</p>
1867
+ * <p>A set of options that defines how DataBrew interprets an Amazon S3
1868
+ * path of the dataset.</p>
1538
1869
  */
1539
1870
  PathOptions?: PathOptions;
1540
1871
  /**
@@ -1667,6 +1998,10 @@ export interface DescribeJobResponse {
1667
1998
  * profile job will run with default settings.</p>
1668
1999
  */
1669
2000
  ProfileConfiguration?: ProfileConfiguration;
2001
+ /**
2002
+ * <p>List of validation configurations that are applied to the profile job.</p>
2003
+ */
2004
+ ValidationConfigurations?: ValidationConfiguration[];
1670
2005
  /**
1671
2006
  * <p>Represents the name and version of a DataBrew recipe.</p>
1672
2007
  */
@@ -1759,6 +2094,10 @@ export interface DescribeJobRunResponse {
1759
2094
  * profile job will run with default settings.</p>
1760
2095
  */
1761
2096
  ProfileConfiguration?: ProfileConfiguration;
2097
+ /**
2098
+ * <p>List of validation configurations that are applied to the profile job.</p>
2099
+ */
2100
+ ValidationConfigurations?: ValidationConfiguration[];
1762
2101
  /**
1763
2102
  * <p>The unique identifier of the job run.</p>
1764
2103
  */
@@ -2001,6 +2340,70 @@ export declare namespace DescribeRecipeResponse {
2001
2340
  */
2002
2341
  const filterSensitiveLog: (obj: DescribeRecipeResponse) => any;
2003
2342
  }
2343
+ export interface DescribeRulesetRequest {
2344
+ /**
2345
+ * <p>The name of the ruleset to be described.</p>
2346
+ */
2347
+ Name: string | undefined;
2348
+ }
2349
+ export declare namespace DescribeRulesetRequest {
2350
+ /**
2351
+ * @internal
2352
+ */
2353
+ const filterSensitiveLog: (obj: DescribeRulesetRequest) => any;
2354
+ }
2355
+ export interface DescribeRulesetResponse {
2356
+ /**
2357
+ * <p>The name of the ruleset.</p>
2358
+ */
2359
+ Name: string | undefined;
2360
+ /**
2361
+ * <p>The description of the ruleset.</p>
2362
+ */
2363
+ Description?: string;
2364
+ /**
2365
+ * <p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
2366
+ * associated with.</p>
2367
+ */
2368
+ TargetArn?: string;
2369
+ /**
2370
+ * <p>A list of rules that are defined with the ruleset. A rule includes one
2371
+ * or more checks to be validated on a DataBrew dataset.</p>
2372
+ */
2373
+ Rules?: Rule[];
2374
+ /**
2375
+ * <p>The date and time that the ruleset was created.</p>
2376
+ */
2377
+ CreateDate?: Date;
2378
+ /**
2379
+ * <p>The Amazon Resource Name (ARN) of the user who created the ruleset.</p>
2380
+ */
2381
+ CreatedBy?: string;
2382
+ /**
2383
+ * <p>The Amazon Resource Name (ARN) of the user who last modified the ruleset.</p>
2384
+ */
2385
+ LastModifiedBy?: string;
2386
+ /**
2387
+ * <p>The modification date and time of the ruleset.</p>
2388
+ */
2389
+ LastModifiedDate?: Date;
2390
+ /**
2391
+ * <p>The Amazon Resource Name (ARN) for the ruleset.</p>
2392
+ */
2393
+ ResourceArn?: string;
2394
+ /**
2395
+ * <p>Metadata tags that have been applied to the ruleset.</p>
2396
+ */
2397
+ Tags?: {
2398
+ [key: string]: string;
2399
+ };
2400
+ }
2401
+ export declare namespace DescribeRulesetResponse {
2402
+ /**
2403
+ * @internal
2404
+ */
2405
+ const filterSensitiveLog: (obj: DescribeRulesetResponse) => any;
2406
+ }
2004
2407
  export interface DescribeScheduleRequest {
2005
2408
  /**
2006
2409
  * <p>The name of the schedule to be described.</p>
@@ -2123,7 +2526,8 @@ export interface Dataset {
2123
2526
  */
2124
2527
  Source?: Source | string;
2125
2528
  /**
2126
- * <p>A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.</p>
2529
+ * <p>A set of options that defines how DataBrew interprets an Amazon S3
2530
+ * path of the dataset.</p>
2127
2531
  */
2128
2532
  PathOptions?: PathOptions;
2129
2533
  /**
@@ -2258,6 +2662,10 @@ export interface JobRun {
2258
2662
  * size parameter.</p>
2259
2663
  */
2260
2664
  JobSample?: JobSample;
2665
+ /**
2666
+ * <p>List of validation configurations that are applied to the profile job run.</p>
2667
+ */
2668
+ ValidationConfigurations?: ValidationConfiguration[];
2261
2669
  }
2262
2670
  export declare namespace JobRun {
2263
2671
  /**
@@ -2439,6 +2847,10 @@ export interface Job {
2439
2847
  * size parameter.</p>
2440
2848
  */
2441
2849
  JobSample?: JobSample;
2850
+ /**
2851
+ * <p>List of validation configurations that are applied to the profile job.</p>
2852
+ */
2853
+ ValidationConfigurations?: ValidationConfiguration[];
2442
2854
  }
2443
2855
  export declare namespace Job {
2444
2856
  /**
@@ -2728,6 +3140,104 @@ export declare namespace ListRecipeVersionsResponse {
2728
3140
  */
2729
3141
  const filterSensitiveLog: (obj: ListRecipeVersionsResponse) => any;
2730
3142
  }
3143
+ export interface ListRulesetsRequest {
3144
+ /**
3145
+ * <p>The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter
3146
+ * indicates to return only those rulesets that are associated with the specified resource.</p>
3147
+ */
3148
+ TargetArn?: string;
3149
+ /**
3150
+ * <p>The maximum number of results to return in this request.</p>
3151
+ */
3152
+ MaxResults?: number;
3153
+ /**
3154
+ * <p>A token generated by DataBrew that specifies where to continue pagination
3155
+ * if a previous request was truncated. To get the next set of pages, pass in
3156
+ * the NextToken value from the response object of the previous page call.</p>
3157
+ */
3158
+ NextToken?: string;
3159
+ }
3160
+ export declare namespace ListRulesetsRequest {
3161
+ /**
3162
+ * @internal
3163
+ */
3164
+ const filterSensitiveLog: (obj: ListRulesetsRequest) => any;
3165
+ }
3166
+ /**
3167
+ * <p>Contains metadata about the ruleset.</p>
3168
+ */
3169
+ export interface RulesetItem {
3170
+ /**
3171
+ * <p>The ID of the Amazon Web Services account that owns the ruleset.</p>
3172
+ */
3173
+ AccountId?: string;
3174
+ /**
3175
+ * <p>The Amazon Resource Name (ARN) of the user who created the ruleset.</p>
3176
+ */
3177
+ CreatedBy?: string;
3178
+ /**
3179
+ * <p>The date and time that the ruleset was created.</p>
3180
+ */
3181
+ CreateDate?: Date;
3182
+ /**
3183
+ * <p>The description of the ruleset.</p>
3184
+ */
3185
+ Description?: string;
3186
+ /**
3187
+ * <p>The Amazon Resource Name (ARN) of the user who last modified the ruleset.</p>
3188
+ */
3189
+ LastModifiedBy?: string;
3190
+ /**
3191
+ * <p>The modification date and time of the ruleset.</p>
3192
+ */
3193
+ LastModifiedDate?: Date;
3194
+ /**
3195
+ * <p>The name of the ruleset.</p>
3196
+ */
3197
+ Name: string | undefined;
3198
+ /**
3199
+ * <p>The Amazon Resource Name (ARN) for the ruleset.</p>
3200
+ */
3201
+ ResourceArn?: string;
3202
+ /**
3203
+ * <p>The number of rules that are defined in the ruleset.</p>
3204
+ */
3205
+ RuleCount?: number;
3206
+ /**
3207
+ * <p>Metadata tags that have been applied to the ruleset.</p>
3208
+ */
3209
+ Tags?: {
3210
+ [key: string]: string;
3211
+ };
3212
+ /**
3213
+ * <p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
3214
+ * associated with.</p>
3215
+ */
3216
+ TargetArn: string | undefined;
3217
+ }
3218
+ export declare namespace RulesetItem {
3219
+ /**
3220
+ * @internal
3221
+ */
3222
+ const filterSensitiveLog: (obj: RulesetItem) => any;
3223
+ }
3224
+ export interface ListRulesetsResponse {
3225
+ /**
3226
+ * <p>A list of RulesetItem. RulesetItem contains meta data of a ruleset.</p>
3227
+ */
3228
+ Rulesets: RulesetItem[] | undefined;
3229
+ /**
3230
+ * <p>A token that you can use in a subsequent call to retrieve the next set of
3231
+ * results.</p>
3232
+ */
3233
+ NextToken?: string;
3234
+ }
3235
+ export declare namespace ListRulesetsResponse {
3236
+ /**
3237
+ * @internal
3238
+ */
3239
+ const filterSensitiveLog: (obj: ListRulesetsResponse) => any;
3240
+ }
2731
3241
  export interface ListSchedulesRequest {
2732
3242
  /**
2733
3243
  * <p>The name of the job that these schedules apply to.</p>
@@ -2893,6 +3403,19 @@ export interface ViewFrame {
2893
3403
  * <p>A list of columns to hide in the view frame.</p>
2894
3404
  */
2895
3405
  HiddenColumns?: string[];
3406
+ /**
3407
+ * <p>The starting index for the range of rows to return in the view frame.</p>
3408
+ */
3409
+ StartRowIndex?: number;
3410
+ /**
3411
+ * <p>The number of rows to include in the view frame, beginning with the
3412
+ * <code>StartRowIndex</code> value.</p>
3413
+ */
3414
+ RowRange?: number;
3415
+ /**
3416
+ * <p>Controls if analytics computation is enabled or disabled. Enabled by default.</p>
3417
+ */
3418
+ Analytics?: AnalyticsMode | string;
2896
3419
  }
2897
3420
  export declare namespace ViewFrame {
2898
3421
  /**
@@ -3185,6 +3708,10 @@ export interface UpdateProfileJobRequest {
3185
3708
  * input data, or write output from a job.</p>
3186
3709
  */
3187
3710
  OutputLocation: S3Location | undefined;
3711
+ /**
3712
+ * <p>List of validation configurations that are applied to the profile job.</p>
3713
+ */
3714
+ ValidationConfigurations?: ValidationConfiguration[];
3188
3715
  /**
3189
3716
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to
3190
3717
  * be assumed when DataBrew runs the job.</p>
@@ -3371,6 +3898,39 @@ export declare namespace UpdateRecipeJobResponse {
3371
3898
  */
3372
3899
  const filterSensitiveLog: (obj: UpdateRecipeJobResponse) => any;
3373
3900
  }
3901
+ export interface UpdateRulesetRequest {
3902
+ /**
3903
+ * <p>The name of the ruleset to be updated.</p>
3904
+ */
3905
+ Name: string | undefined;
3906
+ /**
3907
+ * <p>The description of the ruleset.</p>
3908
+ */
3909
+ Description?: string;
3910
+ /**
3911
+ * <p>A list of rules that are defined with the ruleset. A rule includes one or more
3912
+ * checks to be validated on a DataBrew dataset.</p>
3913
+ */
3914
+ Rules: Rule[] | undefined;
3915
+ }
3916
+ export declare namespace UpdateRulesetRequest {
3917
+ /**
3918
+ * @internal
3919
+ */
3920
+ const filterSensitiveLog: (obj: UpdateRulesetRequest) => any;
3921
+ }
3922
+ export interface UpdateRulesetResponse {
3923
+ /**
3924
+ * <p>The name of the updated ruleset.</p>
3925
+ */
3926
+ Name: string | undefined;
3927
+ }
3928
+ export declare namespace UpdateRulesetResponse {
3929
+ /**
3930
+ * @internal
3931
+ */
3932
+ const filterSensitiveLog: (obj: UpdateRulesetResponse) => any;
3933
+ }
3374
3934
  export interface UpdateScheduleRequest {
3375
3935
  /**
3376
3936
  * <p>The name or names of one or more jobs to be run for this schedule.</p>