1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2018-09-07",
5    "endpointPrefix":"participant.connect",
6    "jsonVersion":"1.1",
7    "protocol":"rest-json",
8    "serviceAbbreviation":"Amazon Connect Participant",
9    "serviceFullName":"Amazon Connect Participant Service",
10    "serviceId":"ConnectParticipant",
11    "signatureVersion":"v4",
12    "signingName":"execute-api",
13    "uid":"connectparticipant-2018-09-07"
14  },
15  "operations":{
16    "CreateParticipantConnection":{
17      "name":"CreateParticipantConnection",
18      "http":{
19        "method":"POST",
20        "requestUri":"/participant/connection"
21      },
22      "input":{"shape":"CreateParticipantConnectionRequest"},
23      "output":{"shape":"CreateParticipantConnectionResponse"},
24      "errors":[
25        {"shape":"AccessDeniedException"},
26        {"shape":"InternalServerException"},
27        {"shape":"ThrottlingException"},
28        {"shape":"ValidationException"}
29      ]
30    },
31    "DisconnectParticipant":{
32      "name":"DisconnectParticipant",
33      "http":{
34        "method":"POST",
35        "requestUri":"/participant/disconnect"
36      },
37      "input":{"shape":"DisconnectParticipantRequest"},
38      "output":{"shape":"DisconnectParticipantResponse"},
39      "errors":[
40        {"shape":"AccessDeniedException"},
41        {"shape":"InternalServerException"},
42        {"shape":"ThrottlingException"},
43        {"shape":"ValidationException"}
44      ]
45    },
46    "GetTranscript":{
47      "name":"GetTranscript",
48      "http":{
49        "method":"POST",
50        "requestUri":"/participant/transcript"
51      },
52      "input":{"shape":"GetTranscriptRequest"},
53      "output":{"shape":"GetTranscriptResponse"},
54      "errors":[
55        {"shape":"AccessDeniedException"},
56        {"shape":"InternalServerException"},
57        {"shape":"ThrottlingException"},
58        {"shape":"ValidationException"}
59      ]
60    },
61    "SendEvent":{
62      "name":"SendEvent",
63      "http":{
64        "method":"POST",
65        "requestUri":"/participant/event"
66      },
67      "input":{"shape":"SendEventRequest"},
68      "output":{"shape":"SendEventResponse"},
69      "errors":[
70        {"shape":"AccessDeniedException"},
71        {"shape":"InternalServerException"},
72        {"shape":"ThrottlingException"},
73        {"shape":"ValidationException"}
74      ]
75    },
76    "SendMessage":{
77      "name":"SendMessage",
78      "http":{
79        "method":"POST",
80        "requestUri":"/participant/message"
81      },
82      "input":{"shape":"SendMessageRequest"},
83      "output":{"shape":"SendMessageResponse"},
84      "errors":[
85        {"shape":"AccessDeniedException"},
86        {"shape":"InternalServerException"},
87        {"shape":"ThrottlingException"},
88        {"shape":"ValidationException"}
89      ]
90    }
91  },
92  "shapes":{
93    "AccessDeniedException":{
94      "type":"structure",
95      "required":["Message"],
96      "members":{
97        "Message":{"shape":"Message"}
98      },
99      "error":{"httpStatusCode":403},
100      "exception":true
101    },
102    "ChatContent":{
103      "type":"string",
104      "max":1024,
105      "min":1
106    },
107    "ChatContentType":{
108      "type":"string",
109      "max":100,
110      "min":1
111    },
112    "ChatItemId":{
113      "type":"string",
114      "max":256,
115      "min":1
116    },
117    "ChatItemType":{
118      "type":"string",
119      "enum":[
120        "MESSAGE",
121        "EVENT",
122        "CONNECTION_ACK"
123      ]
124    },
125    "ClientToken":{
126      "type":"string",
127      "max":500
128    },
129    "ConnectionCredentials":{
130      "type":"structure",
131      "members":{
132        "ConnectionToken":{"shape":"ParticipantToken"},
133        "Expiry":{"shape":"ISO8601Datetime"}
134      }
135    },
136    "ConnectionType":{
137      "type":"string",
138      "enum":[
139        "WEBSOCKET",
140        "CONNECTION_CREDENTIALS"
141      ]
142    },
143    "ConnectionTypeList":{
144      "type":"list",
145      "member":{"shape":"ConnectionType"},
146      "min":1
147    },
148    "ContactId":{
149      "type":"string",
150      "max":256,
151      "min":1
152    },
153    "CreateParticipantConnectionRequest":{
154      "type":"structure",
155      "required":[
156        "Type",
157        "ParticipantToken"
158      ],
159      "members":{
160        "Type":{"shape":"ConnectionTypeList"},
161        "ParticipantToken":{
162          "shape":"ParticipantToken",
163          "location":"header",
164          "locationName":"X-Amz-Bearer"
165        }
166      }
167    },
168    "CreateParticipantConnectionResponse":{
169      "type":"structure",
170      "members":{
171        "Websocket":{"shape":"Websocket"},
172        "ConnectionCredentials":{"shape":"ConnectionCredentials"}
173      }
174    },
175    "DisconnectParticipantRequest":{
176      "type":"structure",
177      "required":["ConnectionToken"],
178      "members":{
179        "ClientToken":{
180          "shape":"ClientToken",
181          "idempotencyToken":true
182        },
183        "ConnectionToken":{
184          "shape":"ParticipantToken",
185          "location":"header",
186          "locationName":"X-Amz-Bearer"
187        }
188      }
189    },
190    "DisconnectParticipantResponse":{
191      "type":"structure",
192      "members":{
193      }
194    },
195    "DisplayName":{
196      "type":"string",
197      "max":256,
198      "min":1
199    },
200    "GetTranscriptRequest":{
201      "type":"structure",
202      "required":["ConnectionToken"],
203      "members":{
204        "ContactId":{"shape":"ContactId"},
205        "MaxResults":{
206          "shape":"MaxResults",
207          "box":true
208        },
209        "NextToken":{"shape":"NextToken"},
210        "ScanDirection":{"shape":"ScanDirection"},
211        "SortOrder":{"shape":"SortKey"},
212        "StartPosition":{"shape":"StartPosition"},
213        "ConnectionToken":{
214          "shape":"ParticipantToken",
215          "location":"header",
216          "locationName":"X-Amz-Bearer"
217        }
218      }
219    },
220    "GetTranscriptResponse":{
221      "type":"structure",
222      "members":{
223        "InitialContactId":{"shape":"ContactId"},
224        "Transcript":{"shape":"Transcript"},
225        "NextToken":{"shape":"NextToken"}
226      }
227    },
228    "ISO8601Datetime":{"type":"string"},
229    "Instant":{
230      "type":"string",
231      "max":100,
232      "min":1
233    },
234    "InternalServerException":{
235      "type":"structure",
236      "required":["Message"],
237      "members":{
238        "Message":{"shape":"Message"}
239      },
240      "error":{"httpStatusCode":500},
241      "exception":true,
242      "fault":true
243    },
244    "Item":{
245      "type":"structure",
246      "members":{
247        "AbsoluteTime":{"shape":"Instant"},
248        "Content":{"shape":"ChatContent"},
249        "ContentType":{"shape":"ChatContentType"},
250        "Id":{"shape":"ChatItemId"},
251        "Type":{"shape":"ChatItemType"},
252        "ParticipantId":{"shape":"ParticipantId"},
253        "DisplayName":{"shape":"DisplayName"},
254        "ParticipantRole":{"shape":"ParticipantRole"}
255      }
256    },
257    "MaxResults":{
258      "type":"integer",
259      "max":100,
260      "min":0
261    },
262    "Message":{"type":"string"},
263    "MostRecent":{
264      "type":"integer",
265      "max":100,
266      "min":0
267    },
268    "NextToken":{
269      "type":"string",
270      "max":1000,
271      "min":1
272    },
273    "ParticipantId":{
274      "type":"string",
275      "max":256,
276      "min":1
277    },
278    "ParticipantRole":{
279      "type":"string",
280      "enum":[
281        "AGENT",
282        "CUSTOMER",
283        "SYSTEM"
284      ]
285    },
286    "ParticipantToken":{
287      "type":"string",
288      "max":1000,
289      "min":1
290    },
291    "PreSignedConnectionUrl":{
292      "type":"string",
293      "max":2000,
294      "min":1
295    },
296    "Reason":{
297      "type":"string",
298      "max":2000,
299      "min":1
300    },
301    "ScanDirection":{
302      "type":"string",
303      "enum":[
304        "FORWARD",
305        "BACKWARD"
306      ]
307    },
308    "SendEventRequest":{
309      "type":"structure",
310      "required":[
311        "ContentType",
312        "ConnectionToken"
313      ],
314      "members":{
315        "ContentType":{"shape":"ChatContentType"},
316        "Content":{"shape":"ChatContent"},
317        "ClientToken":{
318          "shape":"ClientToken",
319          "idempotencyToken":true
320        },
321        "ConnectionToken":{
322          "shape":"ParticipantToken",
323          "location":"header",
324          "locationName":"X-Amz-Bearer"
325        }
326      }
327    },
328    "SendEventResponse":{
329      "type":"structure",
330      "members":{
331        "Id":{"shape":"ChatItemId"},
332        "AbsoluteTime":{"shape":"Instant"}
333      }
334    },
335    "SendMessageRequest":{
336      "type":"structure",
337      "required":[
338        "ContentType",
339        "Content",
340        "ConnectionToken"
341      ],
342      "members":{
343        "ContentType":{"shape":"ChatContentType"},
344        "Content":{"shape":"ChatContent"},
345        "ClientToken":{
346          "shape":"ClientToken",
347          "idempotencyToken":true
348        },
349        "ConnectionToken":{
350          "shape":"ParticipantToken",
351          "location":"header",
352          "locationName":"X-Amz-Bearer"
353        }
354      }
355    },
356    "SendMessageResponse":{
357      "type":"structure",
358      "members":{
359        "Id":{"shape":"ChatItemId"},
360        "AbsoluteTime":{"shape":"Instant"}
361      }
362    },
363    "SortKey":{
364      "type":"string",
365      "enum":[
366        "DESCENDING",
367        "ASCENDING"
368      ]
369    },
370    "StartPosition":{
371      "type":"structure",
372      "members":{
373        "Id":{"shape":"ChatItemId"},
374        "AbsoluteTime":{"shape":"Instant"},
375        "MostRecent":{"shape":"MostRecent"}
376      }
377    },
378    "ThrottlingException":{
379      "type":"structure",
380      "required":["Message"],
381      "members":{
382        "Message":{"shape":"Message"}
383      },
384      "error":{"httpStatusCode":429},
385      "exception":true
386    },
387    "Transcript":{
388      "type":"list",
389      "member":{"shape":"Item"}
390    },
391    "ValidationException":{
392      "type":"structure",
393      "required":["Message"],
394      "members":{
395        "Message":{"shape":"Reason"}
396      },
397      "error":{"httpStatusCode":400},
398      "exception":true
399    },
400    "Websocket":{
401      "type":"structure",
402      "members":{
403        "Url":{"shape":"PreSignedConnectionUrl"},
404        "ConnectionExpiry":{"shape":"ISO8601Datetime"}
405      }
406    }
407  }
408}
409