xref: /aosp_15_r20/external/aws-sdk-java-v2/services/connect/src/main/resources/codegen-resources/api-2.json (revision 8a52c7834d808308836a99fc2a6e0ed8db339086) 
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      "name":"CreateUser",
18      "http":{
19        "method":"PUT",
20        "requestUri":"/users/{InstanceId}"
21      },
22      "input":{"shape":"CreateUserRequest"},
23      "output":{"shape":"CreateUserResponse"},
24      "errors":[
25        {"shape":"InvalidRequestException"},
26        {"shape":"InvalidParameterException"},
27        {"shape":"LimitExceededException"},
28        {"shape":"DuplicateResourceException"},
29        {"shape":"ResourceNotFoundException"},
30        {"shape":"ThrottlingException"},
31        {"shape":"InternalServiceException"}
32      ]
33    },
34    "DeleteUser":{
35      "name":"DeleteUser",
36      "http":{
37        "method":"DELETE",
38        "requestUri":"/users/{InstanceId}/{UserId}"
39      },
40      "input":{"shape":"DeleteUserRequest"},
41      "errors":[
42        {"shape":"InvalidRequestException"},
43        {"shape":"InvalidParameterException"},
44        {"shape":"ResourceNotFoundException"},
45        {"shape":"ThrottlingException"},
46        {"shape":"InternalServiceException"}
47      ]
48    },
49    "DescribeUser":{
50      "name":"DescribeUser",
51      "http":{
52        "method":"GET",
53        "requestUri":"/users/{InstanceId}/{UserId}"
54      },
55      "input":{"shape":"DescribeUserRequest"},
56      "output":{"shape":"DescribeUserResponse"},
57      "errors":[
58        {"shape":"InvalidRequestException"},
59        {"shape":"InvalidParameterException"},
60        {"shape":"ResourceNotFoundException"},
61        {"shape":"ThrottlingException"},
62        {"shape":"InternalServiceException"}
63      ]
64    },
65    "DescribeUserHierarchyGroup":{
66      "name":"DescribeUserHierarchyGroup",
67      "http":{
68        "method":"GET",
69        "requestUri":"/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}"
70      },
71      "input":{"shape":"DescribeUserHierarchyGroupRequest"},
72      "output":{"shape":"DescribeUserHierarchyGroupResponse"},
73      "errors":[
74        {"shape":"InvalidRequestException"},
75        {"shape":"InvalidParameterException"},
76        {"shape":"ResourceNotFoundException"},
77        {"shape":"ThrottlingException"},
78        {"shape":"InternalServiceException"}
79      ]
80    },
81    "DescribeUserHierarchyStructure":{
82      "name":"DescribeUserHierarchyStructure",
83      "http":{
84        "method":"GET",
85        "requestUri":"/user-hierarchy-structure/{InstanceId}"
86      },
87      "input":{"shape":"DescribeUserHierarchyStructureRequest"},
88      "output":{"shape":"DescribeUserHierarchyStructureResponse"},
89      "errors":[
90        {"shape":"InvalidRequestException"},
91        {"shape":"InvalidParameterException"},
92        {"shape":"ResourceNotFoundException"},
93        {"shape":"ThrottlingException"},
94        {"shape":"InternalServiceException"}
95      ]
96    },
97    "GetCurrentMetricData":{
98      "name":"GetCurrentMetricData",
99      "http":{
100        "method":"POST",
101        "requestUri":"/metrics/current/{InstanceId}"
102      },
103      "input":{"shape":"GetCurrentMetricDataRequest"},
104      "output":{"shape":"GetCurrentMetricDataResponse"},
105      "errors":[
106        {"shape":"InvalidRequestException"},
107        {"shape":"InvalidParameterException"},
108        {"shape":"InternalServiceException"},
109        {"shape":"ThrottlingException"},
110        {"shape":"ResourceNotFoundException"}
111      ]
112    },
113    "GetFederationToken":{
114      "name":"GetFederationToken",
115      "http":{
116        "method":"GET",
117        "requestUri":"/user/federate/{InstanceId}"
118      },
119      "input":{"shape":"GetFederationTokenRequest"},
120      "output":{"shape":"GetFederationTokenResponse"},
121      "errors":[
122        {"shape":"InvalidRequestException"},
123        {"shape":"InvalidParameterException"},
124        {"shape":"ResourceNotFoundException"},
125        {"shape":"UserNotFoundException"},
126        {"shape":"InternalServiceException"},
127        {"shape":"DuplicateResourceException"}
128      ]
129    },
130    "GetMetricData":{
131      "name":"GetMetricData",
132      "http":{
133        "method":"POST",
134        "requestUri":"/metrics/historical/{InstanceId}"
135      },
136      "input":{"shape":"GetMetricDataRequest"},
137      "output":{"shape":"GetMetricDataResponse"},
138      "errors":[
139        {"shape":"InvalidRequestException"},
140        {"shape":"InvalidParameterException"},
141        {"shape":"InternalServiceException"},
142        {"shape":"ThrottlingException"},
143        {"shape":"ResourceNotFoundException"}
144      ]
145    },
146    "ListRoutingProfiles":{
147      "name":"ListRoutingProfiles",
148      "http":{
149        "method":"GET",
150        "requestUri":"/routing-profiles-summary/{InstanceId}"
151      },
152      "input":{"shape":"ListRoutingProfilesRequest"},
153      "output":{"shape":"ListRoutingProfilesResponse"},
154      "errors":[
155        {"shape":"InvalidRequestException"},
156        {"shape":"InvalidParameterException"},
157        {"shape":"ResourceNotFoundException"},
158        {"shape":"ThrottlingException"},
159        {"shape":"InternalServiceException"}
160      ]
161    },
162    "ListSecurityProfiles":{
163      "name":"ListSecurityProfiles",
164      "http":{
165        "method":"GET",
166        "requestUri":"/security-profiles-summary/{InstanceId}"
167      },
168      "input":{"shape":"ListSecurityProfilesRequest"},
169      "output":{"shape":"ListSecurityProfilesResponse"},
170      "errors":[
171        {"shape":"InvalidRequestException"},
172        {"shape":"InvalidParameterException"},
173        {"shape":"ResourceNotFoundException"},
174        {"shape":"ThrottlingException"},
175        {"shape":"InternalServiceException"}
176      ]
177    },
178    "ListUserHierarchyGroups":{
179      "name":"ListUserHierarchyGroups",
180      "http":{
181        "method":"GET",
182        "requestUri":"/user-hierarchy-groups-summary/{InstanceId}"
183      },
184      "input":{"shape":"ListUserHierarchyGroupsRequest"},
185      "output":{"shape":"ListUserHierarchyGroupsResponse"},
186      "errors":[
187        {"shape":"InvalidRequestException"},
188        {"shape":"InvalidParameterException"},
189        {"shape":"ResourceNotFoundException"},
190        {"shape":"ThrottlingException"},
191        {"shape":"InternalServiceException"}
192      ]
193    },
194    "ListUsers":{
195      "name":"ListUsers",
196      "http":{
197        "method":"GET",
198        "requestUri":"/users-summary/{InstanceId}"
199      },
200      "input":{"shape":"ListUsersRequest"},
201      "output":{"shape":"ListUsersResponse"},
202      "errors":[
203        {"shape":"InvalidRequestException"},
204        {"shape":"InvalidParameterException"},
205        {"shape":"ResourceNotFoundException"},
206        {"shape":"ThrottlingException"},
207        {"shape":"InternalServiceException"}
208      ]
209    },
210    "StartOutboundVoiceContact":{
211      "name":"StartOutboundVoiceContact",
212      "http":{
213        "method":"PUT",
214        "requestUri":"/contact/outbound-voice"
215      },
216      "input":{"shape":"StartOutboundVoiceContactRequest"},
217      "output":{"shape":"StartOutboundVoiceContactResponse"},
218      "errors":[
219        {"shape":"InvalidRequestException"},
220        {"shape":"InvalidParameterException"},
221        {"shape":"ResourceNotFoundException"},
222        {"shape":"InternalServiceException"},
223        {"shape":"LimitExceededException"},
224        {"shape":"DestinationNotAllowedException"},
225        {"shape":"OutboundContactNotPermittedException"}
226      ]
227    },
228    "StopContact":{
229      "name":"StopContact",
230      "http":{
231        "method":"POST",
232        "requestUri":"/contact/stop"
233      },
234      "input":{"shape":"StopContactRequest"},
235      "output":{"shape":"StopContactResponse"},
236      "errors":[
237        {"shape":"InvalidRequestException"},
238        {"shape":"ContactNotFoundException"},
239        {"shape":"InvalidParameterException"},
240        {"shape":"ResourceNotFoundException"},
241        {"shape":"InternalServiceException"}
242      ]
243    },
244    "UpdateContactAttributes":{
245      "name":"UpdateContactAttributes",
246      "http":{
247        "method":"POST",
248        "requestUri":"/contact/attributes"
249      },
250      "input":{"shape":"UpdateContactAttributesRequest"},
251      "output":{"shape":"UpdateContactAttributesResponse"},
252      "errors":[
253        {"shape":"InvalidRequestException"},
254        {"shape":"InvalidParameterException"},
255        {"shape":"ResourceNotFoundException"},
256        {"shape":"InternalServiceException"}
257      ]
258    },
259    "UpdateUserHierarchy":{
260      "name":"UpdateUserHierarchy",
261      "http":{
262        "method":"POST",
263        "requestUri":"/users/{InstanceId}/{UserId}/hierarchy"
264      },
265      "input":{"shape":"UpdateUserHierarchyRequest"},
266      "errors":[
267        {"shape":"InvalidRequestException"},
268        {"shape":"InvalidParameterException"},
269        {"shape":"ResourceNotFoundException"},
270        {"shape":"ThrottlingException"},
271        {"shape":"InternalServiceException"}
272      ]
273    },
274    "UpdateUserIdentityInfo":{
275      "name":"UpdateUserIdentityInfo",
276      "http":{
277        "method":"POST",
278        "requestUri":"/users/{InstanceId}/{UserId}/identity-info"
279      },
280      "input":{"shape":"UpdateUserIdentityInfoRequest"},
281      "errors":[
282        {"shape":"InvalidRequestException"},
283        {"shape":"InvalidParameterException"},
284        {"shape":"ResourceNotFoundException"},
285        {"shape":"ThrottlingException"},
286        {"shape":"InternalServiceException"}
287      ]
288    },
289    "UpdateUserPhoneConfig":{
290      "name":"UpdateUserPhoneConfig",
291      "http":{
292        "method":"POST",
293        "requestUri":"/users/{InstanceId}/{UserId}/phone-config"
294      },
295      "input":{"shape":"UpdateUserPhoneConfigRequest"},
296      "errors":[
297        {"shape":"InvalidRequestException"},
298        {"shape":"InvalidParameterException"},
299        {"shape":"ResourceNotFoundException"},
300        {"shape":"ThrottlingException"},
301        {"shape":"InternalServiceException"}
302      ]
303    },
304    "UpdateUserRoutingProfile":{
305      "name":"UpdateUserRoutingProfile",
306      "http":{
307        "method":"POST",
308        "requestUri":"/users/{InstanceId}/{UserId}/routing-profile"
309      },
310      "input":{"shape":"UpdateUserRoutingProfileRequest"},
311      "errors":[
312        {"shape":"InvalidRequestException"},
313        {"shape":"InvalidParameterException"},
314        {"shape":"ResourceNotFoundException"},
315        {"shape":"ThrottlingException"},
316        {"shape":"InternalServiceException"}
317      ]
318    },
319    "UpdateUserSecurityProfiles":{
320      "name":"UpdateUserSecurityProfiles",
321      "http":{
322        "method":"POST",
323        "requestUri":"/users/{InstanceId}/{UserId}/security-profiles"
324      },
325      "input":{"shape":"UpdateUserSecurityProfilesRequest"},
326      "errors":[
327        {"shape":"InvalidRequestException"},
328        {"shape":"InvalidParameterException"},
329        {"shape":"ResourceNotFoundException"},
330        {"shape":"ThrottlingException"},
331        {"shape":"InternalServiceException"}
332      ]
333    }
334  },
335  "shapes":{
336    "ARN":{"type":"string"},
337    "AfterContactWorkTimeLimit":{
338      "type":"integer",
339      "min":0
340    },
341    "AgentFirstName":{
342      "type":"string",
343      "max":100,
344      "min":1
345    },
346    "AgentLastName":{
347      "type":"string",
348      "max":100,
349      "min":1
350    },
351    "AgentUsername":{
352      "type":"string",
353      "max":20,
354      "min":1,
355      "pattern":"[a-zA-Z0-9\\_\\-\\.]+"
356    },
357    "AttributeName":{
358      "type":"string",
359      "max":32767,
360      "min":1
361    },
362    "AttributeValue":{
363      "type":"string",
364      "max":32767,
365      "min":0
366    },
367    "Attributes":{
368      "type":"map",
369      "key":{"shape":"AttributeName"},
370      "value":{"shape":"AttributeValue"}
371    },
372    "AutoAccept":{"type":"boolean"},
373    "Channel":{
374      "type":"string",
375      "enum":["VOICE"]
376    },
377    "Channels":{
378      "type":"list",
379      "member":{"shape":"Channel"},
380      "max":1
381    },
382    "ClientToken":{
383      "type":"string",
384      "max":500
385    },
386    "Comparison":{
387      "type":"string",
388      "enum":["LT"]
389    },
390    "ContactFlowId":{
391      "type":"string",
392      "max":500
393    },
394    "ContactId":{
395      "type":"string",
396      "max":256,
397      "min":1
398    },
399    "ContactNotFoundException":{
400      "type":"structure",
401      "members":{
402        "Message":{"shape":"Message"}
403      },
404      "error":{"httpStatusCode":410},
405      "exception":true
406    },
407    "CreateUserRequest":{
408      "type":"structure",
409      "required":[
410        "Username",
411        "PhoneConfig",
412        "SecurityProfileIds",
413        "RoutingProfileId",
414        "InstanceId"
415      ],
416      "members":{
417        "Username":{"shape":"AgentUsername"},
418        "Password":{"shape":"Password"},
419        "IdentityInfo":{"shape":"UserIdentityInfo"},
420        "PhoneConfig":{"shape":"UserPhoneConfig"},
421        "DirectoryUserId":{"shape":"DirectoryUserId"},
422        "SecurityProfileIds":{"shape":"SecurityProfileIds"},
423        "RoutingProfileId":{"shape":"RoutingProfileId"},
424        "HierarchyGroupId":{"shape":"HierarchyGroupId"},
425        "InstanceId":{
426          "shape":"InstanceId",
427          "location":"uri",
428          "locationName":"InstanceId"
429        }
430      }
431    },
432    "CreateUserResponse":{
433      "type":"structure",
434      "members":{
435        "UserId":{"shape":"UserId"},
436        "UserArn":{"shape":"ARN"}
437      }
438    },
439    "Credentials":{
440      "type":"structure",
441      "members":{
442        "AccessToken":{"shape":"SecurityToken"},
443        "AccessTokenExpiration":{"shape":"timestamp"},
444        "RefreshToken":{"shape":"SecurityToken"},
445        "RefreshTokenExpiration":{"shape":"timestamp"}
446      }
447    },
448    "CurrentMetric":{
449      "type":"structure",
450      "members":{
451        "Name":{"shape":"CurrentMetricName"},
452        "Unit":{"shape":"Unit"}
453      }
454    },
455    "CurrentMetricData":{
456      "type":"structure",
457      "members":{
458        "Metric":{"shape":"CurrentMetric"},
459        "Value":{
460          "shape":"Value",
461          "box":true
462        }
463      }
464    },
465    "CurrentMetricDataCollections":{
466      "type":"list",
467      "member":{"shape":"CurrentMetricData"}
468    },
469    "CurrentMetricName":{
470      "type":"string",
471      "enum":[
472        "AGENTS_ONLINE",
473        "AGENTS_AVAILABLE",
474        "AGENTS_ON_CALL",
475        "AGENTS_NON_PRODUCTIVE",
476        "AGENTS_AFTER_CONTACT_WORK",
477        "AGENTS_ERROR",
478        "AGENTS_STAFFED",
479        "CONTACTS_IN_QUEUE",
480        "OLDEST_CONTACT_AGE",
481        "CONTACTS_SCHEDULED"
482      ]
483    },
484    "CurrentMetricResult":{
485      "type":"structure",
486      "members":{
487        "Dimensions":{"shape":"Dimensions"},
488        "Collections":{"shape":"CurrentMetricDataCollections"}
489      }
490    },
491    "CurrentMetricResults":{
492      "type":"list",
493      "member":{"shape":"CurrentMetricResult"}
494    },
495    "CurrentMetrics":{
496      "type":"list",
497      "member":{"shape":"CurrentMetric"}
498    },
499    "DeleteUserRequest":{
500      "type":"structure",
501      "required":[
502        "InstanceId",
503        "UserId"
504      ],
505      "members":{
506        "InstanceId":{
507          "shape":"InstanceId",
508          "location":"uri",
509          "locationName":"InstanceId"
510        },
511        "UserId":{
512          "shape":"UserId",
513          "location":"uri",
514          "locationName":"UserId"
515        }
516      }
517    },
518    "DescribeUserHierarchyGroupRequest":{
519      "type":"structure",
520      "required":[
521        "HierarchyGroupId",
522        "InstanceId"
523      ],
524      "members":{
525        "HierarchyGroupId":{
526          "shape":"HierarchyGroupId",
527          "location":"uri",
528          "locationName":"HierarchyGroupId"
529        },
530        "InstanceId":{
531          "shape":"InstanceId",
532          "location":"uri",
533          "locationName":"InstanceId"
534        }
535      }
536    },
537    "DescribeUserHierarchyGroupResponse":{
538      "type":"structure",
539      "members":{
540        "HierarchyGroup":{"shape":"HierarchyGroup"}
541      }
542    },
543    "DescribeUserHierarchyStructureRequest":{
544      "type":"structure",
545      "required":["InstanceId"],
546      "members":{
547        "InstanceId":{
548          "shape":"InstanceId",
549          "location":"uri",
550          "locationName":"InstanceId"
551        }
552      }
553    },
554    "DescribeUserHierarchyStructureResponse":{
555      "type":"structure",
556      "members":{
557        "HierarchyStructure":{"shape":"HierarchyStructure"}
558      }
559    },
560    "DescribeUserRequest":{
561      "type":"structure",
562      "required":[
563        "UserId",
564        "InstanceId"
565      ],
566      "members":{
567        "UserId":{
568          "shape":"UserId",
569          "location":"uri",
570          "locationName":"UserId"
571        },
572        "InstanceId":{
573          "shape":"InstanceId",
574          "location":"uri",
575          "locationName":"InstanceId"
576        }
577      }
578    },
579    "DescribeUserResponse":{
580      "type":"structure",
581      "members":{
582        "User":{"shape":"User"}
583      }
584    },
585    "DestinationNotAllowedException":{
586      "type":"structure",
587      "members":{
588        "Message":{"shape":"Message"}
589      },
590      "error":{"httpStatusCode":403},
591      "exception":true
592    },
593    "Dimensions":{
594      "type":"structure",
595      "members":{
596        "Queue":{"shape":"QueueReference"},
597        "Channel":{"shape":"Channel"}
598      }
599    },
600    "DirectoryUserId":{"type":"string"},
601    "DuplicateResourceException":{
602      "type":"structure",
603      "members":{
604        "Message":{"shape":"Message"}
605      },
606      "error":{"httpStatusCode":409},
607      "exception":true
608    },
609    "Email":{"type":"string"},
610    "Filters":{
611      "type":"structure",
612      "members":{
613        "Queues":{"shape":"Queues"},
614        "Channels":{"shape":"Channels"}
615      }
616    },
617    "GetCurrentMetricDataRequest":{
618      "type":"structure",
619      "required":[
620        "InstanceId",
621        "Filters",
622        "CurrentMetrics"
623      ],
624      "members":{
625        "InstanceId":{
626          "shape":"InstanceId",
627          "location":"uri",
628          "locationName":"InstanceId"
629        },
630        "Filters":{"shape":"Filters"},
631        "Groupings":{"shape":"Groupings"},
632        "CurrentMetrics":{"shape":"CurrentMetrics"},
633        "NextToken":{"shape":"NextToken"},
634        "MaxResults":{
635          "shape":"MaxResult100",
636          "box":true
637        }
638      }
639    },
640    "GetCurrentMetricDataResponse":{
641      "type":"structure",
642      "members":{
643        "NextToken":{"shape":"NextToken"},
644        "MetricResults":{"shape":"CurrentMetricResults"},
645        "DataSnapshotTime":{"shape":"timestamp"}
646      }
647    },
648    "GetFederationTokenRequest":{
649      "type":"structure",
650      "required":["InstanceId"],
651      "members":{
652        "InstanceId":{
653          "shape":"InstanceId",
654          "location":"uri",
655          "locationName":"InstanceId"
656        }
657      }
658    },
659    "GetFederationTokenResponse":{
660      "type":"structure",
661      "members":{
662        "Credentials":{"shape":"Credentials"}
663      }
664    },
665    "GetMetricDataRequest":{
666      "type":"structure",
667      "required":[
668        "InstanceId",
669        "StartTime",
670        "EndTime",
671        "Filters",
672        "HistoricalMetrics"
673      ],
674      "members":{
675        "InstanceId":{
676          "shape":"InstanceId",
677          "location":"uri",
678          "locationName":"InstanceId"
679        },
680        "StartTime":{"shape":"timestamp"},
681        "EndTime":{"shape":"timestamp"},
682        "Filters":{"shape":"Filters"},
683        "Groupings":{"shape":"Groupings"},
684        "HistoricalMetrics":{"shape":"HistoricalMetrics"},
685        "NextToken":{"shape":"NextToken"},
686        "MaxResults":{
687          "shape":"MaxResult100",
688          "box":true
689        }
690      }
691    },
692    "GetMetricDataResponse":{
693      "type":"structure",
694      "members":{
695        "NextToken":{"shape":"NextToken"},
696        "MetricResults":{"shape":"HistoricalMetricResults"}
697      }
698    },
699    "Grouping":{
700      "type":"string",
701      "enum":[
702        "QUEUE",
703        "CHANNEL"
704      ]
705    },
706    "Groupings":{
707      "type":"list",
708      "member":{"shape":"Grouping"},
709      "max":2
710    },
711    "HierarchyGroup":{
712      "type":"structure",
713      "members":{
714        "Id":{"shape":"HierarchyGroupId"},
715        "Arn":{"shape":"ARN"},
716        "Name":{"shape":"HierarchyGroupName"},
717        "LevelId":{"shape":"HierarchyLevelId"},
718        "HierarchyPath":{"shape":"HierarchyPath"}
719      }
720    },
721    "HierarchyGroupId":{"type":"string"},
722    "HierarchyGroupName":{"type":"string"},
723    "HierarchyGroupSummary":{
724      "type":"structure",
725      "members":{
726        "Id":{"shape":"HierarchyGroupId"},
727        "Arn":{"shape":"ARN"},
728        "Name":{"shape":"HierarchyGroupName"}
729      }
730    },
731    "HierarchyGroupSummaryList":{
732      "type":"list",
733      "member":{"shape":"HierarchyGroupSummary"}
734    },
735    "HierarchyLevel":{
736      "type":"structure",
737      "members":{
738        "Id":{"shape":"HierarchyLevelId"},
739        "Arn":{"shape":"ARN"},
740        "Name":{"shape":"HierarchyLevelName"}
741      }
742    },
743    "HierarchyLevelId":{"type":"string"},
744    "HierarchyLevelName":{"type":"string"},
745    "HierarchyPath":{
746      "type":"structure",
747      "members":{
748        "LevelOne":{"shape":"HierarchyGroupSummary"},
749        "LevelTwo":{"shape":"HierarchyGroupSummary"},
750        "LevelThree":{"shape":"HierarchyGroupSummary"},
751        "LevelFour":{"shape":"HierarchyGroupSummary"},
752        "LevelFive":{"shape":"HierarchyGroupSummary"}
753      }
754    },
755    "HierarchyStructure":{
756      "type":"structure",
757      "members":{
758        "LevelOne":{"shape":"HierarchyLevel"},
759        "LevelTwo":{"shape":"HierarchyLevel"},
760        "LevelThree":{"shape":"HierarchyLevel"},
761        "LevelFour":{"shape":"HierarchyLevel"},
762        "LevelFive":{"shape":"HierarchyLevel"}
763      }
764    },
765    "HistoricalMetric":{
766      "type":"structure",
767      "members":{
768        "Name":{"shape":"HistoricalMetricName"},
769        "Threshold":{
770          "shape":"Threshold",
771          "box":true
772        },
773        "Statistic":{"shape":"Statistic"},
774        "Unit":{"shape":"Unit"}
775      }
776    },
777    "HistoricalMetricData":{
778      "type":"structure",
779      "members":{
780        "Metric":{"shape":"HistoricalMetric"},
781        "Value":{
782          "shape":"Value",
783          "box":true
784        }
785      }
786    },
787    "HistoricalMetricDataCollections":{
788      "type":"list",
789      "member":{"shape":"HistoricalMetricData"}
790    },
791    "HistoricalMetricName":{
792      "type":"string",
793      "enum":[
794        "CONTACTS_QUEUED",
795        "CONTACTS_HANDLED",
796        "CONTACTS_ABANDONED",
797        "CONTACTS_CONSULTED",
798        "CONTACTS_AGENT_HUNG_UP_FIRST",
799        "CONTACTS_HANDLED_INCOMING",
800        "CONTACTS_HANDLED_OUTBOUND",
801        "CONTACTS_HOLD_ABANDONS",
802        "CONTACTS_TRANSFERRED_IN",
803        "CONTACTS_TRANSFERRED_OUT",
804        "CONTACTS_TRANSFERRED_IN_FROM_QUEUE",
805        "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE",
806        "CONTACTS_MISSED",
807        "CALLBACK_CONTACTS_HANDLED",
808        "API_CONTACTS_HANDLED",
809        "OCCUPANCY",
810        "HANDLE_TIME",
811        "AFTER_CONTACT_WORK_TIME",
812        "QUEUED_TIME",
813        "ABANDON_TIME",
814        "QUEUE_ANSWER_TIME",
815        "HOLD_TIME",
816        "INTERACTION_TIME",
817        "INTERACTION_AND_HOLD_TIME",
818        "SERVICE_LEVEL"
819      ]
820    },
821    "HistoricalMetricResult":{
822      "type":"structure",
823      "members":{
824        "Dimensions":{"shape":"Dimensions"},
825        "Collections":{"shape":"HistoricalMetricDataCollections"}
826      }
827    },
828    "HistoricalMetricResults":{
829      "type":"list",
830      "member":{"shape":"HistoricalMetricResult"}
831    },
832    "HistoricalMetrics":{
833      "type":"list",
834      "member":{"shape":"HistoricalMetric"}
835    },
836    "InstanceId":{
837      "type":"string",
838      "max":100,
839      "min":1
840    },
841    "InternalServiceException":{
842      "type":"structure",
843      "members":{
844        "Message":{"shape":"Message"}
845      },
846      "error":{"httpStatusCode":500},
847      "exception":true
848    },
849    "InvalidParameterException":{
850      "type":"structure",
851      "members":{
852        "Message":{"shape":"Message"}
853      },
854      "error":{"httpStatusCode":400},
855      "exception":true
856    },
857    "InvalidRequestException":{
858      "type":"structure",
859      "members":{
860        "Message":{"shape":"Message"}
861      },
862      "error":{"httpStatusCode":400},
863      "exception":true
864    },
865    "LimitExceededException":{
866      "type":"structure",
867      "members":{
868        "Message":{"shape":"Message"}
869      },
870      "error":{"httpStatusCode":429},
871      "exception":true
872    },
873    "ListRoutingProfilesRequest":{
874      "type":"structure",
875      "required":["InstanceId"],
876      "members":{
877        "InstanceId":{
878          "shape":"InstanceId",
879          "location":"uri",
880          "locationName":"InstanceId"
881        },
882        "NextToken":{
883          "shape":"NextToken",
884          "location":"querystring",
885          "locationName":"nextToken"
886        },
887        "MaxResults":{
888          "shape":"MaxResult1000",
889          "box":true,
890          "location":"querystring",
891          "locationName":"maxResults"
892        }
893      }
894    },
895    "ListRoutingProfilesResponse":{
896      "type":"structure",
897      "members":{
898        "RoutingProfileSummaryList":{"shape":"RoutingProfileSummaryList"},
899        "NextToken":{"shape":"NextToken"}
900      }
901    },
902    "ListSecurityProfilesRequest":{
903      "type":"structure",
904      "required":["InstanceId"],
905      "members":{
906        "InstanceId":{
907          "shape":"InstanceId",
908          "location":"uri",
909          "locationName":"InstanceId"
910        },
911        "NextToken":{
912          "shape":"NextToken",
913          "location":"querystring",
914          "locationName":"nextToken"
915        },
916        "MaxResults":{
917          "shape":"MaxResult1000",
918          "box":true,
919          "location":"querystring",
920          "locationName":"maxResults"
921        }
922      }
923    },
924    "ListSecurityProfilesResponse":{
925      "type":"structure",
926      "members":{
927        "SecurityProfileSummaryList":{"shape":"SecurityProfileSummaryList"},
928        "NextToken":{"shape":"NextToken"}
929      }
930    },
931    "ListUserHierarchyGroupsRequest":{
932      "type":"structure",
933      "required":["InstanceId"],
934      "members":{
935        "InstanceId":{
936          "shape":"InstanceId",
937          "location":"uri",
938          "locationName":"InstanceId"
939        },
940        "NextToken":{
941          "shape":"NextToken",
942          "location":"querystring",
943          "locationName":"nextToken"
944        },
945        "MaxResults":{
946          "shape":"MaxResult1000",
947          "box":true,
948          "location":"querystring",
949          "locationName":"maxResults"
950        }
951      }
952    },
953    "ListUserHierarchyGroupsResponse":{
954      "type":"structure",
955      "members":{
956        "UserHierarchyGroupSummaryList":{"shape":"HierarchyGroupSummaryList"},
957        "NextToken":{"shape":"NextToken"}
958      }
959    },
960    "ListUsersRequest":{
961      "type":"structure",
962      "required":["InstanceId"],
963      "members":{
964        "InstanceId":{
965          "shape":"InstanceId",
966          "location":"uri",
967          "locationName":"InstanceId"
968        },
969        "NextToken":{
970          "shape":"NextToken",
971          "location":"querystring",
972          "locationName":"nextToken"
973        },
974        "MaxResults":{
975          "shape":"MaxResult1000",
976          "box":true,
977          "location":"querystring",
978          "locationName":"maxResults"
979        }
980      }
981    },
982    "ListUsersResponse":{
983      "type":"structure",
984      "members":{
985        "UserSummaryList":{"shape":"UserSummaryList"},
986        "NextToken":{"shape":"NextToken"}
987      }
988    },
989    "MaxResult100":{
990      "type":"integer",
991      "max":100,
992      "min":1
993    },
994    "MaxResult1000":{
995      "type":"integer",
996      "max":1000,
997      "min":1
998    },
999    "Message":{"type":"string"},
1000    "NextToken":{"type":"string"},
1001    "OutboundContactNotPermittedException":{
1002      "type":"structure",
1003      "members":{
1004        "Message":{"shape":"Message"}
1005      },
1006      "error":{"httpStatusCode":403},
1007      "exception":true
1008    },
1009    "Password":{
1010      "type":"string",
1011      "pattern":"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/"
1012    },
1013    "PhoneNumber":{"type":"string"},
1014    "PhoneType":{
1015      "type":"string",
1016      "enum":[
1017        "SOFT_PHONE",
1018        "DESK_PHONE"
1019      ]
1020    },
1021    "QueueId":{"type":"string"},
1022    "QueueReference":{
1023      "type":"structure",
1024      "members":{
1025        "Id":{"shape":"QueueId"},
1026        "Arn":{"shape":"ARN"}
1027      }
1028    },
1029    "Queues":{
1030      "type":"list",
1031      "member":{"shape":"QueueId"},
1032      "max":100,
1033      "min":1
1034    },
1035    "ResourceNotFoundException":{
1036      "type":"structure",
1037      "members":{
1038        "Message":{"shape":"Message"}
1039      },
1040      "error":{"httpStatusCode":404},
1041      "exception":true
1042    },
1043    "RoutingProfileId":{"type":"string"},
1044    "RoutingProfileName":{
1045      "type":"string",
1046      "max":100,
1047      "min":1
1048    },
1049    "RoutingProfileSummary":{
1050      "type":"structure",
1051      "members":{
1052        "Id":{"shape":"RoutingProfileId"},
1053        "Arn":{"shape":"ARN"},
1054        "Name":{"shape":"RoutingProfileName"}
1055      }
1056    },
1057    "RoutingProfileSummaryList":{
1058      "type":"list",
1059      "member":{"shape":"RoutingProfileSummary"}
1060    },
1061    "SecurityProfileId":{"type":"string"},
1062    "SecurityProfileIds":{
1063      "type":"list",
1064      "member":{"shape":"SecurityProfileId"},
1065      "max":10,
1066      "min":1
1067    },
1068    "SecurityProfileName":{"type":"string"},
1069    "SecurityProfileSummary":{
1070      "type":"structure",
1071      "members":{
1072        "Id":{"shape":"SecurityProfileId"},
1073        "Arn":{"shape":"ARN"},
1074        "Name":{"shape":"SecurityProfileName"}
1075      }
1076    },
1077    "SecurityProfileSummaryList":{
1078      "type":"list",
1079      "member":{"shape":"SecurityProfileSummary"}
1080    },
1081    "SecurityToken":{
1082      "type":"string",
1083      "sensitive":true
1084    },
1085    "StartOutboundVoiceContactRequest":{
1086      "type":"structure",
1087      "required":[
1088        "DestinationPhoneNumber",
1089        "ContactFlowId",
1090        "InstanceId"
1091      ],
1092      "members":{
1093        "DestinationPhoneNumber":{"shape":"PhoneNumber"},
1094        "ContactFlowId":{"shape":"ContactFlowId"},
1095        "InstanceId":{"shape":"InstanceId"},
1096        "ClientToken":{
1097          "shape":"ClientToken",
1098          "idempotencyToken":true
1099        },
1100        "SourcePhoneNumber":{"shape":"PhoneNumber"},
1101        "QueueId":{"shape":"QueueId"},
1102        "Attributes":{"shape":"Attributes"}
1103      }
1104    },
1105    "StartOutboundVoiceContactResponse":{
1106      "type":"structure",
1107      "members":{
1108        "ContactId":{"shape":"ContactId"}
1109      }
1110    },
1111    "Statistic":{
1112      "type":"string",
1113      "enum":[
1114        "SUM",
1115        "MAX",
1116        "AVG"
1117      ]
1118    },
1119    "StopContactRequest":{
1120      "type":"structure",
1121      "required":[
1122        "ContactId",
1123        "InstanceId"
1124      ],
1125      "members":{
1126        "ContactId":{"shape":"ContactId"},
1127        "InstanceId":{"shape":"InstanceId"}
1128      }
1129    },
1130    "StopContactResponse":{
1131      "type":"structure",
1132      "members":{
1133      }
1134    },
1135    "Threshold":{
1136      "type":"structure",
1137      "members":{
1138        "Comparison":{"shape":"Comparison"},
1139        "ThresholdValue":{
1140          "shape":"ThresholdValue",
1141          "box":true
1142        }
1143      }
1144    },
1145    "ThresholdValue":{"type":"double"},
1146    "ThrottlingException":{
1147      "type":"structure",
1148      "members":{
1149        "Message":{"shape":"Message"}
1150      },
1151      "error":{"httpStatusCode":429},
1152      "exception":true
1153    },
1154    "Unit":{
1155      "type":"string",
1156      "enum":[
1157        "SECONDS",
1158        "COUNT",
1159        "PERCENT"
1160      ]
1161    },
1162    "UpdateContactAttributesRequest":{
1163      "type":"structure",
1164      "required":[
1165        "InitialContactId",
1166        "InstanceId",
1167        "Attributes"
1168      ],
1169      "members":{
1170        "InitialContactId":{"shape":"ContactId"},
1171        "InstanceId":{"shape":"InstanceId"},
1172        "Attributes":{"shape":"Attributes"}
1173      }
1174    },
1175    "UpdateContactAttributesResponse":{
1176      "type":"structure",
1177      "members":{
1178      }
1179    },
1180    "UpdateUserHierarchyRequest":{
1181      "type":"structure",
1182      "required":[
1183        "UserId",
1184        "InstanceId"
1185      ],
1186      "members":{
1187        "HierarchyGroupId":{"shape":"HierarchyGroupId"},
1188        "UserId":{
1189          "shape":"UserId",
1190          "location":"uri",
1191          "locationName":"UserId"
1192        },
1193        "InstanceId":{
1194          "shape":"InstanceId",
1195          "location":"uri",
1196          "locationName":"InstanceId"
1197        }
1198      }
1199    },
1200    "UpdateUserIdentityInfoRequest":{
1201      "type":"structure",
1202      "required":[
1203        "IdentityInfo",
1204        "UserId",
1205        "InstanceId"
1206      ],
1207      "members":{
1208        "IdentityInfo":{"shape":"UserIdentityInfo"},
1209        "UserId":{
1210          "shape":"UserId",
1211          "location":"uri",
1212          "locationName":"UserId"
1213        },
1214        "InstanceId":{
1215          "shape":"InstanceId",
1216          "location":"uri",
1217          "locationName":"InstanceId"
1218        }
1219      }
1220    },
1221    "UpdateUserPhoneConfigRequest":{
1222      "type":"structure",
1223      "required":[
1224        "PhoneConfig",
1225        "UserId",
1226        "InstanceId"
1227      ],
1228      "members":{
1229        "PhoneConfig":{"shape":"UserPhoneConfig"},
1230        "UserId":{
1231          "shape":"UserId",
1232          "location":"uri",
1233          "locationName":"UserId"
1234        },
1235        "InstanceId":{
1236          "shape":"InstanceId",
1237          "location":"uri",
1238          "locationName":"InstanceId"
1239        }
1240      }
1241    },
1242    "UpdateUserRoutingProfileRequest":{
1243      "type":"structure",
1244      "required":[
1245        "RoutingProfileId",
1246        "UserId",
1247        "InstanceId"
1248      ],
1249      "members":{
1250        "RoutingProfileId":{"shape":"RoutingProfileId"},
1251        "UserId":{
1252          "shape":"UserId",
1253          "location":"uri",
1254          "locationName":"UserId"
1255        },
1256        "InstanceId":{
1257          "shape":"InstanceId",
1258          "location":"uri",
1259          "locationName":"InstanceId"
1260        }
1261      }
1262    },
1263    "UpdateUserSecurityProfilesRequest":{
1264      "type":"structure",
1265      "required":[
1266        "SecurityProfileIds",
1267        "UserId",
1268        "InstanceId"
1269      ],
1270      "members":{
1271        "SecurityProfileIds":{"shape":"SecurityProfileIds"},
1272        "UserId":{
1273          "shape":"UserId",
1274          "location":"uri",
1275          "locationName":"UserId"
1276        },
1277        "InstanceId":{
1278          "shape":"InstanceId",
1279          "location":"uri",
1280          "locationName":"InstanceId"
1281        }
1282      }
1283    },
1284    "User":{
1285      "type":"structure",
1286      "members":{
1287        "Id":{"shape":"UserId"},
1288        "Arn":{"shape":"ARN"},
1289        "Username":{"shape":"AgentUsername"},
1290        "IdentityInfo":{"shape":"UserIdentityInfo"},
1291        "PhoneConfig":{"shape":"UserPhoneConfig"},
1292        "DirectoryUserId":{"shape":"DirectoryUserId"},
1293        "SecurityProfileIds":{"shape":"SecurityProfileIds"},
1294        "RoutingProfileId":{"shape":"RoutingProfileId"},
1295        "HierarchyGroupId":{"shape":"HierarchyGroupId"}
1296      }
1297    },
1298    "UserId":{"type":"string"},
1299    "UserIdentityInfo":{
1300      "type":"structure",
1301      "members":{
1302        "FirstName":{"shape":"AgentFirstName"},
1303        "LastName":{"shape":"AgentLastName"},
1304        "Email":{"shape":"Email"}
1305      }
1306    },
1307    "UserNotFoundException":{
1308      "type":"structure",
1309      "members":{
1310        "Message":{"shape":"Message"}
1311      },
1312      "error":{"httpStatusCode":404},
1313      "exception":true
1314    },
1315    "UserPhoneConfig":{
1316      "type":"structure",
1317      "required":["PhoneType"],
1318      "members":{
1319        "PhoneType":{"shape":"PhoneType"},
1320        "AutoAccept":{"shape":"AutoAccept"},
1321        "AfterContactWorkTimeLimit":{"shape":"AfterContactWorkTimeLimit"},
1322        "DeskPhoneNumber":{"shape":"PhoneNumber"}
1323      }
1324    },
1325    "UserSummary":{
1326      "type":"structure",
1327      "members":{
1328        "Id":{"shape":"UserId"},
1329        "Arn":{"shape":"ARN"},
1330        "Username":{"shape":"AgentUsername"}
1331      }
1332    },
1333    "UserSummaryList":{
1334      "type":"list",
1335      "member":{"shape":"UserSummary"}
1336    },
1337    "Value":{"type":"double"},
1338    "timestamp":{"type":"timestamp"}
1339  }
1340}
1341