/
databrew.ts
2104 lines (2103 loc) · 87.6 KB
/
databrew.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const completionSpec: Fig.Spec = {
name: "databrew",
description:
"AWS Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required",
subcommands: [
{
name: "batch-delete-recipe-version",
description:
"Deletes one or more versions of a recipe at a time. The entire request will be rejected if: The recipe does not exist. There is an invalid version identifier in the list of versions. The version list is empty. The version list size exceeds 50. The version list contains duplicate entries. The request will complete successfully, but with partial failures, if: A version does not exist. A version is being used by a job. You specify LATEST_WORKING, but it's being used by a project. The version fails to be deleted. The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response",
options: [
{
name: "--name",
description:
"The name of the recipe whose versions are to be deleted",
args: {
name: "string",
},
},
{
name: "--recipe-versions",
description:
"An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported",
args: {
name: "list",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-dataset",
description: "Creates a new DataBrew dataset",
options: [
{
name: "--name",
description:
"The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space",
args: {
name: "string",
},
},
{
name: "--format",
description:
"The file format of a dataset that is created from an S3 file or folder",
args: {
name: "string",
},
},
{
name: "--format-options",
description:
"Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input",
args: {
name: "structure",
},
},
{
name: "--input",
description:
"Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3",
args: {
name: "structure",
},
},
{
name: "--path-options",
description:
"A set of options that defines how DataBrew interprets an S3 path of the dataset",
args: {
name: "structure",
},
},
{
name: "--tags",
description: "Metadata tags to apply to this dataset",
args: {
name: "map",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-profile-job",
description:
"Creates a new job to analyze a dataset and create its data profile",
options: [
{
name: "--dataset-name",
description: "The name of the dataset that this job is to act upon",
args: {
name: "string",
},
},
{
name: "--encryption-key-arn",
description:
"The Amazon Resource Name (ARN) of an encryption key that is used to protect the job",
args: {
name: "string",
},
},
{
name: "--encryption-mode",
description:
"The encryption mode for the job, which can be one of the following: SSE-KMS - SSE-KMS - Server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3",
args: {
name: "string",
},
},
{
name: "--name",
description:
"The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space",
args: {
name: "string",
},
},
{
name: "--log-subscription",
description:
"Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run",
args: {
name: "string",
},
},
{
name: "--max-capacity",
description:
"The maximum number of nodes that DataBrew can use when the job processes data",
args: {
name: "integer",
},
},
{
name: "--max-retries",
description:
"The maximum number of times to retry the job after a job run fails",
args: {
name: "integer",
},
},
{
name: "--output-location",
description:
"Represents an Amazon S3 location (bucket name and object key) where DataBrew can read input data, or write output from a job",
args: {
name: "structure",
},
},
{
name: "--role-arn",
description:
"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job",
args: {
name: "string",
},
},
{
name: "--tags",
description: "Metadata tags to apply to this job",
args: {
name: "map",
},
},
{
name: "--timeout",
description:
"The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT",
args: {
name: "integer",
},
},
{
name: "--job-sample",
description:
"Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter",
args: {
name: "structure",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-project",
description: "Creates a new DataBrew project",
options: [
{
name: "--dataset-name",
description:
"The name of an existing dataset to associate this project with",
args: {
name: "string",
},
},
{
name: "--name",
description:
"A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space",
args: {
name: "string",
},
},
{
name: "--recipe-name",
description:
"The name of an existing recipe to associate with the project",
args: {
name: "string",
},
},
{
name: "--sample",
description:
"Represents the sample size and sampling type for DataBrew to use for interactive data analysis",
args: {
name: "structure",
},
},
{
name: "--role-arn",
description:
"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request",
args: {
name: "string",
},
},
{
name: "--tags",
description: "Metadata tags to apply to this project",
args: {
name: "map",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-recipe",
description: "Creates a new DataBrew recipe",
options: [
{
name: "--description",
description: "A description for the recipe",
args: {
name: "string",
},
},
{
name: "--name",
description:
"A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space",
args: {
name: "string",
},
},
{
name: "--steps",
description:
"An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and (optionally) an array of condition expressions",
args: {
name: "list",
},
},
{
name: "--tags",
description: "Metadata tags to apply to this recipe",
args: {
name: "map",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-recipe-job",
description:
"Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe",
options: [
{
name: "--dataset-name",
description: "The name of the dataset that this job processes",
args: {
name: "string",
},
},
{
name: "--encryption-key-arn",
description:
"The Amazon Resource Name (ARN) of an encryption key that is used to protect the job",
args: {
name: "string",
},
},
{
name: "--encryption-mode",
description:
"The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with keys managed by AWS KMS. SSE-S3 - Server-side encryption with keys managed by Amazon S3",
args: {
name: "string",
},
},
{
name: "--name",
description:
"A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space",
args: {
name: "string",
},
},
{
name: "--log-subscription",
description:
"Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run",
args: {
name: "string",
},
},
{
name: "--max-capacity",
description:
"The maximum number of nodes that DataBrew can consume when the job processes data",
args: {
name: "integer",
},
},
{
name: "--max-retries",
description:
"The maximum number of times to retry the job after a job run fails",
args: {
name: "integer",
},
},
{
name: "--outputs",
description:
"One or more artifacts that represent the output from running the job",
args: {
name: "list",
},
},
{
name: "--project-name",
description:
"Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe",
args: {
name: "string",
},
},
{
name: "--recipe-reference",
description: "Represents the name and version of a DataBrew recipe",
args: {
name: "structure",
},
},
{
name: "--role-arn",
description:
"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job",
args: {
name: "string",
},
},
{
name: "--tags",
description: "Metadata tags to apply to this job",
args: {
name: "map",
},
},
{
name: "--timeout",
description:
"The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT",
args: {
name: "integer",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "create-schedule",
description:
"Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals",
options: [
{
name: "--job-names",
description: "The name or names of one or more jobs to be run",
args: {
name: "list",
},
},
{
name: "--cron-expression",
description:
"The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the AWS Glue DataBrew Developer Guide",
args: {
name: "string",
},
},
{
name: "--tags",
description: "Metadata tags to apply to this schedule",
args: {
name: "map",
},
},
{
name: "--name",
description:
"A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-dataset",
description: "Deletes a dataset from DataBrew",
options: [
{
name: "--name",
description: "The name of the dataset to be deleted",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-job",
description: "Deletes the specified DataBrew job",
options: [
{
name: "--name",
description: "The name of the job to be deleted",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-project",
description: "Deletes an existing DataBrew project",
options: [
{
name: "--name",
description: "The name of the project to be deleted",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-recipe-version",
description: "Deletes a single version of a DataBrew recipe",
options: [
{
name: "--name",
description: "The name of the recipe",
args: {
name: "string",
},
},
{
name: "--recipe-version",
description:
"The version of the recipe to be deleted. You can specify a numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "delete-schedule",
description: "Deletes the specified DataBrew schedule",
options: [
{
name: "--name",
description: "The name of the schedule to be deleted",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "describe-dataset",
description: "Returns the definition of a specific DataBrew dataset",
options: [
{
name: "--name",
description: "The name of the dataset to be described",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "describe-job",
description: "Returns the definition of a specific DataBrew job",
options: [
{
name: "--name",
description: "The name of the job to be described",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "describe-job-run",
description: "Represents one run of a DataBrew job",
options: [
{
name: "--name",
description: "The name of the job being processed during this run",
args: {
name: "string",
},
},
{
name: "--run-id",
description: "The unique identifier of the job run",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "describe-project",
description: "Returns the definition of a specific DataBrew project",
options: [
{
name: "--name",
description: "The name of the project to be described",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "describe-recipe",
description:
"Returns the definition of a specific DataBrew recipe corresponding to a particular version",
options: [
{
name: "--name",
description: "The name of the recipe to be described",
args: {
name: "string",
},
},
{
name: "--recipe-version",
description:
"The recipe version identifier. If this parameter isn't specified, then the latest published version is returned",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "describe-schedule",
description: "Returns the definition of a specific DataBrew schedule",
options: [
{
name: "--name",
description: "The name of the schedule to be described",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "list-datasets",
description: "Lists all of the DataBrew datasets",
options: [
{
name: "--max-results",
description:
"The maximum number of results to return in this request",
args: {
name: "integer",
},
},
{
name: "--next-token",
description:
"The token returned by a previous call to retrieve the next set of results",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--starting-token",
description:
"A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide",
args: {
name: "string",
},
},
{
name: "--page-size",
description:
"The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide",
args: {
name: "integer",
},
},
{
name: "--max-items",
description:
"The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide",
args: {
name: "integer",
},
},
{
name: "--generate-cli-skeleton",
description:
"Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command",
args: {
name: "string",
suggestions: ["input", "output"],
},
},
],
},
{
name: "list-job-runs",
description:
"Lists all of the previous runs of a particular DataBrew job",
options: [
{
name: "--name",
description: "The name of the job",
args: {
name: "string",
},
},
{
name: "--max-results",
description:
"The maximum number of results to return in this request",
args: {
name: "integer",
},
},
{
name: "--next-token",
description:
"The token returned by a previous call to retrieve the next set of results",
args: {
name: "string",
},
},
{
name: "--cli-input-json",
description:
"Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally",
args: {
name: "string",
},
},
{
name: "--starting-token",
description:
"A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide",
args: {
name: "string",
},
},
{
name: "--page-size",
description:
"The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide",