forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathappflow.ts
More file actions
838 lines (837 loc) · 36.8 KB
/
appflow.ts
File metadata and controls
838 lines (837 loc) · 36.8 KB
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
const completionSpec: Fig.Spec = {
name: "appflow",
description:
"Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors. Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift. Use the following links to get started on the Amazon AppFlow API: Actions: An alphabetical list of all Amazon AppFlow API operations. Data types: An alphabetical list of all Amazon AppFlow data types. Common parameters: Parameters that all Query operations can use. Common errors: Client and server errors that all operations can return. If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide. Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi) with the connector-specific ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuth documentation",
subcommands: [
{
name: "create-connector-profile",
description:
"Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel",
options: [
{
name: "--connector-profile-name",
description:
"The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account",
args: {
name: "string",
},
},
{
name: "--kms-arn",
description:
"The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key",
args: {
name: "string",
},
},
{
name: "--connector-type",
description:
"The type of connector, such as Salesforce, Amplitude, and so on",
args: {
name: "string",
},
},
{
name: "--connection-mode",
description:
"Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet",
args: {
name: "string",
},
},
{
name: "--connector-profile-config",
description:
"Defines the connector-specific configuration and credentials",
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-flow",
description:
"Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
args: {
name: "string",
},
},
{
name: "--description",
description: "A description of the flow you want to create",
args: {
name: "string",
},
},
{
name: "--kms-arn",
description:
"The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key",
args: {
name: "string",
},
},
{
name: "--trigger-config",
description:
"The trigger settings that determine how and when the flow runs",
args: {
name: "structure",
},
},
{
name: "--source-flow-config",
description:
"The configuration that controls how Amazon AppFlow retrieves data from the source connector",
args: {
name: "structure",
},
},
{
name: "--destination-flow-config-list",
description:
"The configuration that controls how Amazon AppFlow places data in the destination connector",
args: {
name: "list",
},
},
{
name: "--tasks",
description:
"A list of tasks that Amazon AppFlow performs while transferring the data in the flow run",
args: {
name: "list",
},
},
{
name: "--tags",
description:
"The tags used to organize, track, or control access for your flow",
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: "delete-connector-profile",
description: "Enables you to delete an existing connector profile",
options: [
{
name: "--connector-profile-name",
description:
"The name of the connector profile. The name is unique for each ConnectorProfile in your account",
args: {
name: "string",
},
},
{
name: "--force-delete",
description:
"Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows",
},
{
name: "--no-force-delete",
description:
"Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows",
},
{
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-flow",
description:
"Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
args: {
name: "string",
},
},
{
name: "--force-delete",
description:
"Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use",
},
{
name: "--no-force-delete",
description:
"Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use",
},
{
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-connector-entity",
description:
"Provides details regarding the entity used with the connector, with a description of the data model for each entity",
options: [
{
name: "--connector-entity-name",
description: "The entity name for that connector",
args: {
name: "string",
},
},
{
name: "--connector-type",
description:
"The type of connector application, such as Salesforce, Amplitude, and so on",
args: {
name: "string",
},
},
{
name: "--connector-profile-name",
description:
"The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account",
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-connector-profiles",
description:
"Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result. If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list",
options: [
{
name: "--connector-profile-names",
description:
"The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account",
args: {
name: "list",
},
},
{
name: "--connector-type",
description:
"The type of connector, such as Salesforce, Amplitude, and so on",
args: {
name: "string",
},
},
{
name: "--max-results",
description:
"Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations)",
args: {
name: "integer",
},
},
{
name: "--next-token",
description: "The pagination token for the next page of data",
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-connectors",
description:
"Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page",
options: [
{
name: "--connector-types",
description:
"The type of connector, such as Salesforce, Amplitude, and so on",
args: {
name: "list",
},
},
{
name: "--next-token",
description: "The pagination token for the next page of data",
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-flow",
description: "Provides a description of the specified flow",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
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-flow-execution-records",
description: "Fetches the execution history of the flow",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
args: {
name: "string",
},
},
{
name: "--max-results",
description:
"Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations)",
args: {
name: "integer",
},
},
{
name: "--next-token",
description: "The pagination token for the next page of data",
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-connector-entities",
description:
"Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity",
options: [
{
name: "--connector-profile-name",
description:
"The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector",
args: {
name: "string",
},
},
{
name: "--connector-type",
description:
"The type of connector, such as Salesforce, Amplitude, and so on",
args: {
name: "string",
},
},
{
name: "--entities-path",
description:
"This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider",
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-flows",
description: "Lists all of the flows associated with your account",
options: [
{
name: "--max-results",
description:
"Specifies the maximum number of items that should be returned in the result set",
args: {
name: "integer",
},
},
{
name: "--next-token",
description: "The pagination token for next page of data",
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-tags-for-resource",
description:
"Retrieves the tags that are associated with a specified flow",
options: [
{
name: "--resource-arn",
description: "The Amazon Resource Name (ARN) of the specified flow",
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: "start-flow",
description:
"Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
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: "stop-flow",
description:
"Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
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: "tag-resource",
description: "Applies a tag to the specified flow",
options: [
{
name: "--resource-arn",
description:
"The Amazon Resource Name (ARN) of the flow that you want to tag",
args: {
name: "string",
},
},
{
name: "--tags",
description:
"The tags used to organize, track, or control access for your flow",
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: "untag-resource",
description: "Removes a tag from the specified flow",
options: [
{
name: "--resource-arn",
description:
"The Amazon Resource Name (ARN) of the flow that you want to untag",
args: {
name: "string",
},
},
{
name: "--tag-keys",
description:
"The tag keys associated with the tag that you want to remove from your flow",
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: "update-connector-profile",
description:
"Updates a given connector profile associated with your account",
options: [
{
name: "--connector-profile-name",
description:
"The name of the connector profile and is unique for each ConnectorProfile in the AWS Account",
args: {
name: "string",
},
},
{
name: "--connection-mode",
description:
"Indicates the connection mode and if it is public or private",
args: {
name: "string",
},
},
{
name: "--connector-profile-config",
description:
"Defines the connector-specific profile configuration and credentials",
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: "update-flow",
description: "Updates an existing flow",
options: [
{
name: "--flow-name",
description:
"The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only",
args: {
name: "string",
},
},
{
name: "--description",
description: "A description of the flow",
args: {
name: "string",
},
},
{
name: "--trigger-config",
description:
"The trigger settings that determine how and when the flow runs",
args: {
name: "structure",
},
},
{
name: "--source-flow-config",
description:
"Contains information about the configuration of the source connector used in the flow",
args: {
name: "structure",
},
},
{
name: "--destination-flow-config-list",
description:
"The configuration that controls how Amazon AppFlow transfers data to the destination connector",
args: {
name: "list",
},
},
{
name: "--tasks",
description:
"A list of tasks that Amazon AppFlow performs while transferring the data in the flow run",
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"],
},
},
],
},
],
};
export default completionSpec;