forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconnect.ts
5258 lines (5257 loc) · 235 KB
/
connect.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: "connect",
description:
"Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale. Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents. There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide. You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints. Working with contact flows? Check out the Amazon Connect Flow language",
subcommands: [
{
name: "associate-approved-origin",
description:
"This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--origin",
description: "The domain to add to your allow list",
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: "associate-instance-storage-config",
description:
"This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--resource-type",
description: "A valid resource type",
args: {
name: "string",
},
},
{
name: "--storage-config",
description: "A valid storage type",
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: "associate-lambda-function",
description:
"This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--function-arn",
description:
"The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140",
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: "associate-lex-bot",
description:
"This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex bot",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--lex-bot",
description: "The Amazon Lex box to associate with the instance",
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: "associate-queue-quick-connects",
description:
"This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--queue-id",
description: "The identifier for the queue",
args: {
name: "string",
},
},
{
name: "--quick-connect-ids",
description: "The quick connects to associate with this queue",
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: "associate-routing-profile-queues",
description: "Associates a set of queues with a routing profile",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--routing-profile-id",
description: "The identifier of the routing profile",
args: {
name: "string",
},
},
{
name: "--queue-configs",
description: "The queues to associate with this routing profile",
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: "associate-security-key",
description:
"This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--key",
description: "A valid security key in PEM format",
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: "create-contact-flow",
description:
"Creates a contact flow for the specified Amazon Connect instance. You can also create and update contact flows using the Amazon Connect Flow language",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--name",
description: "The name of the contact flow",
args: {
name: "string",
},
},
{
name: "--type",
description:
"The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide",
args: {
name: "string",
},
},
{
name: "--description",
description: "The description of the contact flow",
args: {
name: "string",
},
},
{
name: "--content",
description: "The content of the contact flow",
args: {
name: "string",
},
},
{
name: "--tags",
description: "One or more tags",
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-instance",
description:
"This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect",
options: [
{
name: "--client-token",
description: "The idempotency token",
args: {
name: "string",
},
},
{
name: "--identity-management-type",
description:
"The type of identity management for your Amazon Connect users",
args: {
name: "string",
},
},
{
name: "--instance-alias",
description: "The name for your instance",
args: {
name: "string",
},
},
{
name: "--directory-id",
description: "The identifier for the directory",
args: {
name: "string",
},
},
{
name: "--inbound-calls-enabled",
description: "Your contact center handles incoming contacts",
},
{
name: "--no-inbound-calls-enabled",
description: "Your contact center handles incoming contacts",
},
{
name: "--outbound-calls-enabled",
description: "Your contact center allows outbound calls",
},
{
name: "--no-outbound-calls-enabled",
description: "Your contact center allows outbound calls",
},
{
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-integration-association",
description:
"This API is in preview release for Amazon Connect and is subject to change. Create an AppIntegration association with an Amazon Connect instance",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--integration-type",
description: "The type of information to be ingested",
args: {
name: "string",
},
},
{
name: "--integration-arn",
description: "The Amazon Resource Name (ARN) of the integration",
args: {
name: "string",
},
},
{
name: "--source-application-url",
description: "The URL for the external application",
args: {
name: "string",
},
},
{
name: "--source-application-name",
description: "The name of the external application",
args: {
name: "string",
},
},
{
name: "--source-type",
description: "The type of the data source",
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: "create-queue",
description:
"This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--name",
description: "The name of the queue",
args: {
name: "string",
},
},
{
name: "--description",
description: "The description of the queue",
args: {
name: "string",
},
},
{
name: "--outbound-caller-config",
description:
"The outbound caller ID name, number, and outbound whisper flow",
args: {
name: "structure",
},
},
{
name: "--hours-of-operation-id",
description: "The identifier for the hours of operation",
args: {
name: "string",
},
},
{
name: "--max-contacts",
description:
"The maximum number of contacts that can be in the queue before it is considered full",
args: {
name: "integer",
},
},
{
name: "--quick-connect-ids",
description:
"The quick connects available to agents who are working the queue",
args: {
name: "list",
},
},
{
name: "--tags",
description: "One or more tags",
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-quick-connect",
description:
"This API is in preview release for Amazon Connect and is subject to change. Creates a quick connect for the specified Amazon Connect instance",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--name",
description: "The name of the quick connect",
args: {
name: "string",
},
},
{
name: "--description",
description: "The description of the quick connect",
args: {
name: "string",
},
},
{
name: "--quick-connect-config",
description: "Configuration settings for the quick connect",
args: {
name: "structure",
},
},
{
name: "--tags",
description: "One or more tags",
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-routing-profile",
description: "Creates a new routing profile",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--name",
description:
"The name of the routing profile. Must not be more than 127 characters",
args: {
name: "string",
},
},
{
name: "--description",
description:
"Description of the routing profile. Must not be more than 250 characters",
args: {
name: "string",
},
},
{
name: "--default-outbound-queue-id",
description: "The default outbound queue for the routing profile",
args: {
name: "string",
},
},
{
name: "--queue-configs",
description:
"The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls",
args: {
name: "list",
},
},
{
name: "--media-concurrencies",
description:
"The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile",
args: {
name: "list",
},
},
{
name: "--tags",
description: "One or more tags",
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-use-case",
description:
"This API is in preview release for Amazon Connect and is subject to change. Creates a use case for an AppIntegration association",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--integration-association-id",
description: "The identifier for the AppIntegration association",
args: {
name: "string",
},
},
{
name: "--use-case-type",
description:
"The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type",
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: "create-user",
description:
"Creates a user account for the specified Amazon Connect instance. For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide",
options: [
{
name: "--username",
description:
"The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+",
args: {
name: "string",
},
},
{
name: "--password",
description:
"The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password",
args: {
name: "string",
},
},
{
name: "--identity-info",
description: "The information about the identity of the user",
args: {
name: "structure",
},
},
{
name: "--phone-config",
description: "The phone settings for the user",
args: {
name: "structure",
},
},
{
name: "--directory-user-id",
description:
"The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned",
args: {
name: "string",
},
},
{
name: "--security-profile-ids",
description: "The identifier of the security profile for the user",
args: {
name: "list",
},
},
{
name: "--routing-profile-id",
description: "The identifier of the routing profile for the user",
args: {
name: "string",
},
},
{
name: "--hierarchy-group-id",
description: "The identifier of the hierarchy group for the user",
args: {
name: "string",
},
},
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--tags",
description: "One or more tags",
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-user-hierarchy-group",
description: "Creates a new user hierarchy group",
options: [
{
name: "--name",
description:
"The name of the user hierarchy group. Must not be more than 100 characters",
args: {
name: "string",
},
},
{
name: "--parent-group-id",
description:
"The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null",
args: {
name: "string",
},
},
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
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-instance",
description:
"This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
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-integration-association",
description:
"This API is in preview release for Amazon Connect and is subject to change. Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--integration-association-id",
description: "The identifier for the AppIntegration association",
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-quick-connect",
description:
"This API is in preview release for Amazon Connect and is subject to change. Deletes a quick connect",
options: [
{
name: "--instance-id",
description: "The identifier of the Amazon Connect instance",
args: {
name: "string",
},
},
{
name: "--quick-connect-id",
description: "The identifier for the quick connect",
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: