@aws-sdk/client-glue 3.1094.0 → 3.1096.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 (68) 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/runtimeConfig.browser.d.ts +2 -0
  38. package/dist-types/runtimeConfig.d.ts +2 -0
  39. package/dist-types/runtimeConfig.native.d.ts +2 -0
  40. package/dist-types/schemas/schemas_0.d.ts +12 -0
  41. package/dist-types/ts3.4/Glue.d.ts +17 -0
  42. package/dist-types/ts3.4/GlueClient.d.ts +6 -0
  43. package/dist-types/ts3.4/commands/BatchGetDataQualityRulesetEvaluationRunCommand.d.ts +42 -0
  44. package/dist-types/ts3.4/commands/CreateClassifierCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/CreateColumnStatisticsTaskSettingsCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/CreateConnectionCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/CreateCrawlerCommand.d.ts +1 -2
  48. package/dist-types/ts3.4/commands/GetDataQualityModelCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/GetDataQualityModelResultCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/GetDataQualityResultCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/GetDataQualityRuleRecommendationRunCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/GetDataQualityRulesetCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/SearchTablesCommand.d.ts +1 -2
  54. package/dist-types/ts3.4/commands/StartBlueprintRunCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/StartColumnStatisticsTaskRunCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/StartColumnStatisticsTaskRunScheduleCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/StartCrawlerCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  59. package/dist-types/ts3.4/models/enums.d.ts +33 -16
  60. package/dist-types/ts3.4/models/models_0.d.ts +74 -76
  61. package/dist-types/ts3.4/models/models_1.d.ts +80 -87
  62. package/dist-types/ts3.4/models/models_2.d.ts +91 -57
  63. package/dist-types/ts3.4/models/models_3.d.ts +55 -2
  64. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
  65. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
  66. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
  67. package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
  68. package/package.json +6 -6
@@ -1,6 +1,444 @@
1
1
  import type { DocumentType as __DocumentType } from "@smithy/types";
2
- import type { AllowFullTableExternalDataAccessEnum, AuthenticationType, BlueprintRunState, CatalogEncryptionMode, CloudWatchEncryptionMode, ColumnStatisticsState, ColumnStatisticsType, Compatibility, ComputationType, ComputeEnvironment, ConnectionPropertyKey, ConnectionStatus, ConnectionType, CsvHeaderOption, CsvSerdeOption, DatabaseAttributes, DataFormat, DataOperation, DataQualityEncryptionMode, DataQualityModelStatus, ExecutionStatus, FieldDataType, FieldFilterOperator, FunctionType, GlueResourceType, HTTPMethod, IcebergNullOrder, IcebergSortDirection, IcebergStructTypeEnum, InclusionAnnotationValue, IntegrationStatus, JobBookmarksEncryptionMode, Language, LastRefreshType, MetadataOperation, MLUserDataEncryptionModeString, PrincipalType, PropertyLocation, PropertyType, RegistryStatus, ResourceShareType, ResourceType, S3EncryptionMode, ScheduleType, SchemaStatus, SchemaVersionStatus, SessionStatus, SessionType, SettingSource, TableOptimizerType, TaskStatusType, TransformType, TriggerType, UnnestSpec, ViewDialect, WorkerType } from "./enums";
3
- import type { Action, AssetFormEntry, AssetTypeFormReference, AuthConfiguration, AuthenticationConfiguration, Blueprint, Column, ConnectionsList, Crawler, DataQualityAggregatedMetrics, DataQualityAnalyzerResult, DataQualityObservation, DataQualityRuleResult, DataSource, ErrorDetail, EventBatchingCondition, FederatedCatalog, GlueTable, PartitionInput, PhysicalConnectionRequirements, Predicate, PrincipalPermissions, Property, Schedule, SchemaId, StorageDescriptor, TableOptimizerConfiguration, TargetRedshiftCatalog } from "./models_0";
2
+ import type { AllowFullTableExternalDataAccessEnum, AuthenticationType, BlueprintRunState, CatalogEncryptionMode, CloudWatchEncryptionMode, ColumnStatisticsState, ColumnStatisticsType, Compatibility, ComputationType, ComputeEnvironment, ConnectionPropertyKey, ConnectionStatus, ConnectionType, CsvHeaderOption, CsvSerdeOption, DatabaseAttributes, DataFormat, DataOperation, DataQualityEncryptionMode, ExecutionStatus, FieldDataType, FieldFilterOperator, FunctionType, GlueResourceType, HTTPMethod, IcebergNullOrder, IcebergSortDirection, IcebergStructTypeEnum, IntegrationStatus, JobBookmarksEncryptionMode, Language, LastRefreshType, MetadataOperation, MLUserDataEncryptionModeString, PrincipalType, PropertyLocation, PropertyType, RegistryStatus, ResourceShareType, ResourceType, S3EncryptionMode, ScheduleType, SchemaStatus, SchemaVersionStatus, SessionStatus, SessionType, SettingSource, TableOptimizerType, TransformType, TriggerType, UnnestSpec, ViewDialect, WorkerType } from "./enums";
3
+ import type { Action, AssetFormEntry, AssetTypeFormReference, AuthConfiguration, AuthenticationConfiguration, AuthenticationConfigurationInput, Blueprint, Column, ConnectionsList, Crawler, CrawlerTargets, CreateCsvClassifierRequest, CreateGrokClassifierRequest, ErrorDetail, EventBatchingCondition, FederatedCatalog, GlueTable, LakeFormationConfiguration, LineageConfiguration, PartitionInput, Predicate, PrincipalPermissions, Property, RecrawlPolicy, Schedule, SchemaChangePolicy, SchemaId, StorageDescriptor, TableOptimizerConfiguration, TargetRedshiftCatalog } from "./models_0";
4
+ /**
5
+ * <p>Specifies a JSON classifier for <code>CreateClassifier</code> to create.</p>
6
+ * @public
7
+ */
8
+ export interface CreateJsonClassifierRequest {
9
+ /**
10
+ * <p>The name of the classifier.</p>
11
+ * @public
12
+ */
13
+ Name: string | undefined;
14
+ /**
15
+ * <p>A <code>JsonPath</code> string defining the JSON data for the classifier to classify.
16
+ * 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>
17
+ * @public
18
+ */
19
+ JsonPath: string | undefined;
20
+ }
21
+ /**
22
+ * <p>Specifies an XML classifier for <code>CreateClassifier</code> to create.</p>
23
+ * @public
24
+ */
25
+ export interface CreateXMLClassifierRequest {
26
+ /**
27
+ * <p>An identifier of the data format that the classifier matches.</p>
28
+ * @public
29
+ */
30
+ Classification: string | undefined;
31
+ /**
32
+ * <p>The name of the classifier.</p>
33
+ * @public
34
+ */
35
+ Name: string | undefined;
36
+ /**
37
+ * <p>The XML tag designating the element that contains each record in an XML document being
38
+ * parsed. This can't identify a self-closing element (closed by <code>/></code>). An empty
39
+ * row element that contains only attributes can be parsed as long as it ends with a closing tag
40
+ * (for example, <code><row item_a="A" item_b="B"></row></code> is okay, but
41
+ * <code><row item_a="A" item_b="B" /></code> is not).</p>
42
+ * @public
43
+ */
44
+ RowTag?: string | undefined;
45
+ }
46
+ /**
47
+ * @public
48
+ */
49
+ export interface CreateClassifierRequest {
50
+ /**
51
+ * <p>A <code>GrokClassifier</code> object specifying the classifier
52
+ * to create.</p>
53
+ * @public
54
+ */
55
+ GrokClassifier?: CreateGrokClassifierRequest | undefined;
56
+ /**
57
+ * <p>An <code>XMLClassifier</code> object specifying the classifier
58
+ * to create.</p>
59
+ * @public
60
+ */
61
+ XMLClassifier?: CreateXMLClassifierRequest | undefined;
62
+ /**
63
+ * <p>A <code>JsonClassifier</code> object specifying the classifier
64
+ * to create.</p>
65
+ * @public
66
+ */
67
+ JsonClassifier?: CreateJsonClassifierRequest | undefined;
68
+ /**
69
+ * <p>A <code>CsvClassifier</code> object specifying the classifier
70
+ * to create.</p>
71
+ * @public
72
+ */
73
+ CsvClassifier?: CreateCsvClassifierRequest | undefined;
74
+ }
75
+ /**
76
+ * @public
77
+ */
78
+ export interface CreateClassifierResponse {
79
+ }
80
+ /**
81
+ * @public
82
+ */
83
+ export interface CreateColumnStatisticsTaskSettingsRequest {
84
+ /**
85
+ * <p>The name of the database where the table resides.</p>
86
+ * @public
87
+ */
88
+ DatabaseName: string | undefined;
89
+ /**
90
+ * <p>The name of the table for which to generate column statistics.</p>
91
+ * @public
92
+ */
93
+ TableName: string | undefined;
94
+ /**
95
+ * <p>The role used for running the column statistics.</p>
96
+ * @public
97
+ */
98
+ Role: string | undefined;
99
+ /**
100
+ * <p>A schedule for running the column statistics, specified in CRON syntax.</p>
101
+ * @public
102
+ */
103
+ Schedule?: string | undefined;
104
+ /**
105
+ * <p>A list of column names for which to run statistics.</p>
106
+ * @public
107
+ */
108
+ ColumnNameList?: string[] | undefined;
109
+ /**
110
+ * <p>The percentage of data to sample.</p>
111
+ * @public
112
+ */
113
+ SampleSize?: number | undefined;
114
+ /**
115
+ * <p>The ID of the Data Catalog in which the database resides.</p>
116
+ * @public
117
+ */
118
+ CatalogID?: string | undefined;
119
+ /**
120
+ * <p>Name of the security configuration that is used to encrypt CloudWatch logs.</p>
121
+ * @public
122
+ */
123
+ SecurityConfiguration?: string | undefined;
124
+ /**
125
+ * <p>A map of tags.</p>
126
+ * @public
127
+ */
128
+ Tags?: Record<string, string> | undefined;
129
+ }
130
+ /**
131
+ * @public
132
+ */
133
+ export interface CreateColumnStatisticsTaskSettingsResponse {
134
+ }
135
+ /**
136
+ * <p>The OAuth client app in GetConnection response.</p>
137
+ * @public
138
+ */
139
+ export interface PhysicalConnectionRequirements {
140
+ /**
141
+ * <p>The subnet ID used by the connection.</p>
142
+ * @public
143
+ */
144
+ SubnetId?: string | undefined;
145
+ /**
146
+ * <p>The security group ID list used by the connection.</p>
147
+ * @public
148
+ */
149
+ SecurityGroupIdList?: string[] | undefined;
150
+ /**
151
+ * <p>The connection's Availability Zone.</p>
152
+ * @public
153
+ */
154
+ AvailabilityZone?: string | undefined;
155
+ }
156
+ /**
157
+ * <p>A structure that is used to specify a connection to create or update.</p>
158
+ * @public
159
+ */
160
+ export interface ConnectionInput {
161
+ /**
162
+ * <p>The name of the connection.</p>
163
+ * @public
164
+ */
165
+ Name: string | undefined;
166
+ /**
167
+ * <p>The description of the connection.</p>
168
+ * @public
169
+ */
170
+ Description?: string | undefined;
171
+ /**
172
+ * <p>The type of the connection. Currently, these types are supported:</p>
173
+ * <ul>
174
+ * <li>
175
+ * <p>
176
+ * <code>JDBC</code> - Designates a connection to a database through Java Database Connectivity (JDBC).</p>
177
+ * <p>
178
+ * <code>JDBC</code> Connections use the following ConnectionParameters.</p>
179
+ * <ul>
180
+ * <li>
181
+ * <p>Required: All of (<code>HOST</code>, <code>PORT</code>, <code>JDBC_ENGINE</code>) or <code>JDBC_CONNECTION_URL</code>.</p>
182
+ * </li>
183
+ * <li>
184
+ * <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
185
+ * </li>
186
+ * <li>
187
+ * <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>
188
+ * </li>
189
+ * </ul>
190
+ * </li>
191
+ * <li>
192
+ * <p>
193
+ * <code>KAFKA</code> - Designates a connection to an Apache Kafka streaming platform.</p>
194
+ * <p>
195
+ * <code>KAFKA</code> Connections use the following ConnectionParameters.</p>
196
+ * <ul>
197
+ * <li>
198
+ * <p>Required: <code>KAFKA_BOOTSTRAP_SERVERS</code>.</p>
199
+ * </li>
200
+ * <li>
201
+ * <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>
202
+ * </li>
203
+ * <li>
204
+ * <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>
205
+ * </li>
206
+ * <li>
207
+ * <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>
208
+ * </li>
209
+ * <li>
210
+ * <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>
211
+ * </li>
212
+ * <li>
213
+ * <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>
214
+ * </li>
215
+ * </ul>
216
+ * </li>
217
+ * <li>
218
+ * <p>
219
+ * <code>MONGODB</code> - Designates a connection to a MongoDB document database.</p>
220
+ * <p>
221
+ * <code>MONGODB</code> Connections use the following ConnectionParameters.</p>
222
+ * <ul>
223
+ * <li>
224
+ * <p>Required: <code>CONNECTION_URL</code>.</p>
225
+ * </li>
226
+ * <li>
227
+ * <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
228
+ * </li>
229
+ * </ul>
230
+ * </li>
231
+ * <li>
232
+ * <p>
233
+ * <code>VIEW_VALIDATION_REDSHIFT</code> - Designates a connection used for view validation by Amazon Redshift.</p>
234
+ * </li>
235
+ * <li>
236
+ * <p>
237
+ * <code>VIEW_VALIDATION_ATHENA</code> - Designates a connection used for view validation by Amazon Athena.</p>
238
+ * </li>
239
+ * <li>
240
+ * <p>
241
+ * <code>NETWORK</code> - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).</p>
242
+ * <p>
243
+ * <code>NETWORK</code> Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.</p>
244
+ * </li>
245
+ * <li>
246
+ * <p>
247
+ * <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>
248
+ * <p>
249
+ * <code>MARKETPLACE</code> Connections use the following ConnectionParameters.</p>
250
+ * <ul>
251
+ * <li>
252
+ * <p>Required: <code>CONNECTOR_TYPE</code>, <code>CONNECTOR_URL</code>, <code>CONNECTOR_CLASS_NAME</code>, <code>CONNECTION_URL</code>.</p>
253
+ * </li>
254
+ * <li>
255
+ * <p>Required for <code>JDBC</code>
256
+ * <code>CONNECTOR_TYPE</code> connections: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
257
+ * </li>
258
+ * </ul>
259
+ * </li>
260
+ * <li>
261
+ * <p>
262
+ * <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>
263
+ * </li>
264
+ * </ul>
265
+ * <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>
266
+ * <p>
267
+ * <code>SFTP</code> is not supported.</p>
268
+ * <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>
269
+ * <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>
270
+ * @public
271
+ */
272
+ ConnectionType: ConnectionType | undefined;
273
+ /**
274
+ * <p>A list of criteria that can be used in selecting this connection.</p>
275
+ * @public
276
+ */
277
+ MatchCriteria?: string[] | undefined;
278
+ /**
279
+ * <p>These key-value pairs define parameters for the connection.</p>
280
+ * @public
281
+ */
282
+ ConnectionProperties: Partial<Record<ConnectionPropertyKey, string>> | undefined;
283
+ /**
284
+ * <p>Connection properties specific to the Spark compute environment.</p>
285
+ * @public
286
+ */
287
+ SparkProperties?: Record<string, string> | undefined;
288
+ /**
289
+ * <p>Connection properties specific to the Athena compute environment.</p>
290
+ * @public
291
+ */
292
+ AthenaProperties?: Record<string, string> | undefined;
293
+ /**
294
+ * <p>Connection properties specific to the Python compute environment.</p>
295
+ * @public
296
+ */
297
+ PythonProperties?: Record<string, string> | undefined;
298
+ /**
299
+ * <p>The physical connection requirements, such as virtual private cloud (VPC) and <code>SecurityGroup</code>, that are needed to successfully make this connection.</p>
300
+ * @public
301
+ */
302
+ PhysicalConnectionRequirements?: PhysicalConnectionRequirements | undefined;
303
+ /**
304
+ * <p>The authentication properties of the connection.</p>
305
+ * @public
306
+ */
307
+ AuthenticationConfiguration?: AuthenticationConfigurationInput | undefined;
308
+ /**
309
+ * <p>A flag to validate the credentials during create connection. Default is true. </p>
310
+ * @public
311
+ */
312
+ ValidateCredentials?: boolean | undefined;
313
+ /**
314
+ * <p>The compute environments that the specified connection properties are validated against.</p>
315
+ * @public
316
+ */
317
+ ValidateForComputeEnvironments?: ComputeEnvironment[] | undefined;
318
+ }
319
+ /**
320
+ * @public
321
+ */
322
+ export interface CreateConnectionRequest {
323
+ /**
324
+ * <p>The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services
325
+ * account ID is used by default.</p>
326
+ * @public
327
+ */
328
+ CatalogId?: string | undefined;
329
+ /**
330
+ * <p>A <code>ConnectionInput</code> object defining the connection
331
+ * to create.</p>
332
+ * @public
333
+ */
334
+ ConnectionInput: ConnectionInput | undefined;
335
+ /**
336
+ * <p>The tags you assign to the connection.</p>
337
+ * @public
338
+ */
339
+ Tags?: Record<string, string> | undefined;
340
+ }
341
+ /**
342
+ * @public
343
+ */
344
+ export interface CreateConnectionResponse {
345
+ /**
346
+ * <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>
347
+ * @public
348
+ */
349
+ CreateConnectionStatus?: ConnectionStatus | undefined;
350
+ }
351
+ /**
352
+ * @public
353
+ */
354
+ export interface CreateCrawlerRequest {
355
+ /**
356
+ * <p>Name of the new crawler.</p>
357
+ * @public
358
+ */
359
+ Name: string | undefined;
360
+ /**
361
+ * <p>The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to
362
+ * access customer resources.</p>
363
+ * @public
364
+ */
365
+ Role: string | undefined;
366
+ /**
367
+ * <p>The Glue database where results are written, such as:
368
+ * <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
369
+ * @public
370
+ */
371
+ DatabaseName?: string | undefined;
372
+ /**
373
+ * <p>A description of the new crawler.</p>
374
+ * @public
375
+ */
376
+ Description?: string | undefined;
377
+ /**
378
+ * <p>A list of collection of targets to crawl.</p>
379
+ * @public
380
+ */
381
+ Targets: CrawlerTargets | undefined;
382
+ /**
383
+ * <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
384
+ * something every day at 12:15 UTC, you would specify:
385
+ * <code>cron(15 12 * * ? *)</code>.</p>
386
+ * @public
387
+ */
388
+ Schedule?: string | undefined;
389
+ /**
390
+ * <p>A list of custom classifiers that the user has registered. By default, all built-in
391
+ * classifiers are included in a crawl, but these custom classifiers always override the default
392
+ * classifiers for a given classification.</p>
393
+ * @public
394
+ */
395
+ Classifiers?: string[] | undefined;
396
+ /**
397
+ * <p>The table prefix used for catalog tables that are created.</p>
398
+ * @public
399
+ */
400
+ TablePrefix?: string | undefined;
401
+ /**
402
+ * <p>The policy for the crawler's update and deletion behavior.</p>
403
+ * @public
404
+ */
405
+ SchemaChangePolicy?: SchemaChangePolicy | undefined;
406
+ /**
407
+ * <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>
408
+ * @public
409
+ */
410
+ RecrawlPolicy?: RecrawlPolicy | undefined;
411
+ /**
412
+ * <p>Specifies data lineage configuration settings for the crawler.</p>
413
+ * @public
414
+ */
415
+ LineageConfiguration?: LineageConfiguration | undefined;
416
+ /**
417
+ * <p>Specifies Lake Formation configuration settings for the crawler.</p>
418
+ * @public
419
+ */
420
+ LakeFormationConfiguration?: LakeFormationConfiguration | undefined;
421
+ /**
422
+ * <p>Crawler configuration information. This versioned JSON
423
+ * string allows users to specify aspects of a crawler's behavior.
424
+ * For more information, see <a href="https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html">Setting crawler configuration options</a>.</p>
425
+ * @public
426
+ */
427
+ Configuration?: string | undefined;
428
+ /**
429
+ * <p>The name of the <code>SecurityConfiguration</code> structure to be used by this
430
+ * crawler.</p>
431
+ * @public
432
+ */
433
+ CrawlerSecurityConfiguration?: string | undefined;
434
+ /**
435
+ * <p>The tags to use with this crawler request. You may use tags to limit access to the
436
+ * 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
437
+ * guide.</p>
438
+ * @public
439
+ */
440
+ Tags?: Record<string, string> | undefined;
441
+ }
4
442
  /**
5
443
  * @public
6
444
  */
@@ -6955,343 +7393,3 @@ export interface GetDataflowGraphResponse {
6955
7393
  */
6956
7394
  DagEdges?: CodeGenEdge[] | undefined;
6957
7395
  }
6958
- /**
6959
- * @public
6960
- */
6961
- export interface GetDataQualityModelRequest {
6962
- /**
6963
- * <p>The Statistic ID.</p>
6964
- * @public
6965
- */
6966
- StatisticId?: string | undefined;
6967
- /**
6968
- * <p>The Profile ID.</p>
6969
- * @public
6970
- */
6971
- ProfileId: string | undefined;
6972
- }
6973
- /**
6974
- * @public
6975
- */
6976
- export interface GetDataQualityModelResponse {
6977
- /**
6978
- * <p>The training status of the data quality model.</p>
6979
- * @public
6980
- */
6981
- Status?: DataQualityModelStatus | undefined;
6982
- /**
6983
- * <p>The timestamp when the data quality model training started.</p>
6984
- * @public
6985
- */
6986
- StartedOn?: Date | undefined;
6987
- /**
6988
- * <p>The timestamp when the data quality model training completed.</p>
6989
- * @public
6990
- */
6991
- CompletedOn?: Date | undefined;
6992
- /**
6993
- * <p>The training failure reason.</p>
6994
- * @public
6995
- */
6996
- FailureReason?: string | undefined;
6997
- }
6998
- /**
6999
- * @public
7000
- */
7001
- export interface GetDataQualityModelResultRequest {
7002
- /**
7003
- * <p>The Statistic ID.</p>
7004
- * @public
7005
- */
7006
- StatisticId: string | undefined;
7007
- /**
7008
- * <p>The Profile ID.</p>
7009
- * @public
7010
- */
7011
- ProfileId: string | undefined;
7012
- }
7013
- /**
7014
- * <p>The statistic model result.</p>
7015
- * @public
7016
- */
7017
- export interface StatisticModelResult {
7018
- /**
7019
- * <p>The lower bound.</p>
7020
- * @public
7021
- */
7022
- LowerBound?: number | undefined;
7023
- /**
7024
- * <p>The upper bound.</p>
7025
- * @public
7026
- */
7027
- UpperBound?: number | undefined;
7028
- /**
7029
- * <p>The predicted value.</p>
7030
- * @public
7031
- */
7032
- PredictedValue?: number | undefined;
7033
- /**
7034
- * <p>The actual value.</p>
7035
- * @public
7036
- */
7037
- ActualValue?: number | undefined;
7038
- /**
7039
- * <p>The date.</p>
7040
- * @public
7041
- */
7042
- Date?: Date | undefined;
7043
- /**
7044
- * <p>The inclusion annotation.</p>
7045
- * @public
7046
- */
7047
- InclusionAnnotation?: InclusionAnnotationValue | undefined;
7048
- }
7049
- /**
7050
- * @public
7051
- */
7052
- export interface GetDataQualityModelResultResponse {
7053
- /**
7054
- * <p>The timestamp when the data quality model training completed.</p>
7055
- * @public
7056
- */
7057
- CompletedOn?: Date | undefined;
7058
- /**
7059
- * <p>A list of <code>StatisticModelResult</code>
7060
- * </p>
7061
- * @public
7062
- */
7063
- Model?: StatisticModelResult[] | undefined;
7064
- }
7065
- /**
7066
- * @public
7067
- */
7068
- export interface GetDataQualityResultRequest {
7069
- /**
7070
- * <p>A unique result ID for the data quality result.</p>
7071
- * @public
7072
- */
7073
- ResultId: string | undefined;
7074
- }
7075
- /**
7076
- * <p>The response for the data quality result.</p>
7077
- * @public
7078
- */
7079
- export interface GetDataQualityResultResponse {
7080
- /**
7081
- * <p>A unique result ID for the data quality result.</p>
7082
- * @public
7083
- */
7084
- ResultId?: string | undefined;
7085
- /**
7086
- * <p>The Profile ID for the data quality result.</p>
7087
- * @public
7088
- */
7089
- ProfileId?: string | undefined;
7090
- /**
7091
- * <p>An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.</p>
7092
- * @public
7093
- */
7094
- Score?: number | undefined;
7095
- /**
7096
- * <p>The table associated with the data quality result, if any.</p>
7097
- * @public
7098
- */
7099
- DataSource?: DataSource | undefined;
7100
- /**
7101
- * <p>The name of the ruleset associated with the data quality result.</p>
7102
- * @public
7103
- */
7104
- RulesetName?: string | undefined;
7105
- /**
7106
- * <p>In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the <code>evaluationContext</code> can differentiate the nodes.</p>
7107
- * @public
7108
- */
7109
- EvaluationContext?: string | undefined;
7110
- /**
7111
- * <p>The date and time when the run for this data quality result started.</p>
7112
- * @public
7113
- */
7114
- StartedOn?: Date | undefined;
7115
- /**
7116
- * <p>The date and time when the run for this data quality result was completed.</p>
7117
- * @public
7118
- */
7119
- CompletedOn?: Date | undefined;
7120
- /**
7121
- * <p>The job name associated with the data quality result, if any.</p>
7122
- * @public
7123
- */
7124
- JobName?: string | undefined;
7125
- /**
7126
- * <p>The job run ID associated with the data quality result, if any.</p>
7127
- * @public
7128
- */
7129
- JobRunId?: string | undefined;
7130
- /**
7131
- * <p>The unique run ID associated with the ruleset evaluation.</p>
7132
- * @public
7133
- */
7134
- RulesetEvaluationRunId?: string | undefined;
7135
- /**
7136
- * <p>A list of <code>DataQualityRuleResult</code> objects representing the results for each rule. </p>
7137
- * @public
7138
- */
7139
- RuleResults?: DataQualityRuleResult[] | undefined;
7140
- /**
7141
- * <p>A list of <code>DataQualityAnalyzerResult</code> objects representing the results for each analyzer. </p>
7142
- * @public
7143
- */
7144
- AnalyzerResults?: DataQualityAnalyzerResult[] | undefined;
7145
- /**
7146
- * <p>A list of <code>DataQualityObservation</code> objects representing the observations generated after evaluating the rules and analyzers. </p>
7147
- * @public
7148
- */
7149
- Observations?: DataQualityObservation[] | undefined;
7150
- /**
7151
- * <p> A summary of <code>DataQualityAggregatedMetrics</code> objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results. </p>
7152
- * @public
7153
- */
7154
- AggregatedMetrics?: DataQualityAggregatedMetrics | undefined;
7155
- }
7156
- /**
7157
- * @public
7158
- */
7159
- export interface GetDataQualityRuleRecommendationRunRequest {
7160
- /**
7161
- * <p>The unique run identifier associated with this run.</p>
7162
- * @public
7163
- */
7164
- RunId: string | undefined;
7165
- }
7166
- /**
7167
- * <p>The response for the Data Quality rule recommendation run.</p>
7168
- * @public
7169
- */
7170
- export interface GetDataQualityRuleRecommendationRunResponse {
7171
- /**
7172
- * <p>The unique run identifier associated with this run.</p>
7173
- * @public
7174
- */
7175
- RunId?: string | undefined;
7176
- /**
7177
- * <p>The data source (an Glue table) associated with this run.</p>
7178
- * @public
7179
- */
7180
- DataSource?: DataSource | undefined;
7181
- /**
7182
- * <p>An IAM role supplied to encrypt the results of the run.</p>
7183
- * @public
7184
- */
7185
- Role?: string | undefined;
7186
- /**
7187
- * <p>The number of <code>G.1X</code> workers to be used in the run. The default is 5.</p>
7188
- * @public
7189
- */
7190
- NumberOfWorkers?: number | undefined;
7191
- /**
7192
- * <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>
7193
- * @public
7194
- */
7195
- Timeout?: number | undefined;
7196
- /**
7197
- * <p>The status for this run.</p>
7198
- * @public
7199
- */
7200
- Status?: TaskStatusType | undefined;
7201
- /**
7202
- * <p>The error strings that are associated with the run.</p>
7203
- * @public
7204
- */
7205
- ErrorString?: string | undefined;
7206
- /**
7207
- * <p>The date and time when this run started.</p>
7208
- * @public
7209
- */
7210
- StartedOn?: Date | undefined;
7211
- /**
7212
- * <p>A timestamp. The last point in time when this data quality rule recommendation run was modified.</p>
7213
- * @public
7214
- */
7215
- LastModifiedOn?: Date | undefined;
7216
- /**
7217
- * <p>The date and time when this run was completed.</p>
7218
- * @public
7219
- */
7220
- CompletedOn?: Date | undefined;
7221
- /**
7222
- * <p>The amount of time (in seconds) that the run consumed resources.</p>
7223
- * @public
7224
- */
7225
- ExecutionTime?: number | undefined;
7226
- /**
7227
- * <p>When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.</p>
7228
- * @public
7229
- */
7230
- RecommendedRuleset?: string | undefined;
7231
- /**
7232
- * <p>The name of the ruleset that was created by the run.</p>
7233
- * @public
7234
- */
7235
- CreatedRulesetName?: string | undefined;
7236
- /**
7237
- * <p>The name of the security configuration created with the data quality encryption option.</p>
7238
- * @public
7239
- */
7240
- DataQualitySecurityConfiguration?: string | undefined;
7241
- }
7242
- /**
7243
- * @public
7244
- */
7245
- export interface GetDataQualityRulesetRequest {
7246
- /**
7247
- * <p>The name of the ruleset.</p>
7248
- * @public
7249
- */
7250
- Name: string | undefined;
7251
- }
7252
- /**
7253
- * <p>Returns the data quality ruleset response.</p>
7254
- * @public
7255
- */
7256
- export interface GetDataQualityRulesetResponse {
7257
- /**
7258
- * <p>The name of the ruleset.</p>
7259
- * @public
7260
- */
7261
- Name?: string | undefined;
7262
- /**
7263
- * <p>A description of the ruleset.</p>
7264
- * @public
7265
- */
7266
- Description?: string | undefined;
7267
- /**
7268
- * <p>A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.</p>
7269
- * @public
7270
- */
7271
- Ruleset?: string | undefined;
7272
- /**
7273
- * <p>The name and database name of the target table.</p>
7274
- * @public
7275
- */
7276
- TargetTable?: DataQualityTargetTable | undefined;
7277
- /**
7278
- * <p>A timestamp. The time and date that this data quality ruleset was created.</p>
7279
- * @public
7280
- */
7281
- CreatedOn?: Date | undefined;
7282
- /**
7283
- * <p>A timestamp. The last point in time when this data quality ruleset was modified.</p>
7284
- * @public
7285
- */
7286
- LastModifiedOn?: Date | undefined;
7287
- /**
7288
- * <p>When a ruleset was created from a recommendation run, this run ID is generated to link the two together.</p>
7289
- * @public
7290
- */
7291
- RecommendationRunId?: string | undefined;
7292
- /**
7293
- * <p>The name of the security configuration created with the data quality encryption option.</p>
7294
- * @public
7295
- */
7296
- DataQualitySecurityConfiguration?: string | undefined;
7297
- }