connectparticipant-2018-09-07.min.json 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  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. "CompleteAttachmentUpload": {
  17. "http": {
  18. "requestUri": "/participant/complete-attachment-upload"
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "AttachmentIds",
  24. "ClientToken",
  25. "ConnectionToken"
  26. ],
  27. "members": {
  28. "AttachmentIds": {
  29. "type": "list",
  30. "member": {}
  31. },
  32. "ClientToken": {
  33. "idempotencyToken": true
  34. },
  35. "ConnectionToken": {
  36. "location": "header",
  37. "locationName": "X-Amz-Bearer"
  38. }
  39. }
  40. },
  41. "output": {
  42. "type": "structure",
  43. "members": {}
  44. }
  45. },
  46. "CreateParticipantConnection": {
  47. "http": {
  48. "requestUri": "/participant/connection"
  49. },
  50. "input": {
  51. "type": "structure",
  52. "required": [
  53. "ParticipantToken"
  54. ],
  55. "members": {
  56. "Type": {
  57. "type": "list",
  58. "member": {}
  59. },
  60. "ParticipantToken": {
  61. "location": "header",
  62. "locationName": "X-Amz-Bearer"
  63. },
  64. "ConnectParticipant": {
  65. "type": "boolean"
  66. }
  67. }
  68. },
  69. "output": {
  70. "type": "structure",
  71. "members": {
  72. "Websocket": {
  73. "type": "structure",
  74. "members": {
  75. "Url": {},
  76. "ConnectionExpiry": {}
  77. }
  78. },
  79. "ConnectionCredentials": {
  80. "type": "structure",
  81. "members": {
  82. "ConnectionToken": {},
  83. "Expiry": {}
  84. }
  85. }
  86. }
  87. }
  88. },
  89. "DescribeView": {
  90. "http": {
  91. "method": "GET",
  92. "requestUri": "/participant/views/{ViewToken}"
  93. },
  94. "input": {
  95. "type": "structure",
  96. "required": [
  97. "ViewToken",
  98. "ConnectionToken"
  99. ],
  100. "members": {
  101. "ViewToken": {
  102. "location": "uri",
  103. "locationName": "ViewToken"
  104. },
  105. "ConnectionToken": {
  106. "location": "header",
  107. "locationName": "X-Amz-Bearer"
  108. }
  109. }
  110. },
  111. "output": {
  112. "type": "structure",
  113. "members": {
  114. "View": {
  115. "type": "structure",
  116. "members": {
  117. "Id": {},
  118. "Arn": {},
  119. "Name": {
  120. "type": "string",
  121. "sensitive": true
  122. },
  123. "Version": {
  124. "type": "integer"
  125. },
  126. "Content": {
  127. "type": "structure",
  128. "members": {
  129. "InputSchema": {
  130. "type": "string",
  131. "sensitive": true
  132. },
  133. "Template": {
  134. "type": "string",
  135. "sensitive": true
  136. },
  137. "Actions": {
  138. "type": "list",
  139. "member": {
  140. "type": "string",
  141. "sensitive": true
  142. }
  143. }
  144. }
  145. }
  146. }
  147. }
  148. }
  149. }
  150. },
  151. "DisconnectParticipant": {
  152. "http": {
  153. "requestUri": "/participant/disconnect"
  154. },
  155. "input": {
  156. "type": "structure",
  157. "required": [
  158. "ConnectionToken"
  159. ],
  160. "members": {
  161. "ClientToken": {
  162. "idempotencyToken": true
  163. },
  164. "ConnectionToken": {
  165. "location": "header",
  166. "locationName": "X-Amz-Bearer"
  167. }
  168. }
  169. },
  170. "output": {
  171. "type": "structure",
  172. "members": {}
  173. }
  174. },
  175. "GetAttachment": {
  176. "http": {
  177. "requestUri": "/participant/attachment"
  178. },
  179. "input": {
  180. "type": "structure",
  181. "required": [
  182. "AttachmentId",
  183. "ConnectionToken"
  184. ],
  185. "members": {
  186. "AttachmentId": {},
  187. "ConnectionToken": {
  188. "location": "header",
  189. "locationName": "X-Amz-Bearer"
  190. }
  191. }
  192. },
  193. "output": {
  194. "type": "structure",
  195. "members": {
  196. "Url": {},
  197. "UrlExpiry": {}
  198. }
  199. }
  200. },
  201. "GetTranscript": {
  202. "http": {
  203. "requestUri": "/participant/transcript"
  204. },
  205. "input": {
  206. "type": "structure",
  207. "required": [
  208. "ConnectionToken"
  209. ],
  210. "members": {
  211. "ContactId": {},
  212. "MaxResults": {
  213. "type": "integer"
  214. },
  215. "NextToken": {},
  216. "ScanDirection": {},
  217. "SortOrder": {},
  218. "StartPosition": {
  219. "type": "structure",
  220. "members": {
  221. "Id": {},
  222. "AbsoluteTime": {},
  223. "MostRecent": {
  224. "type": "integer"
  225. }
  226. }
  227. },
  228. "ConnectionToken": {
  229. "location": "header",
  230. "locationName": "X-Amz-Bearer"
  231. }
  232. }
  233. },
  234. "output": {
  235. "type": "structure",
  236. "members": {
  237. "InitialContactId": {},
  238. "Transcript": {
  239. "type": "list",
  240. "member": {
  241. "type": "structure",
  242. "members": {
  243. "AbsoluteTime": {},
  244. "Content": {},
  245. "ContentType": {},
  246. "Id": {},
  247. "Type": {},
  248. "ParticipantId": {},
  249. "DisplayName": {},
  250. "ParticipantRole": {},
  251. "Attachments": {
  252. "type": "list",
  253. "member": {
  254. "type": "structure",
  255. "members": {
  256. "ContentType": {},
  257. "AttachmentId": {},
  258. "AttachmentName": {},
  259. "Status": {}
  260. }
  261. }
  262. },
  263. "MessageMetadata": {
  264. "type": "structure",
  265. "members": {
  266. "MessageId": {},
  267. "Receipts": {
  268. "type": "list",
  269. "member": {
  270. "type": "structure",
  271. "members": {
  272. "DeliveredTimestamp": {},
  273. "ReadTimestamp": {},
  274. "RecipientParticipantId": {}
  275. }
  276. }
  277. }
  278. }
  279. },
  280. "RelatedContactId": {},
  281. "ContactId": {}
  282. }
  283. }
  284. },
  285. "NextToken": {}
  286. }
  287. }
  288. },
  289. "SendEvent": {
  290. "http": {
  291. "requestUri": "/participant/event"
  292. },
  293. "input": {
  294. "type": "structure",
  295. "required": [
  296. "ContentType",
  297. "ConnectionToken"
  298. ],
  299. "members": {
  300. "ContentType": {},
  301. "Content": {},
  302. "ClientToken": {
  303. "idempotencyToken": true
  304. },
  305. "ConnectionToken": {
  306. "location": "header",
  307. "locationName": "X-Amz-Bearer"
  308. }
  309. }
  310. },
  311. "output": {
  312. "type": "structure",
  313. "members": {
  314. "Id": {},
  315. "AbsoluteTime": {}
  316. }
  317. }
  318. },
  319. "SendMessage": {
  320. "http": {
  321. "requestUri": "/participant/message"
  322. },
  323. "input": {
  324. "type": "structure",
  325. "required": [
  326. "ContentType",
  327. "Content",
  328. "ConnectionToken"
  329. ],
  330. "members": {
  331. "ContentType": {},
  332. "Content": {},
  333. "ClientToken": {
  334. "idempotencyToken": true
  335. },
  336. "ConnectionToken": {
  337. "location": "header",
  338. "locationName": "X-Amz-Bearer"
  339. }
  340. }
  341. },
  342. "output": {
  343. "type": "structure",
  344. "members": {
  345. "Id": {},
  346. "AbsoluteTime": {}
  347. }
  348. }
  349. },
  350. "StartAttachmentUpload": {
  351. "http": {
  352. "requestUri": "/participant/start-attachment-upload"
  353. },
  354. "input": {
  355. "type": "structure",
  356. "required": [
  357. "ContentType",
  358. "AttachmentSizeInBytes",
  359. "AttachmentName",
  360. "ClientToken",
  361. "ConnectionToken"
  362. ],
  363. "members": {
  364. "ContentType": {},
  365. "AttachmentSizeInBytes": {
  366. "type": "long"
  367. },
  368. "AttachmentName": {},
  369. "ClientToken": {
  370. "idempotencyToken": true
  371. },
  372. "ConnectionToken": {
  373. "location": "header",
  374. "locationName": "X-Amz-Bearer"
  375. }
  376. }
  377. },
  378. "output": {
  379. "type": "structure",
  380. "members": {
  381. "AttachmentId": {},
  382. "UploadMetadata": {
  383. "type": "structure",
  384. "members": {
  385. "Url": {},
  386. "UrlExpiry": {},
  387. "HeadersToInclude": {
  388. "type": "map",
  389. "key": {},
  390. "value": {}
  391. }
  392. }
  393. }
  394. }
  395. }
  396. }
  397. },
  398. "shapes": {}
  399. }