UNPKG

21.1 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2017-08-08",
5 "endpointPrefix": "connect",
6 "jsonVersion": "1.1",
7 "protocol": "rest-json",
8 "serviceAbbreviation": "Amazon Connect",
9 "serviceFullName": "Amazon Connect Service",
10 "serviceId": "Connect",
11 "signatureVersion": "v4",
12 "signingName": "connect",
13 "uid": "connect-2017-08-08"
14 },
15 "operations": {
16 "CreateUser": {
17 "http": {
18 "method": "PUT",
19 "requestUri": "/users/{InstanceId}"
20 },
21 "input": {
22 "type": "structure",
23 "required": [
24 "Username",
25 "PhoneConfig",
26 "SecurityProfileIds",
27 "RoutingProfileId",
28 "InstanceId"
29 ],
30 "members": {
31 "Username": {},
32 "Password": {},
33 "IdentityInfo": {
34 "shape": "S4"
35 },
36 "PhoneConfig": {
37 "shape": "S8"
38 },
39 "DirectoryUserId": {},
40 "SecurityProfileIds": {
41 "shape": "Se"
42 },
43 "RoutingProfileId": {},
44 "HierarchyGroupId": {},
45 "InstanceId": {
46 "location": "uri",
47 "locationName": "InstanceId"
48 }
49 }
50 },
51 "output": {
52 "type": "structure",
53 "members": {
54 "UserId": {},
55 "UserArn": {}
56 }
57 }
58 },
59 "DeleteUser": {
60 "http": {
61 "method": "DELETE",
62 "requestUri": "/users/{InstanceId}/{UserId}"
63 },
64 "input": {
65 "type": "structure",
66 "required": [
67 "InstanceId",
68 "UserId"
69 ],
70 "members": {
71 "InstanceId": {
72 "location": "uri",
73 "locationName": "InstanceId"
74 },
75 "UserId": {
76 "location": "uri",
77 "locationName": "UserId"
78 }
79 }
80 }
81 },
82 "DescribeUser": {
83 "http": {
84 "method": "GET",
85 "requestUri": "/users/{InstanceId}/{UserId}"
86 },
87 "input": {
88 "type": "structure",
89 "required": [
90 "UserId",
91 "InstanceId"
92 ],
93 "members": {
94 "UserId": {
95 "location": "uri",
96 "locationName": "UserId"
97 },
98 "InstanceId": {
99 "location": "uri",
100 "locationName": "InstanceId"
101 }
102 }
103 },
104 "output": {
105 "type": "structure",
106 "members": {
107 "User": {
108 "type": "structure",
109 "members": {
110 "Id": {},
111 "Arn": {},
112 "Username": {},
113 "IdentityInfo": {
114 "shape": "S4"
115 },
116 "PhoneConfig": {
117 "shape": "S8"
118 },
119 "DirectoryUserId": {},
120 "SecurityProfileIds": {
121 "shape": "Se"
122 },
123 "RoutingProfileId": {},
124 "HierarchyGroupId": {}
125 }
126 }
127 }
128 }
129 },
130 "DescribeUserHierarchyGroup": {
131 "http": {
132 "method": "GET",
133 "requestUri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}"
134 },
135 "input": {
136 "type": "structure",
137 "required": [
138 "HierarchyGroupId",
139 "InstanceId"
140 ],
141 "members": {
142 "HierarchyGroupId": {
143 "location": "uri",
144 "locationName": "HierarchyGroupId"
145 },
146 "InstanceId": {
147 "location": "uri",
148 "locationName": "InstanceId"
149 }
150 }
151 },
152 "output": {
153 "type": "structure",
154 "members": {
155 "HierarchyGroup": {
156 "type": "structure",
157 "members": {
158 "Id": {},
159 "Arn": {},
160 "Name": {},
161 "LevelId": {},
162 "HierarchyPath": {
163 "type": "structure",
164 "members": {
165 "LevelOne": {
166 "shape": "Sw"
167 },
168 "LevelTwo": {
169 "shape": "Sw"
170 },
171 "LevelThree": {
172 "shape": "Sw"
173 },
174 "LevelFour": {
175 "shape": "Sw"
176 },
177 "LevelFive": {
178 "shape": "Sw"
179 }
180 }
181 }
182 }
183 }
184 }
185 }
186 },
187 "DescribeUserHierarchyStructure": {
188 "http": {
189 "method": "GET",
190 "requestUri": "/user-hierarchy-structure/{InstanceId}"
191 },
192 "input": {
193 "type": "structure",
194 "required": [
195 "InstanceId"
196 ],
197 "members": {
198 "InstanceId": {
199 "location": "uri",
200 "locationName": "InstanceId"
201 }
202 }
203 },
204 "output": {
205 "type": "structure",
206 "members": {
207 "HierarchyStructure": {
208 "type": "structure",
209 "members": {
210 "LevelOne": {
211 "shape": "S10"
212 },
213 "LevelTwo": {
214 "shape": "S10"
215 },
216 "LevelThree": {
217 "shape": "S10"
218 },
219 "LevelFour": {
220 "shape": "S10"
221 },
222 "LevelFive": {
223 "shape": "S10"
224 }
225 }
226 }
227 }
228 }
229 },
230 "GetContactAttributes": {
231 "http": {
232 "method": "GET",
233 "requestUri": "/contact/attributes/{InstanceId}/{InitialContactId}"
234 },
235 "input": {
236 "type": "structure",
237 "required": [
238 "InstanceId",
239 "InitialContactId"
240 ],
241 "members": {
242 "InstanceId": {
243 "location": "uri",
244 "locationName": "InstanceId"
245 },
246 "InitialContactId": {
247 "location": "uri",
248 "locationName": "InitialContactId"
249 }
250 }
251 },
252 "output": {
253 "type": "structure",
254 "members": {
255 "Attributes": {
256 "shape": "S15"
257 }
258 }
259 }
260 },
261 "GetCurrentMetricData": {
262 "http": {
263 "requestUri": "/metrics/current/{InstanceId}"
264 },
265 "input": {
266 "type": "structure",
267 "required": [
268 "InstanceId",
269 "Filters",
270 "CurrentMetrics"
271 ],
272 "members": {
273 "InstanceId": {
274 "location": "uri",
275 "locationName": "InstanceId"
276 },
277 "Filters": {
278 "shape": "S19"
279 },
280 "Groupings": {
281 "shape": "S1e"
282 },
283 "CurrentMetrics": {
284 "type": "list",
285 "member": {
286 "shape": "S1h"
287 }
288 },
289 "NextToken": {},
290 "MaxResults": {
291 "type": "integer"
292 }
293 }
294 },
295 "output": {
296 "type": "structure",
297 "members": {
298 "NextToken": {},
299 "MetricResults": {
300 "type": "list",
301 "member": {
302 "type": "structure",
303 "members": {
304 "Dimensions": {
305 "shape": "S1p"
306 },
307 "Collections": {
308 "type": "list",
309 "member": {
310 "type": "structure",
311 "members": {
312 "Metric": {
313 "shape": "S1h"
314 },
315 "Value": {
316 "type": "double"
317 }
318 }
319 }
320 }
321 }
322 }
323 },
324 "DataSnapshotTime": {
325 "type": "timestamp"
326 }
327 }
328 }
329 },
330 "GetFederationToken": {
331 "http": {
332 "method": "GET",
333 "requestUri": "/user/federate/{InstanceId}"
334 },
335 "input": {
336 "type": "structure",
337 "required": [
338 "InstanceId"
339 ],
340 "members": {
341 "InstanceId": {
342 "location": "uri",
343 "locationName": "InstanceId"
344 }
345 }
346 },
347 "output": {
348 "type": "structure",
349 "members": {
350 "Credentials": {
351 "type": "structure",
352 "members": {
353 "AccessToken": {
354 "shape": "S1y"
355 },
356 "AccessTokenExpiration": {
357 "type": "timestamp"
358 },
359 "RefreshToken": {
360 "shape": "S1y"
361 },
362 "RefreshTokenExpiration": {
363 "type": "timestamp"
364 }
365 }
366 }
367 }
368 }
369 },
370 "GetMetricData": {
371 "http": {
372 "requestUri": "/metrics/historical/{InstanceId}"
373 },
374 "input": {
375 "type": "structure",
376 "required": [
377 "InstanceId",
378 "StartTime",
379 "EndTime",
380 "Filters",
381 "HistoricalMetrics"
382 ],
383 "members": {
384 "InstanceId": {
385 "location": "uri",
386 "locationName": "InstanceId"
387 },
388 "StartTime": {
389 "type": "timestamp"
390 },
391 "EndTime": {
392 "type": "timestamp"
393 },
394 "Filters": {
395 "shape": "S19"
396 },
397 "Groupings": {
398 "shape": "S1e"
399 },
400 "HistoricalMetrics": {
401 "type": "list",
402 "member": {
403 "shape": "S21"
404 }
405 },
406 "NextToken": {},
407 "MaxResults": {
408 "type": "integer"
409 }
410 }
411 },
412 "output": {
413 "type": "structure",
414 "members": {
415 "NextToken": {},
416 "MetricResults": {
417 "type": "list",
418 "member": {
419 "type": "structure",
420 "members": {
421 "Dimensions": {
422 "shape": "S1p"
423 },
424 "Collections": {
425 "type": "list",
426 "member": {
427 "type": "structure",
428 "members": {
429 "Metric": {
430 "shape": "S21"
431 },
432 "Value": {
433 "type": "double"
434 }
435 }
436 }
437 }
438 }
439 }
440 }
441 }
442 }
443 },
444 "ListRoutingProfiles": {
445 "http": {
446 "method": "GET",
447 "requestUri": "/routing-profiles-summary/{InstanceId}"
448 },
449 "input": {
450 "type": "structure",
451 "required": [
452 "InstanceId"
453 ],
454 "members": {
455 "InstanceId": {
456 "location": "uri",
457 "locationName": "InstanceId"
458 },
459 "NextToken": {
460 "location": "querystring",
461 "locationName": "nextToken"
462 },
463 "MaxResults": {
464 "location": "querystring",
465 "locationName": "maxResults",
466 "type": "integer"
467 }
468 }
469 },
470 "output": {
471 "type": "structure",
472 "members": {
473 "RoutingProfileSummaryList": {
474 "type": "list",
475 "member": {
476 "type": "structure",
477 "members": {
478 "Id": {},
479 "Arn": {},
480 "Name": {}
481 }
482 }
483 },
484 "NextToken": {}
485 }
486 }
487 },
488 "ListSecurityProfiles": {
489 "http": {
490 "method": "GET",
491 "requestUri": "/security-profiles-summary/{InstanceId}"
492 },
493 "input": {
494 "type": "structure",
495 "required": [
496 "InstanceId"
497 ],
498 "members": {
499 "InstanceId": {
500 "location": "uri",
501 "locationName": "InstanceId"
502 },
503 "NextToken": {
504 "location": "querystring",
505 "locationName": "nextToken"
506 },
507 "MaxResults": {
508 "location": "querystring",
509 "locationName": "maxResults",
510 "type": "integer"
511 }
512 }
513 },
514 "output": {
515 "type": "structure",
516 "members": {
517 "SecurityProfileSummaryList": {
518 "type": "list",
519 "member": {
520 "type": "structure",
521 "members": {
522 "Id": {},
523 "Arn": {},
524 "Name": {}
525 }
526 }
527 },
528 "NextToken": {}
529 }
530 }
531 },
532 "ListUserHierarchyGroups": {
533 "http": {
534 "method": "GET",
535 "requestUri": "/user-hierarchy-groups-summary/{InstanceId}"
536 },
537 "input": {
538 "type": "structure",
539 "required": [
540 "InstanceId"
541 ],
542 "members": {
543 "InstanceId": {
544 "location": "uri",
545 "locationName": "InstanceId"
546 },
547 "NextToken": {
548 "location": "querystring",
549 "locationName": "nextToken"
550 },
551 "MaxResults": {
552 "location": "querystring",
553 "locationName": "maxResults",
554 "type": "integer"
555 }
556 }
557 },
558 "output": {
559 "type": "structure",
560 "members": {
561 "UserHierarchyGroupSummaryList": {
562 "type": "list",
563 "member": {
564 "shape": "Sw"
565 }
566 },
567 "NextToken": {}
568 }
569 }
570 },
571 "ListUsers": {
572 "http": {
573 "method": "GET",
574 "requestUri": "/users-summary/{InstanceId}"
575 },
576 "input": {
577 "type": "structure",
578 "required": [
579 "InstanceId"
580 ],
581 "members": {
582 "InstanceId": {
583 "location": "uri",
584 "locationName": "InstanceId"
585 },
586 "NextToken": {
587 "location": "querystring",
588 "locationName": "nextToken"
589 },
590 "MaxResults": {
591 "location": "querystring",
592 "locationName": "maxResults",
593 "type": "integer"
594 }
595 }
596 },
597 "output": {
598 "type": "structure",
599 "members": {
600 "UserSummaryList": {
601 "type": "list",
602 "member": {
603 "type": "structure",
604 "members": {
605 "Id": {},
606 "Arn": {},
607 "Username": {}
608 }
609 }
610 },
611 "NextToken": {}
612 }
613 }
614 },
615 "StartOutboundVoiceContact": {
616 "http": {
617 "method": "PUT",
618 "requestUri": "/contact/outbound-voice"
619 },
620 "input": {
621 "type": "structure",
622 "required": [
623 "DestinationPhoneNumber",
624 "ContactFlowId",
625 "InstanceId"
626 ],
627 "members": {
628 "DestinationPhoneNumber": {},
629 "ContactFlowId": {},
630 "InstanceId": {},
631 "ClientToken": {
632 "idempotencyToken": true
633 },
634 "SourcePhoneNumber": {},
635 "QueueId": {},
636 "Attributes": {
637 "shape": "S15"
638 }
639 }
640 },
641 "output": {
642 "type": "structure",
643 "members": {
644 "ContactId": {}
645 }
646 }
647 },
648 "StopContact": {
649 "http": {
650 "requestUri": "/contact/stop"
651 },
652 "input": {
653 "type": "structure",
654 "required": [
655 "ContactId",
656 "InstanceId"
657 ],
658 "members": {
659 "ContactId": {},
660 "InstanceId": {}
661 }
662 },
663 "output": {
664 "type": "structure",
665 "members": {}
666 }
667 },
668 "UpdateContactAttributes": {
669 "http": {
670 "requestUri": "/contact/attributes"
671 },
672 "input": {
673 "type": "structure",
674 "required": [
675 "InitialContactId",
676 "InstanceId",
677 "Attributes"
678 ],
679 "members": {
680 "InitialContactId": {},
681 "InstanceId": {},
682 "Attributes": {
683 "shape": "S15"
684 }
685 }
686 },
687 "output": {
688 "type": "structure",
689 "members": {}
690 }
691 },
692 "UpdateUserHierarchy": {
693 "http": {
694 "requestUri": "/users/{InstanceId}/{UserId}/hierarchy"
695 },
696 "input": {
697 "type": "structure",
698 "required": [
699 "UserId",
700 "InstanceId"
701 ],
702 "members": {
703 "HierarchyGroupId": {},
704 "UserId": {
705 "location": "uri",
706 "locationName": "UserId"
707 },
708 "InstanceId": {
709 "location": "uri",
710 "locationName": "InstanceId"
711 }
712 }
713 }
714 },
715 "UpdateUserIdentityInfo": {
716 "http": {
717 "requestUri": "/users/{InstanceId}/{UserId}/identity-info"
718 },
719 "input": {
720 "type": "structure",
721 "required": [
722 "IdentityInfo",
723 "UserId",
724 "InstanceId"
725 ],
726 "members": {
727 "IdentityInfo": {
728 "shape": "S4"
729 },
730 "UserId": {
731 "location": "uri",
732 "locationName": "UserId"
733 },
734 "InstanceId": {
735 "location": "uri",
736 "locationName": "InstanceId"
737 }
738 }
739 }
740 },
741 "UpdateUserPhoneConfig": {
742 "http": {
743 "requestUri": "/users/{InstanceId}/{UserId}/phone-config"
744 },
745 "input": {
746 "type": "structure",
747 "required": [
748 "PhoneConfig",
749 "UserId",
750 "InstanceId"
751 ],
752 "members": {
753 "PhoneConfig": {
754 "shape": "S8"
755 },
756 "UserId": {
757 "location": "uri",
758 "locationName": "UserId"
759 },
760 "InstanceId": {
761 "location": "uri",
762 "locationName": "InstanceId"
763 }
764 }
765 }
766 },
767 "UpdateUserRoutingProfile": {
768 "http": {
769 "requestUri": "/users/{InstanceId}/{UserId}/routing-profile"
770 },
771 "input": {
772 "type": "structure",
773 "required": [
774 "RoutingProfileId",
775 "UserId",
776 "InstanceId"
777 ],
778 "members": {
779 "RoutingProfileId": {},
780 "UserId": {
781 "location": "uri",
782 "locationName": "UserId"
783 },
784 "InstanceId": {
785 "location": "uri",
786 "locationName": "InstanceId"
787 }
788 }
789 }
790 },
791 "UpdateUserSecurityProfiles": {
792 "http": {
793 "requestUri": "/users/{InstanceId}/{UserId}/security-profiles"
794 },
795 "input": {
796 "type": "structure",
797 "required": [
798 "SecurityProfileIds",
799 "UserId",
800 "InstanceId"
801 ],
802 "members": {
803 "SecurityProfileIds": {
804 "shape": "Se"
805 },
806 "UserId": {
807 "location": "uri",
808 "locationName": "UserId"
809 },
810 "InstanceId": {
811 "location": "uri",
812 "locationName": "InstanceId"
813 }
814 }
815 }
816 }
817 },
818 "shapes": {
819 "S4": {
820 "type": "structure",
821 "members": {
822 "FirstName": {},
823 "LastName": {},
824 "Email": {}
825 }
826 },
827 "S8": {
828 "type": "structure",
829 "required": [
830 "PhoneType"
831 ],
832 "members": {
833 "PhoneType": {},
834 "AutoAccept": {
835 "type": "boolean"
836 },
837 "AfterContactWorkTimeLimit": {
838 "type": "integer"
839 },
840 "DeskPhoneNumber": {}
841 }
842 },
843 "Se": {
844 "type": "list",
845 "member": {}
846 },
847 "Sw": {
848 "type": "structure",
849 "members": {
850 "Id": {},
851 "Arn": {},
852 "Name": {}
853 }
854 },
855 "S10": {
856 "type": "structure",
857 "members": {
858 "Id": {},
859 "Arn": {},
860 "Name": {}
861 }
862 },
863 "S15": {
864 "type": "map",
865 "key": {},
866 "value": {}
867 },
868 "S19": {
869 "type": "structure",
870 "members": {
871 "Queues": {
872 "type": "list",
873 "member": {}
874 },
875 "Channels": {
876 "type": "list",
877 "member": {}
878 }
879 }
880 },
881 "S1e": {
882 "type": "list",
883 "member": {}
884 },
885 "S1h": {
886 "type": "structure",
887 "members": {
888 "Name": {},
889 "Unit": {}
890 }
891 },
892 "S1p": {
893 "type": "structure",
894 "members": {
895 "Queue": {
896 "type": "structure",
897 "members": {
898 "Id": {},
899 "Arn": {}
900 }
901 },
902 "Channel": {}
903 }
904 },
905 "S1y": {
906 "type": "string",
907 "sensitive": true
908 },
909 "S21": {
910 "type": "structure",
911 "members": {
912 "Name": {},
913 "Threshold": {
914 "type": "structure",
915 "members": {
916 "Comparison": {},
917 "ThresholdValue": {
918 "type": "double"
919 }
920 }
921 },
922 "Statistic": {},
923 "Unit": {}
924 }
925 }
926 }
927}
\No newline at end of file