@aws-sdk/client-glue 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,14 +7,17 @@ import { ColumnStatistics, Compatibility, DataCatalogEncryptionSettings, DataQua
7
7
  */
8
8
  export interface GetUnfilteredPartitionMetadataResponse {
9
9
  /**
10
+ * @public
10
11
  * <p>A Partition object containing the partition metadata.</p>
11
12
  */
12
13
  Partition?: Partition;
13
14
  /**
15
+ * @public
14
16
  * <p>A list of column names that the user has been granted access to.</p>
15
17
  */
16
18
  AuthorizedColumns?: string[];
17
19
  /**
20
+ * @public
18
21
  * <p>A Boolean value that indicates whether the partition location is registered
19
22
  * with Lake Formation.</p>
20
23
  */
@@ -28,6 +31,7 @@ export declare class PermissionTypeMismatchException extends __BaseException {
28
31
  readonly name: "PermissionTypeMismatchException";
29
32
  readonly $fault: "client";
30
33
  /**
34
+ * @public
31
35
  * <p>There is a mismatch between the SupportedPermissionType used in the query request
32
36
  * and the permissions defined on the target table.</p>
33
37
  */
@@ -42,19 +46,23 @@ export declare class PermissionTypeMismatchException extends __BaseException {
42
46
  */
43
47
  export interface GetUnfilteredPartitionsMetadataRequest {
44
48
  /**
49
+ * @public
45
50
  * <p>The ID of the Data Catalog where the partitions in question reside. If none is provided,
46
51
  * the AWS account ID is used by default. </p>
47
52
  */
48
53
  CatalogId: string | undefined;
49
54
  /**
55
+ * @public
50
56
  * <p>The name of the catalog database where the partitions reside.</p>
51
57
  */
52
58
  DatabaseName: string | undefined;
53
59
  /**
60
+ * @public
54
61
  * <p>The name of the table that contains the partition.</p>
55
62
  */
56
63
  TableName: string | undefined;
57
64
  /**
65
+ * @public
58
66
  * <p>An expression that filters the partitions to be returned.</p>
59
67
  * <p>The expression uses SQL syntax similar to the SQL <code>WHERE</code> filter clause. The
60
68
  * SQL statement parser <a href="http://jsqlparser.sourceforge.net/home.php">JSQLParser</a> parses the expression. </p>
@@ -158,23 +166,28 @@ export interface GetUnfilteredPartitionsMetadataRequest {
158
166
  */
159
167
  Expression?: string;
160
168
  /**
169
+ * @public
161
170
  * <p>A structure containing Lake Formation audit context information.</p>
162
171
  */
163
172
  AuditContext?: AuditContext;
164
173
  /**
174
+ * @public
165
175
  * <p>A list of supported permission types. </p>
166
176
  */
167
177
  SupportedPermissionTypes: (PermissionType | string)[] | undefined;
168
178
  /**
179
+ * @public
169
180
  * <p>A continuation token, if this is not the first call to retrieve
170
181
  * these partitions.</p>
171
182
  */
172
183
  NextToken?: string;
173
184
  /**
185
+ * @public
174
186
  * <p>The segment of the table's partitions to scan in this request.</p>
175
187
  */
176
188
  Segment?: Segment;
177
189
  /**
190
+ * @public
178
191
  * <p>The maximum number of partitions to return in a single response.</p>
179
192
  */
180
193
  MaxResults?: number;
@@ -185,14 +198,17 @@ export interface GetUnfilteredPartitionsMetadataRequest {
185
198
  */
186
199
  export interface UnfilteredPartition {
187
200
  /**
201
+ * @public
188
202
  * <p>The partition object.</p>
189
203
  */
190
204
  Partition?: Partition;
191
205
  /**
206
+ * @public
192
207
  * <p>The list of columns the user has permissions to access.</p>
193
208
  */
194
209
  AuthorizedColumns?: string[];
195
210
  /**
211
+ * @public
196
212
  * <p>A Boolean value indicating that the partition location is registered with Lake Formation.</p>
197
213
  */
198
214
  IsRegisteredWithLakeFormation?: boolean;
@@ -202,10 +218,12 @@ export interface UnfilteredPartition {
202
218
  */
203
219
  export interface GetUnfilteredPartitionsMetadataResponse {
204
220
  /**
221
+ * @public
205
222
  * <p>A list of requested partitions.</p>
206
223
  */
207
224
  UnfilteredPartitions?: UnfilteredPartition[];
208
225
  /**
226
+ * @public
209
227
  * <p>A continuation token, if the returned list of partitions does not include the last
210
228
  * one.</p>
211
229
  */
@@ -216,22 +234,27 @@ export interface GetUnfilteredPartitionsMetadataResponse {
216
234
  */
217
235
  export interface GetUnfilteredTableMetadataRequest {
218
236
  /**
237
+ * @public
219
238
  * <p>The catalog ID where the table resides.</p>
220
239
  */
221
240
  CatalogId: string | undefined;
222
241
  /**
242
+ * @public
223
243
  * <p>(Required) Specifies the name of a database that contains the table.</p>
224
244
  */
225
245
  DatabaseName: string | undefined;
226
246
  /**
247
+ * @public
227
248
  * <p>(Required) Specifies the name of a table for which you are requesting metadata.</p>
228
249
  */
229
250
  Name: string | undefined;
230
251
  /**
252
+ * @public
231
253
  * <p>A structure containing Lake Formation audit context information.</p>
232
254
  */
233
255
  AuditContext?: AuditContext;
234
256
  /**
257
+ * @public
235
258
  * <p>(Required) A list of supported permission types. </p>
236
259
  */
237
260
  SupportedPermissionTypes: (PermissionType | string)[] | undefined;
@@ -242,10 +265,12 @@ export interface GetUnfilteredTableMetadataRequest {
242
265
  */
243
266
  export interface ColumnRowFilter {
244
267
  /**
268
+ * @public
245
269
  * <p>A string containing the name of the column.</p>
246
270
  */
247
271
  ColumnName?: string;
248
272
  /**
273
+ * @public
249
274
  * <p>A string containing the row-level filter expression.</p>
250
275
  */
251
276
  RowFilterExpression?: string;
@@ -255,19 +280,23 @@ export interface ColumnRowFilter {
255
280
  */
256
281
  export interface GetUnfilteredTableMetadataResponse {
257
282
  /**
283
+ * @public
258
284
  * <p>A Table object containing the table metadata.</p>
259
285
  */
260
286
  Table?: Table;
261
287
  /**
288
+ * @public
262
289
  * <p>A list of column names that the user has been granted access to.</p>
263
290
  */
264
291
  AuthorizedColumns?: string[];
265
292
  /**
293
+ * @public
266
294
  * <p>A Boolean value that indicates whether the partition location is registered
267
295
  * with Lake Formation.</p>
268
296
  */
269
297
  IsRegisteredWithLakeFormation?: boolean;
270
298
  /**
299
+ * @public
271
300
  * <p>A list of column row filters.</p>
272
301
  */
273
302
  CellFilters?: ColumnRowFilter[];
@@ -277,15 +306,18 @@ export interface GetUnfilteredTableMetadataResponse {
277
306
  */
278
307
  export interface GetUserDefinedFunctionRequest {
279
308
  /**
309
+ * @public
280
310
  * <p>The ID of the Data Catalog where the function to be retrieved is located. If none is
281
311
  * provided, the Amazon Web Services account ID is used by default.</p>
282
312
  */
283
313
  CatalogId?: string;
284
314
  /**
315
+ * @public
285
316
  * <p>The name of the catalog database where the function is located.</p>
286
317
  */
287
318
  DatabaseName: string | undefined;
288
319
  /**
320
+ * @public
289
321
  * <p>The name of the function.</p>
290
322
  */
291
323
  FunctionName: string | undefined;
@@ -297,34 +329,42 @@ export interface GetUserDefinedFunctionRequest {
297
329
  */
298
330
  export interface UserDefinedFunction {
299
331
  /**
332
+ * @public
300
333
  * <p>The name of the function.</p>
301
334
  */
302
335
  FunctionName?: string;
303
336
  /**
337
+ * @public
304
338
  * <p>The name of the catalog database that contains the function.</p>
305
339
  */
306
340
  DatabaseName?: string;
307
341
  /**
342
+ * @public
308
343
  * <p>The Java class that contains the function code.</p>
309
344
  */
310
345
  ClassName?: string;
311
346
  /**
347
+ * @public
312
348
  * <p>The owner of the function.</p>
313
349
  */
314
350
  OwnerName?: string;
315
351
  /**
352
+ * @public
316
353
  * <p>The owner type.</p>
317
354
  */
318
355
  OwnerType?: PrincipalType | string;
319
356
  /**
357
+ * @public
320
358
  * <p>The time at which the function was created.</p>
321
359
  */
322
360
  CreateTime?: Date;
323
361
  /**
362
+ * @public
324
363
  * <p>The resource URIs for the function.</p>
325
364
  */
326
365
  ResourceUris?: ResourceUri[];
327
366
  /**
367
+ * @public
328
368
  * <p>The ID of the Data Catalog in which the function resides.</p>
329
369
  */
330
370
  CatalogId?: string;
@@ -334,6 +374,7 @@ export interface UserDefinedFunction {
334
374
  */
335
375
  export interface GetUserDefinedFunctionResponse {
336
376
  /**
377
+ * @public
337
378
  * <p>The requested function definition.</p>
338
379
  */
339
380
  UserDefinedFunction?: UserDefinedFunction;
@@ -343,25 +384,30 @@ export interface GetUserDefinedFunctionResponse {
343
384
  */
344
385
  export interface GetUserDefinedFunctionsRequest {
345
386
  /**
387
+ * @public
346
388
  * <p>The ID of the Data Catalog where the functions to be retrieved are located. If none is
347
389
  * provided, the Amazon Web Services account ID is used by default.</p>
348
390
  */
349
391
  CatalogId?: string;
350
392
  /**
393
+ * @public
351
394
  * <p>The name of the catalog database where the functions are located. If none is provided, functions from all the
352
395
  * databases across the catalog will be returned.</p>
353
396
  */
354
397
  DatabaseName?: string;
355
398
  /**
399
+ * @public
356
400
  * <p>An optional function-name pattern string that filters the function
357
401
  * definitions returned.</p>
358
402
  */
359
403
  Pattern: string | undefined;
360
404
  /**
405
+ * @public
361
406
  * <p>A continuation token, if this is a continuation call.</p>
362
407
  */
363
408
  NextToken?: string;
364
409
  /**
410
+ * @public
365
411
  * <p>The maximum number of functions to return in one response.</p>
366
412
  */
367
413
  MaxResults?: number;
@@ -371,10 +417,12 @@ export interface GetUserDefinedFunctionsRequest {
371
417
  */
372
418
  export interface GetUserDefinedFunctionsResponse {
373
419
  /**
420
+ * @public
374
421
  * <p>A list of requested function definitions.</p>
375
422
  */
376
423
  UserDefinedFunctions?: UserDefinedFunction[];
377
424
  /**
425
+ * @public
378
426
  * <p>A continuation token, if the list of functions returned does
379
427
  * not include the last requested function.</p>
380
428
  */
@@ -385,10 +433,12 @@ export interface GetUserDefinedFunctionsResponse {
385
433
  */
386
434
  export interface GetWorkflowRequest {
387
435
  /**
436
+ * @public
388
437
  * <p>The name of the workflow to retrieve.</p>
389
438
  */
390
439
  Name: string | undefined;
391
440
  /**
441
+ * @public
392
442
  * <p>Specifies whether to include a graph when returning the workflow resource metadata.</p>
393
443
  */
394
444
  IncludeGraph?: boolean;
@@ -398,6 +448,7 @@ export interface GetWorkflowRequest {
398
448
  */
399
449
  export interface GetWorkflowResponse {
400
450
  /**
451
+ * @public
401
452
  * <p>The resource metadata for the workflow.</p>
402
453
  */
403
454
  Workflow?: Workflow;
@@ -407,14 +458,17 @@ export interface GetWorkflowResponse {
407
458
  */
408
459
  export interface GetWorkflowRunRequest {
409
460
  /**
461
+ * @public
410
462
  * <p>Name of the workflow being run.</p>
411
463
  */
412
464
  Name: string | undefined;
413
465
  /**
466
+ * @public
414
467
  * <p>The ID of the workflow run.</p>
415
468
  */
416
469
  RunId: string | undefined;
417
470
  /**
471
+ * @public
418
472
  * <p>Specifies whether to include the workflow graph in response or not.</p>
419
473
  */
420
474
  IncludeGraph?: boolean;
@@ -424,6 +478,7 @@ export interface GetWorkflowRunRequest {
424
478
  */
425
479
  export interface GetWorkflowRunResponse {
426
480
  /**
481
+ * @public
427
482
  * <p>The requested workflow run metadata.</p>
428
483
  */
429
484
  Run?: WorkflowRun;
@@ -433,10 +488,12 @@ export interface GetWorkflowRunResponse {
433
488
  */
434
489
  export interface GetWorkflowRunPropertiesRequest {
435
490
  /**
491
+ * @public
436
492
  * <p>Name of the workflow which was run.</p>
437
493
  */
438
494
  Name: string | undefined;
439
495
  /**
496
+ * @public
440
497
  * <p>The ID of the workflow run whose run properties should be returned.</p>
441
498
  */
442
499
  RunId: string | undefined;
@@ -446,6 +503,7 @@ export interface GetWorkflowRunPropertiesRequest {
446
503
  */
447
504
  export interface GetWorkflowRunPropertiesResponse {
448
505
  /**
506
+ * @public
449
507
  * <p>The workflow run properties which were set during the specified run.</p>
450
508
  */
451
509
  RunProperties?: Record<string, string>;
@@ -455,18 +513,22 @@ export interface GetWorkflowRunPropertiesResponse {
455
513
  */
456
514
  export interface GetWorkflowRunsRequest {
457
515
  /**
516
+ * @public
458
517
  * <p>Name of the workflow whose metadata of runs should be returned.</p>
459
518
  */
460
519
  Name: string | undefined;
461
520
  /**
521
+ * @public
462
522
  * <p>Specifies whether to include the workflow graph in response or not.</p>
463
523
  */
464
524
  IncludeGraph?: boolean;
465
525
  /**
526
+ * @public
466
527
  * <p>The maximum size of the response.</p>
467
528
  */
468
529
  NextToken?: string;
469
530
  /**
531
+ * @public
470
532
  * <p>The maximum number of workflow runs to be included in the response.</p>
471
533
  */
472
534
  MaxResults?: number;
@@ -476,10 +538,12 @@ export interface GetWorkflowRunsRequest {
476
538
  */
477
539
  export interface GetWorkflowRunsResponse {
478
540
  /**
541
+ * @public
479
542
  * <p>A list of workflow run metadata objects.</p>
480
543
  */
481
544
  Runs?: WorkflowRun[];
482
545
  /**
546
+ * @public
483
547
  * <p>A continuation token, if not all requested workflow runs have been returned.</p>
484
548
  */
485
549
  NextToken?: string;
@@ -489,6 +553,7 @@ export interface GetWorkflowRunsResponse {
489
553
  */
490
554
  export interface ImportCatalogToGlueRequest {
491
555
  /**
556
+ * @public
492
557
  * <p>The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.</p>
493
558
  */
494
559
  CatalogId?: string;
@@ -503,14 +568,17 @@ export interface ImportCatalogToGlueResponse {
503
568
  */
504
569
  export interface ListBlueprintsRequest {
505
570
  /**
571
+ * @public
506
572
  * <p>A continuation token, if this is a continuation request.</p>
507
573
  */
508
574
  NextToken?: string;
509
575
  /**
576
+ * @public
510
577
  * <p>The maximum size of a list to return.</p>
511
578
  */
512
579
  MaxResults?: number;
513
580
  /**
581
+ * @public
514
582
  * <p>Filters the list by an Amazon Web Services resource tag.</p>
515
583
  */
516
584
  Tags?: Record<string, string>;
@@ -520,10 +588,12 @@ export interface ListBlueprintsRequest {
520
588
  */
521
589
  export interface ListBlueprintsResponse {
522
590
  /**
591
+ * @public
523
592
  * <p>List of names of blueprints in the account.</p>
524
593
  */
525
594
  Blueprints?: string[];
526
595
  /**
596
+ * @public
527
597
  * <p>A continuation token, if not all blueprint names have been returned.</p>
528
598
  */
529
599
  NextToken?: string;
@@ -533,14 +603,17 @@ export interface ListBlueprintsResponse {
533
603
  */
534
604
  export interface ListCrawlersRequest {
535
605
  /**
606
+ * @public
536
607
  * <p>The maximum size of a list to return.</p>
537
608
  */
538
609
  MaxResults?: number;
539
610
  /**
611
+ * @public
540
612
  * <p>A continuation token, if this is a continuation request.</p>
541
613
  */
542
614
  NextToken?: string;
543
615
  /**
616
+ * @public
544
617
  * <p>Specifies to return only these tagged resources.</p>
545
618
  */
546
619
  Tags?: Record<string, string>;
@@ -550,10 +623,12 @@ export interface ListCrawlersRequest {
550
623
  */
551
624
  export interface ListCrawlersResponse {
552
625
  /**
626
+ * @public
553
627
  * <p>The names of all crawlers in the account, or the crawlers with the specified tags.</p>
554
628
  */
555
629
  CrawlerNames?: string[];
556
630
  /**
631
+ * @public
557
632
  * <p>A continuation token, if the returned list does not contain the
558
633
  * last metric available.</p>
559
634
  */
@@ -596,6 +671,7 @@ export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator
596
671
  */
597
672
  export interface CrawlsFilter {
598
673
  /**
674
+ * @public
599
675
  * <p>A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:</p>
600
676
  * <ul>
601
677
  * <li>
@@ -618,6 +694,7 @@ export interface CrawlsFilter {
618
694
  */
619
695
  FieldName?: FieldName | string;
620
696
  /**
697
+ * @public
621
698
  * <p>A defined comparator that operates on the value. The available operators are:</p>
622
699
  * <ul>
623
700
  * <li>
@@ -648,6 +725,7 @@ export interface CrawlsFilter {
648
725
  */
649
726
  FilterOperator?: FilterOperator | string;
650
727
  /**
728
+ * @public
651
729
  * <p>The value provided for comparison on the crawl field. </p>
652
730
  */
653
731
  FieldValue?: string;
@@ -657,18 +735,22 @@ export interface CrawlsFilter {
657
735
  */
658
736
  export interface ListCrawlsRequest {
659
737
  /**
738
+ * @public
660
739
  * <p>The name of the crawler whose runs you want to retrieve.</p>
661
740
  */
662
741
  CrawlerName: string | undefined;
663
742
  /**
743
+ * @public
664
744
  * <p>The maximum number of results to return. The default is 20, and maximum is 100.</p>
665
745
  */
666
746
  MaxResults?: number;
667
747
  /**
748
+ * @public
668
749
  * <p>Filters the crawls by the criteria you specify in a list of <code>CrawlsFilter</code> objects.</p>
669
750
  */
670
751
  Filters?: CrawlsFilter[];
671
752
  /**
753
+ * @public
672
754
  * <p>A continuation token, if this is a continuation call.</p>
673
755
  */
674
756
  NextToken?: string;
@@ -693,42 +775,52 @@ export type CrawlerHistoryState = (typeof CrawlerHistoryState)[keyof typeof Craw
693
775
  */
694
776
  export interface CrawlerHistory {
695
777
  /**
778
+ * @public
696
779
  * <p>A UUID identifier for each crawl.</p>
697
780
  */
698
781
  CrawlId?: string;
699
782
  /**
783
+ * @public
700
784
  * <p>The state of the crawl.</p>
701
785
  */
702
786
  State?: CrawlerHistoryState | string;
703
787
  /**
788
+ * @public
704
789
  * <p>The date and time on which the crawl started.</p>
705
790
  */
706
791
  StartTime?: Date;
707
792
  /**
793
+ * @public
708
794
  * <p>The date and time on which the crawl ended.</p>
709
795
  */
710
796
  EndTime?: Date;
711
797
  /**
798
+ * @public
712
799
  * <p>A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.</p>
713
800
  */
714
801
  Summary?: string;
715
802
  /**
803
+ * @public
716
804
  * <p>If an error occurred, the error message associated with the crawl.</p>
717
805
  */
718
806
  ErrorMessage?: string;
719
807
  /**
808
+ * @public
720
809
  * <p>The log group associated with the crawl.</p>
721
810
  */
722
811
  LogGroup?: string;
723
812
  /**
813
+ * @public
724
814
  * <p>The log stream associated with the crawl.</p>
725
815
  */
726
816
  LogStream?: string;
727
817
  /**
818
+ * @public
728
819
  * <p>The prefix for a CloudWatch message about this crawl.</p>
729
820
  */
730
821
  MessagePrefix?: string;
731
822
  /**
823
+ * @public
732
824
  * <p>The number of data processing units (DPU) used in hours for the crawl.</p>
733
825
  */
734
826
  DPUHour?: number;
@@ -738,10 +830,12 @@ export interface CrawlerHistory {
738
830
  */
739
831
  export interface ListCrawlsResponse {
740
832
  /**
833
+ * @public
741
834
  * <p>A list of <code>CrawlerHistory</code> objects representing the crawl runs that meet your criteria.</p>
742
835
  */
743
836
  Crawls?: CrawlerHistory[];
744
837
  /**
838
+ * @public
745
839
  * <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
746
840
  */
747
841
  NextToken?: string;
@@ -751,14 +845,17 @@ export interface ListCrawlsResponse {
751
845
  */
752
846
  export interface ListCustomEntityTypesRequest {
753
847
  /**
848
+ * @public
754
849
  * <p>A paginated token to offset the results.</p>
755
850
  */
756
851
  NextToken?: string;
757
852
  /**
853
+ * @public
758
854
  * <p>The maximum number of results to return.</p>
759
855
  */
760
856
  MaxResults?: number;
761
857
  /**
858
+ * @public
762
859
  * <p>A list of key-value pair tags.</p>
763
860
  */
764
861
  Tags?: Record<string, string>;
@@ -768,10 +865,12 @@ export interface ListCustomEntityTypesRequest {
768
865
  */
769
866
  export interface ListCustomEntityTypesResponse {
770
867
  /**
868
+ * @public
771
869
  * <p>A list of <code>CustomEntityType</code> objects representing custom patterns.</p>
772
870
  */
773
871
  CustomEntityTypes?: CustomEntityType[];
774
872
  /**
873
+ * @public
775
874
  * <p>A pagination token, if more results are available.</p>
776
875
  */
777
876
  NextToken?: string;
@@ -782,22 +881,27 @@ export interface ListCustomEntityTypesResponse {
782
881
  */
783
882
  export interface DataQualityResultFilterCriteria {
784
883
  /**
884
+ * @public
785
885
  * <p>Filter results by the specified data source. For example, retrieving all results for an Glue table.</p>
786
886
  */
787
887
  DataSource?: DataSource;
788
888
  /**
889
+ * @public
789
890
  * <p>Filter results by the specified job name.</p>
790
891
  */
791
892
  JobName?: string;
792
893
  /**
894
+ * @public
793
895
  * <p>Filter results by the specified job run ID.</p>
794
896
  */
795
897
  JobRunId?: string;
796
898
  /**
899
+ * @public
797
900
  * <p>Filter results by runs that started after this time.</p>
798
901
  */
799
902
  StartedAfter?: Date;
800
903
  /**
904
+ * @public
801
905
  * <p>Filter results by runs that started before this time.</p>
802
906
  */
803
907
  StartedBefore?: Date;
@@ -807,14 +911,17 @@ export interface DataQualityResultFilterCriteria {
807
911
  */
808
912
  export interface ListDataQualityResultsRequest {
809
913
  /**
914
+ * @public
810
915
  * <p>The filter criteria.</p>
811
916
  */
812
917
  Filter?: DataQualityResultFilterCriteria;
813
918
  /**
919
+ * @public
814
920
  * <p>A paginated token to offset the results.</p>
815
921
  */
816
922
  NextToken?: string;
817
923
  /**
924
+ * @public
818
925
  * <p>The maximum number of results to return.</p>
819
926
  */
820
927
  MaxResults?: number;
@@ -825,22 +932,27 @@ export interface ListDataQualityResultsRequest {
825
932
  */
826
933
  export interface DataQualityResultDescription {
827
934
  /**
935
+ * @public
828
936
  * <p>The unique result ID for this data quality result.</p>
829
937
  */
830
938
  ResultId?: string;
831
939
  /**
940
+ * @public
832
941
  * <p>The table name associated with the data quality result.</p>
833
942
  */
834
943
  DataSource?: DataSource;
835
944
  /**
945
+ * @public
836
946
  * <p>The job name associated with the data quality result.</p>
837
947
  */
838
948
  JobName?: string;
839
949
  /**
950
+ * @public
840
951
  * <p>The job run ID associated with the data quality result.</p>
841
952
  */
842
953
  JobRunId?: string;
843
954
  /**
955
+ * @public
844
956
  * <p>The time that the run started for this data quality result.</p>
845
957
  */
846
958
  StartedOn?: Date;
@@ -850,10 +962,12 @@ export interface DataQualityResultDescription {
850
962
  */
851
963
  export interface ListDataQualityResultsResponse {
852
964
  /**
965
+ * @public
853
966
  * <p>A list of <code>DataQualityResultDescription</code> objects.</p>
854
967
  */
855
968
  Results: DataQualityResultDescription[] | undefined;
856
969
  /**
970
+ * @public
857
971
  * <p>A pagination token, if more results are available.</p>
858
972
  */
859
973
  NextToken?: string;
@@ -864,14 +978,17 @@ export interface ListDataQualityResultsResponse {
864
978
  */
865
979
  export interface DataQualityRuleRecommendationRunFilter {
866
980
  /**
981
+ * @public
867
982
  * <p>Filter based on a specified data source (Glue table).</p>
868
983
  */
869
984
  DataSource: DataSource | undefined;
870
985
  /**
986
+ * @public
871
987
  * <p>Filter based on time for results started before provided time.</p>
872
988
  */
873
989
  StartedBefore?: Date;
874
990
  /**
991
+ * @public
875
992
  * <p>Filter based on time for results started after provided time.</p>
876
993
  */
877
994
  StartedAfter?: Date;
@@ -881,14 +998,17 @@ export interface DataQualityRuleRecommendationRunFilter {
881
998
  */
882
999
  export interface ListDataQualityRuleRecommendationRunsRequest {
883
1000
  /**
1001
+ * @public
884
1002
  * <p>The filter criteria.</p>
885
1003
  */
886
1004
  Filter?: DataQualityRuleRecommendationRunFilter;
887
1005
  /**
1006
+ * @public
888
1007
  * <p>A paginated token to offset the results.</p>
889
1008
  */
890
1009
  NextToken?: string;
891
1010
  /**
1011
+ * @public
892
1012
  * <p>The maximum number of results to return.</p>
893
1013
  */
894
1014
  MaxResults?: number;
@@ -899,18 +1019,22 @@ export interface ListDataQualityRuleRecommendationRunsRequest {
899
1019
  */
900
1020
  export interface DataQualityRuleRecommendationRunDescription {
901
1021
  /**
1022
+ * @public
902
1023
  * <p>The unique run identifier associated with this run.</p>
903
1024
  */
904
1025
  RunId?: string;
905
1026
  /**
1027
+ * @public
906
1028
  * <p>The status for this run.</p>
907
1029
  */
908
1030
  Status?: TaskStatusType | string;
909
1031
  /**
1032
+ * @public
910
1033
  * <p>The date and time when this run started.</p>
911
1034
  */
912
1035
  StartedOn?: Date;
913
1036
  /**
1037
+ * @public
914
1038
  * <p>The data source (Glue table) associated with the recommendation run.</p>
915
1039
  */
916
1040
  DataSource?: DataSource;
@@ -920,10 +1044,12 @@ export interface DataQualityRuleRecommendationRunDescription {
920
1044
  */
921
1045
  export interface ListDataQualityRuleRecommendationRunsResponse {
922
1046
  /**
1047
+ * @public
923
1048
  * <p>A list of <code>DataQualityRuleRecommendationRunDescription</code> objects.</p>
924
1049
  */
925
1050
  Runs?: DataQualityRuleRecommendationRunDescription[];
926
1051
  /**
1052
+ * @public
927
1053
  * <p>A pagination token, if more results are available.</p>
928
1054
  */
929
1055
  NextToken?: string;
@@ -934,14 +1060,17 @@ export interface ListDataQualityRuleRecommendationRunsResponse {
934
1060
  */
935
1061
  export interface DataQualityRulesetEvaluationRunFilter {
936
1062
  /**
1063
+ * @public
937
1064
  * <p>Filter based on a data source (an Glue table) associated with the run.</p>
938
1065
  */
939
1066
  DataSource: DataSource | undefined;
940
1067
  /**
1068
+ * @public
941
1069
  * <p>Filter results by runs that started before this time.</p>
942
1070
  */
943
1071
  StartedBefore?: Date;
944
1072
  /**
1073
+ * @public
945
1074
  * <p>Filter results by runs that started after this time.</p>
946
1075
  */
947
1076
  StartedAfter?: Date;
@@ -951,14 +1080,17 @@ export interface DataQualityRulesetEvaluationRunFilter {
951
1080
  */
952
1081
  export interface ListDataQualityRulesetEvaluationRunsRequest {
953
1082
  /**
1083
+ * @public
954
1084
  * <p>The filter criteria.</p>
955
1085
  */
956
1086
  Filter?: DataQualityRulesetEvaluationRunFilter;
957
1087
  /**
1088
+ * @public
958
1089
  * <p>A paginated token to offset the results.</p>
959
1090
  */
960
1091
  NextToken?: string;
961
1092
  /**
1093
+ * @public
962
1094
  * <p>The maximum number of results to return.</p>
963
1095
  */
964
1096
  MaxResults?: number;
@@ -969,18 +1101,22 @@ export interface ListDataQualityRulesetEvaluationRunsRequest {
969
1101
  */
970
1102
  export interface DataQualityRulesetEvaluationRunDescription {
971
1103
  /**
1104
+ * @public
972
1105
  * <p>The unique run identifier associated with this run.</p>
973
1106
  */
974
1107
  RunId?: string;
975
1108
  /**
1109
+ * @public
976
1110
  * <p>The status for this run.</p>
977
1111
  */
978
1112
  Status?: TaskStatusType | string;
979
1113
  /**
1114
+ * @public
980
1115
  * <p>The date and time when the run started.</p>
981
1116
  */
982
1117
  StartedOn?: Date;
983
1118
  /**
1119
+ * @public
984
1120
  * <p>The data source (an Glue table) associated with the run.</p>
985
1121
  */
986
1122
  DataSource?: DataSource;
@@ -990,10 +1126,12 @@ export interface DataQualityRulesetEvaluationRunDescription {
990
1126
  */
991
1127
  export interface ListDataQualityRulesetEvaluationRunsResponse {
992
1128
  /**
1129
+ * @public
993
1130
  * <p>A list of <code>DataQualityRulesetEvaluationRunDescription</code> objects representing data quality ruleset runs.</p>
994
1131
  */
995
1132
  Runs?: DataQualityRulesetEvaluationRunDescription[];
996
1133
  /**
1134
+ * @public
997
1135
  * <p>A pagination token, if more results are available.</p>
998
1136
  */
999
1137
  NextToken?: string;
@@ -1004,30 +1142,37 @@ export interface ListDataQualityRulesetEvaluationRunsResponse {
1004
1142
  */
1005
1143
  export interface DataQualityRulesetFilterCriteria {
1006
1144
  /**
1145
+ * @public
1007
1146
  * <p>The name of the ruleset filter criteria.</p>
1008
1147
  */
1009
1148
  Name?: string;
1010
1149
  /**
1150
+ * @public
1011
1151
  * <p>The description of the ruleset filter criteria.</p>
1012
1152
  */
1013
1153
  Description?: string;
1014
1154
  /**
1155
+ * @public
1015
1156
  * <p>Filter on rulesets created before this date.</p>
1016
1157
  */
1017
1158
  CreatedBefore?: Date;
1018
1159
  /**
1160
+ * @public
1019
1161
  * <p>Filter on rulesets created after this date.</p>
1020
1162
  */
1021
1163
  CreatedAfter?: Date;
1022
1164
  /**
1165
+ * @public
1023
1166
  * <p>Filter on rulesets last modified before this date.</p>
1024
1167
  */
1025
1168
  LastModifiedBefore?: Date;
1026
1169
  /**
1170
+ * @public
1027
1171
  * <p>Filter on rulesets last modified after this date.</p>
1028
1172
  */
1029
1173
  LastModifiedAfter?: Date;
1030
1174
  /**
1175
+ * @public
1031
1176
  * <p>The name and database name of the target table.</p>
1032
1177
  */
1033
1178
  TargetTable?: DataQualityTargetTable;
@@ -1037,18 +1182,22 @@ export interface DataQualityRulesetFilterCriteria {
1037
1182
  */
1038
1183
  export interface ListDataQualityRulesetsRequest {
1039
1184
  /**
1185
+ * @public
1040
1186
  * <p>A paginated token to offset the results.</p>
1041
1187
  */
1042
1188
  NextToken?: string;
1043
1189
  /**
1190
+ * @public
1044
1191
  * <p>The maximum number of results to return.</p>
1045
1192
  */
1046
1193
  MaxResults?: number;
1047
1194
  /**
1195
+ * @public
1048
1196
  * <p>The filter criteria. </p>
1049
1197
  */
1050
1198
  Filter?: DataQualityRulesetFilterCriteria;
1051
1199
  /**
1200
+ * @public
1052
1201
  * <p>A list of key-value pair tags.</p>
1053
1202
  */
1054
1203
  Tags?: Record<string, string>;
@@ -1059,30 +1208,37 @@ export interface ListDataQualityRulesetsRequest {
1059
1208
  */
1060
1209
  export interface DataQualityRulesetListDetails {
1061
1210
  /**
1211
+ * @public
1062
1212
  * <p>The name of the data quality ruleset.</p>
1063
1213
  */
1064
1214
  Name?: string;
1065
1215
  /**
1216
+ * @public
1066
1217
  * <p>A description of the data quality ruleset.</p>
1067
1218
  */
1068
1219
  Description?: string;
1069
1220
  /**
1221
+ * @public
1070
1222
  * <p>The date and time the data quality ruleset was created.</p>
1071
1223
  */
1072
1224
  CreatedOn?: Date;
1073
1225
  /**
1226
+ * @public
1074
1227
  * <p>The date and time the data quality ruleset was last modified.</p>
1075
1228
  */
1076
1229
  LastModifiedOn?: Date;
1077
1230
  /**
1231
+ * @public
1078
1232
  * <p>An object representing an Glue table.</p>
1079
1233
  */
1080
1234
  TargetTable?: DataQualityTargetTable;
1081
1235
  /**
1236
+ * @public
1082
1237
  * <p>When a ruleset was created from a recommendation run, this run ID is generated to link the two together.</p>
1083
1238
  */
1084
1239
  RecommendationRunId?: string;
1085
1240
  /**
1241
+ * @public
1086
1242
  * <p>The number of rules in the ruleset.</p>
1087
1243
  */
1088
1244
  RuleCount?: number;
@@ -1092,10 +1248,12 @@ export interface DataQualityRulesetListDetails {
1092
1248
  */
1093
1249
  export interface ListDataQualityRulesetsResponse {
1094
1250
  /**
1251
+ * @public
1095
1252
  * <p>A paginated list of rulesets for the specified list of Glue tables.</p>
1096
1253
  */
1097
1254
  Rulesets?: DataQualityRulesetListDetails[];
1098
1255
  /**
1256
+ * @public
1099
1257
  * <p>A pagination token, if more results are available.</p>
1100
1258
  */
1101
1259
  NextToken?: string;
@@ -1105,14 +1263,17 @@ export interface ListDataQualityRulesetsResponse {
1105
1263
  */
1106
1264
  export interface ListDevEndpointsRequest {
1107
1265
  /**
1266
+ * @public
1108
1267
  * <p>A continuation token, if this is a continuation request.</p>
1109
1268
  */
1110
1269
  NextToken?: string;
1111
1270
  /**
1271
+ * @public
1112
1272
  * <p>The maximum size of a list to return.</p>
1113
1273
  */
1114
1274
  MaxResults?: number;
1115
1275
  /**
1276
+ * @public
1116
1277
  * <p>Specifies to return only these tagged resources.</p>
1117
1278
  */
1118
1279
  Tags?: Record<string, string>;
@@ -1122,11 +1283,13 @@ export interface ListDevEndpointsRequest {
1122
1283
  */
1123
1284
  export interface ListDevEndpointsResponse {
1124
1285
  /**
1286
+ * @public
1125
1287
  * <p>The names of all the <code>DevEndpoint</code>s in the account, or the
1126
1288
  * <code>DevEndpoint</code>s with the specified tags.</p>
1127
1289
  */
1128
1290
  DevEndpointNames?: string[];
1129
1291
  /**
1292
+ * @public
1130
1293
  * <p>A continuation token, if the returned list does not contain the
1131
1294
  * last metric available.</p>
1132
1295
  */
@@ -1137,14 +1300,17 @@ export interface ListDevEndpointsResponse {
1137
1300
  */
1138
1301
  export interface ListJobsRequest {
1139
1302
  /**
1303
+ * @public
1140
1304
  * <p>A continuation token, if this is a continuation request.</p>
1141
1305
  */
1142
1306
  NextToken?: string;
1143
1307
  /**
1308
+ * @public
1144
1309
  * <p>The maximum size of a list to return.</p>
1145
1310
  */
1146
1311
  MaxResults?: number;
1147
1312
  /**
1313
+ * @public
1148
1314
  * <p>Specifies to return only these tagged resources.</p>
1149
1315
  */
1150
1316
  Tags?: Record<string, string>;
@@ -1154,10 +1320,12 @@ export interface ListJobsRequest {
1154
1320
  */
1155
1321
  export interface ListJobsResponse {
1156
1322
  /**
1323
+ * @public
1157
1324
  * <p>The names of all jobs in the account, or the jobs with the specified tags.</p>
1158
1325
  */
1159
1326
  JobNames?: string[];
1160
1327
  /**
1328
+ * @public
1161
1329
  * <p>A continuation token, if the returned list does not contain the
1162
1330
  * last metric available.</p>
1163
1331
  */
@@ -1168,22 +1336,27 @@ export interface ListJobsResponse {
1168
1336
  */
1169
1337
  export interface ListMLTransformsRequest {
1170
1338
  /**
1339
+ * @public
1171
1340
  * <p>A continuation token, if this is a continuation request.</p>
1172
1341
  */
1173
1342
  NextToken?: string;
1174
1343
  /**
1344
+ * @public
1175
1345
  * <p>The maximum size of a list to return.</p>
1176
1346
  */
1177
1347
  MaxResults?: number;
1178
1348
  /**
1349
+ * @public
1179
1350
  * <p>A <code>TransformFilterCriteria</code> used to filter the machine learning transforms.</p>
1180
1351
  */
1181
1352
  Filter?: TransformFilterCriteria;
1182
1353
  /**
1354
+ * @public
1183
1355
  * <p>A <code>TransformSortCriteria</code> used to sort the machine learning transforms.</p>
1184
1356
  */
1185
1357
  Sort?: TransformSortCriteria;
1186
1358
  /**
1359
+ * @public
1187
1360
  * <p>Specifies to return only these tagged resources.</p>
1188
1361
  */
1189
1362
  Tags?: Record<string, string>;
@@ -1193,11 +1366,13 @@ export interface ListMLTransformsRequest {
1193
1366
  */
1194
1367
  export interface ListMLTransformsResponse {
1195
1368
  /**
1369
+ * @public
1196
1370
  * <p>The identifiers of all the machine learning transforms in the account, or the
1197
1371
  * machine learning transforms with the specified tags.</p>
1198
1372
  */
1199
1373
  TransformIds: string[] | undefined;
1200
1374
  /**
1375
+ * @public
1201
1376
  * <p>A continuation token, if the returned list does not contain the
1202
1377
  * last metric available.</p>
1203
1378
  */
@@ -1208,10 +1383,12 @@ export interface ListMLTransformsResponse {
1208
1383
  */
1209
1384
  export interface ListRegistriesInput {
1210
1385
  /**
1386
+ * @public
1211
1387
  * <p>Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.</p>
1212
1388
  */
1213
1389
  MaxResults?: number;
1214
1390
  /**
1391
+ * @public
1215
1392
  * <p>A continuation token, if this is a continuation call.</p>
1216
1393
  */
1217
1394
  NextToken?: string;
@@ -1222,26 +1399,32 @@ export interface ListRegistriesInput {
1222
1399
  */
1223
1400
  export interface RegistryListItem {
1224
1401
  /**
1402
+ * @public
1225
1403
  * <p>The name of the registry.</p>
1226
1404
  */
1227
1405
  RegistryName?: string;
1228
1406
  /**
1407
+ * @public
1229
1408
  * <p>The Amazon Resource Name (ARN) of the registry.</p>
1230
1409
  */
1231
1410
  RegistryArn?: string;
1232
1411
  /**
1412
+ * @public
1233
1413
  * <p>A description of the registry.</p>
1234
1414
  */
1235
1415
  Description?: string;
1236
1416
  /**
1417
+ * @public
1237
1418
  * <p>The status of the registry.</p>
1238
1419
  */
1239
1420
  Status?: RegistryStatus | string;
1240
1421
  /**
1422
+ * @public
1241
1423
  * <p>The data the registry was created.</p>
1242
1424
  */
1243
1425
  CreatedTime?: string;
1244
1426
  /**
1427
+ * @public
1245
1428
  * <p>The date the registry was updated.</p>
1246
1429
  */
1247
1430
  UpdatedTime?: string;
@@ -1251,10 +1434,12 @@ export interface RegistryListItem {
1251
1434
  */
1252
1435
  export interface ListRegistriesResponse {
1253
1436
  /**
1437
+ * @public
1254
1438
  * <p>An array of <code>RegistryDetailedListItem</code> objects containing minimal details of each registry.</p>
1255
1439
  */
1256
1440
  Registries?: RegistryListItem[];
1257
1441
  /**
1442
+ * @public
1258
1443
  * <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
1259
1444
  */
1260
1445
  NextToken?: string;
@@ -1264,14 +1449,17 @@ export interface ListRegistriesResponse {
1264
1449
  */
1265
1450
  export interface ListSchemasInput {
1266
1451
  /**
1452
+ * @public
1267
1453
  * <p>A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).</p>
1268
1454
  */
1269
1455
  RegistryId?: RegistryId;
1270
1456
  /**
1457
+ * @public
1271
1458
  * <p>Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.</p>
1272
1459
  */
1273
1460
  MaxResults?: number;
1274
1461
  /**
1462
+ * @public
1275
1463
  * <p>A continuation token, if this is a continuation call.</p>
1276
1464
  */
1277
1465
  NextToken?: string;
@@ -1282,30 +1470,37 @@ export interface ListSchemasInput {
1282
1470
  */
1283
1471
  export interface SchemaListItem {
1284
1472
  /**
1473
+ * @public
1285
1474
  * <p>the name of the registry where the schema resides.</p>
1286
1475
  */
1287
1476
  RegistryName?: string;
1288
1477
  /**
1478
+ * @public
1289
1479
  * <p>The name of the schema.</p>
1290
1480
  */
1291
1481
  SchemaName?: string;
1292
1482
  /**
1483
+ * @public
1293
1484
  * <p>The Amazon Resource Name (ARN) for the schema.</p>
1294
1485
  */
1295
1486
  SchemaArn?: string;
1296
1487
  /**
1488
+ * @public
1297
1489
  * <p>A description for the schema.</p>
1298
1490
  */
1299
1491
  Description?: string;
1300
1492
  /**
1493
+ * @public
1301
1494
  * <p>The status of the schema.</p>
1302
1495
  */
1303
1496
  SchemaStatus?: SchemaStatus | string;
1304
1497
  /**
1498
+ * @public
1305
1499
  * <p>The date and time that a schema was created.</p>
1306
1500
  */
1307
1501
  CreatedTime?: string;
1308
1502
  /**
1503
+ * @public
1309
1504
  * <p>The date and time that a schema was updated.</p>
1310
1505
  */
1311
1506
  UpdatedTime?: string;
@@ -1315,10 +1510,12 @@ export interface SchemaListItem {
1315
1510
  */
1316
1511
  export interface ListSchemasResponse {
1317
1512
  /**
1513
+ * @public
1318
1514
  * <p>An array of <code>SchemaListItem</code> objects containing details of each schema.</p>
1319
1515
  */
1320
1516
  Schemas?: SchemaListItem[];
1321
1517
  /**
1518
+ * @public
1322
1519
  * <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
1323
1520
  */
1324
1521
  NextToken?: string;
@@ -1328,6 +1525,7 @@ export interface ListSchemasResponse {
1328
1525
  */
1329
1526
  export interface ListSchemaVersionsInput {
1330
1527
  /**
1528
+ * @public
1331
1529
  * <p>This is a wrapper structure to contain schema identity fields. The structure contains:</p>
1332
1530
  * <ul>
1333
1531
  * <li>
@@ -1340,10 +1538,12 @@ export interface ListSchemaVersionsInput {
1340
1538
  */
1341
1539
  SchemaId: SchemaId | undefined;
1342
1540
  /**
1541
+ * @public
1343
1542
  * <p>Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.</p>
1344
1543
  */
1345
1544
  MaxResults?: number;
1346
1545
  /**
1546
+ * @public
1347
1547
  * <p>A continuation token, if this is a continuation call.</p>
1348
1548
  */
1349
1549
  NextToken?: string;
@@ -1354,22 +1554,27 @@ export interface ListSchemaVersionsInput {
1354
1554
  */
1355
1555
  export interface SchemaVersionListItem {
1356
1556
  /**
1557
+ * @public
1357
1558
  * <p>The Amazon Resource Name (ARN) of the schema.</p>
1358
1559
  */
1359
1560
  SchemaArn?: string;
1360
1561
  /**
1562
+ * @public
1361
1563
  * <p>The unique identifier of the schema version.</p>
1362
1564
  */
1363
1565
  SchemaVersionId?: string;
1364
1566
  /**
1567
+ * @public
1365
1568
  * <p>The version number of the schema.</p>
1366
1569
  */
1367
1570
  VersionNumber?: number;
1368
1571
  /**
1572
+ * @public
1369
1573
  * <p>The status of the schema version.</p>
1370
1574
  */
1371
1575
  Status?: SchemaVersionStatus | string;
1372
1576
  /**
1577
+ * @public
1373
1578
  * <p>The date and time the schema version was created.</p>
1374
1579
  */
1375
1580
  CreatedTime?: string;
@@ -1379,10 +1584,12 @@ export interface SchemaVersionListItem {
1379
1584
  */
1380
1585
  export interface ListSchemaVersionsResponse {
1381
1586
  /**
1587
+ * @public
1382
1588
  * <p>An array of <code>SchemaVersionList</code> objects containing details of each schema version.</p>
1383
1589
  */
1384
1590
  Schemas?: SchemaVersionListItem[];
1385
1591
  /**
1592
+ * @public
1386
1593
  * <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
1387
1594
  */
1388
1595
  NextToken?: string;
@@ -1392,18 +1599,22 @@ export interface ListSchemaVersionsResponse {
1392
1599
  */
1393
1600
  export interface ListSessionsRequest {
1394
1601
  /**
1602
+ * @public
1395
1603
  * <p>The token for the next set of results, or null if there are no more result. </p>
1396
1604
  */
1397
1605
  NextToken?: string;
1398
1606
  /**
1607
+ * @public
1399
1608
  * <p>The maximum number of results. </p>
1400
1609
  */
1401
1610
  MaxResults?: number;
1402
1611
  /**
1612
+ * @public
1403
1613
  * <p>Tags belonging to the session. </p>
1404
1614
  */
1405
1615
  Tags?: Record<string, string>;
1406
1616
  /**
1617
+ * @public
1407
1618
  * <p>The origin of the request. </p>
1408
1619
  */
1409
1620
  RequestOrigin?: string;
@@ -1413,14 +1624,17 @@ export interface ListSessionsRequest {
1413
1624
  */
1414
1625
  export interface ListSessionsResponse {
1415
1626
  /**
1627
+ * @public
1416
1628
  * <p>Returns the ID of the session. </p>
1417
1629
  */
1418
1630
  Ids?: string[];
1419
1631
  /**
1632
+ * @public
1420
1633
  * <p>Returns the session object. </p>
1421
1634
  */
1422
1635
  Sessions?: Session[];
1423
1636
  /**
1637
+ * @public
1424
1638
  * <p>The token for the next set of results, or null if there are no more result. </p>
1425
1639
  */
1426
1640
  NextToken?: string;
@@ -1430,14 +1644,17 @@ export interface ListSessionsResponse {
1430
1644
  */
1431
1645
  export interface ListStatementsRequest {
1432
1646
  /**
1647
+ * @public
1433
1648
  * <p>The Session ID of the statements.</p>
1434
1649
  */
1435
1650
  SessionId: string | undefined;
1436
1651
  /**
1652
+ * @public
1437
1653
  * <p>The origin of the request to list statements.</p>
1438
1654
  */
1439
1655
  RequestOrigin?: string;
1440
1656
  /**
1657
+ * @public
1441
1658
  * <p>A continuation token, if this is a continuation call.</p>
1442
1659
  */
1443
1660
  NextToken?: string;
@@ -1447,10 +1664,12 @@ export interface ListStatementsRequest {
1447
1664
  */
1448
1665
  export interface ListStatementsResponse {
1449
1666
  /**
1667
+ * @public
1450
1668
  * <p>Returns the list of statements.</p>
1451
1669
  */
1452
1670
  Statements?: Statement[];
1453
1671
  /**
1672
+ * @public
1454
1673
  * <p>A continuation token, if not all statements have yet been returned.</p>
1455
1674
  */
1456
1675
  NextToken?: string;
@@ -1460,19 +1679,23 @@ export interface ListStatementsResponse {
1460
1679
  */
1461
1680
  export interface ListTriggersRequest {
1462
1681
  /**
1682
+ * @public
1463
1683
  * <p>A continuation token, if this is a continuation request.</p>
1464
1684
  */
1465
1685
  NextToken?: string;
1466
1686
  /**
1687
+ * @public
1467
1688
  * <p> The name of the job for which to retrieve triggers. The trigger that can start this job
1468
1689
  * is returned. If there is no such trigger, all triggers are returned.</p>
1469
1690
  */
1470
1691
  DependentJobName?: string;
1471
1692
  /**
1693
+ * @public
1472
1694
  * <p>The maximum size of a list to return.</p>
1473
1695
  */
1474
1696
  MaxResults?: number;
1475
1697
  /**
1698
+ * @public
1476
1699
  * <p>Specifies to return only these tagged resources.</p>
1477
1700
  */
1478
1701
  Tags?: Record<string, string>;
@@ -1482,10 +1705,12 @@ export interface ListTriggersRequest {
1482
1705
  */
1483
1706
  export interface ListTriggersResponse {
1484
1707
  /**
1708
+ * @public
1485
1709
  * <p>The names of all triggers in the account, or the triggers with the specified tags.</p>
1486
1710
  */
1487
1711
  TriggerNames?: string[];
1488
1712
  /**
1713
+ * @public
1489
1714
  * <p>A continuation token, if the returned list does not contain the
1490
1715
  * last metric available.</p>
1491
1716
  */
@@ -1496,10 +1721,12 @@ export interface ListTriggersResponse {
1496
1721
  */
1497
1722
  export interface ListWorkflowsRequest {
1498
1723
  /**
1724
+ * @public
1499
1725
  * <p>A continuation token, if this is a continuation request.</p>
1500
1726
  */
1501
1727
  NextToken?: string;
1502
1728
  /**
1729
+ * @public
1503
1730
  * <p>The maximum size of a list to return.</p>
1504
1731
  */
1505
1732
  MaxResults?: number;
@@ -1509,10 +1736,12 @@ export interface ListWorkflowsRequest {
1509
1736
  */
1510
1737
  export interface ListWorkflowsResponse {
1511
1738
  /**
1739
+ * @public
1512
1740
  * <p>List of names of workflows in the account.</p>
1513
1741
  */
1514
1742
  Workflows?: string[];
1515
1743
  /**
1744
+ * @public
1516
1745
  * <p>A continuation token, if not all workflow names have been returned.</p>
1517
1746
  */
1518
1747
  NextToken?: string;
@@ -1522,11 +1751,13 @@ export interface ListWorkflowsResponse {
1522
1751
  */
1523
1752
  export interface PutDataCatalogEncryptionSettingsRequest {
1524
1753
  /**
1754
+ * @public
1525
1755
  * <p>The ID of the Data Catalog to set the security configuration for. If none is provided, the
1526
1756
  * Amazon Web Services account ID is used by default.</p>
1527
1757
  */
1528
1758
  CatalogId?: string;
1529
1759
  /**
1760
+ * @public
1530
1761
  * <p>The security configuration to set.</p>
1531
1762
  */
1532
1763
  DataCatalogEncryptionSettings: DataCatalogEncryptionSettings | undefined;
@@ -1566,26 +1797,31 @@ export type ExistCondition = (typeof ExistCondition)[keyof typeof ExistCondition
1566
1797
  */
1567
1798
  export interface PutResourcePolicyRequest {
1568
1799
  /**
1800
+ * @public
1569
1801
  * <p>Contains the policy document to set, in JSON format.</p>
1570
1802
  */
1571
1803
  PolicyInJson: string | undefined;
1572
1804
  /**
1805
+ * @public
1573
1806
  * <p>Do not use. For internal use only.</p>
1574
1807
  */
1575
1808
  ResourceArn?: string;
1576
1809
  /**
1810
+ * @public
1577
1811
  * <p>The hash value returned when the previous policy was set using
1578
1812
  * <code>PutResourcePolicy</code>. Its purpose is to prevent concurrent modifications of a
1579
1813
  * policy. Do not use this parameter if no previous policy has been set.</p>
1580
1814
  */
1581
1815
  PolicyHashCondition?: string;
1582
1816
  /**
1817
+ * @public
1583
1818
  * <p>A value of <code>MUST_EXIST</code> is used to update a policy. A value of
1584
1819
  * <code>NOT_EXIST</code> is used to create a new policy. If a value of <code>NONE</code> or a
1585
1820
  * null value is used, the call does not depend on the existence of a policy.</p>
1586
1821
  */
1587
1822
  PolicyExistsCondition?: ExistCondition | string;
1588
1823
  /**
1824
+ * @public
1589
1825
  * <p>If <code>'TRUE'</code>, indicates that you are using both methods to grant cross-account
1590
1826
  * access to Data Catalog resources:</p>
1591
1827
  * <ul>
@@ -1607,6 +1843,7 @@ export interface PutResourcePolicyRequest {
1607
1843
  */
1608
1844
  export interface PutResourcePolicyResponse {
1609
1845
  /**
1846
+ * @public
1610
1847
  * <p>A hash of the policy that has just been set. This must
1611
1848
  * be included in a subsequent call that overwrites or updates
1612
1849
  * this policy.</p>
@@ -1619,10 +1856,12 @@ export interface PutResourcePolicyResponse {
1619
1856
  */
1620
1857
  export interface MetadataKeyValuePair {
1621
1858
  /**
1859
+ * @public
1622
1860
  * <p>A metadata key.</p>
1623
1861
  */
1624
1862
  MetadataKey?: string;
1625
1863
  /**
1864
+ * @public
1626
1865
  * <p>A metadata key’s corresponding value.</p>
1627
1866
  */
1628
1867
  MetadataValue?: string;
@@ -1632,18 +1871,22 @@ export interface MetadataKeyValuePair {
1632
1871
  */
1633
1872
  export interface PutSchemaVersionMetadataInput {
1634
1873
  /**
1874
+ * @public
1635
1875
  * <p>The unique ID for the schema.</p>
1636
1876
  */
1637
1877
  SchemaId?: SchemaId;
1638
1878
  /**
1879
+ * @public
1639
1880
  * <p>The version number of the schema.</p>
1640
1881
  */
1641
1882
  SchemaVersionNumber?: SchemaVersionNumber;
1642
1883
  /**
1884
+ * @public
1643
1885
  * <p>The unique version ID of the schema version.</p>
1644
1886
  */
1645
1887
  SchemaVersionId?: string;
1646
1888
  /**
1889
+ * @public
1647
1890
  * <p>The metadata key's corresponding value.</p>
1648
1891
  */
1649
1892
  MetadataKeyValue: MetadataKeyValuePair | undefined;
@@ -1653,34 +1896,42 @@ export interface PutSchemaVersionMetadataInput {
1653
1896
  */
1654
1897
  export interface PutSchemaVersionMetadataResponse {
1655
1898
  /**
1899
+ * @public
1656
1900
  * <p>The Amazon Resource Name (ARN) for the schema.</p>
1657
1901
  */
1658
1902
  SchemaArn?: string;
1659
1903
  /**
1904
+ * @public
1660
1905
  * <p>The name for the schema.</p>
1661
1906
  */
1662
1907
  SchemaName?: string;
1663
1908
  /**
1909
+ * @public
1664
1910
  * <p>The name for the registry.</p>
1665
1911
  */
1666
1912
  RegistryName?: string;
1667
1913
  /**
1914
+ * @public
1668
1915
  * <p>The latest version of the schema.</p>
1669
1916
  */
1670
1917
  LatestVersion?: boolean;
1671
1918
  /**
1919
+ * @public
1672
1920
  * <p>The version number of the schema.</p>
1673
1921
  */
1674
1922
  VersionNumber?: number;
1675
1923
  /**
1924
+ * @public
1676
1925
  * <p>The unique version ID of the schema version.</p>
1677
1926
  */
1678
1927
  SchemaVersionId?: string;
1679
1928
  /**
1929
+ * @public
1680
1930
  * <p>The metadata key.</p>
1681
1931
  */
1682
1932
  MetadataKey?: string;
1683
1933
  /**
1934
+ * @public
1684
1935
  * <p>The value of the metadata key.</p>
1685
1936
  */
1686
1937
  MetadataValue?: string;
@@ -1690,14 +1941,17 @@ export interface PutSchemaVersionMetadataResponse {
1690
1941
  */
1691
1942
  export interface PutWorkflowRunPropertiesRequest {
1692
1943
  /**
1944
+ * @public
1693
1945
  * <p>Name of the workflow which was run.</p>
1694
1946
  */
1695
1947
  Name: string | undefined;
1696
1948
  /**
1949
+ * @public
1697
1950
  * <p>The ID of the workflow run for which the run properties should be updated.</p>
1698
1951
  */
1699
1952
  RunId: string | undefined;
1700
1953
  /**
1954
+ * @public
1701
1955
  * <p>The properties to put for the specified run.</p>
1702
1956
  */
1703
1957
  RunProperties: Record<string, string> | undefined;
@@ -1712,26 +1966,32 @@ export interface PutWorkflowRunPropertiesResponse {
1712
1966
  */
1713
1967
  export interface QuerySchemaVersionMetadataInput {
1714
1968
  /**
1969
+ * @public
1715
1970
  * <p>A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).</p>
1716
1971
  */
1717
1972
  SchemaId?: SchemaId;
1718
1973
  /**
1974
+ * @public
1719
1975
  * <p>The version number of the schema.</p>
1720
1976
  */
1721
1977
  SchemaVersionNumber?: SchemaVersionNumber;
1722
1978
  /**
1979
+ * @public
1723
1980
  * <p>The unique version ID of the schema version.</p>
1724
1981
  */
1725
1982
  SchemaVersionId?: string;
1726
1983
  /**
1984
+ * @public
1727
1985
  * <p>Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.</p>
1728
1986
  */
1729
1987
  MetadataList?: MetadataKeyValuePair[];
1730
1988
  /**
1989
+ * @public
1731
1990
  * <p>Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.</p>
1732
1991
  */
1733
1992
  MaxResults?: number;
1734
1993
  /**
1994
+ * @public
1735
1995
  * <p>A continuation token, if this is a continuation call.</p>
1736
1996
  */
1737
1997
  NextToken?: string;
@@ -1742,10 +2002,12 @@ export interface QuerySchemaVersionMetadataInput {
1742
2002
  */
1743
2003
  export interface OtherMetadataValueListItem {
1744
2004
  /**
2005
+ * @public
1745
2006
  * <p>The metadata key’s corresponding value for the other metadata belonging to the same metadata key.</p>
1746
2007
  */
1747
2008
  MetadataValue?: string;
1748
2009
  /**
2010
+ * @public
1749
2011
  * <p>The time at which the entry was created.</p>
1750
2012
  */
1751
2013
  CreatedTime?: string;
@@ -1756,14 +2018,17 @@ export interface OtherMetadataValueListItem {
1756
2018
  */
1757
2019
  export interface MetadataInfo {
1758
2020
  /**
2021
+ * @public
1759
2022
  * <p>The metadata key’s corresponding value.</p>
1760
2023
  */
1761
2024
  MetadataValue?: string;
1762
2025
  /**
2026
+ * @public
1763
2027
  * <p>The time at which the entry was created.</p>
1764
2028
  */
1765
2029
  CreatedTime?: string;
1766
2030
  /**
2031
+ * @public
1767
2032
  * <p>Other metadata belonging to the same metadata key.</p>
1768
2033
  */
1769
2034
  OtherMetadataValueList?: OtherMetadataValueListItem[];
@@ -1773,14 +2038,17 @@ export interface MetadataInfo {
1773
2038
  */
1774
2039
  export interface QuerySchemaVersionMetadataResponse {
1775
2040
  /**
2041
+ * @public
1776
2042
  * <p>A map of a metadata key and associated values.</p>
1777
2043
  */
1778
2044
  MetadataInfoMap?: Record<string, MetadataInfo>;
1779
2045
  /**
2046
+ * @public
1780
2047
  * <p>The unique version ID of the schema version.</p>
1781
2048
  */
1782
2049
  SchemaVersionId?: string;
1783
2050
  /**
2051
+ * @public
1784
2052
  * <p>A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.</p>
1785
2053
  */
1786
2054
  NextToken?: string;
@@ -1790,6 +2058,7 @@ export interface QuerySchemaVersionMetadataResponse {
1790
2058
  */
1791
2059
  export interface RegisterSchemaVersionInput {
1792
2060
  /**
2061
+ * @public
1793
2062
  * <p>This is a wrapper structure to contain schema identity fields. The structure contains:</p>
1794
2063
  * <ul>
1795
2064
  * <li>
@@ -1802,6 +2071,7 @@ export interface RegisterSchemaVersionInput {
1802
2071
  */
1803
2072
  SchemaId: SchemaId | undefined;
1804
2073
  /**
2074
+ * @public
1805
2075
  * <p>The schema definition using the <code>DataFormat</code> setting for the <code>SchemaName</code>.</p>
1806
2076
  */
1807
2077
  SchemaDefinition: string | undefined;
@@ -1811,14 +2081,17 @@ export interface RegisterSchemaVersionInput {
1811
2081
  */
1812
2082
  export interface RegisterSchemaVersionResponse {
1813
2083
  /**
2084
+ * @public
1814
2085
  * <p>The unique ID that represents the version of this schema.</p>
1815
2086
  */
1816
2087
  SchemaVersionId?: string;
1817
2088
  /**
2089
+ * @public
1818
2090
  * <p>The version of this schema (for sync flow only, in case this is the first version).</p>
1819
2091
  */
1820
2092
  VersionNumber?: number;
1821
2093
  /**
2094
+ * @public
1822
2095
  * <p>The status of the schema version.</p>
1823
2096
  */
1824
2097
  Status?: SchemaVersionStatus | string;
@@ -1828,18 +2101,22 @@ export interface RegisterSchemaVersionResponse {
1828
2101
  */
1829
2102
  export interface RemoveSchemaVersionMetadataInput {
1830
2103
  /**
2104
+ * @public
1831
2105
  * <p>A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).</p>
1832
2106
  */
1833
2107
  SchemaId?: SchemaId;
1834
2108
  /**
2109
+ * @public
1835
2110
  * <p>The version number of the schema.</p>
1836
2111
  */
1837
2112
  SchemaVersionNumber?: SchemaVersionNumber;
1838
2113
  /**
2114
+ * @public
1839
2115
  * <p>The unique version ID of the schema version.</p>
1840
2116
  */
1841
2117
  SchemaVersionId?: string;
1842
2118
  /**
2119
+ * @public
1843
2120
  * <p>The value of the metadata key.</p>
1844
2121
  */
1845
2122
  MetadataKeyValue: MetadataKeyValuePair | undefined;
@@ -1849,34 +2126,42 @@ export interface RemoveSchemaVersionMetadataInput {
1849
2126
  */
1850
2127
  export interface RemoveSchemaVersionMetadataResponse {
1851
2128
  /**
2129
+ * @public
1852
2130
  * <p>The Amazon Resource Name (ARN) of the schema.</p>
1853
2131
  */
1854
2132
  SchemaArn?: string;
1855
2133
  /**
2134
+ * @public
1856
2135
  * <p>The name of the schema.</p>
1857
2136
  */
1858
2137
  SchemaName?: string;
1859
2138
  /**
2139
+ * @public
1860
2140
  * <p>The name of the registry.</p>
1861
2141
  */
1862
2142
  RegistryName?: string;
1863
2143
  /**
2144
+ * @public
1864
2145
  * <p>The latest version of the schema.</p>
1865
2146
  */
1866
2147
  LatestVersion?: boolean;
1867
2148
  /**
2149
+ * @public
1868
2150
  * <p>The version number of the schema.</p>
1869
2151
  */
1870
2152
  VersionNumber?: number;
1871
2153
  /**
2154
+ * @public
1872
2155
  * <p>The version ID for the schema version.</p>
1873
2156
  */
1874
2157
  SchemaVersionId?: string;
1875
2158
  /**
2159
+ * @public
1876
2160
  * <p>The metadata key.</p>
1877
2161
  */
1878
2162
  MetadataKey?: string;
1879
2163
  /**
2164
+ * @public
1880
2165
  * <p>The value of the metadata key.</p>
1881
2166
  */
1882
2167
  MetadataValue?: string;
@@ -1886,10 +2171,12 @@ export interface RemoveSchemaVersionMetadataResponse {
1886
2171
  */
1887
2172
  export interface ResetJobBookmarkRequest {
1888
2173
  /**
2174
+ * @public
1889
2175
  * <p>The name of the job in question.</p>
1890
2176
  */
1891
2177
  JobName: string | undefined;
1892
2178
  /**
2179
+ * @public
1893
2180
  * <p>The unique run identifier associated with this job run.</p>
1894
2181
  */
1895
2182
  RunId?: string;
@@ -1899,6 +2186,7 @@ export interface ResetJobBookmarkRequest {
1899
2186
  */
1900
2187
  export interface ResetJobBookmarkResponse {
1901
2188
  /**
2189
+ * @public
1902
2190
  * <p>The reset bookmark entry.</p>
1903
2191
  */
1904
2192
  JobBookmarkEntry?: JobBookmarkEntry;
@@ -1911,6 +2199,7 @@ export declare class ConcurrentRunsExceededException extends __BaseException {
1911
2199
  readonly name: "ConcurrentRunsExceededException";
1912
2200
  readonly $fault: "client";
1913
2201
  /**
2202
+ * @public
1914
2203
  * <p>A message describing the problem.</p>
1915
2204
  */
1916
2205
  Message?: string;
@@ -1927,6 +2216,7 @@ export declare class IllegalWorkflowStateException extends __BaseException {
1927
2216
  readonly name: "IllegalWorkflowStateException";
1928
2217
  readonly $fault: "client";
1929
2218
  /**
2219
+ * @public
1930
2220
  * <p>A message describing the problem.</p>
1931
2221
  */
1932
2222
  Message?: string;
@@ -1940,14 +2230,17 @@ export declare class IllegalWorkflowStateException extends __BaseException {
1940
2230
  */
1941
2231
  export interface ResumeWorkflowRunRequest {
1942
2232
  /**
2233
+ * @public
1943
2234
  * <p>The name of the workflow to resume.</p>
1944
2235
  */
1945
2236
  Name: string | undefined;
1946
2237
  /**
2238
+ * @public
1947
2239
  * <p>The ID of the workflow run to resume.</p>
1948
2240
  */
1949
2241
  RunId: string | undefined;
1950
2242
  /**
2243
+ * @public
1951
2244
  * <p>A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.</p>
1952
2245
  */
1953
2246
  NodeIds: string[] | undefined;
@@ -1957,10 +2250,12 @@ export interface ResumeWorkflowRunRequest {
1957
2250
  */
1958
2251
  export interface ResumeWorkflowRunResponse {
1959
2252
  /**
2253
+ * @public
1960
2254
  * <p>The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.</p>
1961
2255
  */
1962
2256
  RunId?: string;
1963
2257
  /**
2258
+ * @public
1964
2259
  * <p>A list of the node IDs for the nodes that were actually restarted.</p>
1965
2260
  */
1966
2261
  NodeIds?: string[];
@@ -1970,14 +2265,17 @@ export interface ResumeWorkflowRunResponse {
1970
2265
  */
1971
2266
  export interface RunStatementRequest {
1972
2267
  /**
2268
+ * @public
1973
2269
  * <p>The Session Id of the statement to be run.</p>
1974
2270
  */
1975
2271
  SessionId: string | undefined;
1976
2272
  /**
2273
+ * @public
1977
2274
  * <p>The statement code to be run.</p>
1978
2275
  */
1979
2276
  Code: string | undefined;
1980
2277
  /**
2278
+ * @public
1981
2279
  * <p>The origin of the request.</p>
1982
2280
  */
1983
2281
  RequestOrigin?: string;
@@ -1987,6 +2285,7 @@ export interface RunStatementRequest {
1987
2285
  */
1988
2286
  export interface RunStatementResponse {
1989
2287
  /**
2288
+ * @public
1990
2289
  * <p>Returns the Id of the statement that was run.</p>
1991
2290
  */
1992
2291
  Id?: number;
@@ -2012,14 +2311,17 @@ export type Comparator = (typeof Comparator)[keyof typeof Comparator];
2012
2311
  */
2013
2312
  export interface PropertyPredicate {
2014
2313
  /**
2314
+ * @public
2015
2315
  * <p>The key of the property.</p>
2016
2316
  */
2017
2317
  Key?: string;
2018
2318
  /**
2319
+ * @public
2019
2320
  * <p>The value of the property.</p>
2020
2321
  */
2021
2322
  Value?: string;
2022
2323
  /**
2324
+ * @public
2023
2325
  * <p>The comparator used to compare this property to others.</p>
2024
2326
  */
2025
2327
  Comparator?: Comparator | string;
@@ -2042,10 +2344,12 @@ export type Sort = (typeof Sort)[keyof typeof Sort];
2042
2344
  */
2043
2345
  export interface SortCriterion {
2044
2346
  /**
2347
+ * @public
2045
2348
  * <p>The name of the field on which to sort.</p>
2046
2349
  */
2047
2350
  FieldName?: string;
2048
2351
  /**
2352
+ * @public
2049
2353
  * <p>An ascending or descending sort.</p>
2050
2354
  */
2051
2355
  Sort?: Sort | string;
@@ -2055,34 +2359,41 @@ export interface SortCriterion {
2055
2359
  */
2056
2360
  export interface SearchTablesRequest {
2057
2361
  /**
2362
+ * @public
2058
2363
  * <p>A unique identifier, consisting of <code>
2059
2364
  * <i>account_id</i>
2060
2365
  * </code>.</p>
2061
2366
  */
2062
2367
  CatalogId?: string;
2063
2368
  /**
2369
+ * @public
2064
2370
  * <p>A continuation token, included if this is a continuation call.</p>
2065
2371
  */
2066
2372
  NextToken?: string;
2067
2373
  /**
2374
+ * @public
2068
2375
  * <p>A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.</p>
2069
2376
  * <p>The <code>Comparator</code> member of the <code>PropertyPredicate</code> struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when <code>Key=Name</code>, a fuzzy match algorithm is used. The <code>Key</code> field (for example, the value of the <code>Name</code> field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the <code>Value</code> member of <code>PropertyPredicate</code>. For example, if <code>Key=Name</code> and <code>Value=link</code>, tables named <code>customer-link</code> and <code>xx-link-yy</code> are returned, but <code>xxlinkyy</code> is not returned.</p>
2070
2377
  */
2071
2378
  Filters?: PropertyPredicate[];
2072
2379
  /**
2380
+ * @public
2073
2381
  * <p>A string used for a text search.</p>
2074
2382
  * <p>Specifying a value in quotes filters based on an exact match to the value.</p>
2075
2383
  */
2076
2384
  SearchText?: string;
2077
2385
  /**
2386
+ * @public
2078
2387
  * <p>A list of criteria for sorting the results by a field name, in an ascending or descending order.</p>
2079
2388
  */
2080
2389
  SortCriteria?: SortCriterion[];
2081
2390
  /**
2391
+ * @public
2082
2392
  * <p>The maximum number of tables to return in a single response.</p>
2083
2393
  */
2084
2394
  MaxResults?: number;
2085
2395
  /**
2396
+ * @public
2086
2397
  * <p>Allows you to specify that you want to search the tables shared with your account. The allowable values are <code>FOREIGN</code> or <code>ALL</code>. </p>
2087
2398
  * <ul>
2088
2399
  * <li>
@@ -2100,10 +2411,12 @@ export interface SearchTablesRequest {
2100
2411
  */
2101
2412
  export interface SearchTablesResponse {
2102
2413
  /**
2414
+ * @public
2103
2415
  * <p>A continuation token, present if the current list segment is not the last.</p>
2104
2416
  */
2105
2417
  NextToken?: string;
2106
2418
  /**
2419
+ * @public
2107
2420
  * <p>A list of the requested <code>Table</code> objects. The <code>SearchTables</code> response returns only the tables that you have access to.</p>
2108
2421
  */
2109
2422
  TableList?: Table[];
@@ -2116,6 +2429,7 @@ export declare class IllegalBlueprintStateException extends __BaseException {
2116
2429
  readonly name: "IllegalBlueprintStateException";
2117
2430
  readonly $fault: "client";
2118
2431
  /**
2432
+ * @public
2119
2433
  * <p>A message describing the problem.</p>
2120
2434
  */
2121
2435
  Message?: string;
@@ -2129,14 +2443,17 @@ export declare class IllegalBlueprintStateException extends __BaseException {
2129
2443
  */
2130
2444
  export interface StartBlueprintRunRequest {
2131
2445
  /**
2446
+ * @public
2132
2447
  * <p>The name of the blueprint.</p>
2133
2448
  */
2134
2449
  BlueprintName: string | undefined;
2135
2450
  /**
2451
+ * @public
2136
2452
  * <p>Specifies the parameters as a <code>BlueprintParameters</code> object.</p>
2137
2453
  */
2138
2454
  Parameters?: string;
2139
2455
  /**
2456
+ * @public
2140
2457
  * <p>Specifies the IAM role used to create the workflow.</p>
2141
2458
  */
2142
2459
  RoleArn: string | undefined;
@@ -2146,6 +2463,7 @@ export interface StartBlueprintRunRequest {
2146
2463
  */
2147
2464
  export interface StartBlueprintRunResponse {
2148
2465
  /**
2466
+ * @public
2149
2467
  * <p>The run ID for this blueprint run.</p>
2150
2468
  */
2151
2469
  RunId?: string;
@@ -2155,6 +2473,7 @@ export interface StartBlueprintRunResponse {
2155
2473
  */
2156
2474
  export interface StartCrawlerRequest {
2157
2475
  /**
2476
+ * @public
2158
2477
  * <p>Name of the crawler to start.</p>
2159
2478
  */
2160
2479
  Name: string | undefined;
@@ -2172,6 +2491,7 @@ export declare class NoScheduleException extends __BaseException {
2172
2491
  readonly name: "NoScheduleException";
2173
2492
  readonly $fault: "client";
2174
2493
  /**
2494
+ * @public
2175
2495
  * <p>A message describing the problem.</p>
2176
2496
  */
2177
2497
  Message?: string;
@@ -2188,6 +2508,7 @@ export declare class SchedulerRunningException extends __BaseException {
2188
2508
  readonly name: "SchedulerRunningException";
2189
2509
  readonly $fault: "client";
2190
2510
  /**
2511
+ * @public
2191
2512
  * <p>A message describing the problem.</p>
2192
2513
  */
2193
2514
  Message?: string;
@@ -2201,6 +2522,7 @@ export declare class SchedulerRunningException extends __BaseException {
2201
2522
  */
2202
2523
  export interface StartCrawlerScheduleRequest {
2203
2524
  /**
2525
+ * @public
2204
2526
  * <p>Name of the crawler to schedule.</p>
2205
2527
  */
2206
2528
  CrawlerName: string | undefined;
@@ -2215,26 +2537,32 @@ export interface StartCrawlerScheduleResponse {
2215
2537
  */
2216
2538
  export interface StartDataQualityRuleRecommendationRunRequest {
2217
2539
  /**
2540
+ * @public
2218
2541
  * <p>The data source (Glue table) associated with this run.</p>
2219
2542
  */
2220
2543
  DataSource: DataSource | undefined;
2221
2544
  /**
2545
+ * @public
2222
2546
  * <p>An IAM role supplied to encrypt the results of the run.</p>
2223
2547
  */
2224
2548
  Role: string | undefined;
2225
2549
  /**
2550
+ * @public
2226
2551
  * <p>The number of <code>G.1X</code> workers to be used in the run. The default is 5.</p>
2227
2552
  */
2228
2553
  NumberOfWorkers?: number;
2229
2554
  /**
2555
+ * @public
2230
2556
  * <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>
2231
2557
  */
2232
2558
  Timeout?: number;
2233
2559
  /**
2560
+ * @public
2234
2561
  * <p>A name for the ruleset.</p>
2235
2562
  */
2236
2563
  CreatedRulesetName?: string;
2237
2564
  /**
2565
+ * @public
2238
2566
  * <p>Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.</p>
2239
2567
  */
2240
2568
  ClientToken?: string;
@@ -2244,6 +2572,7 @@ export interface StartDataQualityRuleRecommendationRunRequest {
2244
2572
  */
2245
2573
  export interface StartDataQualityRuleRecommendationRunResponse {
2246
2574
  /**
2575
+ * @public
2247
2576
  * <p>The unique run identifier associated with this run.</p>
2248
2577
  */
2249
2578
  RunId?: string;
@@ -2253,34 +2582,42 @@ export interface StartDataQualityRuleRecommendationRunResponse {
2253
2582
  */
2254
2583
  export interface StartDataQualityRulesetEvaluationRunRequest {
2255
2584
  /**
2585
+ * @public
2256
2586
  * <p>The data source (Glue table) associated with this run.</p>
2257
2587
  */
2258
2588
  DataSource: DataSource | undefined;
2259
2589
  /**
2590
+ * @public
2260
2591
  * <p>An IAM role supplied to encrypt the results of the run.</p>
2261
2592
  */
2262
2593
  Role: string | undefined;
2263
2594
  /**
2595
+ * @public
2264
2596
  * <p>The number of <code>G.1X</code> workers to be used in the run. The default is 5.</p>
2265
2597
  */
2266
2598
  NumberOfWorkers?: number;
2267
2599
  /**
2600
+ * @public
2268
2601
  * <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>
2269
2602
  */
2270
2603
  Timeout?: number;
2271
2604
  /**
2605
+ * @public
2272
2606
  * <p>Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.</p>
2273
2607
  */
2274
2608
  ClientToken?: string;
2275
2609
  /**
2610
+ * @public
2276
2611
  * <p>Additional run options you can specify for an evaluation run.</p>
2277
2612
  */
2278
2613
  AdditionalRunOptions?: DataQualityEvaluationRunAdditionalRunOptions;
2279
2614
  /**
2615
+ * @public
2280
2616
  * <p>A list of ruleset names.</p>
2281
2617
  */
2282
2618
  RulesetNames: string[] | undefined;
2283
2619
  /**
2620
+ * @public
2284
2621
  * <p>A map of reference strings to additional data sources you can specify for an evaluation run.</p>
2285
2622
  */
2286
2623
  AdditionalDataSources?: Record<string, DataSource>;
@@ -2290,6 +2627,7 @@ export interface StartDataQualityRulesetEvaluationRunRequest {
2290
2627
  */
2291
2628
  export interface StartDataQualityRulesetEvaluationRunResponse {
2292
2629
  /**
2630
+ * @public
2293
2631
  * <p>The unique run identifier associated with this run.</p>
2294
2632
  */
2295
2633
  RunId?: string;
@@ -2299,10 +2637,12 @@ export interface StartDataQualityRulesetEvaluationRunResponse {
2299
2637
  */
2300
2638
  export interface StartExportLabelsTaskRunRequest {
2301
2639
  /**
2640
+ * @public
2302
2641
  * <p>The unique identifier of the machine learning transform.</p>
2303
2642
  */
2304
2643
  TransformId: string | undefined;
2305
2644
  /**
2645
+ * @public
2306
2646
  * <p>The Amazon S3 path where you export the labels.</p>
2307
2647
  */
2308
2648
  OutputS3Path: string | undefined;
@@ -2312,6 +2652,7 @@ export interface StartExportLabelsTaskRunRequest {
2312
2652
  */
2313
2653
  export interface StartExportLabelsTaskRunResponse {
2314
2654
  /**
2655
+ * @public
2315
2656
  * <p>The unique identifier for the task run.</p>
2316
2657
  */
2317
2658
  TaskRunId?: string;
@@ -2321,15 +2662,18 @@ export interface StartExportLabelsTaskRunResponse {
2321
2662
  */
2322
2663
  export interface StartImportLabelsTaskRunRequest {
2323
2664
  /**
2665
+ * @public
2324
2666
  * <p>The unique identifier of the machine learning transform.</p>
2325
2667
  */
2326
2668
  TransformId: string | undefined;
2327
2669
  /**
2670
+ * @public
2328
2671
  * <p>The Amazon Simple Storage Service (Amazon S3) path from where you import the
2329
2672
  * labels.</p>
2330
2673
  */
2331
2674
  InputS3Path: string | undefined;
2332
2675
  /**
2676
+ * @public
2333
2677
  * <p>Indicates whether to overwrite your existing labels.</p>
2334
2678
  */
2335
2679
  ReplaceAllLabels?: boolean;
@@ -2339,6 +2683,7 @@ export interface StartImportLabelsTaskRunRequest {
2339
2683
  */
2340
2684
  export interface StartImportLabelsTaskRunResponse {
2341
2685
  /**
2686
+ * @public
2342
2687
  * <p>The unique identifier for the task run.</p>
2343
2688
  */
2344
2689
  TaskRunId?: string;
@@ -2348,14 +2693,17 @@ export interface StartImportLabelsTaskRunResponse {
2348
2693
  */
2349
2694
  export interface StartJobRunRequest {
2350
2695
  /**
2696
+ * @public
2351
2697
  * <p>The name of the job definition to use.</p>
2352
2698
  */
2353
2699
  JobName: string | undefined;
2354
2700
  /**
2701
+ * @public
2355
2702
  * <p>The ID of a previous <code>JobRun</code> to retry.</p>
2356
2703
  */
2357
2704
  JobRunId?: string;
2358
2705
  /**
2706
+ * @public
2359
2707
  * <p>The job arguments associated with this run. For this job run, they replace the default
2360
2708
  * arguments set in the job definition itself.</p>
2361
2709
  * <p>You can specify arguments here that your own job-execution script
@@ -2372,6 +2720,7 @@ export interface StartJobRunRequest {
2372
2720
  */
2373
2721
  Arguments?: Record<string, string>;
2374
2722
  /**
2723
+ * @public
2375
2724
  * @deprecated
2376
2725
  *
2377
2726
  * <p>This field is deprecated. Use <code>MaxCapacity</code> instead.</p>
@@ -2383,12 +2732,14 @@ export interface StartJobRunRequest {
2383
2732
  */
2384
2733
  AllocatedCapacity?: number;
2385
2734
  /**
2735
+ * @public
2386
2736
  * <p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can
2387
2737
  * consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p>
2388
2738
  * <p>Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).</p>
2389
2739
  */
2390
2740
  Timeout?: number;
2391
2741
  /**
2742
+ * @public
2392
2743
  * <p>For Glue version 1.0 or earlier jobs, using the standard worker type, the number of
2393
2744
  * Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is
2394
2745
  * a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB
@@ -2414,15 +2765,18 @@ export interface StartJobRunRequest {
2414
2765
  */
2415
2766
  MaxCapacity?: number;
2416
2767
  /**
2768
+ * @public
2417
2769
  * <p>The name of the <code>SecurityConfiguration</code> structure to be used with this job
2418
2770
  * run.</p>
2419
2771
  */
2420
2772
  SecurityConfiguration?: string;
2421
2773
  /**
2774
+ * @public
2422
2775
  * <p>Specifies configuration properties of a job run notification.</p>
2423
2776
  */
2424
2777
  NotificationProperty?: NotificationProperty;
2425
2778
  /**
2779
+ * @public
2426
2780
  * <p>The type of predefined worker that is allocated when a job runs. Accepts a value of
2427
2781
  * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.</p>
2428
2782
  * <ul>
@@ -2448,10 +2802,12 @@ export interface StartJobRunRequest {
2448
2802
  */
2449
2803
  WorkerType?: WorkerType | string;
2450
2804
  /**
2805
+ * @public
2451
2806
  * <p>The number of workers of a defined <code>workerType</code> that are allocated when a job runs.</p>
2452
2807
  */
2453
2808
  NumberOfWorkers?: number;
2454
2809
  /**
2810
+ * @public
2455
2811
  * <p>Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.</p>
2456
2812
  * <p>The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary. </p>
2457
2813
  * <p>Only jobs with Glue version 3.0 and above and command type <code>glueetl</code> will be allowed to set <code>ExecutionClass</code> to <code>FLEX</code>. The flexible execution class is available for Spark jobs.</p>
@@ -2463,6 +2819,7 @@ export interface StartJobRunRequest {
2463
2819
  */
2464
2820
  export interface StartJobRunResponse {
2465
2821
  /**
2822
+ * @public
2466
2823
  * <p>The ID assigned to this job run.</p>
2467
2824
  */
2468
2825
  JobRunId?: string;
@@ -2475,6 +2832,7 @@ export declare class MLTransformNotReadyException extends __BaseException {
2475
2832
  readonly name: "MLTransformNotReadyException";
2476
2833
  readonly $fault: "client";
2477
2834
  /**
2835
+ * @public
2478
2836
  * <p>A message describing the problem.</p>
2479
2837
  */
2480
2838
  Message?: string;
@@ -2488,6 +2846,7 @@ export declare class MLTransformNotReadyException extends __BaseException {
2488
2846
  */
2489
2847
  export interface StartMLEvaluationTaskRunRequest {
2490
2848
  /**
2849
+ * @public
2491
2850
  * <p>The unique identifier of the machine learning transform.</p>
2492
2851
  */
2493
2852
  TransformId: string | undefined;
@@ -2497,6 +2856,7 @@ export interface StartMLEvaluationTaskRunRequest {
2497
2856
  */
2498
2857
  export interface StartMLEvaluationTaskRunResponse {
2499
2858
  /**
2859
+ * @public
2500
2860
  * <p>The unique identifier associated with this run.</p>
2501
2861
  */
2502
2862
  TaskRunId?: string;
@@ -2506,10 +2866,12 @@ export interface StartMLEvaluationTaskRunResponse {
2506
2866
  */
2507
2867
  export interface StartMLLabelingSetGenerationTaskRunRequest {
2508
2868
  /**
2869
+ * @public
2509
2870
  * <p>The unique identifier of the machine learning transform.</p>
2510
2871
  */
2511
2872
  TransformId: string | undefined;
2512
2873
  /**
2874
+ * @public
2513
2875
  * <p>The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling
2514
2876
  * set.</p>
2515
2877
  */
@@ -2520,6 +2882,7 @@ export interface StartMLLabelingSetGenerationTaskRunRequest {
2520
2882
  */
2521
2883
  export interface StartMLLabelingSetGenerationTaskRunResponse {
2522
2884
  /**
2885
+ * @public
2523
2886
  * <p>The unique run identifier that is associated with this task run.</p>
2524
2887
  */
2525
2888
  TaskRunId?: string;
@@ -2529,6 +2892,7 @@ export interface StartMLLabelingSetGenerationTaskRunResponse {
2529
2892
  */
2530
2893
  export interface StartTriggerRequest {
2531
2894
  /**
2895
+ * @public
2532
2896
  * <p>The name of the trigger to start.</p>
2533
2897
  */
2534
2898
  Name: string | undefined;
@@ -2538,6 +2902,7 @@ export interface StartTriggerRequest {
2538
2902
  */
2539
2903
  export interface StartTriggerResponse {
2540
2904
  /**
2905
+ * @public
2541
2906
  * <p>The name of the trigger that was started.</p>
2542
2907
  */
2543
2908
  Name?: string;
@@ -2547,10 +2912,12 @@ export interface StartTriggerResponse {
2547
2912
  */
2548
2913
  export interface StartWorkflowRunRequest {
2549
2914
  /**
2915
+ * @public
2550
2916
  * <p>The name of the workflow to start.</p>
2551
2917
  */
2552
2918
  Name: string | undefined;
2553
2919
  /**
2920
+ * @public
2554
2921
  * <p>The workflow run properties for the new workflow run.</p>
2555
2922
  */
2556
2923
  RunProperties?: Record<string, string>;
@@ -2560,6 +2927,7 @@ export interface StartWorkflowRunRequest {
2560
2927
  */
2561
2928
  export interface StartWorkflowRunResponse {
2562
2929
  /**
2930
+ * @public
2563
2931
  * <p>An Id for the new run.</p>
2564
2932
  */
2565
2933
  RunId?: string;
@@ -2572,6 +2940,7 @@ export declare class CrawlerNotRunningException extends __BaseException {
2572
2940
  readonly name: "CrawlerNotRunningException";
2573
2941
  readonly $fault: "client";
2574
2942
  /**
2943
+ * @public
2575
2944
  * <p>A message describing the problem.</p>
2576
2945
  */
2577
2946
  Message?: string;
@@ -2588,6 +2957,7 @@ export declare class CrawlerStoppingException extends __BaseException {
2588
2957
  readonly name: "CrawlerStoppingException";
2589
2958
  readonly $fault: "client";
2590
2959
  /**
2960
+ * @public
2591
2961
  * <p>A message describing the problem.</p>
2592
2962
  */
2593
2963
  Message?: string;
@@ -2601,6 +2971,7 @@ export declare class CrawlerStoppingException extends __BaseException {
2601
2971
  */
2602
2972
  export interface StopCrawlerRequest {
2603
2973
  /**
2974
+ * @public
2604
2975
  * <p>Name of the crawler to stop.</p>
2605
2976
  */
2606
2977
  Name: string | undefined;
@@ -2618,6 +2989,7 @@ export declare class SchedulerNotRunningException extends __BaseException {
2618
2989
  readonly name: "SchedulerNotRunningException";
2619
2990
  readonly $fault: "client";
2620
2991
  /**
2992
+ * @public
2621
2993
  * <p>A message describing the problem.</p>
2622
2994
  */
2623
2995
  Message?: string;
@@ -2631,6 +3003,7 @@ export declare class SchedulerNotRunningException extends __BaseException {
2631
3003
  */
2632
3004
  export interface StopCrawlerScheduleRequest {
2633
3005
  /**
3006
+ * @public
2634
3007
  * <p>Name of the crawler whose schedule state to set.</p>
2635
3008
  */
2636
3009
  CrawlerName: string | undefined;
@@ -2645,10 +3018,12 @@ export interface StopCrawlerScheduleResponse {
2645
3018
  */
2646
3019
  export interface StopSessionRequest {
2647
3020
  /**
3021
+ * @public
2648
3022
  * <p>The ID of the session to be stopped.</p>
2649
3023
  */
2650
3024
  Id: string | undefined;
2651
3025
  /**
3026
+ * @public
2652
3027
  * <p>The origin of the request.</p>
2653
3028
  */
2654
3029
  RequestOrigin?: string;
@@ -2658,6 +3033,7 @@ export interface StopSessionRequest {
2658
3033
  */
2659
3034
  export interface StopSessionResponse {
2660
3035
  /**
3036
+ * @public
2661
3037
  * <p>Returns the Id of the stopped session.</p>
2662
3038
  */
2663
3039
  Id?: string;
@@ -2667,6 +3043,7 @@ export interface StopSessionResponse {
2667
3043
  */
2668
3044
  export interface StopTriggerRequest {
2669
3045
  /**
3046
+ * @public
2670
3047
  * <p>The name of the trigger to stop.</p>
2671
3048
  */
2672
3049
  Name: string | undefined;
@@ -2676,6 +3053,7 @@ export interface StopTriggerRequest {
2676
3053
  */
2677
3054
  export interface StopTriggerResponse {
2678
3055
  /**
3056
+ * @public
2679
3057
  * <p>The name of the trigger that was stopped.</p>
2680
3058
  */
2681
3059
  Name?: string;
@@ -2685,10 +3063,12 @@ export interface StopTriggerResponse {
2685
3063
  */
2686
3064
  export interface StopWorkflowRunRequest {
2687
3065
  /**
3066
+ * @public
2688
3067
  * <p>The name of the workflow to stop.</p>
2689
3068
  */
2690
3069
  Name: string | undefined;
2691
3070
  /**
3071
+ * @public
2692
3072
  * <p>The ID of the workflow run to stop.</p>
2693
3073
  */
2694
3074
  RunId: string | undefined;
@@ -2703,11 +3083,13 @@ export interface StopWorkflowRunResponse {
2703
3083
  */
2704
3084
  export interface TagResourceRequest {
2705
3085
  /**
3086
+ * @public
2706
3087
  * <p>The ARN of the Glue resource to which to add the tags. For more
2707
3088
  * information about Glue resource ARNs, see the <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id">Glue ARN string pattern</a>.</p>
2708
3089
  */
2709
3090
  ResourceArn: string | undefined;
2710
3091
  /**
3092
+ * @public
2711
3093
  * <p>Tags to add to this resource.</p>
2712
3094
  */
2713
3095
  TagsToAdd: Record<string, string> | undefined;
@@ -2722,10 +3104,12 @@ export interface TagResourceResponse {
2722
3104
  */
2723
3105
  export interface UntagResourceRequest {
2724
3106
  /**
3107
+ * @public
2725
3108
  * <p>The Amazon Resource Name (ARN) of the resource from which to remove the tags.</p>
2726
3109
  */
2727
3110
  ResourceArn: string | undefined;
2728
3111
  /**
3112
+ * @public
2729
3113
  * <p>Tags to remove from this resource.</p>
2730
3114
  */
2731
3115
  TagsToRemove: string[] | undefined;
@@ -2740,14 +3124,17 @@ export interface UntagResourceResponse {
2740
3124
  */
2741
3125
  export interface UpdateBlueprintRequest {
2742
3126
  /**
3127
+ * @public
2743
3128
  * <p>The name of the blueprint.</p>
2744
3129
  */
2745
3130
  Name: string | undefined;
2746
3131
  /**
3132
+ * @public
2747
3133
  * <p>A description of the blueprint.</p>
2748
3134
  */
2749
3135
  Description?: string;
2750
3136
  /**
3137
+ * @public
2751
3138
  * <p>Specifies a path in Amazon S3 where the blueprint is published.</p>
2752
3139
  */
2753
3140
  BlueprintLocation: string | undefined;
@@ -2757,6 +3144,7 @@ export interface UpdateBlueprintRequest {
2757
3144
  */
2758
3145
  export interface UpdateBlueprintResponse {
2759
3146
  /**
3147
+ * @public
2760
3148
  * <p>Returns the name of the blueprint that was updated.</p>
2761
3149
  */
2762
3150
  Name?: string;
@@ -2767,39 +3155,48 @@ export interface UpdateBlueprintResponse {
2767
3155
  */
2768
3156
  export interface UpdateCsvClassifierRequest {
2769
3157
  /**
3158
+ * @public
2770
3159
  * <p>The name of the classifier.</p>
2771
3160
  */
2772
3161
  Name: string | undefined;
2773
3162
  /**
3163
+ * @public
2774
3164
  * <p>A custom symbol to denote what separates each column entry in the row.</p>
2775
3165
  */
2776
3166
  Delimiter?: string;
2777
3167
  /**
3168
+ * @public
2778
3169
  * <p>A custom symbol to denote what combines content into a single column value. It must be
2779
3170
  * different from the column delimiter.</p>
2780
3171
  */
2781
3172
  QuoteSymbol?: string;
2782
3173
  /**
3174
+ * @public
2783
3175
  * <p>Indicates whether the CSV file contains a header.</p>
2784
3176
  */
2785
3177
  ContainsHeader?: CsvHeaderOption | string;
2786
3178
  /**
3179
+ * @public
2787
3180
  * <p>A list of strings representing column names.</p>
2788
3181
  */
2789
3182
  Header?: string[];
2790
3183
  /**
3184
+ * @public
2791
3185
  * <p>Specifies not to trim values before identifying the type of column values. The default value is true.</p>
2792
3186
  */
2793
3187
  DisableValueTrimming?: boolean;
2794
3188
  /**
3189
+ * @public
2795
3190
  * <p>Enables the processing of files that contain only one column.</p>
2796
3191
  */
2797
3192
  AllowSingleColumn?: boolean;
2798
3193
  /**
3194
+ * @public
2799
3195
  * <p>Specifies the configuration of custom datatypes.</p>
2800
3196
  */
2801
3197
  CustomDatatypeConfigured?: boolean;
2802
3198
  /**
3199
+ * @public
2803
3200
  * <p>Specifies a list of supported custom datatypes.</p>
2804
3201
  */
2805
3202
  CustomDatatypes?: string[];
@@ -2811,19 +3208,23 @@ export interface UpdateCsvClassifierRequest {
2811
3208
  */
2812
3209
  export interface UpdateGrokClassifierRequest {
2813
3210
  /**
3211
+ * @public
2814
3212
  * <p>The name of the <code>GrokClassifier</code>.</p>
2815
3213
  */
2816
3214
  Name: string | undefined;
2817
3215
  /**
3216
+ * @public
2818
3217
  * <p>An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs,
2819
3218
  * Amazon CloudWatch Logs, and so on.</p>
2820
3219
  */
2821
3220
  Classification?: string;
2822
3221
  /**
3222
+ * @public
2823
3223
  * <p>The grok pattern used by this classifier.</p>
2824
3224
  */
2825
3225
  GrokPattern?: string;
2826
3226
  /**
3227
+ * @public
2827
3228
  * <p>Optional custom grok patterns used by this classifier.</p>
2828
3229
  */
2829
3230
  CustomPatterns?: string;
@@ -2834,10 +3235,12 @@ export interface UpdateGrokClassifierRequest {
2834
3235
  */
2835
3236
  export interface UpdateJsonClassifierRequest {
2836
3237
  /**
3238
+ * @public
2837
3239
  * <p>The name of the classifier.</p>
2838
3240
  */
2839
3241
  Name: string | undefined;
2840
3242
  /**
3243
+ * @public
2841
3244
  * <p>A <code>JsonPath</code> string defining the JSON data for the classifier to classify.
2842
3245
  * 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>
2843
3246
  */
@@ -2849,14 +3252,17 @@ export interface UpdateJsonClassifierRequest {
2849
3252
  */
2850
3253
  export interface UpdateXMLClassifierRequest {
2851
3254
  /**
3255
+ * @public
2852
3256
  * <p>The name of the classifier.</p>
2853
3257
  */
2854
3258
  Name: string | undefined;
2855
3259
  /**
3260
+ * @public
2856
3261
  * <p>An identifier of the data format that the classifier matches.</p>
2857
3262
  */
2858
3263
  Classification?: string;
2859
3264
  /**
3265
+ * @public
2860
3266
  * <p>The XML tag designating the element that contains each record in an XML document being
2861
3267
  * parsed. This cannot identify a self-closing element (closed by <code>/></code>). An empty
2862
3268
  * row element that contains only attributes can be parsed as long as it ends with a closing tag
@@ -2870,18 +3276,22 @@ export interface UpdateXMLClassifierRequest {
2870
3276
  */
2871
3277
  export interface UpdateClassifierRequest {
2872
3278
  /**
3279
+ * @public
2873
3280
  * <p>A <code>GrokClassifier</code> object with updated fields.</p>
2874
3281
  */
2875
3282
  GrokClassifier?: UpdateGrokClassifierRequest;
2876
3283
  /**
3284
+ * @public
2877
3285
  * <p>An <code>XMLClassifier</code> object with updated fields.</p>
2878
3286
  */
2879
3287
  XMLClassifier?: UpdateXMLClassifierRequest;
2880
3288
  /**
3289
+ * @public
2881
3290
  * <p>A <code>JsonClassifier</code> object with updated fields.</p>
2882
3291
  */
2883
3292
  JsonClassifier?: UpdateJsonClassifierRequest;
2884
3293
  /**
3294
+ * @public
2885
3295
  * <p>A <code>CsvClassifier</code> object with updated fields.</p>
2886
3296
  */
2887
3297
  CsvClassifier?: UpdateCsvClassifierRequest;
@@ -2899,6 +3309,7 @@ export declare class VersionMismatchException extends __BaseException {
2899
3309
  readonly name: "VersionMismatchException";
2900
3310
  readonly $fault: "client";
2901
3311
  /**
3312
+ * @public
2902
3313
  * <p>A message describing the problem.</p>
2903
3314
  */
2904
3315
  Message?: string;
@@ -2912,23 +3323,28 @@ export declare class VersionMismatchException extends __BaseException {
2912
3323
  */
2913
3324
  export interface UpdateColumnStatisticsForPartitionRequest {
2914
3325
  /**
3326
+ * @public
2915
3327
  * <p>The ID of the Data Catalog where the partitions in question reside.
2916
3328
  * If none is supplied, the Amazon Web Services account ID is used by default.</p>
2917
3329
  */
2918
3330
  CatalogId?: string;
2919
3331
  /**
3332
+ * @public
2920
3333
  * <p>The name of the catalog database where the partitions reside.</p>
2921
3334
  */
2922
3335
  DatabaseName: string | undefined;
2923
3336
  /**
3337
+ * @public
2924
3338
  * <p>The name of the partitions' table.</p>
2925
3339
  */
2926
3340
  TableName: string | undefined;
2927
3341
  /**
3342
+ * @public
2928
3343
  * <p>A list of partition values identifying the partition.</p>
2929
3344
  */
2930
3345
  PartitionValues: string[] | undefined;
2931
3346
  /**
3347
+ * @public
2932
3348
  * <p>A list of the column statistics.</p>
2933
3349
  */
2934
3350
  ColumnStatisticsList: ColumnStatistics[] | undefined;
@@ -2939,10 +3355,12 @@ export interface UpdateColumnStatisticsForPartitionRequest {
2939
3355
  */
2940
3356
  export interface ColumnStatisticsError {
2941
3357
  /**
3358
+ * @public
2942
3359
  * <p>The <code>ColumnStatistics</code> of the column.</p>
2943
3360
  */
2944
3361
  ColumnStatistics?: ColumnStatistics;
2945
3362
  /**
3363
+ * @public
2946
3364
  * <p>An error message with the reason for the failure of an operation.</p>
2947
3365
  */
2948
3366
  Error?: ErrorDetail;
@@ -2952,6 +3370,7 @@ export interface ColumnStatisticsError {
2952
3370
  */
2953
3371
  export interface UpdateColumnStatisticsForPartitionResponse {
2954
3372
  /**
3373
+ * @public
2955
3374
  * <p>Error occurred during updating column statistics data.</p>
2956
3375
  */
2957
3376
  Errors?: ColumnStatisticsError[];
@@ -2961,19 +3380,23 @@ export interface UpdateColumnStatisticsForPartitionResponse {
2961
3380
  */
2962
3381
  export interface UpdateColumnStatisticsForTableRequest {
2963
3382
  /**
3383
+ * @public
2964
3384
  * <p>The ID of the Data Catalog where the partitions in question reside.
2965
3385
  * If none is supplied, the Amazon Web Services account ID is used by default.</p>
2966
3386
  */
2967
3387
  CatalogId?: string;
2968
3388
  /**
3389
+ * @public
2969
3390
  * <p>The name of the catalog database where the partitions reside.</p>
2970
3391
  */
2971
3392
  DatabaseName: string | undefined;
2972
3393
  /**
3394
+ * @public
2973
3395
  * <p>The name of the partitions' table.</p>
2974
3396
  */
2975
3397
  TableName: string | undefined;
2976
3398
  /**
3399
+ * @public
2977
3400
  * <p>A list of the column statistics.</p>
2978
3401
  */
2979
3402
  ColumnStatisticsList: ColumnStatistics[] | undefined;
@@ -2983,6 +3406,7 @@ export interface UpdateColumnStatisticsForTableRequest {
2983
3406
  */
2984
3407
  export interface UpdateColumnStatisticsForTableResponse {
2985
3408
  /**
3409
+ * @public
2986
3410
  * <p>List of ColumnStatisticsErrors.</p>
2987
3411
  */
2988
3412
  Errors?: ColumnStatisticsError[];
@@ -2992,15 +3416,18 @@ export interface UpdateColumnStatisticsForTableResponse {
2992
3416
  */
2993
3417
  export interface UpdateConnectionRequest {
2994
3418
  /**
3419
+ * @public
2995
3420
  * <p>The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services
2996
3421
  * account ID is used by default.</p>
2997
3422
  */
2998
3423
  CatalogId?: string;
2999
3424
  /**
3425
+ * @public
3000
3426
  * <p>The name of the connection definition to update.</p>
3001
3427
  */
3002
3428
  Name: string | undefined;
3003
3429
  /**
3430
+ * @public
3004
3431
  * <p>A <code>ConnectionInput</code> object that redefines the connection
3005
3432
  * in question.</p>
3006
3433
  */
@@ -3016,34 +3443,41 @@ export interface UpdateConnectionResponse {
3016
3443
  */
3017
3444
  export interface UpdateCrawlerRequest {
3018
3445
  /**
3446
+ * @public
3019
3447
  * <p>Name of the new crawler.</p>
3020
3448
  */
3021
3449
  Name: string | undefined;
3022
3450
  /**
3451
+ * @public
3023
3452
  * <p>The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler
3024
3453
  * to access customer resources.</p>
3025
3454
  */
3026
3455
  Role?: string;
3027
3456
  /**
3457
+ * @public
3028
3458
  * <p>The Glue database where results are stored, such as:
3029
3459
  * <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
3030
3460
  */
3031
3461
  DatabaseName?: string;
3032
3462
  /**
3463
+ * @public
3033
3464
  * <p>A description of the new crawler.</p>
3034
3465
  */
3035
3466
  Description?: string;
3036
3467
  /**
3468
+ * @public
3037
3469
  * <p>A list of targets to crawl.</p>
3038
3470
  */
3039
3471
  Targets?: CrawlerTargets;
3040
3472
  /**
3473
+ * @public
3041
3474
  * <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
3042
3475
  * something every day at 12:15 UTC, you would specify:
3043
3476
  * <code>cron(15 12 * * ? *)</code>.</p>
3044
3477
  */
3045
3478
  Schedule?: string;
3046
3479
  /**
3480
+ * @public
3047
3481
  * <p>A list of custom classifiers that the user
3048
3482
  * has registered. By default, all built-in classifiers are included in a crawl,
3049
3483
  * but these custom classifiers always override the default classifiers
@@ -3051,32 +3485,39 @@ export interface UpdateCrawlerRequest {
3051
3485
  */
3052
3486
  Classifiers?: string[];
3053
3487
  /**
3488
+ * @public
3054
3489
  * <p>The table prefix used for catalog tables that are created.</p>
3055
3490
  */
3056
3491
  TablePrefix?: string;
3057
3492
  /**
3493
+ * @public
3058
3494
  * <p>The policy for the crawler's update and deletion behavior.</p>
3059
3495
  */
3060
3496
  SchemaChangePolicy?: SchemaChangePolicy;
3061
3497
  /**
3498
+ * @public
3062
3499
  * <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>
3063
3500
  */
3064
3501
  RecrawlPolicy?: RecrawlPolicy;
3065
3502
  /**
3503
+ * @public
3066
3504
  * <p>Specifies data lineage configuration settings for the crawler.</p>
3067
3505
  */
3068
3506
  LineageConfiguration?: LineageConfiguration;
3069
3507
  /**
3508
+ * @public
3070
3509
  * <p>Specifies Lake Formation configuration settings for the crawler.</p>
3071
3510
  */
3072
3511
  LakeFormationConfiguration?: LakeFormationConfiguration;
3073
3512
  /**
3513
+ * @public
3074
3514
  * <p>Crawler configuration information. This versioned JSON string allows users
3075
3515
  * to specify aspects of a crawler's behavior.
3076
3516
  * For more information, see <a href="https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html">Setting crawler configuration options</a>.</p>
3077
3517
  */
3078
3518
  Configuration?: string;
3079
3519
  /**
3520
+ * @public
3080
3521
  * <p>The name of the <code>SecurityConfiguration</code> structure to be used by this
3081
3522
  * crawler.</p>
3082
3523
  */
@@ -3092,10 +3533,12 @@ export interface UpdateCrawlerResponse {
3092
3533
  */
3093
3534
  export interface UpdateCrawlerScheduleRequest {
3094
3535
  /**
3536
+ * @public
3095
3537
  * <p>The name of the crawler whose schedule to update.</p>
3096
3538
  */
3097
3539
  CrawlerName: string | undefined;
3098
3540
  /**
3541
+ * @public
3099
3542
  * <p>The updated <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
3100
3543
  * something every day at 12:15 UTC, you would specify:
3101
3544
  * <code>cron(15 12 * * ? *)</code>.</p>
@@ -3112,16 +3555,19 @@ export interface UpdateCrawlerScheduleResponse {
3112
3555
  */
3113
3556
  export interface UpdateDatabaseRequest {
3114
3557
  /**
3558
+ * @public
3115
3559
  * <p>The ID of the Data Catalog in which the metadata database resides. If none is provided,
3116
3560
  * the Amazon Web Services account ID is used by default.</p>
3117
3561
  */
3118
3562
  CatalogId?: string;
3119
3563
  /**
3564
+ * @public
3120
3565
  * <p>The name of the database to update in the catalog. For Hive
3121
3566
  * compatibility, this is folded to lowercase.</p>
3122
3567
  */
3123
3568
  Name: string | undefined;
3124
3569
  /**
3570
+ * @public
3125
3571
  * <p>A <code>DatabaseInput</code> object specifying the new definition
3126
3572
  * of the metadata database in the catalog.</p>
3127
3573
  */
@@ -3137,14 +3583,17 @@ export interface UpdateDatabaseResponse {
3137
3583
  */
3138
3584
  export interface UpdateDataQualityRulesetRequest {
3139
3585
  /**
3586
+ * @public
3140
3587
  * <p>The name of the data quality ruleset.</p>
3141
3588
  */
3142
3589
  Name: string | undefined;
3143
3590
  /**
3591
+ * @public
3144
3592
  * <p>A description of the ruleset.</p>
3145
3593
  */
3146
3594
  Description?: string;
3147
3595
  /**
3596
+ * @public
3148
3597
  * <p>A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.</p>
3149
3598
  */
3150
3599
  Ruleset?: string;
@@ -3154,14 +3603,17 @@ export interface UpdateDataQualityRulesetRequest {
3154
3603
  */
3155
3604
  export interface UpdateDataQualityRulesetResponse {
3156
3605
  /**
3606
+ * @public
3157
3607
  * <p>The name of the data quality ruleset.</p>
3158
3608
  */
3159
3609
  Name?: string;
3160
3610
  /**
3611
+ * @public
3161
3612
  * <p>A description of the ruleset.</p>
3162
3613
  */
3163
3614
  Description?: string;
3164
3615
  /**
3616
+ * @public
3165
3617
  * <p>A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.</p>
3166
3618
  */
3167
3619
  Ruleset?: string;
@@ -3172,6 +3624,7 @@ export interface UpdateDataQualityRulesetResponse {
3172
3624
  */
3173
3625
  export interface DevEndpointCustomLibraries {
3174
3626
  /**
3627
+ * @public
3175
3628
  * <p>The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3)
3176
3629
  * bucket that should be loaded in your <code>DevEndpoint</code>. Multiple values must be
3177
3630
  * complete paths separated by a comma.</p>
@@ -3183,6 +3636,7 @@ export interface DevEndpointCustomLibraries {
3183
3636
  */
3184
3637
  ExtraPythonLibsS3Path?: string;
3185
3638
  /**
3639
+ * @public
3186
3640
  * <p>The path to one or more Java <code>.jar</code> files in an S3 bucket that should be loaded
3187
3641
  * in your <code>DevEndpoint</code>.</p>
3188
3642
  * <note>
@@ -3196,37 +3650,45 @@ export interface DevEndpointCustomLibraries {
3196
3650
  */
3197
3651
  export interface UpdateDevEndpointRequest {
3198
3652
  /**
3653
+ * @public
3199
3654
  * <p>The name of the <code>DevEndpoint</code> to be updated.</p>
3200
3655
  */
3201
3656
  EndpointName: string | undefined;
3202
3657
  /**
3658
+ * @public
3203
3659
  * <p>The public key for the <code>DevEndpoint</code> to use.</p>
3204
3660
  */
3205
3661
  PublicKey?: string;
3206
3662
  /**
3663
+ * @public
3207
3664
  * <p>The list of public keys for the <code>DevEndpoint</code> to use.</p>
3208
3665
  */
3209
3666
  AddPublicKeys?: string[];
3210
3667
  /**
3668
+ * @public
3211
3669
  * <p>The list of public keys to be deleted from the <code>DevEndpoint</code>.</p>
3212
3670
  */
3213
3671
  DeletePublicKeys?: string[];
3214
3672
  /**
3673
+ * @public
3215
3674
  * <p>Custom Python or Java libraries to be loaded in the <code>DevEndpoint</code>.</p>
3216
3675
  */
3217
3676
  CustomLibraries?: DevEndpointCustomLibraries;
3218
3677
  /**
3678
+ * @public
3219
3679
  * <p>
3220
3680
  * <code>True</code> if the list of custom libraries to be loaded in the development endpoint
3221
3681
  * needs to be updated, or <code>False</code> if otherwise.</p>
3222
3682
  */
3223
3683
  UpdateEtlLibraries?: boolean;
3224
3684
  /**
3685
+ * @public
3225
3686
  * <p>The list of argument keys to be deleted from the map of arguments used to configure the
3226
3687
  * <code>DevEndpoint</code>.</p>
3227
3688
  */
3228
3689
  DeleteArguments?: string[];
3229
3690
  /**
3691
+ * @public
3230
3692
  * <p>The map of arguments to add the map of arguments used to configure the
3231
3693
  * <code>DevEndpoint</code>.</p>
3232
3694
  * <p>Valid arguments are:</p>
@@ -3251,6 +3713,7 @@ export interface UpdateDevEndpointResponse {
3251
3713
  */
3252
3714
  export interface UpdateJobResponse {
3253
3715
  /**
3716
+ * @public
3254
3717
  * <p>Returns the name of the updated job definition.</p>
3255
3718
  */
3256
3719
  JobName?: string;
@@ -3260,38 +3723,47 @@ export interface UpdateJobResponse {
3260
3723
  */
3261
3724
  export interface UpdateJobFromSourceControlRequest {
3262
3725
  /**
3726
+ * @public
3263
3727
  * <p>The name of the Glue job to be synchronized to or from the remote repository.</p>
3264
3728
  */
3265
3729
  JobName?: string;
3266
3730
  /**
3731
+ * @public
3267
3732
  * <p>The provider for the remote repository.</p>
3268
3733
  */
3269
3734
  Provider?: SourceControlProvider | string;
3270
3735
  /**
3736
+ * @public
3271
3737
  * <p>The name of the remote repository that contains the job artifacts.</p>
3272
3738
  */
3273
3739
  RepositoryName?: string;
3274
3740
  /**
3741
+ * @public
3275
3742
  * <p>The owner of the remote repository that contains the job artifacts.</p>
3276
3743
  */
3277
3744
  RepositoryOwner?: string;
3278
3745
  /**
3746
+ * @public
3279
3747
  * <p>An optional branch in the remote repository.</p>
3280
3748
  */
3281
3749
  BranchName?: string;
3282
3750
  /**
3751
+ * @public
3283
3752
  * <p>An optional folder in the remote repository.</p>
3284
3753
  */
3285
3754
  Folder?: string;
3286
3755
  /**
3756
+ * @public
3287
3757
  * <p>A commit ID for a commit in the remote repository.</p>
3288
3758
  */
3289
3759
  CommitId?: string;
3290
3760
  /**
3761
+ * @public
3291
3762
  * <p>The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.</p>
3292
3763
  */
3293
3764
  AuthStrategy?: SourceControlAuthStrategy | string;
3294
3765
  /**
3766
+ * @public
3295
3767
  * <p>The value of the authorization token.</p>
3296
3768
  */
3297
3769
  AuthToken?: string;
@@ -3301,6 +3773,7 @@ export interface UpdateJobFromSourceControlRequest {
3301
3773
  */
3302
3774
  export interface UpdateJobFromSourceControlResponse {
3303
3775
  /**
3776
+ * @public
3304
3777
  * <p>The name of the Glue job.</p>
3305
3778
  */
3306
3779
  JobName?: string;
@@ -3310,32 +3783,39 @@ export interface UpdateJobFromSourceControlResponse {
3310
3783
  */
3311
3784
  export interface UpdateMLTransformRequest {
3312
3785
  /**
3786
+ * @public
3313
3787
  * <p>A unique identifier that was generated when the transform was created.</p>
3314
3788
  */
3315
3789
  TransformId: string | undefined;
3316
3790
  /**
3791
+ * @public
3317
3792
  * <p>The unique name that you gave the transform when you created it.</p>
3318
3793
  */
3319
3794
  Name?: string;
3320
3795
  /**
3796
+ * @public
3321
3797
  * <p>A description of the transform. The default is an empty string.</p>
3322
3798
  */
3323
3799
  Description?: string;
3324
3800
  /**
3801
+ * @public
3325
3802
  * <p>The configuration parameters that are specific to the transform type (algorithm) used.
3326
3803
  * Conditionally dependent on the transform type.</p>
3327
3804
  */
3328
3805
  Parameters?: TransformParameters;
3329
3806
  /**
3807
+ * @public
3330
3808
  * <p>The name or Amazon Resource Name (ARN) of the IAM role with the required
3331
3809
  * permissions.</p>
3332
3810
  */
3333
3811
  Role?: string;
3334
3812
  /**
3813
+ * @public
3335
3814
  * <p>This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see <a href="https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions">Glue Versions</a> in the developer guide.</p>
3336
3815
  */
3337
3816
  GlueVersion?: string;
3338
3817
  /**
3818
+ * @public
3339
3819
  * <p>The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of
3340
3820
  * processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more
3341
3821
  * information, see the <a href="https://aws.amazon.com/glue/pricing/">Glue pricing
@@ -3344,6 +3824,7 @@ export interface UpdateMLTransformRequest {
3344
3824
  */
3345
3825
  MaxCapacity?: number;
3346
3826
  /**
3827
+ * @public
3347
3828
  * <p>The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.</p>
3348
3829
  * <ul>
3349
3830
  * <li>
@@ -3359,14 +3840,17 @@ export interface UpdateMLTransformRequest {
3359
3840
  */
3360
3841
  WorkerType?: WorkerType | string;
3361
3842
  /**
3843
+ * @public
3362
3844
  * <p>The number of workers of a defined <code>workerType</code> that are allocated when this task runs.</p>
3363
3845
  */
3364
3846
  NumberOfWorkers?: number;
3365
3847
  /**
3848
+ * @public
3366
3849
  * <p>The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>
3367
3850
  */
3368
3851
  Timeout?: number;
3369
3852
  /**
3853
+ * @public
3370
3854
  * <p>The maximum number of times to retry a task for this transform after a task run fails.</p>
3371
3855
  */
3372
3856
  MaxRetries?: number;
@@ -3376,6 +3860,7 @@ export interface UpdateMLTransformRequest {
3376
3860
  */
3377
3861
  export interface UpdateMLTransformResponse {
3378
3862
  /**
3863
+ * @public
3379
3864
  * <p>The unique identifier for the transform that was updated.</p>
3380
3865
  */
3381
3866
  TransformId?: string;
@@ -3385,24 +3870,29 @@ export interface UpdateMLTransformResponse {
3385
3870
  */
3386
3871
  export interface UpdatePartitionRequest {
3387
3872
  /**
3873
+ * @public
3388
3874
  * <p>The ID of the Data Catalog where the partition to be updated resides. If none is provided,
3389
3875
  * the Amazon Web Services account ID is used by default.</p>
3390
3876
  */
3391
3877
  CatalogId?: string;
3392
3878
  /**
3879
+ * @public
3393
3880
  * <p>The name of the catalog database in which the table in question
3394
3881
  * resides.</p>
3395
3882
  */
3396
3883
  DatabaseName: string | undefined;
3397
3884
  /**
3885
+ * @public
3398
3886
  * <p>The name of the table in which the partition to be updated is located.</p>
3399
3887
  */
3400
3888
  TableName: string | undefined;
3401
3889
  /**
3890
+ * @public
3402
3891
  * <p>List of partition key values that define the partition to update.</p>
3403
3892
  */
3404
3893
  PartitionValueList: string[] | undefined;
3405
3894
  /**
3895
+ * @public
3406
3896
  * <p>The new partition object to update the partition to.</p>
3407
3897
  * <p>The <code>Values</code> property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.</p>
3408
3898
  */
@@ -3418,10 +3908,12 @@ export interface UpdatePartitionResponse {
3418
3908
  */
3419
3909
  export interface UpdateRegistryInput {
3420
3910
  /**
3911
+ * @public
3421
3912
  * <p>This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).</p>
3422
3913
  */
3423
3914
  RegistryId: RegistryId | undefined;
3424
3915
  /**
3916
+ * @public
3425
3917
  * <p>A description of the registry. If description is not provided, this field will not be updated.</p>
3426
3918
  */
3427
3919
  Description: string | undefined;
@@ -3431,10 +3923,12 @@ export interface UpdateRegistryInput {
3431
3923
  */
3432
3924
  export interface UpdateRegistryResponse {
3433
3925
  /**
3926
+ * @public
3434
3927
  * <p>The name of the updated registry.</p>
3435
3928
  */
3436
3929
  RegistryName?: string;
3437
3930
  /**
3931
+ * @public
3438
3932
  * <p>The Amazon Resource name (ARN) of the updated registry.</p>
3439
3933
  */
3440
3934
  RegistryArn?: string;
@@ -3444,6 +3938,7 @@ export interface UpdateRegistryResponse {
3444
3938
  */
3445
3939
  export interface UpdateSchemaInput {
3446
3940
  /**
3941
+ * @public
3447
3942
  * <p>This is a wrapper structure to contain schema identity fields. The structure contains:</p>
3448
3943
  * <ul>
3449
3944
  * <li>
@@ -3456,14 +3951,17 @@ export interface UpdateSchemaInput {
3456
3951
  */
3457
3952
  SchemaId: SchemaId | undefined;
3458
3953
  /**
3954
+ * @public
3459
3955
  * <p>Version number required for check pointing. One of <code>VersionNumber</code> or <code>Compatibility</code> has to be provided.</p>
3460
3956
  */
3461
3957
  SchemaVersionNumber?: SchemaVersionNumber;
3462
3958
  /**
3959
+ * @public
3463
3960
  * <p>The new compatibility setting for the schema.</p>
3464
3961
  */
3465
3962
  Compatibility?: Compatibility | string;
3466
3963
  /**
3964
+ * @public
3467
3965
  * <p>The new description for the schema.</p>
3468
3966
  */
3469
3967
  Description?: string;
@@ -3473,14 +3971,17 @@ export interface UpdateSchemaInput {
3473
3971
  */
3474
3972
  export interface UpdateSchemaResponse {
3475
3973
  /**
3974
+ * @public
3476
3975
  * <p>The Amazon Resource Name (ARN) of the schema.</p>
3477
3976
  */
3478
3977
  SchemaArn?: string;
3479
3978
  /**
3979
+ * @public
3480
3980
  * <p>The name of the schema.</p>
3481
3981
  */
3482
3982
  SchemaName?: string;
3483
3983
  /**
3984
+ * @public
3484
3985
  * <p>The name of the registry that contains the schema.</p>
3485
3986
  */
3486
3987
  RegistryName?: string;
@@ -3490,38 +3991,47 @@ export interface UpdateSchemaResponse {
3490
3991
  */
3491
3992
  export interface UpdateSourceControlFromJobRequest {
3492
3993
  /**
3994
+ * @public
3493
3995
  * <p>The name of the Glue job to be synchronized to or from the remote repository.</p>
3494
3996
  */
3495
3997
  JobName?: string;
3496
3998
  /**
3999
+ * @public
3497
4000
  * <p>The provider for the remote repository.</p>
3498
4001
  */
3499
4002
  Provider?: SourceControlProvider | string;
3500
4003
  /**
4004
+ * @public
3501
4005
  * <p>The name of the remote repository that contains the job artifacts.</p>
3502
4006
  */
3503
4007
  RepositoryName?: string;
3504
4008
  /**
4009
+ * @public
3505
4010
  * <p>The owner of the remote repository that contains the job artifacts.</p>
3506
4011
  */
3507
4012
  RepositoryOwner?: string;
3508
4013
  /**
4014
+ * @public
3509
4015
  * <p>An optional branch in the remote repository.</p>
3510
4016
  */
3511
4017
  BranchName?: string;
3512
4018
  /**
4019
+ * @public
3513
4020
  * <p>An optional folder in the remote repository.</p>
3514
4021
  */
3515
4022
  Folder?: string;
3516
4023
  /**
4024
+ * @public
3517
4025
  * <p>A commit ID for a commit in the remote repository.</p>
3518
4026
  */
3519
4027
  CommitId?: string;
3520
4028
  /**
4029
+ * @public
3521
4030
  * <p>The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.</p>
3522
4031
  */
3523
4032
  AuthStrategy?: SourceControlAuthStrategy | string;
3524
4033
  /**
4034
+ * @public
3525
4035
  * <p>The value of the authorization token.</p>
3526
4036
  */
3527
4037
  AuthToken?: string;
@@ -3531,6 +4041,7 @@ export interface UpdateSourceControlFromJobRequest {
3531
4041
  */
3532
4042
  export interface UpdateSourceControlFromJobResponse {
3533
4043
  /**
4044
+ * @public
3534
4045
  * <p>The name of the Glue job.</p>
3535
4046
  */
3536
4047
  JobName?: string;
@@ -3540,31 +4051,37 @@ export interface UpdateSourceControlFromJobResponse {
3540
4051
  */
3541
4052
  export interface UpdateTableRequest {
3542
4053
  /**
4054
+ * @public
3543
4055
  * <p>The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account
3544
4056
  * ID is used by default.</p>
3545
4057
  */
3546
4058
  CatalogId?: string;
3547
4059
  /**
4060
+ * @public
3548
4061
  * <p>The name of the catalog database in which the table resides. For Hive
3549
4062
  * compatibility, this name is entirely lowercase.</p>
3550
4063
  */
3551
4064
  DatabaseName: string | undefined;
3552
4065
  /**
4066
+ * @public
3553
4067
  * <p>An updated <code>TableInput</code> object to define the metadata table
3554
4068
  * in the catalog.</p>
3555
4069
  */
3556
4070
  TableInput: TableInput | undefined;
3557
4071
  /**
4072
+ * @public
3558
4073
  * <p>By default, <code>UpdateTable</code> always creates an archived version of the table
3559
4074
  * before updating it. However, if <code>skipArchive</code> is set to true,
3560
4075
  * <code>UpdateTable</code> does not create the archived version.</p>
3561
4076
  */
3562
4077
  SkipArchive?: boolean;
3563
4078
  /**
4079
+ * @public
3564
4080
  * <p>The transaction ID at which to update the table contents. </p>
3565
4081
  */
3566
4082
  TransactionId?: string;
3567
4083
  /**
4084
+ * @public
3568
4085
  * <p>The version ID at which to update the table contents. </p>
3569
4086
  */
3570
4087
  VersionId?: string;
@@ -3581,14 +4098,17 @@ export interface UpdateTableResponse {
3581
4098
  */
3582
4099
  export interface TriggerUpdate {
3583
4100
  /**
4101
+ * @public
3584
4102
  * <p>Reserved for future use.</p>
3585
4103
  */
3586
4104
  Name?: string;
3587
4105
  /**
4106
+ * @public
3588
4107
  * <p>A description of this trigger.</p>
3589
4108
  */
3590
4109
  Description?: string;
3591
4110
  /**
4111
+ * @public
3592
4112
  * <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
3593
4113
  * Schedules for Jobs and Crawlers</a>. For example, to run
3594
4114
  * something every day at 12:15 UTC, you would specify:
@@ -3596,14 +4116,17 @@ export interface TriggerUpdate {
3596
4116
  */
3597
4117
  Schedule?: string;
3598
4118
  /**
4119
+ * @public
3599
4120
  * <p>The actions initiated by this trigger.</p>
3600
4121
  */
3601
4122
  Actions?: Action[];
3602
4123
  /**
4124
+ * @public
3603
4125
  * <p>The predicate of this trigger, which defines when it will fire.</p>
3604
4126
  */
3605
4127
  Predicate?: Predicate;
3606
4128
  /**
4129
+ * @public
3607
4130
  * <p>Batch condition that must be met (specified number of events received or batch time window expired)
3608
4131
  * before EventBridge event trigger fires.</p>
3609
4132
  */
@@ -3614,10 +4137,12 @@ export interface TriggerUpdate {
3614
4137
  */
3615
4138
  export interface UpdateTriggerRequest {
3616
4139
  /**
4140
+ * @public
3617
4141
  * <p>The name of the trigger to update.</p>
3618
4142
  */
3619
4143
  Name: string | undefined;
3620
4144
  /**
4145
+ * @public
3621
4146
  * <p>The new values with which to update the trigger.</p>
3622
4147
  */
3623
4148
  TriggerUpdate: TriggerUpdate | undefined;
@@ -3627,6 +4152,7 @@ export interface UpdateTriggerRequest {
3627
4152
  */
3628
4153
  export interface UpdateTriggerResponse {
3629
4154
  /**
4155
+ * @public
3630
4156
  * <p>The resulting trigger definition.</p>
3631
4157
  */
3632
4158
  Trigger?: Trigger;
@@ -3636,20 +4162,24 @@ export interface UpdateTriggerResponse {
3636
4162
  */
3637
4163
  export interface UpdateUserDefinedFunctionRequest {
3638
4164
  /**
4165
+ * @public
3639
4166
  * <p>The ID of the Data Catalog where the function to be updated is located. If none is
3640
4167
  * provided, the Amazon Web Services account ID is used by default.</p>
3641
4168
  */
3642
4169
  CatalogId?: string;
3643
4170
  /**
4171
+ * @public
3644
4172
  * <p>The name of the catalog database where the function to be updated is
3645
4173
  * located.</p>
3646
4174
  */
3647
4175
  DatabaseName: string | undefined;
3648
4176
  /**
4177
+ * @public
3649
4178
  * <p>The name of the function.</p>
3650
4179
  */
3651
4180
  FunctionName: string | undefined;
3652
4181
  /**
4182
+ * @public
3653
4183
  * <p>A <code>FunctionInput</code> object that redefines the function in the Data
3654
4184
  * Catalog.</p>
3655
4185
  */
@@ -3665,18 +4195,22 @@ export interface UpdateUserDefinedFunctionResponse {
3665
4195
  */
3666
4196
  export interface UpdateWorkflowRequest {
3667
4197
  /**
4198
+ * @public
3668
4199
  * <p>Name of the workflow to be updated.</p>
3669
4200
  */
3670
4201
  Name: string | undefined;
3671
4202
  /**
4203
+ * @public
3672
4204
  * <p>The description of the workflow.</p>
3673
4205
  */
3674
4206
  Description?: string;
3675
4207
  /**
4208
+ * @public
3676
4209
  * <p>A collection of properties to be used as part of each execution of the workflow.</p>
3677
4210
  */
3678
4211
  DefaultRunProperties?: Record<string, string>;
3679
4212
  /**
4213
+ * @public
3680
4214
  * <p>You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.</p>
3681
4215
  */
3682
4216
  MaxConcurrentRuns?: number;
@@ -3686,6 +4220,7 @@ export interface UpdateWorkflowRequest {
3686
4220
  */
3687
4221
  export interface UpdateWorkflowResponse {
3688
4222
  /**
4223
+ * @public
3689
4224
  * <p>The name of the workflow which was specified in input.</p>
3690
4225
  */
3691
4226
  Name?: string;
@@ -3696,26 +4231,32 @@ export interface UpdateWorkflowResponse {
3696
4231
  */
3697
4232
  export interface Mapping {
3698
4233
  /**
4234
+ * @public
3699
4235
  * <p>After the apply mapping, what the name of the column should be. Can be the same as <code>FromPath</code>.</p>
3700
4236
  */
3701
4237
  ToKey?: string;
3702
4238
  /**
4239
+ * @public
3703
4240
  * <p>The table or column to be modified.</p>
3704
4241
  */
3705
4242
  FromPath?: string[];
3706
4243
  /**
4244
+ * @public
3707
4245
  * <p>The type of the data to be modified.</p>
3708
4246
  */
3709
4247
  FromType?: string;
3710
4248
  /**
4249
+ * @public
3711
4250
  * <p>The data type that the data is to be modified to.</p>
3712
4251
  */
3713
4252
  ToType?: string;
3714
4253
  /**
4254
+ * @public
3715
4255
  * <p>If true, then the column is removed.</p>
3716
4256
  */
3717
4257
  Dropped?: boolean;
3718
4258
  /**
4259
+ * @public
3719
4260
  * <p>Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also <code>Mapping</code>, but its <code>FromPath</code> will be the parent's <code>FromPath</code> plus the <code>FromPath</code> from this structure.</p>
3720
4261
  * <p>For the children part, suppose you have the structure:</p>
3721
4262
  * <p>
@@ -3756,14 +4297,17 @@ export interface Mapping {
3756
4297
  */
3757
4298
  export interface ApplyMapping {
3758
4299
  /**
4300
+ * @public
3759
4301
  * <p>The name of the transform node.</p>
3760
4302
  */
3761
4303
  Name: string | undefined;
3762
4304
  /**
4305
+ * @public
3763
4306
  * <p>The data inputs identified by their node names.</p>
3764
4307
  */
3765
4308
  Inputs: string[] | undefined;
3766
4309
  /**
4310
+ * @public
3767
4311
  * <p>Specifies the mapping of data property keys in the data source to data property keys in the data target.</p>
3768
4312
  */
3769
4313
  Mapping: Mapping[] | undefined;
@@ -3775,279 +4319,348 @@ export interface ApplyMapping {
3775
4319
  */
3776
4320
  export interface CodeGenConfigurationNode {
3777
4321
  /**
4322
+ * @public
3778
4323
  * <p>Specifies a connector to an Amazon Athena data source.</p>
3779
4324
  */
3780
4325
  AthenaConnectorSource?: AthenaConnectorSource;
3781
4326
  /**
4327
+ * @public
3782
4328
  * <p>Specifies a connector to a JDBC data source.</p>
3783
4329
  */
3784
4330
  JDBCConnectorSource?: JDBCConnectorSource;
3785
4331
  /**
4332
+ * @public
3786
4333
  * <p>Specifies a connector to an Apache Spark data source.</p>
3787
4334
  */
3788
4335
  SparkConnectorSource?: SparkConnectorSource;
3789
4336
  /**
4337
+ * @public
3790
4338
  * <p>Specifies a data store in the Glue Data Catalog.</p>
3791
4339
  */
3792
4340
  CatalogSource?: CatalogSource;
3793
4341
  /**
4342
+ * @public
3794
4343
  * <p>Specifies an Amazon Redshift data store.</p>
3795
4344
  */
3796
4345
  RedshiftSource?: RedshiftSource;
3797
4346
  /**
4347
+ * @public
3798
4348
  * <p>Specifies an Amazon S3 data store in the Glue Data Catalog.</p>
3799
4349
  */
3800
4350
  S3CatalogSource?: S3CatalogSource;
3801
4351
  /**
4352
+ * @public
3802
4353
  * <p>Specifies a command-separated value (CSV) data store stored in Amazon S3.</p>
3803
4354
  */
3804
4355
  S3CsvSource?: S3CsvSource;
3805
4356
  /**
4357
+ * @public
3806
4358
  * <p>Specifies a JSON data store stored in Amazon S3.</p>
3807
4359
  */
3808
4360
  S3JsonSource?: S3JsonSource;
3809
4361
  /**
4362
+ * @public
3810
4363
  * <p>Specifies an Apache Parquet data store stored in Amazon S3.</p>
3811
4364
  */
3812
4365
  S3ParquetSource?: S3ParquetSource;
3813
4366
  /**
4367
+ * @public
3814
4368
  * <p>Specifies a relational catalog data store in the Glue Data Catalog.</p>
3815
4369
  */
3816
4370
  RelationalCatalogSource?: RelationalCatalogSource;
3817
4371
  /**
4372
+ * @public
3818
4373
  * <p>Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.</p>
3819
4374
  */
3820
4375
  DynamoDBCatalogSource?: DynamoDBCatalogSource;
3821
4376
  /**
4377
+ * @public
3822
4378
  * <p>Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.</p>
3823
4379
  */
3824
4380
  JDBCConnectorTarget?: JDBCConnectorTarget;
3825
4381
  /**
4382
+ * @public
3826
4383
  * <p>Specifies a target that uses an Apache Spark connector.</p>
3827
4384
  */
3828
4385
  SparkConnectorTarget?: SparkConnectorTarget;
3829
4386
  /**
4387
+ * @public
3830
4388
  * <p>Specifies a target that uses a Glue Data Catalog table.</p>
3831
4389
  */
3832
4390
  CatalogTarget?: BasicCatalogTarget;
3833
4391
  /**
4392
+ * @public
3834
4393
  * <p>Specifies a target that uses Amazon Redshift.</p>
3835
4394
  */
3836
4395
  RedshiftTarget?: RedshiftTarget;
3837
4396
  /**
4397
+ * @public
3838
4398
  * <p>Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.</p>
3839
4399
  */
3840
4400
  S3CatalogTarget?: S3CatalogTarget;
3841
4401
  /**
4402
+ * @public
3842
4403
  * <p>Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.</p>
3843
4404
  */
3844
4405
  S3GlueParquetTarget?: S3GlueParquetTarget;
3845
4406
  /**
4407
+ * @public
3846
4408
  * <p>Specifies a data target that writes to Amazon S3.</p>
3847
4409
  */
3848
4410
  S3DirectTarget?: S3DirectTarget;
3849
4411
  /**
4412
+ * @public
3850
4413
  * <p>Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.</p>
3851
4414
  */
3852
4415
  ApplyMapping?: ApplyMapping;
3853
4416
  /**
4417
+ * @public
3854
4418
  * <p>Specifies a transform that chooses the data property keys that you want to keep.</p>
3855
4419
  */
3856
4420
  SelectFields?: SelectFields;
3857
4421
  /**
4422
+ * @public
3858
4423
  * <p>Specifies a transform that chooses the data property keys that you want to drop.</p>
3859
4424
  */
3860
4425
  DropFields?: DropFields;
3861
4426
  /**
4427
+ * @public
3862
4428
  * <p>Specifies a transform that renames a single data property key.</p>
3863
4429
  */
3864
4430
  RenameField?: RenameField;
3865
4431
  /**
4432
+ * @public
3866
4433
  * <p>Specifies a transform that writes samples of the data to an Amazon S3 bucket.</p>
3867
4434
  */
3868
4435
  Spigot?: Spigot;
3869
4436
  /**
4437
+ * @public
3870
4438
  * <p>Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.</p>
3871
4439
  */
3872
4440
  Join?: Join;
3873
4441
  /**
4442
+ * @public
3874
4443
  * <p>Specifies a transform that splits data property keys into two <code>DynamicFrames</code>. The output is a collection of <code>DynamicFrames</code>: one with selected data property keys, and one with the remaining data property keys.</p>
3875
4444
  */
3876
4445
  SplitFields?: SplitFields;
3877
4446
  /**
4447
+ * @public
3878
4448
  * <p>Specifies a transform that chooses one <code>DynamicFrame</code> from a collection of <code>DynamicFrames</code>. The output is the selected <code>DynamicFrame</code>
3879
4449
  * </p>
3880
4450
  */
3881
4451
  SelectFromCollection?: SelectFromCollection;
3882
4452
  /**
4453
+ * @public
3883
4454
  * <p>Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.</p>
3884
4455
  */
3885
4456
  FillMissingValues?: FillMissingValues;
3886
4457
  /**
4458
+ * @public
3887
4459
  * <p>Specifies a transform that splits a dataset into two, based on a filter condition.</p>
3888
4460
  */
3889
4461
  Filter?: Filter;
3890
4462
  /**
4463
+ * @public
3891
4464
  * <p>Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.</p>
3892
4465
  */
3893
4466
  CustomCode?: CustomCode;
3894
4467
  /**
4468
+ * @public
3895
4469
  * <p>Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single <code>DynamicFrame</code>.</p>
3896
4470
  */
3897
4471
  SparkSQL?: SparkSQL;
3898
4472
  /**
4473
+ * @public
3899
4474
  * <p>Specifies a direct Amazon Kinesis data source.</p>
3900
4475
  */
3901
4476
  DirectKinesisSource?: DirectKinesisSource;
3902
4477
  /**
4478
+ * @public
3903
4479
  * <p>Specifies an Apache Kafka data store.</p>
3904
4480
  */
3905
4481
  DirectKafkaSource?: DirectKafkaSource;
3906
4482
  /**
4483
+ * @public
3907
4484
  * <p>Specifies a Kinesis data source in the Glue Data Catalog.</p>
3908
4485
  */
3909
4486
  CatalogKinesisSource?: CatalogKinesisSource;
3910
4487
  /**
4488
+ * @public
3911
4489
  * <p>Specifies an Apache Kafka data store in the Data Catalog.</p>
3912
4490
  */
3913
4491
  CatalogKafkaSource?: CatalogKafkaSource;
3914
4492
  /**
4493
+ * @public
3915
4494
  * <p>Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.</p>
3916
4495
  */
3917
4496
  DropNullFields?: DropNullFields;
3918
4497
  /**
4498
+ * @public
3919
4499
  * <p>Specifies a transform that merges a <code>DynamicFrame</code> with a staging <code>DynamicFrame</code> based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated. </p>
3920
4500
  */
3921
4501
  Merge?: Merge;
3922
4502
  /**
4503
+ * @public
3923
4504
  * <p>Specifies a transform that combines the rows from two or more datasets into a single result.</p>
3924
4505
  */
3925
4506
  Union?: Union;
3926
4507
  /**
4508
+ * @public
3927
4509
  * <p>Specifies a transform that identifies, removes or masks PII data.</p>
3928
4510
  */
3929
4511
  PIIDetection?: PIIDetection;
3930
4512
  /**
4513
+ * @public
3931
4514
  * <p>Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.</p>
3932
4515
  */
3933
4516
  Aggregate?: Aggregate;
3934
4517
  /**
4518
+ * @public
3935
4519
  * <p>Specifies a transform that removes rows of repeating data from a data set.</p>
3936
4520
  */
3937
4521
  DropDuplicates?: DropDuplicates;
3938
4522
  /**
4523
+ * @public
3939
4524
  * <p>Specifies a data target that writes to a goverened catalog.</p>
3940
4525
  */
3941
4526
  GovernedCatalogTarget?: GovernedCatalogTarget;
3942
4527
  /**
4528
+ * @public
3943
4529
  * <p>Specifies a data source in a goverened Data Catalog.</p>
3944
4530
  */
3945
4531
  GovernedCatalogSource?: GovernedCatalogSource;
3946
4532
  /**
4533
+ * @public
3947
4534
  * <p>Specifies a Microsoft SQL server data source in the Glue Data Catalog.</p>
3948
4535
  */
3949
4536
  MicrosoftSQLServerCatalogSource?: MicrosoftSQLServerCatalogSource;
3950
4537
  /**
4538
+ * @public
3951
4539
  * <p>Specifies a MySQL data source in the Glue Data Catalog.</p>
3952
4540
  */
3953
4541
  MySQLCatalogSource?: MySQLCatalogSource;
3954
4542
  /**
4543
+ * @public
3955
4544
  * <p>Specifies an Oracle data source in the Glue Data Catalog.</p>
3956
4545
  */
3957
4546
  OracleSQLCatalogSource?: OracleSQLCatalogSource;
3958
4547
  /**
4548
+ * @public
3959
4549
  * <p>Specifies a PostgresSQL data source in the Glue Data Catalog.</p>
3960
4550
  */
3961
4551
  PostgreSQLCatalogSource?: PostgreSQLCatalogSource;
3962
4552
  /**
4553
+ * @public
3963
4554
  * <p>Specifies a target that uses Microsoft SQL.</p>
3964
4555
  */
3965
4556
  MicrosoftSQLServerCatalogTarget?: MicrosoftSQLServerCatalogTarget;
3966
4557
  /**
4558
+ * @public
3967
4559
  * <p>Specifies a target that uses MySQL.</p>
3968
4560
  */
3969
4561
  MySQLCatalogTarget?: MySQLCatalogTarget;
3970
4562
  /**
4563
+ * @public
3971
4564
  * <p>Specifies a target that uses Oracle SQL.</p>
3972
4565
  */
3973
4566
  OracleSQLCatalogTarget?: OracleSQLCatalogTarget;
3974
4567
  /**
4568
+ * @public
3975
4569
  * <p>Specifies a target that uses Postgres SQL.</p>
3976
4570
  */
3977
4571
  PostgreSQLCatalogTarget?: PostgreSQLCatalogTarget;
3978
4572
  /**
4573
+ * @public
3979
4574
  * <p>Specifies a custom visual transform created by a user.</p>
3980
4575
  */
3981
4576
  DynamicTransform?: DynamicTransform;
3982
4577
  /**
4578
+ * @public
3983
4579
  * <p>Specifies your data quality evaluation criteria.</p>
3984
4580
  */
3985
4581
  EvaluateDataQuality?: EvaluateDataQuality;
3986
4582
  /**
4583
+ * @public
3987
4584
  * <p>Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.</p>
3988
4585
  */
3989
4586
  S3CatalogHudiSource?: S3CatalogHudiSource;
3990
4587
  /**
4588
+ * @public
3991
4589
  * <p>Specifies a Hudi data source that is registered in the Glue Data Catalog.</p>
3992
4590
  */
3993
4591
  CatalogHudiSource?: CatalogHudiSource;
3994
4592
  /**
4593
+ * @public
3995
4594
  * <p>Specifies a Hudi data source stored in Amazon S3.</p>
3996
4595
  */
3997
4596
  S3HudiSource?: S3HudiSource;
3998
4597
  /**
4598
+ * @public
3999
4599
  * <p>Specifies a target that writes to a Hudi data source in the Glue Data Catalog.</p>
4000
4600
  */
4001
4601
  S3HudiCatalogTarget?: S3HudiCatalogTarget;
4002
4602
  /**
4603
+ * @public
4003
4604
  * <p>Specifies a target that writes to a Hudi data source in Amazon S3.</p>
4004
4605
  */
4005
4606
  S3HudiDirectTarget?: S3HudiDirectTarget;
4006
4607
  /**
4608
+ * @public
4007
4609
  * <p>Specifies the direct JDBC source connection.</p>
4008
4610
  */
4009
4611
  DirectJDBCSource?: DirectJDBCSource;
4010
4612
  /**
4613
+ * @public
4011
4614
  * <p>Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.</p>
4012
4615
  */
4013
4616
  S3CatalogDeltaSource?: S3CatalogDeltaSource;
4014
4617
  /**
4618
+ * @public
4015
4619
  * <p>Specifies a Delta Lake data source that is registered in the Glue Data Catalog.</p>
4016
4620
  */
4017
4621
  CatalogDeltaSource?: CatalogDeltaSource;
4018
4622
  /**
4623
+ * @public
4019
4624
  * <p>Specifies a Delta Lake data source stored in Amazon S3.</p>
4020
4625
  */
4021
4626
  S3DeltaSource?: S3DeltaSource;
4022
4627
  /**
4628
+ * @public
4023
4629
  * <p>Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.</p>
4024
4630
  */
4025
4631
  S3DeltaCatalogTarget?: S3DeltaCatalogTarget;
4026
4632
  /**
4633
+ * @public
4027
4634
  * <p>Specifies a target that writes to a Delta Lake data source in Amazon S3.</p>
4028
4635
  */
4029
4636
  S3DeltaDirectTarget?: S3DeltaDirectTarget;
4030
4637
  /**
4638
+ * @public
4031
4639
  * <p>Specifies a target that writes to a data source in Amazon Redshift.</p>
4032
4640
  */
4033
4641
  AmazonRedshiftSource?: AmazonRedshiftSource;
4034
4642
  /**
4643
+ * @public
4035
4644
  * <p>Specifies a target that writes to a data target in Amazon Redshift.</p>
4036
4645
  */
4037
4646
  AmazonRedshiftTarget?: AmazonRedshiftTarget;
4038
4647
  /**
4648
+ * @public
4039
4649
  * <p>Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.</p>
4040
4650
  */
4041
4651
  EvaluateDataQualityMultiFrame?: EvaluateDataQualityMultiFrame;
4042
4652
  /**
4653
+ * @public
4043
4654
  * <p>Specifies a Glue DataBrew recipe node.</p>
4044
4655
  */
4045
4656
  Recipe?: Recipe;
4046
4657
  /**
4658
+ * @public
4047
4659
  * <p>Specifies a Snowflake data source.</p>
4048
4660
  */
4049
4661
  SnowflakeSource?: SnowflakeSource;
4050
4662
  /**
4663
+ * @public
4051
4664
  * <p>Specifies a target that writes to a Snowflake data source.</p>
4052
4665
  */
4053
4666
  SnowflakeTarget?: SnowflakeTarget;
@@ -4057,31 +4670,38 @@ export interface CodeGenConfigurationNode {
4057
4670
  */
4058
4671
  export interface CreateJobRequest {
4059
4672
  /**
4673
+ * @public
4060
4674
  * <p>The name you assign to this job definition. It must be unique in your account.</p>
4061
4675
  */
4062
4676
  Name: string | undefined;
4063
4677
  /**
4678
+ * @public
4064
4679
  * <p>Description of the job being defined.</p>
4065
4680
  */
4066
4681
  Description?: string;
4067
4682
  /**
4683
+ * @public
4068
4684
  * <p>This field is reserved for future use.</p>
4069
4685
  */
4070
4686
  LogUri?: string;
4071
4687
  /**
4688
+ * @public
4072
4689
  * <p>The name or Amazon Resource Name (ARN) of the IAM role associated with this job.</p>
4073
4690
  */
4074
4691
  Role: string | undefined;
4075
4692
  /**
4693
+ * @public
4076
4694
  * <p>An <code>ExecutionProperty</code> specifying the maximum number of concurrent runs allowed
4077
4695
  * for this job.</p>
4078
4696
  */
4079
4697
  ExecutionProperty?: ExecutionProperty;
4080
4698
  /**
4699
+ * @public
4081
4700
  * <p>The <code>JobCommand</code> that runs this job.</p>
4082
4701
  */
4083
4702
  Command: JobCommand | undefined;
4084
4703
  /**
4704
+ * @public
4085
4705
  * <p>The default arguments for every run of this job, specified as name-value pairs.</p>
4086
4706
  * <p>You can specify arguments here that your own job-execution script
4087
4707
  * consumes, as well as arguments that Glue itself consumes.</p>
@@ -4097,19 +4717,23 @@ export interface CreateJobRequest {
4097
4717
  */
4098
4718
  DefaultArguments?: Record<string, string>;
4099
4719
  /**
4720
+ * @public
4100
4721
  * <p>Arguments for this job that are not overridden when providing job arguments
4101
4722
  * in a job run, specified as name-value pairs.</p>
4102
4723
  */
4103
4724
  NonOverridableArguments?: Record<string, string>;
4104
4725
  /**
4726
+ * @public
4105
4727
  * <p>The connections used for this job.</p>
4106
4728
  */
4107
4729
  Connections?: ConnectionsList;
4108
4730
  /**
4731
+ * @public
4109
4732
  * <p>The maximum number of times to retry this job if it fails.</p>
4110
4733
  */
4111
4734
  MaxRetries?: number;
4112
4735
  /**
4736
+ * @public
4113
4737
  * @deprecated
4114
4738
  *
4115
4739
  * <p>This parameter is deprecated. Use <code>MaxCapacity</code> instead.</p>
@@ -4121,12 +4745,14 @@ export interface CreateJobRequest {
4121
4745
  */
4122
4746
  AllocatedCapacity?: number;
4123
4747
  /**
4748
+ * @public
4124
4749
  * <p>The job timeout in minutes. This is the maximum time that a job run
4125
4750
  * can consume resources before it is terminated and enters <code>TIMEOUT</code>
4126
4751
  * status. The default is 2,880 minutes (48 hours).</p>
4127
4752
  */
4128
4753
  Timeout?: number;
4129
4754
  /**
4755
+ * @public
4130
4756
  * <p>For Glue version 1.0 or earlier jobs, using the standard worker type, the number of
4131
4757
  * Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is
4132
4758
  * a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB
@@ -4152,19 +4778,23 @@ export interface CreateJobRequest {
4152
4778
  */
4153
4779
  MaxCapacity?: number;
4154
4780
  /**
4781
+ * @public
4155
4782
  * <p>The name of the <code>SecurityConfiguration</code> structure to be used with this
4156
4783
  * job.</p>
4157
4784
  */
4158
4785
  SecurityConfiguration?: string;
4159
4786
  /**
4787
+ * @public
4160
4788
  * <p>The tags to use with this job. You may use tags to limit access to the job. 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 guide.</p>
4161
4789
  */
4162
4790
  Tags?: Record<string, string>;
4163
4791
  /**
4792
+ * @public
4164
4793
  * <p>Specifies configuration properties of a job notification.</p>
4165
4794
  */
4166
4795
  NotificationProperty?: NotificationProperty;
4167
4796
  /**
4797
+ * @public
4168
4798
  * <p>In Spark jobs, <code>GlueVersion</code> determines the versions of Apache Spark and Python
4169
4799
  * that Glue available in a job. The Python version indicates the version
4170
4800
  * supported for jobs of type Spark. </p>
@@ -4178,10 +4808,12 @@ export interface CreateJobRequest {
4178
4808
  */
4179
4809
  GlueVersion?: string;
4180
4810
  /**
4811
+ * @public
4181
4812
  * <p>The number of workers of a defined <code>workerType</code> that are allocated when a job runs.</p>
4182
4813
  */
4183
4814
  NumberOfWorkers?: number;
4184
4815
  /**
4816
+ * @public
4185
4817
  * <p>The type of predefined worker that is allocated when a job runs. Accepts a value of
4186
4818
  * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.</p>
4187
4819
  * <ul>
@@ -4207,16 +4839,19 @@ export interface CreateJobRequest {
4207
4839
  */
4208
4840
  WorkerType?: WorkerType | string;
4209
4841
  /**
4842
+ * @public
4210
4843
  * <p>The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.</p>
4211
4844
  */
4212
4845
  CodeGenConfigurationNodes?: Record<string, CodeGenConfigurationNode>;
4213
4846
  /**
4847
+ * @public
4214
4848
  * <p>Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.</p>
4215
4849
  * <p>The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary. </p>
4216
4850
  * <p>Only jobs with Glue version 3.0 and above and command type <code>glueetl</code> will be allowed to set <code>ExecutionClass</code> to <code>FLEX</code>. The flexible execution class is available for Spark jobs.</p>
4217
4851
  */
4218
4852
  ExecutionClass?: ExecutionClass | string;
4219
4853
  /**
4854
+ * @public
4220
4855
  * <p>The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.</p>
4221
4856
  */
4222
4857
  SourceControlDetails?: SourceControlDetails;
@@ -4227,39 +4862,48 @@ export interface CreateJobRequest {
4227
4862
  */
4228
4863
  export interface Job {
4229
4864
  /**
4865
+ * @public
4230
4866
  * <p>The name you assign to this job definition.</p>
4231
4867
  */
4232
4868
  Name?: string;
4233
4869
  /**
4870
+ * @public
4234
4871
  * <p>A description of the job.</p>
4235
4872
  */
4236
4873
  Description?: string;
4237
4874
  /**
4875
+ * @public
4238
4876
  * <p>This field is reserved for future use.</p>
4239
4877
  */
4240
4878
  LogUri?: string;
4241
4879
  /**
4880
+ * @public
4242
4881
  * <p>The name or Amazon Resource Name (ARN) of the IAM role associated with this job.</p>
4243
4882
  */
4244
4883
  Role?: string;
4245
4884
  /**
4885
+ * @public
4246
4886
  * <p>The time and date that this job definition was created.</p>
4247
4887
  */
4248
4888
  CreatedOn?: Date;
4249
4889
  /**
4890
+ * @public
4250
4891
  * <p>The last point in time when this job definition was modified.</p>
4251
4892
  */
4252
4893
  LastModifiedOn?: Date;
4253
4894
  /**
4895
+ * @public
4254
4896
  * <p>An <code>ExecutionProperty</code> specifying the maximum number of concurrent runs allowed
4255
4897
  * for this job.</p>
4256
4898
  */
4257
4899
  ExecutionProperty?: ExecutionProperty;
4258
4900
  /**
4901
+ * @public
4259
4902
  * <p>The <code>JobCommand</code> that runs this job.</p>
4260
4903
  */
4261
4904
  Command?: JobCommand;
4262
4905
  /**
4906
+ * @public
4263
4907
  * <p>The default arguments for every run of this job, specified as name-value pairs.</p>
4264
4908
  * <p>You can specify arguments here that your own job-execution script
4265
4909
  * consumes, as well as arguments that Glue itself consumes.</p>
@@ -4275,19 +4919,23 @@ export interface Job {
4275
4919
  */
4276
4920
  DefaultArguments?: Record<string, string>;
4277
4921
  /**
4922
+ * @public
4278
4923
  * <p>Arguments for this job that are not overridden when providing job arguments
4279
4924
  * in a job run, specified as name-value pairs.</p>
4280
4925
  */
4281
4926
  NonOverridableArguments?: Record<string, string>;
4282
4927
  /**
4928
+ * @public
4283
4929
  * <p>The connections used for this job.</p>
4284
4930
  */
4285
4931
  Connections?: ConnectionsList;
4286
4932
  /**
4933
+ * @public
4287
4934
  * <p>The maximum number of times to retry this job after a JobRun fails.</p>
4288
4935
  */
4289
4936
  MaxRetries?: number;
4290
4937
  /**
4938
+ * @public
4291
4939
  * @deprecated
4292
4940
  *
4293
4941
  * <p>This field is deprecated. Use <code>MaxCapacity</code> instead.</p>
@@ -4300,12 +4948,14 @@ export interface Job {
4300
4948
  */
4301
4949
  AllocatedCapacity?: number;
4302
4950
  /**
4951
+ * @public
4303
4952
  * <p>The job timeout in minutes. This is the maximum time that a job run
4304
4953
  * can consume resources before it is terminated and enters <code>TIMEOUT</code>
4305
4954
  * status. The default is 2,880 minutes (48 hours).</p>
4306
4955
  */
4307
4956
  Timeout?: number;
4308
4957
  /**
4958
+ * @public
4309
4959
  * <p>For Glue version 1.0 or earlier jobs, using the standard worker type, the number of
4310
4960
  * Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is
4311
4961
  * a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB
@@ -4331,6 +4981,7 @@ export interface Job {
4331
4981
  */
4332
4982
  MaxCapacity?: number;
4333
4983
  /**
4984
+ * @public
4334
4985
  * <p>The type of predefined worker that is allocated when a job runs. Accepts a value of
4335
4986
  * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.</p>
4336
4987
  * <ul>
@@ -4356,19 +5007,23 @@ export interface Job {
4356
5007
  */
4357
5008
  WorkerType?: WorkerType | string;
4358
5009
  /**
5010
+ * @public
4359
5011
  * <p>The number of workers of a defined <code>workerType</code> that are allocated when a job runs.</p>
4360
5012
  */
4361
5013
  NumberOfWorkers?: number;
4362
5014
  /**
5015
+ * @public
4363
5016
  * <p>The name of the <code>SecurityConfiguration</code> structure to be used with this
4364
5017
  * job.</p>
4365
5018
  */
4366
5019
  SecurityConfiguration?: string;
4367
5020
  /**
5021
+ * @public
4368
5022
  * <p>Specifies configuration properties of a job notification.</p>
4369
5023
  */
4370
5024
  NotificationProperty?: NotificationProperty;
4371
5025
  /**
5026
+ * @public
4372
5027
  * <p>In Spark jobs, <code>GlueVersion</code> determines the versions of Apache Spark and Python
4373
5028
  * that Glue available in a job. The Python version indicates the version
4374
5029
  * supported for jobs of type Spark. </p>
@@ -4382,16 +5037,19 @@ export interface Job {
4382
5037
  */
4383
5038
  GlueVersion?: string;
4384
5039
  /**
5040
+ * @public
4385
5041
  * <p>The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.</p>
4386
5042
  */
4387
5043
  CodeGenConfigurationNodes?: Record<string, CodeGenConfigurationNode>;
4388
5044
  /**
5045
+ * @public
4389
5046
  * <p>Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.</p>
4390
5047
  * <p>The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary. </p>
4391
5048
  * <p>Only jobs with Glue version 3.0 and above and command type <code>glueetl</code> will be allowed to set <code>ExecutionClass</code> to <code>FLEX</code>. The flexible execution class is available for Spark jobs.</p>
4392
5049
  */
4393
5050
  ExecutionClass?: ExecutionClass | string;
4394
5051
  /**
5052
+ * @public
4395
5053
  * <p>The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.</p>
4396
5054
  */
4397
5055
  SourceControlDetails?: SourceControlDetails;
@@ -4403,28 +5061,34 @@ export interface Job {
4403
5061
  */
4404
5062
  export interface JobUpdate {
4405
5063
  /**
5064
+ * @public
4406
5065
  * <p>Description of the job being defined.</p>
4407
5066
  */
4408
5067
  Description?: string;
4409
5068
  /**
5069
+ * @public
4410
5070
  * <p>This field is reserved for future use.</p>
4411
5071
  */
4412
5072
  LogUri?: string;
4413
5073
  /**
5074
+ * @public
4414
5075
  * <p>The name or Amazon Resource Name (ARN) of the IAM role associated with this job
4415
5076
  * (required).</p>
4416
5077
  */
4417
5078
  Role?: string;
4418
5079
  /**
5080
+ * @public
4419
5081
  * <p>An <code>ExecutionProperty</code> specifying the maximum number of concurrent runs allowed
4420
5082
  * for this job.</p>
4421
5083
  */
4422
5084
  ExecutionProperty?: ExecutionProperty;
4423
5085
  /**
5086
+ * @public
4424
5087
  * <p>The <code>JobCommand</code> that runs this job (required).</p>
4425
5088
  */
4426
5089
  Command?: JobCommand;
4427
5090
  /**
5091
+ * @public
4428
5092
  * <p>The default arguments for every run of this job, specified as name-value pairs.</p>
4429
5093
  * <p>You can specify arguments here that your own job-execution script
4430
5094
  * consumes, as well as arguments that Glue itself consumes.</p>
@@ -4440,19 +5104,23 @@ export interface JobUpdate {
4440
5104
  */
4441
5105
  DefaultArguments?: Record<string, string>;
4442
5106
  /**
5107
+ * @public
4443
5108
  * <p>Arguments for this job that are not overridden when providing job arguments
4444
5109
  * in a job run, specified as name-value pairs.</p>
4445
5110
  */
4446
5111
  NonOverridableArguments?: Record<string, string>;
4447
5112
  /**
5113
+ * @public
4448
5114
  * <p>The connections used for this job.</p>
4449
5115
  */
4450
5116
  Connections?: ConnectionsList;
4451
5117
  /**
5118
+ * @public
4452
5119
  * <p>The maximum number of times to retry this job if it fails.</p>
4453
5120
  */
4454
5121
  MaxRetries?: number;
4455
5122
  /**
5123
+ * @public
4456
5124
  * @deprecated
4457
5125
  *
4458
5126
  * <p>This field is deprecated. Use <code>MaxCapacity</code> instead.</p>
@@ -4464,12 +5132,14 @@ export interface JobUpdate {
4464
5132
  */
4465
5133
  AllocatedCapacity?: number;
4466
5134
  /**
5135
+ * @public
4467
5136
  * <p>The job timeout in minutes. This is the maximum time that a job run
4468
5137
  * can consume resources before it is terminated and enters <code>TIMEOUT</code>
4469
5138
  * status. The default is 2,880 minutes (48 hours).</p>
4470
5139
  */
4471
5140
  Timeout?: number;
4472
5141
  /**
5142
+ * @public
4473
5143
  * <p>For Glue version 1.0 or earlier jobs, using the standard worker type, the number of
4474
5144
  * Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is
4475
5145
  * a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB
@@ -4495,6 +5165,7 @@ export interface JobUpdate {
4495
5165
  */
4496
5166
  MaxCapacity?: number;
4497
5167
  /**
5168
+ * @public
4498
5169
  * <p>The type of predefined worker that is allocated when a job runs. Accepts a value of
4499
5170
  * G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.</p>
4500
5171
  * <ul>
@@ -4520,19 +5191,23 @@ export interface JobUpdate {
4520
5191
  */
4521
5192
  WorkerType?: WorkerType | string;
4522
5193
  /**
5194
+ * @public
4523
5195
  * <p>The number of workers of a defined <code>workerType</code> that are allocated when a job runs.</p>
4524
5196
  */
4525
5197
  NumberOfWorkers?: number;
4526
5198
  /**
5199
+ * @public
4527
5200
  * <p>The name of the <code>SecurityConfiguration</code> structure to be used with this
4528
5201
  * job.</p>
4529
5202
  */
4530
5203
  SecurityConfiguration?: string;
4531
5204
  /**
5205
+ * @public
4532
5206
  * <p>Specifies the configuration properties of a job notification.</p>
4533
5207
  */
4534
5208
  NotificationProperty?: NotificationProperty;
4535
5209
  /**
5210
+ * @public
4536
5211
  * <p>In Spark jobs, <code>GlueVersion</code> determines the versions of Apache Spark and Python
4537
5212
  * that Glue available in a job. The Python version indicates the version
4538
5213
  * supported for jobs of type Spark. </p>
@@ -4546,16 +5221,19 @@ export interface JobUpdate {
4546
5221
  */
4547
5222
  GlueVersion?: string;
4548
5223
  /**
5224
+ * @public
4549
5225
  * <p>The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.</p>
4550
5226
  */
4551
5227
  CodeGenConfigurationNodes?: Record<string, CodeGenConfigurationNode>;
4552
5228
  /**
5229
+ * @public
4553
5230
  * <p>Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.</p>
4554
5231
  * <p>The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary. </p>
4555
5232
  * <p>Only jobs with Glue version 3.0 and above and command type <code>glueetl</code> will be allowed to set <code>ExecutionClass</code> to <code>FLEX</code>. The flexible execution class is available for Spark jobs.</p>
4556
5233
  */
4557
5234
  ExecutionClass?: ExecutionClass | string;
4558
5235
  /**
5236
+ * @public
4559
5237
  * <p>The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.</p>
4560
5238
  */
4561
5239
  SourceControlDetails?: SourceControlDetails;
@@ -4565,6 +5243,7 @@ export interface JobUpdate {
4565
5243
  */
4566
5244
  export interface GetJobResponse {
4567
5245
  /**
5246
+ * @public
4568
5247
  * <p>The requested job definition.</p>
4569
5248
  */
4570
5249
  Job?: Job;
@@ -4574,10 +5253,12 @@ export interface GetJobResponse {
4574
5253
  */
4575
5254
  export interface UpdateJobRequest {
4576
5255
  /**
5256
+ * @public
4577
5257
  * <p>The name of the job definition to update.</p>
4578
5258
  */
4579
5259
  JobName: string | undefined;
4580
5260
  /**
5261
+ * @public
4581
5262
  * <p>Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.</p>
4582
5263
  */
4583
5264
  JobUpdate: JobUpdate | undefined;
@@ -4587,10 +5268,12 @@ export interface UpdateJobRequest {
4587
5268
  */
4588
5269
  export interface BatchGetJobsResponse {
4589
5270
  /**
5271
+ * @public
4590
5272
  * <p>A list of job definitions.</p>
4591
5273
  */
4592
5274
  Jobs?: Job[];
4593
5275
  /**
5276
+ * @public
4594
5277
  * <p>A list of names of jobs not found.</p>
4595
5278
  */
4596
5279
  JobsNotFound?: string[];
@@ -4600,10 +5283,12 @@ export interface BatchGetJobsResponse {
4600
5283
  */
4601
5284
  export interface GetJobsResponse {
4602
5285
  /**
5286
+ * @public
4603
5287
  * <p>A list of job definitions.</p>
4604
5288
  */
4605
5289
  Jobs?: Job[];
4606
5290
  /**
5291
+ * @public
4607
5292
  * <p>A continuation token, if not all job definitions have yet been returned.</p>
4608
5293
  */
4609
5294
  NextToken?: string;