@aws-sdk/client-glue 3.1095.0 → 3.1097.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 (62) hide show
  1. package/README.md +7 -0
  2. package/dist-cjs/index.js +221 -90
  3. package/dist-es/Glue.js +2 -0
  4. package/dist-es/commands/BatchGetDataQualityRulesetEvaluationRunCommand.js +4 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/enums.js +26 -13
  7. package/dist-es/schemas/schemas_0.js +177 -76
  8. package/dist-types/Glue.d.ts +7 -0
  9. package/dist-types/GlueClient.d.ts +3 -2
  10. package/dist-types/commands/BatchGetDataQualityResultCommand.d.ts +11 -0
  11. package/dist-types/commands/BatchGetDataQualityRulesetEvaluationRunCommand.d.ts +202 -0
  12. package/dist-types/commands/CreateClassifierCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateColumnStatisticsTaskSettingsCommand.d.ts +1 -1
  14. package/dist-types/commands/CreateConnectionCommand.d.ts +1 -1
  15. package/dist-types/commands/CreateCrawlerCommand.d.ts +1 -2
  16. package/dist-types/commands/GetDataQualityModelCommand.d.ts +1 -1
  17. package/dist-types/commands/GetDataQualityModelResultCommand.d.ts +1 -1
  18. package/dist-types/commands/GetDataQualityResultCommand.d.ts +12 -1
  19. package/dist-types/commands/GetDataQualityRuleRecommendationRunCommand.d.ts +4 -1
  20. package/dist-types/commands/GetDataQualityRulesetCommand.d.ts +1 -1
  21. package/dist-types/commands/GetDataQualityRulesetEvaluationRunCommand.d.ts +48 -0
  22. package/dist-types/commands/ListDataQualityRuleRecommendationRunsCommand.d.ts +4 -0
  23. package/dist-types/commands/ListDataQualityStatisticsCommand.d.ts +9 -0
  24. package/dist-types/commands/SearchTablesCommand.d.ts +1 -2
  25. package/dist-types/commands/StartBlueprintRunCommand.d.ts +1 -1
  26. package/dist-types/commands/StartColumnStatisticsTaskRunCommand.d.ts +1 -1
  27. package/dist-types/commands/StartColumnStatisticsTaskRunScheduleCommand.d.ts +1 -1
  28. package/dist-types/commands/StartCrawlerCommand.d.ts +1 -1
  29. package/dist-types/commands/StartDataQualityRuleRecommendationRunCommand.d.ts +3 -0
  30. package/dist-types/commands/StartDataQualityRulesetEvaluationRunCommand.d.ts +48 -0
  31. package/dist-types/commands/index.d.ts +1 -0
  32. package/dist-types/models/enums.d.ts +66 -29
  33. package/dist-types/models/models_0.d.ts +305 -439
  34. package/dist-types/models/models_1.d.ts +440 -342
  35. package/dist-types/models/models_2.d.ts +358 -222
  36. package/dist-types/models/models_3.d.ts +218 -4
  37. package/dist-types/schemas/schemas_0.d.ts +12 -0
  38. package/dist-types/ts3.4/Glue.d.ts +17 -0
  39. package/dist-types/ts3.4/GlueClient.d.ts +6 -0
  40. package/dist-types/ts3.4/commands/BatchGetDataQualityRulesetEvaluationRunCommand.d.ts +42 -0
  41. package/dist-types/ts3.4/commands/CreateClassifierCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/CreateColumnStatisticsTaskSettingsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/CreateConnectionCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/CreateCrawlerCommand.d.ts +1 -2
  45. package/dist-types/ts3.4/commands/GetDataQualityModelCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/GetDataQualityModelResultCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/GetDataQualityResultCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/GetDataQualityRuleRecommendationRunCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/GetDataQualityRulesetCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/SearchTablesCommand.d.ts +1 -2
  51. package/dist-types/ts3.4/commands/StartBlueprintRunCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/StartColumnStatisticsTaskRunCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/StartColumnStatisticsTaskRunScheduleCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/StartCrawlerCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  56. package/dist-types/ts3.4/models/enums.d.ts +33 -16
  57. package/dist-types/ts3.4/models/models_0.d.ts +74 -76
  58. package/dist-types/ts3.4/models/models_1.d.ts +80 -87
  59. package/dist-types/ts3.4/models/models_2.d.ts +91 -57
  60. package/dist-types/ts3.4/models/models_3.d.ts +55 -2
  61. package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
  62. package/package.json +3 -3
@@ -1,4 +1,4 @@
1
- import type { AdditionalOptionKeys, AggFunction, AllowFullTableExternalDataAccessEnum, AuthenticationType, BlueprintStatus, CompactionStrategy, CompressionType, ComputeEnvironment, ConfigurationSource, ConnectionPropertyKey, ConnectionStatus, ConnectionType, CrawlerLineageSettings, CrawlerState, CrawlState, CsvHeaderOption, CsvSerdeOption, DataFormat, DataOperation, DataQualityRuleResultStatus, DdbExportType, DeleteBehavior, DeltaTargetCompressionType, DQStopJobOnFailureTiming, DQTransformOutput, ExecutionClass, FilterLogicalOperator, FilterOperation, FilterValueType, GlueRecordType, HudiTargetCompressionType, HyperTargetCompressionType, IcebergTargetCompressionType, InclusionAnnotationValue, JDBCConnectionType, JDBCDataType, JdbcMetadataEntry, JobMode, JobRunState, JoinType, LastCrawlStatus, Logical, LogicalOperator, NodeType, OAuth2GrantType, OverwriteChildResourcePermissionsWithDefaultEnum, ParamType, ParquetCompressionType, Permission, PiiType, PropertyLocation, PropertyType, QuoteChar, RecrawlBehavior, ScheduleState, Separator, SourceControlAuthStrategy, SourceControlProvider, StartingPosition, TableOptimizerEventType, TableOptimizerType, TargetFormat, TaskStatusType, TriggerState, TriggerType, UnionType, UpdateBehavior, UpdateCatalogBehavior, WorkerType, WorkflowRunStatus } from "./enums";
1
+ import type { AdditionalOptionKeys, AggFunction, AllowFullTableExternalDataAccessEnum, AuthenticationType, BlueprintStatus, CompactionStrategy, CompressionType, ConfigurationSource, CrawlerLineageSettings, CrawlerState, CrawlState, CsvHeaderOption, CsvSerdeOption, DataFormat, DataOperation, DataQualityRuleResultStatus, DdbExportType, DeleteBehavior, DeltaTargetCompressionType, DQCompositeRuleEvaluationMethod, DQStopJobOnFailureTiming, DQTransformOutput, ExecutionClass, FilterLogicalOperator, FilterOperation, FilterValueType, GlueRecordType, HudiTargetCompressionType, HyperTargetCompressionType, IcebergTargetCompressionType, InclusionAnnotationValue, JDBCConnectionType, JDBCDataType, JdbcMetadataEntry, JobMode, JobRunState, JoinType, LastCrawlStatus, Logical, LogicalOperator, NodeType, OAuth2GrantType, ObservationConfiguration, ObservationMode, OverwriteChildResourcePermissionsWithDefaultEnum, ParamType, ParquetCompressionType, Permission, PiiType, PropertyLocation, PropertyType, QuoteChar, RecrawlBehavior, ResultTypeEnum, ScheduleState, Separator, SourceControlAuthStrategy, SourceControlProvider, StartingPosition, TableOptimizerEventType, TableOptimizerType, TargetFormat, TaskStatusType, TriggerState, TriggerType, UnionType, UpdateBehavior, UpdateCatalogBehavior, WorkerType, WorkflowRunStatus } from "./enums";
2
2
  /**
3
3
  * <p>Specifies configuration properties of a notification.</p>
4
4
  * @public
@@ -2131,6 +2131,27 @@ export interface DataQualityAggregatedMetrics {
2131
2131
  */
2132
2132
  TotalRulesFailed?: number | undefined;
2133
2133
  }
2134
+ /**
2135
+ * <p>The distribution data for a statistic.</p>
2136
+ * @public
2137
+ */
2138
+ export interface DistributionData {
2139
+ /**
2140
+ * <p>The bin edge values for the distribution.</p>
2141
+ * @public
2142
+ */
2143
+ BinEdges?: string[] | undefined;
2144
+ /**
2145
+ * <p>The frequency count for each bin in the distribution.</p>
2146
+ * @public
2147
+ */
2148
+ Count?: number[] | undefined;
2149
+ /**
2150
+ * <p>The data type of the column for the distribution.</p>
2151
+ * @public
2152
+ */
2153
+ DataType?: string | undefined;
2154
+ }
2134
2155
  /**
2135
2156
  * <p>Describes the result of the evaluation of a data quality analyzer.</p>
2136
2157
  * @public
@@ -2156,6 +2177,11 @@ export interface DataQualityAnalyzerResult {
2156
2177
  * @public
2157
2178
  */
2158
2179
  EvaluatedMetrics?: Record<string, number> | undefined;
2180
+ /**
2181
+ * <p>A map of distribution metrics associated with the evaluation of the analyzer.</p>
2182
+ * @public
2183
+ */
2184
+ EvaluatedDistributions?: Record<string, DistributionData> | undefined;
2159
2185
  }
2160
2186
  /**
2161
2187
  * <p>The database and table in the Glue Data Catalog that is used for input or output data
@@ -2472,6 +2498,284 @@ export interface BatchGetDataQualityResultResponse {
2472
2498
  */
2473
2499
  ResultsNotFound?: string[] | undefined;
2474
2500
  }
2501
+ /**
2502
+ * @public
2503
+ */
2504
+ export interface BatchGetDataQualityRulesetEvaluationRunRequest {
2505
+ /**
2506
+ * <p>A list of unique run identifiers for the evaluation runs to retrieve.</p>
2507
+ * @public
2508
+ */
2509
+ RunIds: string[] | undefined;
2510
+ }
2511
+ /**
2512
+ * <p>The configuration for a Glue Data Catalog table used to store data quality results.</p>
2513
+ * @public
2514
+ */
2515
+ export interface CatalogTableConfigOptions {
2516
+ /**
2517
+ * <p>The name of the database in the Glue Data Catalog.</p>
2518
+ * @public
2519
+ */
2520
+ DatabaseName?: string | undefined;
2521
+ /**
2522
+ * <p>The name of the table in the Glue Data Catalog.</p>
2523
+ * @public
2524
+ */
2525
+ TableName?: string | undefined;
2526
+ /**
2527
+ * <p>The Amazon S3 location for storing the results.</p>
2528
+ * @public
2529
+ */
2530
+ S3Location?: string | undefined;
2531
+ /**
2532
+ * <p>A unique identifier for the Glue Data Catalog.</p>
2533
+ * @public
2534
+ */
2535
+ CatalogId?: string | undefined;
2536
+ }
2537
+ /**
2538
+ * <p>The configuration for writing data quality rule results.</p>
2539
+ * @public
2540
+ */
2541
+ export interface DataQualityRuleResultsOptions {
2542
+ /**
2543
+ * <p>Set to true to write data quality rule results.</p>
2544
+ * @public
2545
+ */
2546
+ WriteDataQualityRuleResultsEnabled?: boolean | undefined;
2547
+ /**
2548
+ * <p>The Glue Data Catalog table configuration for storing the rule results.</p>
2549
+ * @public
2550
+ */
2551
+ CatalogTableConfig?: CatalogTableConfigOptions | undefined;
2552
+ }
2553
+ /**
2554
+ * <p>The configuration for writing observation results.</p>
2555
+ * @public
2556
+ */
2557
+ export interface ObservationResultsOptions {
2558
+ /**
2559
+ * <p>Set to true to write observation results.</p>
2560
+ * @public
2561
+ */
2562
+ WriteObservationResultsEnabled?: boolean | undefined;
2563
+ /**
2564
+ * <p>The Glue Data Catalog table configuration for storing the observation results.</p>
2565
+ * @public
2566
+ */
2567
+ CatalogTableConfig?: CatalogTableConfigOptions | undefined;
2568
+ }
2569
+ /**
2570
+ * <p>The configuration for writing distribution results.</p>
2571
+ * @public
2572
+ */
2573
+ export interface DistributionResultsOptions {
2574
+ /**
2575
+ * <p>Set to true to write distribution results.</p>
2576
+ * @public
2577
+ */
2578
+ WriteDistributionResultsEnabled?: boolean | undefined;
2579
+ /**
2580
+ * <p>The Glue Data Catalog table configuration for storing the distribution results.</p>
2581
+ * @public
2582
+ */
2583
+ CatalogTableConfig?: CatalogTableConfigOptions | undefined;
2584
+ }
2585
+ /**
2586
+ * <p>The configuration for writing profiling results.</p>
2587
+ * @public
2588
+ */
2589
+ export interface ProfilingResultsOptions {
2590
+ /**
2591
+ * <p>Set to true to write profiling results.</p>
2592
+ * @public
2593
+ */
2594
+ WriteProfilingResultsEnabled?: boolean | undefined;
2595
+ /**
2596
+ * <p>The Glue Data Catalog table configuration for storing the profiling results.</p>
2597
+ * @public
2598
+ */
2599
+ CatalogTableConfig?: CatalogTableConfigOptions | undefined;
2600
+ /**
2601
+ * <p>The configuration for writing distribution results.</p>
2602
+ * @public
2603
+ */
2604
+ DistributionResults?: DistributionResultsOptions | undefined;
2605
+ }
2606
+ /**
2607
+ * <p>The configuration for writing row-level evaluation results.</p>
2608
+ * @public
2609
+ */
2610
+ export interface RowLevelResultsOptions {
2611
+ /**
2612
+ * <p>The maximum number of rows to write in the results.</p>
2613
+ * @public
2614
+ */
2615
+ MaxRowsToWrite?: number | undefined;
2616
+ /**
2617
+ * <p>The result type to include in the row-level results output.</p>
2618
+ * @public
2619
+ */
2620
+ ResultType?: ResultTypeEnum | undefined;
2621
+ /**
2622
+ * <p>The Glue Data Catalog table configuration for storing the results.</p>
2623
+ * @public
2624
+ */
2625
+ CatalogTableConfig?: CatalogTableConfigOptions | undefined;
2626
+ }
2627
+ /**
2628
+ * <p>Additional run options you can specify for an evaluation run.</p>
2629
+ * @public
2630
+ */
2631
+ export interface DataQualityEvaluationRunAdditionalRunOptions {
2632
+ /**
2633
+ * <p>Whether or not to enable CloudWatch metrics.</p>
2634
+ * @public
2635
+ */
2636
+ CloudWatchMetricsEnabled?: boolean | undefined;
2637
+ /**
2638
+ * <p>Prefix for Amazon S3 to store results.</p>
2639
+ * @public
2640
+ */
2641
+ ResultsS3Prefix?: string | undefined;
2642
+ /**
2643
+ * <p>Set the evaluation method for composite rules in the ruleset to ROW/COLUMN</p>
2644
+ * @public
2645
+ */
2646
+ CompositeRuleEvaluationMethod?: DQCompositeRuleEvaluationMethod | undefined;
2647
+ /**
2648
+ * <p>A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <code><CustomLogGroupPrefix>/error</code> and <code><CustomLogGroupPrefix>/output</code> instead of the default <code>/aws-glue/data-quality/error</code> and <code>/aws-glue/data-quality/output</code> log groups.</p>
2649
+ * @public
2650
+ */
2651
+ CustomLogGroupPrefix?: string | undefined;
2652
+ /**
2653
+ * <p>The configuration for writing row-level evaluation results to a Glue Data Catalog table.</p>
2654
+ * @public
2655
+ */
2656
+ RowLevelResults?: RowLevelResultsOptions | undefined;
2657
+ /**
2658
+ * <p>The configuration for writing profiling results to a Glue Data Catalog table.</p>
2659
+ * @public
2660
+ */
2661
+ ProfilingResults?: ProfilingResultsOptions | undefined;
2662
+ /**
2663
+ * <p>The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.</p>
2664
+ * @public
2665
+ */
2666
+ ObservationScope?: ObservationConfiguration | undefined;
2667
+ /**
2668
+ * <p>The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.</p>
2669
+ * @public
2670
+ */
2671
+ ObservationMode?: ObservationMode | undefined;
2672
+ /**
2673
+ * <p>The configuration for writing rule results to a Glue Data Catalog table.</p>
2674
+ * @public
2675
+ */
2676
+ DataQualityRuleResults?: DataQualityRuleResultsOptions | undefined;
2677
+ /**
2678
+ * <p>The configuration for writing observation results to a Glue Data Catalog table.</p>
2679
+ * @public
2680
+ */
2681
+ ObservationResults?: ObservationResultsOptions | undefined;
2682
+ }
2683
+ /**
2684
+ * <p>The details of a data quality ruleset evaluation run.</p>
2685
+ * @public
2686
+ */
2687
+ export interface DataQualityRulesetEvaluationRun {
2688
+ /**
2689
+ * <p>The unique run identifier associated with this run.</p>
2690
+ * @public
2691
+ */
2692
+ RunId?: string | undefined;
2693
+ /**
2694
+ * <p>A data source (an Glue table) for which you want data quality results.</p>
2695
+ * @public
2696
+ */
2697
+ DataSource?: DataSource | undefined;
2698
+ /**
2699
+ * <p>An IAM role supplied to encrypt the results of the run.</p>
2700
+ * @public
2701
+ */
2702
+ Role?: string | undefined;
2703
+ /**
2704
+ * <p>The number of <code>G.1X</code> workers to be used in the run. The default is 5.</p>
2705
+ * @public
2706
+ */
2707
+ NumberOfWorkers?: number | undefined;
2708
+ /**
2709
+ * <p>The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>
2710
+ * @public
2711
+ */
2712
+ Timeout?: number | undefined;
2713
+ /**
2714
+ * <p>Additional run options you can specify for an evaluation run.</p>
2715
+ * @public
2716
+ */
2717
+ AdditionalRunOptions?: DataQualityEvaluationRunAdditionalRunOptions | undefined;
2718
+ /**
2719
+ * <p>The status for this run.</p>
2720
+ * @public
2721
+ */
2722
+ Status?: TaskStatusType | undefined;
2723
+ /**
2724
+ * <p>The error strings that are associated with the run.</p>
2725
+ * @public
2726
+ */
2727
+ ErrorString?: string | undefined;
2728
+ /**
2729
+ * <p>The date and time when this run started.</p>
2730
+ * @public
2731
+ */
2732
+ StartedOn?: Date | undefined;
2733
+ /**
2734
+ * <p>A timestamp. The last point in time when this run was modified.</p>
2735
+ * @public
2736
+ */
2737
+ LastModifiedOn?: Date | undefined;
2738
+ /**
2739
+ * <p>The date and time when this run was completed.</p>
2740
+ * @public
2741
+ */
2742
+ CompletedOn?: Date | undefined;
2743
+ /**
2744
+ * <p>The amount of time (in seconds) that the run consumed resources.</p>
2745
+ * @public
2746
+ */
2747
+ ExecutionTime?: number | undefined;
2748
+ /**
2749
+ * <p>A list of ruleset names for the run.</p>
2750
+ * @public
2751
+ */
2752
+ RulesetNames?: string[] | undefined;
2753
+ /**
2754
+ * <p>A list of result IDs for the data quality results for the run.</p>
2755
+ * @public
2756
+ */
2757
+ ResultIds?: string[] | undefined;
2758
+ /**
2759
+ * <p>A map of reference strings to additional data sources you can specify for an evaluation run.</p>
2760
+ * @public
2761
+ */
2762
+ AdditionalDataSources?: Record<string, DataSource> | undefined;
2763
+ }
2764
+ /**
2765
+ * @public
2766
+ */
2767
+ export interface BatchGetDataQualityRulesetEvaluationRunResponse {
2768
+ /**
2769
+ * <p>A list of evaluation run details for the requested run IDs.</p>
2770
+ * @public
2771
+ */
2772
+ Runs?: DataQualityRulesetEvaluationRun[] | undefined;
2773
+ /**
2774
+ * <p>A list of run IDs that were not found.</p>
2775
+ * @public
2776
+ */
2777
+ RunsNotFound?: string[] | undefined;
2778
+ }
2475
2779
  /**
2476
2780
  * @public
2477
2781
  */
@@ -8649,441 +8953,3 @@ export interface CreateGrokClassifierRequest {
8649
8953
  */
8650
8954
  CustomPatterns?: string | undefined;
8651
8955
  }
8652
- /**
8653
- * <p>Specifies a JSON classifier for <code>CreateClassifier</code> to create.</p>
8654
- * @public
8655
- */
8656
- export interface CreateJsonClassifierRequest {
8657
- /**
8658
- * <p>The name of the classifier.</p>
8659
- * @public
8660
- */
8661
- Name: string | undefined;
8662
- /**
8663
- * <p>A <code>JsonPath</code> string defining the JSON data for the classifier to classify.
8664
- * Glue supports a subset of JsonPath, as described in <a href="https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json">Writing JsonPath Custom Classifiers</a>.</p>
8665
- * @public
8666
- */
8667
- JsonPath: string | undefined;
8668
- }
8669
- /**
8670
- * <p>Specifies an XML classifier for <code>CreateClassifier</code> to create.</p>
8671
- * @public
8672
- */
8673
- export interface CreateXMLClassifierRequest {
8674
- /**
8675
- * <p>An identifier of the data format that the classifier matches.</p>
8676
- * @public
8677
- */
8678
- Classification: string | undefined;
8679
- /**
8680
- * <p>The name of the classifier.</p>
8681
- * @public
8682
- */
8683
- Name: string | undefined;
8684
- /**
8685
- * <p>The XML tag designating the element that contains each record in an XML document being
8686
- * parsed. This can't identify a self-closing element (closed by <code>/></code>). An empty
8687
- * row element that contains only attributes can be parsed as long as it ends with a closing tag
8688
- * (for example, <code><row item_a="A" item_b="B"></row></code> is okay, but
8689
- * <code><row item_a="A" item_b="B" /></code> is not).</p>
8690
- * @public
8691
- */
8692
- RowTag?: string | undefined;
8693
- }
8694
- /**
8695
- * @public
8696
- */
8697
- export interface CreateClassifierRequest {
8698
- /**
8699
- * <p>A <code>GrokClassifier</code> object specifying the classifier
8700
- * to create.</p>
8701
- * @public
8702
- */
8703
- GrokClassifier?: CreateGrokClassifierRequest | undefined;
8704
- /**
8705
- * <p>An <code>XMLClassifier</code> object specifying the classifier
8706
- * to create.</p>
8707
- * @public
8708
- */
8709
- XMLClassifier?: CreateXMLClassifierRequest | undefined;
8710
- /**
8711
- * <p>A <code>JsonClassifier</code> object specifying the classifier
8712
- * to create.</p>
8713
- * @public
8714
- */
8715
- JsonClassifier?: CreateJsonClassifierRequest | undefined;
8716
- /**
8717
- * <p>A <code>CsvClassifier</code> object specifying the classifier
8718
- * to create.</p>
8719
- * @public
8720
- */
8721
- CsvClassifier?: CreateCsvClassifierRequest | undefined;
8722
- }
8723
- /**
8724
- * @public
8725
- */
8726
- export interface CreateClassifierResponse {
8727
- }
8728
- /**
8729
- * @public
8730
- */
8731
- export interface CreateColumnStatisticsTaskSettingsRequest {
8732
- /**
8733
- * <p>The name of the database where the table resides.</p>
8734
- * @public
8735
- */
8736
- DatabaseName: string | undefined;
8737
- /**
8738
- * <p>The name of the table for which to generate column statistics.</p>
8739
- * @public
8740
- */
8741
- TableName: string | undefined;
8742
- /**
8743
- * <p>The role used for running the column statistics.</p>
8744
- * @public
8745
- */
8746
- Role: string | undefined;
8747
- /**
8748
- * <p>A schedule for running the column statistics, specified in CRON syntax.</p>
8749
- * @public
8750
- */
8751
- Schedule?: string | undefined;
8752
- /**
8753
- * <p>A list of column names for which to run statistics.</p>
8754
- * @public
8755
- */
8756
- ColumnNameList?: string[] | undefined;
8757
- /**
8758
- * <p>The percentage of data to sample.</p>
8759
- * @public
8760
- */
8761
- SampleSize?: number | undefined;
8762
- /**
8763
- * <p>The ID of the Data Catalog in which the database resides.</p>
8764
- * @public
8765
- */
8766
- CatalogID?: string | undefined;
8767
- /**
8768
- * <p>Name of the security configuration that is used to encrypt CloudWatch logs.</p>
8769
- * @public
8770
- */
8771
- SecurityConfiguration?: string | undefined;
8772
- /**
8773
- * <p>A map of tags.</p>
8774
- * @public
8775
- */
8776
- Tags?: Record<string, string> | undefined;
8777
- }
8778
- /**
8779
- * @public
8780
- */
8781
- export interface CreateColumnStatisticsTaskSettingsResponse {
8782
- }
8783
- /**
8784
- * <p>The OAuth client app in GetConnection response.</p>
8785
- * @public
8786
- */
8787
- export interface PhysicalConnectionRequirements {
8788
- /**
8789
- * <p>The subnet ID used by the connection.</p>
8790
- * @public
8791
- */
8792
- SubnetId?: string | undefined;
8793
- /**
8794
- * <p>The security group ID list used by the connection.</p>
8795
- * @public
8796
- */
8797
- SecurityGroupIdList?: string[] | undefined;
8798
- /**
8799
- * <p>The connection's Availability Zone.</p>
8800
- * @public
8801
- */
8802
- AvailabilityZone?: string | undefined;
8803
- }
8804
- /**
8805
- * <p>A structure that is used to specify a connection to create or update.</p>
8806
- * @public
8807
- */
8808
- export interface ConnectionInput {
8809
- /**
8810
- * <p>The name of the connection.</p>
8811
- * @public
8812
- */
8813
- Name: string | undefined;
8814
- /**
8815
- * <p>The description of the connection.</p>
8816
- * @public
8817
- */
8818
- Description?: string | undefined;
8819
- /**
8820
- * <p>The type of the connection. Currently, these types are supported:</p>
8821
- * <ul>
8822
- * <li>
8823
- * <p>
8824
- * <code>JDBC</code> - Designates a connection to a database through Java Database Connectivity (JDBC).</p>
8825
- * <p>
8826
- * <code>JDBC</code> Connections use the following ConnectionParameters.</p>
8827
- * <ul>
8828
- * <li>
8829
- * <p>Required: All of (<code>HOST</code>, <code>PORT</code>, <code>JDBC_ENGINE</code>) or <code>JDBC_CONNECTION_URL</code>.</p>
8830
- * </li>
8831
- * <li>
8832
- * <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
8833
- * </li>
8834
- * <li>
8835
- * <p>Optional: <code>JDBC_ENFORCE_SSL</code>, <code>CUSTOM_JDBC_CERT</code>, <code>CUSTOM_JDBC_CERT_STRING</code>, <code>SKIP_CUSTOM_JDBC_CERT_VALIDATION</code>. These parameters are used to configure SSL with JDBC.</p>
8836
- * </li>
8837
- * </ul>
8838
- * </li>
8839
- * <li>
8840
- * <p>
8841
- * <code>KAFKA</code> - Designates a connection to an Apache Kafka streaming platform.</p>
8842
- * <p>
8843
- * <code>KAFKA</code> Connections use the following ConnectionParameters.</p>
8844
- * <ul>
8845
- * <li>
8846
- * <p>Required: <code>KAFKA_BOOTSTRAP_SERVERS</code>.</p>
8847
- * </li>
8848
- * <li>
8849
- * <p>Optional: <code>KAFKA_SSL_ENABLED</code>, <code>KAFKA_CUSTOM_CERT</code>, <code>KAFKA_SKIP_CUSTOM_CERT_VALIDATION</code>. These parameters are used to configure SSL with <code>KAFKA</code>.</p>
8850
- * </li>
8851
- * <li>
8852
- * <p>Optional: <code>KAFKA_CLIENT_KEYSTORE</code>, <code>KAFKA_CLIENT_KEYSTORE_PASSWORD</code>, <code>KAFKA_CLIENT_KEY_PASSWORD</code>, <code>ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD</code>, <code>ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD</code>. These parameters are used to configure TLS client configuration with SSL in <code>KAFKA</code>.</p>
8853
- * </li>
8854
- * <li>
8855
- * <p>Optional: <code>KAFKA_SASL_MECHANISM</code>. Can be specified as <code>SCRAM-SHA-512</code>, <code>GSSAPI</code>, or <code>AWS_MSK_IAM</code>.</p>
8856
- * </li>
8857
- * <li>
8858
- * <p>Optional: <code>KAFKA_SASL_SCRAM_USERNAME</code>, <code>KAFKA_SASL_SCRAM_PASSWORD</code>, <code>ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD</code>. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with <code>KAFKA</code>.</p>
8859
- * </li>
8860
- * <li>
8861
- * <p>Optional: <code>KAFKA_SASL_GSSAPI_KEYTAB</code>, <code>KAFKA_SASL_GSSAPI_KRB5_CONF</code>, <code>KAFKA_SASL_GSSAPI_SERVICE</code>, <code>KAFKA_SASL_GSSAPI_PRINCIPAL</code>. These parameters are used to configure SASL/GSSAPI authentication with <code>KAFKA</code>.</p>
8862
- * </li>
8863
- * </ul>
8864
- * </li>
8865
- * <li>
8866
- * <p>
8867
- * <code>MONGODB</code> - Designates a connection to a MongoDB document database.</p>
8868
- * <p>
8869
- * <code>MONGODB</code> Connections use the following ConnectionParameters.</p>
8870
- * <ul>
8871
- * <li>
8872
- * <p>Required: <code>CONNECTION_URL</code>.</p>
8873
- * </li>
8874
- * <li>
8875
- * <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
8876
- * </li>
8877
- * </ul>
8878
- * </li>
8879
- * <li>
8880
- * <p>
8881
- * <code>VIEW_VALIDATION_REDSHIFT</code> - Designates a connection used for view validation by Amazon Redshift.</p>
8882
- * </li>
8883
- * <li>
8884
- * <p>
8885
- * <code>VIEW_VALIDATION_ATHENA</code> - Designates a connection used for view validation by Amazon Athena.</p>
8886
- * </li>
8887
- * <li>
8888
- * <p>
8889
- * <code>NETWORK</code> - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).</p>
8890
- * <p>
8891
- * <code>NETWORK</code> Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.</p>
8892
- * </li>
8893
- * <li>
8894
- * <p>
8895
- * <code>MARKETPLACE</code> - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.</p>
8896
- * <p>
8897
- * <code>MARKETPLACE</code> Connections use the following ConnectionParameters.</p>
8898
- * <ul>
8899
- * <li>
8900
- * <p>Required: <code>CONNECTOR_TYPE</code>, <code>CONNECTOR_URL</code>, <code>CONNECTOR_CLASS_NAME</code>, <code>CONNECTION_URL</code>.</p>
8901
- * </li>
8902
- * <li>
8903
- * <p>Required for <code>JDBC</code>
8904
- * <code>CONNECTOR_TYPE</code> connections: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
8905
- * </li>
8906
- * </ul>
8907
- * </li>
8908
- * <li>
8909
- * <p>
8910
- * <code>CUSTOM</code> - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.</p>
8911
- * </li>
8912
- * </ul>
8913
- * <p>For more information on the connection parameters needed for a particular connector, see the documentation for the connector in <a href="https://docs.aws.amazon.com/glue/latest/dg/console-connections.html">Adding an Glue connection</a>in the Glue User Guide.</p>
8914
- * <p>
8915
- * <code>SFTP</code> is not supported.</p>
8916
- * <p>For more information about how optional ConnectionProperties are used to configure features in Glue, consult <a href="https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html">Glue connection properties</a>.</p>
8917
- * <p>For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult <a href="https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html">Using connectors and connections</a>.</p>
8918
- * @public
8919
- */
8920
- ConnectionType: ConnectionType | undefined;
8921
- /**
8922
- * <p>A list of criteria that can be used in selecting this connection.</p>
8923
- * @public
8924
- */
8925
- MatchCriteria?: string[] | undefined;
8926
- /**
8927
- * <p>These key-value pairs define parameters for the connection.</p>
8928
- * @public
8929
- */
8930
- ConnectionProperties: Partial<Record<ConnectionPropertyKey, string>> | undefined;
8931
- /**
8932
- * <p>Connection properties specific to the Spark compute environment.</p>
8933
- * @public
8934
- */
8935
- SparkProperties?: Record<string, string> | undefined;
8936
- /**
8937
- * <p>Connection properties specific to the Athena compute environment.</p>
8938
- * @public
8939
- */
8940
- AthenaProperties?: Record<string, string> | undefined;
8941
- /**
8942
- * <p>Connection properties specific to the Python compute environment.</p>
8943
- * @public
8944
- */
8945
- PythonProperties?: Record<string, string> | undefined;
8946
- /**
8947
- * <p>The physical connection requirements, such as virtual private cloud (VPC) and <code>SecurityGroup</code>, that are needed to successfully make this connection.</p>
8948
- * @public
8949
- */
8950
- PhysicalConnectionRequirements?: PhysicalConnectionRequirements | undefined;
8951
- /**
8952
- * <p>The authentication properties of the connection.</p>
8953
- * @public
8954
- */
8955
- AuthenticationConfiguration?: AuthenticationConfigurationInput | undefined;
8956
- /**
8957
- * <p>A flag to validate the credentials during create connection. Default is true. </p>
8958
- * @public
8959
- */
8960
- ValidateCredentials?: boolean | undefined;
8961
- /**
8962
- * <p>The compute environments that the specified connection properties are validated against.</p>
8963
- * @public
8964
- */
8965
- ValidateForComputeEnvironments?: ComputeEnvironment[] | undefined;
8966
- }
8967
- /**
8968
- * @public
8969
- */
8970
- export interface CreateConnectionRequest {
8971
- /**
8972
- * <p>The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services
8973
- * account ID is used by default.</p>
8974
- * @public
8975
- */
8976
- CatalogId?: string | undefined;
8977
- /**
8978
- * <p>A <code>ConnectionInput</code> object defining the connection
8979
- * to create.</p>
8980
- * @public
8981
- */
8982
- ConnectionInput: ConnectionInput | undefined;
8983
- /**
8984
- * <p>The tags you assign to the connection.</p>
8985
- * @public
8986
- */
8987
- Tags?: Record<string, string> | undefined;
8988
- }
8989
- /**
8990
- * @public
8991
- */
8992
- export interface CreateConnectionResponse {
8993
- /**
8994
- * <p>The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.</p>
8995
- * @public
8996
- */
8997
- CreateConnectionStatus?: ConnectionStatus | undefined;
8998
- }
8999
- /**
9000
- * @public
9001
- */
9002
- export interface CreateCrawlerRequest {
9003
- /**
9004
- * <p>Name of the new crawler.</p>
9005
- * @public
9006
- */
9007
- Name: string | undefined;
9008
- /**
9009
- * <p>The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to
9010
- * access customer resources.</p>
9011
- * @public
9012
- */
9013
- Role: string | undefined;
9014
- /**
9015
- * <p>The Glue database where results are written, such as:
9016
- * <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
9017
- * @public
9018
- */
9019
- DatabaseName?: string | undefined;
9020
- /**
9021
- * <p>A description of the new crawler.</p>
9022
- * @public
9023
- */
9024
- Description?: string | undefined;
9025
- /**
9026
- * <p>A list of collection of targets to crawl.</p>
9027
- * @public
9028
- */
9029
- Targets: CrawlerTargets | undefined;
9030
- /**
9031
- * <p>A <code>cron</code> expression used to specify the schedule (see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html">Time-Based Schedules for Jobs and Crawlers</a>. For example, to run
9032
- * something every day at 12:15 UTC, you would specify:
9033
- * <code>cron(15 12 * * ? *)</code>.</p>
9034
- * @public
9035
- */
9036
- Schedule?: string | undefined;
9037
- /**
9038
- * <p>A list of custom classifiers that the user has registered. By default, all built-in
9039
- * classifiers are included in a crawl, but these custom classifiers always override the default
9040
- * classifiers for a given classification.</p>
9041
- * @public
9042
- */
9043
- Classifiers?: string[] | undefined;
9044
- /**
9045
- * <p>The table prefix used for catalog tables that are created.</p>
9046
- * @public
9047
- */
9048
- TablePrefix?: string | undefined;
9049
- /**
9050
- * <p>The policy for the crawler's update and deletion behavior.</p>
9051
- * @public
9052
- */
9053
- SchemaChangePolicy?: SchemaChangePolicy | undefined;
9054
- /**
9055
- * <p>A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.</p>
9056
- * @public
9057
- */
9058
- RecrawlPolicy?: RecrawlPolicy | undefined;
9059
- /**
9060
- * <p>Specifies data lineage configuration settings for the crawler.</p>
9061
- * @public
9062
- */
9063
- LineageConfiguration?: LineageConfiguration | undefined;
9064
- /**
9065
- * <p>Specifies Lake Formation configuration settings for the crawler.</p>
9066
- * @public
9067
- */
9068
- LakeFormationConfiguration?: LakeFormationConfiguration | undefined;
9069
- /**
9070
- * <p>Crawler configuration information. This versioned JSON
9071
- * string allows users to specify aspects of a crawler's behavior.
9072
- * For more information, see <a href="https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html">Setting crawler configuration options</a>.</p>
9073
- * @public
9074
- */
9075
- Configuration?: string | undefined;
9076
- /**
9077
- * <p>The name of the <code>SecurityConfiguration</code> structure to be used by this
9078
- * crawler.</p>
9079
- * @public
9080
- */
9081
- CrawlerSecurityConfiguration?: string | undefined;
9082
- /**
9083
- * <p>The tags to use with this crawler request. You may use tags to limit access to the
9084
- * crawler. For more information about tags in Glue, see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html">Amazon Web Services Tags in Glue</a> in the developer
9085
- * guide.</p>
9086
- * @public
9087
- */
9088
- Tags?: Record<string, string> | undefined;
9089
- }