/
docs-2.json
3106 lines (3106 loc) · 168 KB
/
docs-2.json
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
{
"version": "2.0",
"service": "<p>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.</p> <p>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.</p> <p>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 <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect Endpoints</a>.</p> <note> <p>Working with contact flows? Check out the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p> </note>",
"operations": {
"AssociateApprovedOrigin": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates an approved origin to an Amazon Connect instance.</p>",
"AssociateBot": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.</p>",
"AssociateInstanceStorageConfig": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>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.</p> <p>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.</p>",
"AssociateLambdaFunction": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Lambda function.</p>",
"AssociateLexBot": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.</p>",
"AssociateQueueQuickConnects": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a set of quick connects with a queue.</p>",
"AssociateRoutingProfileQueues": "<p>Associates a set of queues with a routing profile.</p>",
"AssociateSecurityKey": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a security key to the instance.</p>",
"CreateAgentStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates an agent status for the specified Amazon Connect instance.</p>",
"CreateContactFlow": "<p>Creates a contact flow for the specified Amazon Connect instance.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>",
"CreateHoursOfOperation": "<p>Creates hours of operation. </p>",
"CreateInstance": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>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. </p> <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.</p>",
"CreateIntegrationAssociation": "<p>Creates an AWS resource association with an Amazon Connect instance.</p>",
"CreateQueue": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a new queue for the specified Amazon Connect instance.</p>",
"CreateQuickConnect": "<p>Creates a quick connect for the specified Amazon Connect instance.</p>",
"CreateRoutingProfile": "<p>Creates a new routing profile.</p>",
"CreateUseCase": "<p>Creates a use case for an integration association.</p>",
"CreateUser": "<p>Creates a user account for the specified Amazon Connect instance.</p> <p>For information about how to create user accounts using the Amazon Connect console, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html\">Add Users</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"CreateUserHierarchyGroup": "<p>Creates a new user hierarchy group.</p>",
"DeleteHoursOfOperation": "<p>Deletes an hours of operation.</p>",
"DeleteInstance": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the Amazon Connect instance.</p> <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.</p>",
"DeleteIntegrationAssociation": "<p>Deletes an AWS resource association from an Amazon Connect instance. The association must not have any use cases associated with it.</p>",
"DeleteQuickConnect": "<p>Deletes a quick connect.</p>",
"DeleteUseCase": "<p>Deletes a use case from an integration association.</p>",
"DeleteUser": "<p>Deletes a user account from the specified Amazon Connect instance.</p> <p>For information about what happens to a user's data when their account is deleted, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html\">Delete Users from Your Amazon Connect Instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"DeleteUserHierarchyGroup": "<p>Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.</p>",
"DescribeAgentStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes an agent status.</p>",
"DescribeContactFlow": "<p>Describes the specified contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>",
"DescribeHoursOfOperation": "<p>Describes the hours of operation.</p>",
"DescribeInstance": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. </p> <p>If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.</p>",
"DescribeInstanceAttribute": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified instance attribute.</p>",
"DescribeInstanceStorageConfig": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.</p>",
"DescribeQueue": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified queue.</p>",
"DescribeQuickConnect": "<p>Describes the quick connect.</p>",
"DescribeRoutingProfile": "<p>Describes the specified routing profile.</p>",
"DescribeUser": "<p>Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.</p>",
"DescribeUserHierarchyGroup": "<p>Describes the specified hierarchy group.</p>",
"DescribeUserHierarchyStructure": "<p>Describes the hierarchy structure of the specified Amazon Connect instance.</p>",
"DisassociateApprovedOrigin": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes access to integrated applications from Amazon Connect.</p>",
"DisassociateBot": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. </p>",
"DisassociateInstanceStorageConfig": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Removes the storage type configurations for the specified resource type and association ID.</p>",
"DisassociateLambdaFunction": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Remove the Lambda function from the dropdown options available in the relevant contact flow blocks.</p>",
"DisassociateLexBot": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified Amazon Lex bot.</p>",
"DisassociateQueueQuickConnects": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Disassociates a set of quick connects from a queue.</p>",
"DisassociateRoutingProfileQueues": "<p>Disassociates a set of queues from a routing profile.</p>",
"DisassociateSecurityKey": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the specified security key.</p>",
"GetContactAttributes": "<p>Retrieves the contact attributes for the specified contact.</p>",
"GetCurrentMetricData": "<p>Gets the real-time metric data from the specified Amazon Connect instance.</p> <p>For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"GetFederationToken": "<p>Retrieves a token for federation.</p> <note> <p>This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: </p> <p> <code>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</code> </p> </note>",
"GetMetricData": "<p>Gets historical metric data from the specified Amazon Connect instance.</p> <p>For a description of each historical metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListAgentStatuses": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists agent statuses.</p>",
"ListApprovedOrigins": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all approved origins associated with the instance.</p>",
"ListBots": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. </p>",
"ListContactFlows": "<p>Provides information about the contact flows for the specified Amazon Connect instance.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>For more information about contact flows, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html\">Contact Flows</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListHoursOfOperations": "<p>Provides information about the hours of operation for the specified Amazon Connect instance.</p> <p>For more information about hours of operation, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html\">Set the Hours of Operation for a Queue</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListInstanceAttributes": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all attribute types for the given instance.</p>",
"ListInstanceStorageConfigs": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of storage configs for the identified instance and resource type.</p>",
"ListInstances": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.</p>",
"ListIntegrationAssociations": "<p>Provides summary information about the AWS resource associations for the specified Amazon Connect instance.</p>",
"ListLambdaFunctions": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.</p>",
"ListLexBots": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all the Amazon Lex bots currently associated with the instance.</p>",
"ListPhoneNumbers": "<p>Provides information about the phone numbers for the specified Amazon Connect instance. </p> <p>For more information about phone numbers, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html\">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListPrompts": "<p>Provides information about the prompts for the specified Amazon Connect instance.</p>",
"ListQueueQuickConnects": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists the quick connects associated with a queue.</p>",
"ListQueues": "<p>Provides information about the queues for the specified Amazon Connect instance.</p> <p>If you do not specify a <code>QueueTypes</code> parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.</p> <p>For more information about queues, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html\">Queues: Standard and Agent</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListQuickConnects": "<p>Provides information about the quick connects for the specified Amazon Connect instance. </p>",
"ListRoutingProfileQueues": "<p>Lists the queues associated with a routing profile.</p>",
"ListRoutingProfiles": "<p>Provides summary information about the routing profiles for the specified Amazon Connect instance.</p> <p>For more information about routing profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html\">Routing Profiles</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html\">Create a Routing Profile</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListSecurityKeys": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all security keys associated with the instance.</p>",
"ListSecurityProfiles": "<p>Provides summary information about the security profiles for the specified Amazon Connect instance.</p> <p>For more information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListTagsForResource": "<p>Lists the tags for the specified resource.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListUseCases": "<p>Lists the use cases for the integration association. </p>",
"ListUserHierarchyGroups": "<p>Provides summary information about the hierarchy groups for the specified Amazon Connect instance.</p> <p>For more information about agent hierarchies, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html\">Set Up Agent Hierarchies</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ListUsers": "<p>Provides summary information about the users for the specified Amazon Connect instance.</p>",
"ResumeContactRecording": "<p>When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.</p> <p>Only voice recordings are supported at this time.</p>",
"StartChatContact": "<p>Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in two situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>For more information about chat, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat.html\">Chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"StartContactRecording": "<p>Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.</p> <p>You can use this API to override the recording behavior configured in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html\">Set recording behavior</a> block.</p> <p>Only voice recordings are supported at this time.</p>",
"StartOutboundVoiceContact": "<p>Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in <code>ContactFlowId</code>).</p> <p>Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.</p> <p>There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.</p> <note> <p>UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </note> <note> <p>Campaign calls are not allowed by default. Before you can make a call with <code>TrafficType</code> = <code>CAMPAIGN</code>, you must submit a service quota increase request. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </note>",
"StartTaskContact": "<p>Initiates a contact flow to start a new task.</p>",
"StopContact": "<p>Ends the specified contact.</p>",
"StopContactRecording": "<p>Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.</p> <p>Only voice recordings are supported at this time.</p>",
"SuspendContactRecording": "<p>When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. </p> <p>The period of time that the recording is suspended is filled with silence in the final recording. </p> <p>Only voice recordings are supported at this time.</p>",
"TagResource": "<p>Adds the specified tags to the specified resource.</p> <p>The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, and hours of operation.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"UntagResource": "<p>Removes the specified tags from the specified resource.</p>",
"UpdateAgentStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates agent status.</p>",
"UpdateContactAttributes": "<p>Creates or updates user-defined contact attributes associated with the specified contact.</p> <p>You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.</p> <p>Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about CTR retention and the maximum size of the CTR attributes section, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits\">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>. </p> <p> <b>Important:</b> You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.</p>",
"UpdateContactFlowContent": "<p>Updates the specified contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>",
"UpdateContactFlowName": "<p>The name of the contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>",
"UpdateHoursOfOperation": "<p>Updates the hours of operation.</p>",
"UpdateInstanceAttribute": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the value for the specified attribute type.</p>",
"UpdateInstanceStorageConfig": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates an existing configuration for a resource type. This API is idempotent.</p>",
"UpdateQueueHoursOfOperation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the hours of operation for the specified queue.</p>",
"UpdateQueueMaxContacts": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the maximum number of contacts allowed in a queue before it is considered full.</p>",
"UpdateQueueName": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the name and description of a queue. At least <code>Name</code> or <code>Description</code> must be provided.</p>",
"UpdateQueueOutboundCallerConfig": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.</p>",
"UpdateQueueStatus": "<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the status of the queue.</p>",
"UpdateQuickConnectConfig": "<p>Updates the configuration settings for the specified quick connect.</p>",
"UpdateQuickConnectName": "<p>Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least <code>Name</code> or <code>Description</code> must be provided.</p>",
"UpdateRoutingProfileConcurrency": "<p>Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.</p>",
"UpdateRoutingProfileDefaultOutboundQueue": "<p>Updates the default outbound queue of a routing profile.</p>",
"UpdateRoutingProfileName": "<p>Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least <code>Name</code> or <code>Description</code> must be provided.</p>",
"UpdateRoutingProfileQueues": "<p>Updates the properties associated with a set of queues for a routing profile.</p>",
"UpdateUserHierarchy": "<p>Assigns the specified hierarchy group to the specified user.</p>",
"UpdateUserHierarchyGroupName": "<p>Updates the name of the user hierarchy group. </p>",
"UpdateUserHierarchyStructure": "<p>Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.</p>",
"UpdateUserIdentityInfo": "<p>Updates the identity information for the specified user.</p> <important> <p>We strongly recommend limiting who has the ability to invoke <code>UpdateUserIdentityInfo</code>. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html\">Best Practices for Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p> </important>",
"UpdateUserPhoneConfig": "<p>Updates the phone configuration settings for the specified user.</p>",
"UpdateUserRoutingProfile": "<p>Assigns the specified routing profile to the specified user.</p>",
"UpdateUserSecurityProfiles": "<p>Assigns the specified security profiles to the specified user.</p>"
},
"shapes": {
"ARN": {
"base": null,
"refs": {
"AgentStatus$AgentStatusARN": "<p>The Amazon Resource Name (ARN) of the agent status.</p>",
"AgentStatusSummary$Arn": "<p>The Amazon Resource Name (ARN) for the agent status.</p>",
"ContactFlow$Arn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>",
"ContactFlowSummary$Arn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>",
"CreateAgentStatusResponse$AgentStatusARN": "<p>The Amazon Resource Name (ARN) of the agent status.</p>",
"CreateContactFlowResponse$ContactFlowArn": "<p>The Amazon Resource Name (ARN) of the contact flow.</p>",
"CreateHoursOfOperationResponse$HoursOfOperationArn": "<p>The Amazon Resource Name (ARN) for the hours of operation.</p>",
"CreateInstanceResponse$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
"CreateIntegrationAssociationRequest$IntegrationArn": "<p>The Amazon Resource Name (ARN) of the integration.</p>",
"CreateIntegrationAssociationResponse$IntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the association.</p>",
"CreateQueueResponse$QueueArn": "<p>The Amazon Resource Name (ARN) of the queue.</p>",
"CreateQuickConnectResponse$QuickConnectARN": "<p>The Amazon Resource Name (ARN) for the quick connect. </p>",
"CreateRoutingProfileResponse$RoutingProfileArn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>",
"CreateUseCaseResponse$UseCaseArn": "<p>The Amazon Resource Name (ARN) for the use case.</p>",
"CreateUserHierarchyGroupResponse$HierarchyGroupArn": "<p>The Amazon Resource Name (ARN) of the hierarchy group. </p>",
"CreateUserResponse$UserArn": "<p>The Amazon Resource Name (ARN) of the user account.</p>",
"HierarchyGroup$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>",
"HierarchyGroupSummary$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy group.</p>",
"HierarchyLevel$Arn": "<p>The Amazon Resource Name (ARN) of the hierarchy level.</p>",
"HoursOfOperation$HoursOfOperationArn": "<p>The Amazon Resource Name (ARN) for the hours of operation.</p>",
"HoursOfOperationSummary$Arn": "<p>The Amazon Resource Name (ARN) of the hours of operation.</p>",
"Instance$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
"Instance$ServiceRole": "<p>The service role of the instance.</p>",
"InstanceSummary$Arn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
"InstanceSummary$ServiceRole": "<p>The service role of the instance.</p>",
"IntegrationAssociationSummary$IntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the AppIntegration association.</p>",
"IntegrationAssociationSummary$IntegrationArn": "<p>The Amazon Resource Name (ARN) for the AppIntegration.</p>",
"KinesisFirehoseConfig$FirehoseArn": "<p>The Amazon Resource Name (ARN) of the delivery stream.</p>",
"KinesisStreamConfig$StreamArn": "<p>The Amazon Resource Name (ARN) of the data stream.</p>",
"ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"PhoneNumberSummary$Arn": "<p>The Amazon Resource Name (ARN) of the phone number.</p>",
"PromptSummary$Arn": "<p>The Amazon Resource Name (ARN) of the prompt.</p>",
"Queue$QueueArn": "<p>The Amazon Resource Name (ARN) for the queue.</p>",
"QueueReference$Arn": "<p>The Amazon Resource Name (ARN) of the queue.</p>",
"QueueSummary$Arn": "<p>The Amazon Resource Name (ARN) of the queue.</p>",
"QuickConnect$QuickConnectARN": "<p>The Amazon Resource Name (ARN) of the quick connect.</p>",
"QuickConnectSummary$Arn": "<p>The Amazon Resource Name (ARN) of the quick connect.</p>",
"ResourceInUseException$ResourceId": "<p>The identifier for the resource.</p>",
"RoutingProfile$RoutingProfileArn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>",
"RoutingProfileQueueConfigSummary$QueueArn": "<p>The Amazon Resource Name (ARN) of the queue.</p>",
"RoutingProfileSummary$Arn": "<p>The Amazon Resource Name (ARN) of the routing profile.</p>",
"SecurityProfileSummary$Arn": "<p>The Amazon Resource Name (ARN) of the security profile.</p>",
"TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"UseCase$UseCaseArn": "<p>The Amazon Resource Name (ARN) for the use case.</p>",
"User$Arn": "<p>The Amazon Resource Name (ARN) of the user account.</p>",
"UserSummary$Arn": "<p>The Amazon Resource Name (ARN) of the user account.</p>"
}
},
"AfterContactWorkTimeLimit": {
"base": null,
"refs": {
"UserPhoneConfig$AfterContactWorkTimeLimit": "<p>The After Call Work (ACW) timeout setting, in seconds.</p>"
}
},
"AgentFirstName": {
"base": null,
"refs": {
"UserIdentityInfo$FirstName": "<p>The first name. This is required if you are using Amazon Connect or SAML for identity management.</p>"
}
},
"AgentLastName": {
"base": null,
"refs": {
"UserIdentityInfo$LastName": "<p>The last name. This is required if you are using Amazon Connect or SAML for identity management.</p>"
}
},
"AgentStatus": {
"base": "<p>Contains information about an agent status.</p>",
"refs": {
"DescribeAgentStatusResponse$AgentStatus": "<p>The agent status.</p>"
}
},
"AgentStatusDescription": {
"base": null,
"refs": {
"AgentStatus$Description": "<p>The description of the agent status.</p>",
"CreateAgentStatusRequest$Description": "<p>The description of the status.</p>"
}
},
"AgentStatusId": {
"base": null,
"refs": {
"AgentStatus$AgentStatusId": "<p>The identifier of the agent status.</p>",
"AgentStatusSummary$Id": "<p>The identifier for an agent status.</p>",
"CreateAgentStatusResponse$AgentStatusId": "<p>The identifier of the agent status.</p>",
"DescribeAgentStatusRequest$AgentStatusId": "<p>The identifier for the agent status.</p>",
"UpdateAgentStatusRequest$AgentStatusId": "<p>The identifier of the agent status.</p>"
}
},
"AgentStatusName": {
"base": null,
"refs": {
"AgentStatus$Name": "<p>The name of the agent status.</p>",
"AgentStatusSummary$Name": "<p>The name of the agent status.</p>",
"CreateAgentStatusRequest$Name": "<p>The name of the status.</p>",
"UpdateAgentStatusRequest$Name": "<p>The name of the agent status.</p>"
}
},
"AgentStatusOrderNumber": {
"base": null,
"refs": {
"AgentStatus$DisplayOrder": "<p>The display order of the agent status.</p>",
"CreateAgentStatusRequest$DisplayOrder": "<p>The display order of the status.</p>",
"UpdateAgentStatusRequest$DisplayOrder": "<p>The display order of the agent status.</p>"
}
},
"AgentStatusState": {
"base": null,
"refs": {
"AgentStatus$State": "<p>The state of the agent status.</p>",
"CreateAgentStatusRequest$State": "<p>The state of the status.</p>",
"UpdateAgentStatusRequest$State": "<p>The state of the agent status.</p>"
}
},
"AgentStatusSummary": {
"base": "<p>Summary information for an agent status.</p>",
"refs": {
"AgentStatusSummaryList$member": null
}
},
"AgentStatusSummaryList": {
"base": null,
"refs": {
"ListAgentStatusResponse$AgentStatusSummaryList": "<p>A summary of agent statuses.</p>"
}
},
"AgentStatusType": {
"base": null,
"refs": {
"AgentStatus$Type": "<p>The type of agent status.</p>",
"AgentStatusSummary$Type": "<p>The type of the agent status.</p>",
"AgentStatusTypes$member": null
}
},
"AgentStatusTypes": {
"base": null,
"refs": {
"ListAgentStatusRequest$AgentStatusTypes": "<p>Available agent status types.</p>"
}
},
"AgentUsername": {
"base": null,
"refs": {
"CreateUserRequest$Username": "<p>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_-.\\@]+.</p>",
"User$Username": "<p>The user name assigned to the user account.</p>",
"UserSummary$Username": "<p>The Amazon Connect user name of the user account.</p>"
}
},
"AliasArn": {
"base": null,
"refs": {
"LexV2Bot$AliasArn": "<p>The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.</p>"
}
},
"AnswerMachineDetectionConfig": {
"base": "<p>Configuration of the answering machine detection.</p>",
"refs": {
"StartOutboundVoiceContactRequest$AnswerMachineDetectionConfig": "<p>Configuration of the answering machine detection for this outbound call. </p>"
}
},
"AssociateApprovedOriginRequest": {
"base": null,
"refs": {
}
},
"AssociateBotRequest": {
"base": null,
"refs": {
}
},
"AssociateInstanceStorageConfigRequest": {
"base": null,
"refs": {
}
},
"AssociateInstanceStorageConfigResponse": {
"base": null,
"refs": {
}
},
"AssociateLambdaFunctionRequest": {
"base": null,
"refs": {
}
},
"AssociateLexBotRequest": {
"base": null,
"refs": {
}
},
"AssociateQueueQuickConnectsRequest": {
"base": null,
"refs": {
}
},
"AssociateRoutingProfileQueuesRequest": {
"base": null,
"refs": {
}
},
"AssociateSecurityKeyRequest": {
"base": null,
"refs": {
}
},
"AssociateSecurityKeyResponse": {
"base": null,
"refs": {
}
},
"AssociationId": {
"base": null,
"refs": {
"AssociateInstanceStorageConfigResponse$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"AssociateSecurityKeyResponse$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"DescribeInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"DisassociateInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"DisassociateSecurityKeyRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"InstanceStorageConfig$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"SecurityKey$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>",
"UpdateInstanceStorageConfigRequest$AssociationId": "<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>"
}
},
"Attribute": {
"base": "<p>A toggle for an individual feature at the instance level.</p>",
"refs": {
"AttributesList$member": null,
"DescribeInstanceAttributeResponse$Attribute": "<p>The type of attribute.</p>"
}
},
"AttributeName": {
"base": null,
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": null,
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": null,
"refs": {
"GetContactAttributesResponse$Attributes": "<p>Information about the attributes.</p>",
"StartChatContactRequest$Attributes": "<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes. </p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>",
"StartOutboundVoiceContactRequest$Attributes": "<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>",
"StartTaskContactRequest$Attributes": "<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>",
"UpdateContactAttributesRequest$Attributes": "<p>The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.</p> <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>"
}
},
"AttributesList": {
"base": null,
"refs": {
"ListInstanceAttributesResponse$Attributes": "<p>The attribute types.</p>"
}
},
"AutoAccept": {
"base": null,
"refs": {
"UserPhoneConfig$AutoAccept": "<p>The Auto accept setting.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"AnswerMachineDetectionConfig$EnableAnswerMachineDetection": "<p>The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>. </p>",
"AnswerMachineDetectionConfig$AwaitAnswerMachinePrompt": "<p>Wait for the answering machine prompt.</p>",
"UpdateAgentStatusRequest$ResetOrderNumber": "<p>A number indicating the reset order of the agent status.</p>"
}
},
"BotName": {
"base": null,
"refs": {
"DisassociateLexBotRequest$BotName": "<p>The name of the Amazon Lex bot. Maximum character limit of 50.</p>",
"LexBot$Name": "<p>The name of the Amazon Lex bot.</p>"
}
},
"BucketName": {
"base": null,
"refs": {
"S3Config$BucketName": "<p>The S3 bucket name.</p>"
}
},
"CampaignId": {
"base": null,
"refs": {
"StartOutboundVoiceContactRequest$CampaignId": "<p>The campaign identifier of the outbound communication.</p>"
}
},
"Channel": {
"base": null,
"refs": {
"Channels$member": null,
"Dimensions$Channel": "<p>The channel used for grouping and filters.</p>",
"MediaConcurrency$Channel": "<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>",
"RoutingProfileQueueConfigSummary$Channel": "<p>The channels this queue supports.</p>",
"RoutingProfileQueueReference$Channel": "<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>"
}
},
"Channels": {
"base": null,
"refs": {
"Filters$Channels": "<p>The channel to use to filter the metrics.</p>"
}
},
"ChatContent": {
"base": null,
"refs": {
"ChatMessage$Content": "<p>The content of the chat message.</p>"
}
},
"ChatContentType": {
"base": null,
"refs": {
"ChatMessage$ContentType": "<p>The type of the content. Supported types are text and plain.</p>"
}
},
"ChatMessage": {
"base": "<p>A chat message.</p>",
"refs": {
"StartChatContactRequest$InitialMessage": "<p>The initial message to be sent to the newly created chat.</p>"
}
},
"ClientToken": {
"base": null,
"refs": {
"CreateInstanceRequest$ClientToken": "<p>The idempotency token.</p>",
"StartChatContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"StartOutboundVoiceContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. </p>",
"StartTaskContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
}
},
"CommonNameLength127": {
"base": null,
"refs": {
"CreateHoursOfOperationRequest$Name": "<p>The name of the hours of operation.</p>",
"CreateQueueRequest$Name": "<p>The name of the queue.</p>",
"HoursOfOperation$Name": "<p>The name for the hours of operation.</p>",
"Queue$Name": "<p>The name of the queue.</p>",
"UpdateHoursOfOperationRequest$Name": "<p>The name of the hours of operation.</p>",
"UpdateQueueNameRequest$Name": "<p>The name of the queue.</p>"
}
},
"Comparison": {
"base": null,
"refs": {
"Threshold$Comparison": "<p>The type of comparison. Only \"less than\" (LT) comparisons are supported.</p>"
}
},
"Concurrency": {
"base": null,
"refs": {
"MediaConcurrency$Concurrency": "<p>The number of contacts an agent can have on a channel simultaneously.</p> <p>Valid Range for <code>VOICE</code>: Minimum value of 1. Maximum value of 1.</p> <p>Valid Range for <code>CHAT</code>: Minimum value of 1. Maximum value of 10.</p> <p>Valid Range for <code>TASK</code>: Minimum value of 1. Maximum value of 10.</p>"
}
},
"ContactFlow": {
"base": "<p>Contains information about a contact flow.</p>",
"refs": {
"DescribeContactFlowResponse$ContactFlow": "<p>Information about the contact flow.</p>"
}
},
"ContactFlowContent": {
"base": null,
"refs": {
"ContactFlow$Content": "<p>The content of the contact flow.</p>",
"CreateContactFlowRequest$Content": "<p>The content of the contact flow. </p>",
"UpdateContactFlowContentRequest$Content": "<p>The JSON string that represents contact flow’s content. For an example, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html\">Example contact flow in Amazon Connect Flow language</a> in the <i>Amazon Connect Administrator Guide</i>. </p>"
}
},
"ContactFlowDescription": {
"base": null,
"refs": {
"ContactFlow$Description": "<p>The description of the contact flow.</p>",
"CreateContactFlowRequest$Description": "<p>The description of the contact flow. </p>",
"UpdateContactFlowNameRequest$Description": "<p>The description of the contact flow.</p>"
}
},
"ContactFlowId": {
"base": null,
"refs": {
"ContactFlow$Id": "<p>The identifier of the contact flow.</p>",
"ContactFlowSummary$Id": "<p>The identifier of the contact flow.</p>",
"CreateContactFlowResponse$ContactFlowId": "<p>The identifier of the contact flow.</p>",
"DescribeContactFlowRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>",
"OutboundCallerConfig$OutboundFlowId": "<p>The outbound whisper flow to be used during an outbound call.</p>",
"QueueQuickConnectConfig$ContactFlowId": "<p>The identifier of the contact flow.</p>",
"StartChatContactRequest$ContactFlowId": "<p>The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>",
"StartOutboundVoiceContactRequest$ContactFlowId": "<p>The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>",
"StartTaskContactRequest$ContactFlowId": "<p>The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>",
"UpdateContactFlowContentRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>",
"UpdateContactFlowNameRequest$ContactFlowId": "<p>The identifier of the contact flow.</p>",
"UserQuickConnectConfig$ContactFlowId": "<p>The identifier of the contact flow.</p>"
}
},
"ContactFlowName": {
"base": null,
"refs": {
"ContactFlow$Name": "<p>The name of the contact flow.</p>",
"ContactFlowSummary$Name": "<p>The name of the contact flow.</p>",
"CreateContactFlowRequest$Name": "<p>The name of the contact flow.</p>",
"UpdateContactFlowNameRequest$Name": "<p>The name of the contact flow.</p>"
}
},
"ContactFlowNotPublishedException": {
"base": "<p>The contact flow has not been published.</p>",
"refs": {
}
},
"ContactFlowSummary": {
"base": "<p>Contains summary information about a contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>",
"refs": {
"ContactFlowSummaryList$member": null
}
},
"ContactFlowSummaryList": {
"base": null,
"refs": {
"ListContactFlowsResponse$ContactFlowSummaryList": "<p>Information about the contact flows.</p>"
}
},
"ContactFlowType": {
"base": null,
"refs": {
"ContactFlow$Type": "<p>The type of the contact flow. For descriptions of the available types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types\">Choose a Contact Flow Type</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"ContactFlowSummary$ContactFlowType": "<p>The type of contact flow.</p>",
"ContactFlowTypes$member": null,
"CreateContactFlowRequest$Type": "<p>The type of the contact flow. For descriptions of the available types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types\">Choose a Contact Flow Type</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
}
},
"ContactFlowTypes": {
"base": null,
"refs": {
"ListContactFlowsRequest$ContactFlowTypes": "<p>The type of contact flow.</p>"
}
},
"ContactId": {
"base": null,
"refs": {
"GetContactAttributesRequest$InitialContactId": "<p>The identifier of the initial contact.</p>",
"ResumeContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>",
"ResumeContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>",
"StartChatContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance. </p>",
"StartContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>",
"StartContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>",
"StartOutboundVoiceContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance.</p>",
"StartTaskContactRequest$PreviousContactId": "<p>The identifier of the previous chat, voice, or task contact. </p>",
"StartTaskContactResponse$ContactId": "<p>The identifier of this contact within the Amazon Connect instance.</p>",
"StopContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>",
"StopContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>",
"StopContactRequest$ContactId": "<p>The ID of the contact.</p>",
"SuspendContactRecordingRequest$ContactId": "<p>The identifier of the contact.</p>",
"SuspendContactRecordingRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>",
"UpdateContactAttributesRequest$InitialContactId": "<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p>"
}
},
"ContactNotFoundException": {
"base": "<p>The contact with the specified ID is not active or does not exist.</p>",
"refs": {
}
},
"ContactReferences": {
"base": null,
"refs": {
"StartTaskContactRequest$References": "<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP).</p>"
}
},
"CreateAgentStatusRequest": {
"base": null,
"refs": {
}
},
"CreateAgentStatusResponse": {
"base": null,
"refs": {
}
},
"CreateContactFlowRequest": {
"base": null,
"refs": {
}
},
"CreateContactFlowResponse": {
"base": null,
"refs": {
}
},
"CreateHoursOfOperationRequest": {
"base": null,
"refs": {
}
},
"CreateHoursOfOperationResponse": {
"base": null,
"refs": {
}
},
"CreateInstanceRequest": {
"base": null,
"refs": {
}
},
"CreateInstanceResponse": {
"base": null,
"refs": {
}
},
"CreateIntegrationAssociationRequest": {
"base": null,
"refs": {
}
},
"CreateIntegrationAssociationResponse": {
"base": null,
"refs": {
}
},
"CreateQueueRequest": {
"base": null,
"refs": {
}
},
"CreateQueueResponse": {
"base": null,
"refs": {
}
},
"CreateQuickConnectRequest": {
"base": null,
"refs": {
}
},
"CreateQuickConnectResponse": {
"base": null,
"refs": {
}
},
"CreateRoutingProfileRequest": {
"base": null,
"refs": {
}
},
"CreateRoutingProfileResponse": {
"base": null,
"refs": {
}
},
"CreateUseCaseRequest": {
"base": null,
"refs": {
}
},
"CreateUseCaseResponse": {
"base": null,
"refs": {
}
},
"CreateUserHierarchyGroupRequest": {
"base": null,
"refs": {
}
},
"CreateUserHierarchyGroupResponse": {
"base": null,
"refs": {
}
},
"CreateUserRequest": {
"base": null,
"refs": {
}
},
"CreateUserResponse": {
"base": null,
"refs": {
}
},
"Credentials": {
"base": "<p>Contains credentials to use for federation.</p>",
"refs": {
"GetFederationTokenResponse$Credentials": "<p>The credentials to use for federation.</p>"
}
},
"CurrentMetric": {
"base": "<p>Contains information about a real-time metric. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"refs": {
"CurrentMetricData$Metric": "<p>Information about the metric.</p>",
"CurrentMetrics$member": null
}
},
"CurrentMetricData": {
"base": "<p>Contains the data for a real-time metric.</p>",
"refs": {
"CurrentMetricDataCollections$member": null
}
},
"CurrentMetricDataCollections": {
"base": null,
"refs": {
"CurrentMetricResult$Collections": "<p>The set of metrics.</p>"
}
},
"CurrentMetricName": {
"base": "<p>The current metric names.</p>",
"refs": {
"CurrentMetric$Name": "<p>The name of the metric.</p>"
}
},
"CurrentMetricResult": {
"base": "<p>Contains information about a set of real-time metrics.</p>",
"refs": {
"CurrentMetricResults$member": null
}
},
"CurrentMetricResults": {
"base": null,
"refs": {
"GetCurrentMetricDataResponse$MetricResults": "<p>Information about the real-time metrics.</p>"
}
},
"CurrentMetrics": {
"base": null,
"refs": {
"GetCurrentMetricDataRequest$CurrentMetrics": "<p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time\">ACW</a> </p> </dd> <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time\">Available</a> </p> </dd> <dt>AGENTS_ERROR</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time\">Error</a> </p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time\">NPT (Non-Productive Time)</a> </p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ONLINE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time\">Online</a> </p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time\">Staffed</a> </p> </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time\">In queue</a> </p> </dd> <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time\">Scheduled</a> </p> </dd> <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p> <p>When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:</p> <p> <code>{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 </code>}</p> <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time\">Oldest</a> </p> </dd> <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time\">Active</a> </p> </dd> <dt>SLOTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time\">Availability</a> </p> </dd> </dl>"
}
},
"Delay": {
"base": null,
"refs": {
"RoutingProfileQueueConfig$Delay": "<p>The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html\">Queues: priority and delay</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
"RoutingProfileQueueConfigSummary$Delay": "<p>The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html\">Queues: priority and delay</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
}
},
"DeleteHoursOfOperationRequest": {
"base": null,
"refs": {
}
},
"DeleteInstanceRequest": {
"base": null,
"refs": {
}
},
"DeleteIntegrationAssociationRequest": {
"base": null,
"refs": {
}
},
"DeleteQuickConnectRequest": {
"base": null,
"refs": {
}
},
"DeleteUseCaseRequest": {
"base": null,
"refs": {
}
},
"DeleteUserHierarchyGroupRequest": {
"base": null,
"refs": {
}
},
"DeleteUserRequest": {
"base": null,
"refs": {
}
},
"DescribeAgentStatusRequest": {
"base": null,
"refs": {
}
},
"DescribeAgentStatusResponse": {
"base": null,
"refs": {
}
},
"DescribeContactFlowRequest": {
"base": null,
"refs": {
}
},
"DescribeContactFlowResponse": {
"base": null,
"refs": {
}
},
"DescribeHoursOfOperationRequest": {
"base": null,
"refs": {
}
},
"DescribeHoursOfOperationResponse": {
"base": null,
"refs": {
}
},
"DescribeInstanceAttributeRequest": {
"base": null,
"refs": {
}
},
"DescribeInstanceAttributeResponse": {
"base": null,
"refs": {
}
},
"DescribeInstanceRequest": {
"base": null,
"refs": {
}
},
"DescribeInstanceResponse": {
"base": null,
"refs": {
}
},
"DescribeInstanceStorageConfigRequest": {
"base": null,
"refs": {
}
},
"DescribeInstanceStorageConfigResponse": {
"base": null,
"refs": {
}
},
"DescribeQueueRequest": {
"base": null,
"refs": {
}
},
"DescribeQueueResponse": {
"base": null,
"refs": {
}
},
"DescribeQuickConnectRequest": {
"base": null,
"refs": {
}
},
"DescribeQuickConnectResponse": {
"base": null,
"refs": {
}
},
"DescribeRoutingProfileRequest": {
"base": null,
"refs": {
}
},
"DescribeRoutingProfileResponse": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyGroupRequest": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyGroupResponse": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyStructureRequest": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyStructureResponse": {
"base": null,
"refs": {
}
},
"DescribeUserRequest": {
"base": null,
"refs": {
}
},
"DescribeUserResponse": {
"base": null,
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"StartTaskContactRequest$Description": "<p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>"
}
},
"DestinationNotAllowedException": {
"base": "<p>Outbound calls to the destination number are not allowed.</p>",
"refs": {
}
},
"Dimensions": {
"base": "<p>Contains information about the dimensions for a set of metrics.</p>",
"refs": {
"CurrentMetricResult$Dimensions": "<p>The dimensions for the metrics.</p>",
"HistoricalMetricResult$Dimensions": "<p>The dimension for the metrics.</p>"
}
},
"DirectoryAlias": {
"base": null,
"refs": {
"CreateInstanceRequest$InstanceAlias": "<p>The name for your instance.</p>",
"Instance$InstanceAlias": "<p>The alias of instance.</p>",
"InstanceSummary$InstanceAlias": "<p>The alias of the instance.</p>"
}
},
"DirectoryId": {
"base": null,
"refs": {
"CreateInstanceRequest$DirectoryId": "<p>The identifier for the directory.</p>"
}
},
"DirectoryType": {
"base": null,
"refs": {
"CreateInstanceRequest$IdentityManagementType": "<p>The type of identity management for your Amazon Connect users.</p>",
"Instance$IdentityManagementType": "<p>The identity management type.</p>",
"InstanceSummary$IdentityManagementType": "<p>The identity management type of the instance.</p>"
}
},
"DirectoryUserId": {
"base": null,
"refs": {
"CreateUserRequest$DirectoryUserId": "<p>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.</p> <p>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.</p>",
"User$DirectoryUserId": "<p>The identifier of the user account in the directory used for identity management.</p>"
}
},
"DisassociateApprovedOriginRequest": {
"base": null,
"refs": {
}
},
"DisassociateBotRequest": {
"base": null,
"refs": {
}
},
"DisassociateInstanceStorageConfigRequest": {
"base": null,
"refs": {
}
},
"DisassociateLambdaFunctionRequest": {
"base": null,
"refs": {
}
},
"DisassociateLexBotRequest": {
"base": null,
"refs": {
}
},
"DisassociateQueueQuickConnectsRequest": {
"base": null,
"refs": {
}
},
"DisassociateRoutingProfileQueuesRequest": {
"base": null,
"refs": {
}
},
"DisassociateSecurityKeyRequest": {
"base": null,
"refs": {
}
},
"DisplayName": {
"base": null,
"refs": {
"ParticipantDetails$DisplayName": "<p>Display name of the participant.</p>"
}