connectcases-2022-10-03.min.json 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2022-10-03",
  5. "endpointPrefix": "cases",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceAbbreviation": "ConnectCases",
  9. "serviceFullName": "Amazon Connect Cases",
  10. "serviceId": "ConnectCases",
  11. "signatureVersion": "v4",
  12. "signingName": "cases",
  13. "uid": "connectcases-2022-10-03"
  14. },
  15. "operations": {
  16. "BatchGetField": {
  17. "http": {
  18. "requestUri": "/domains/{domainId}/fields-batch",
  19. "responseCode": 200
  20. },
  21. "input": {
  22. "type": "structure",
  23. "required": [
  24. "domainId",
  25. "fields"
  26. ],
  27. "members": {
  28. "domainId": {
  29. "location": "uri",
  30. "locationName": "domainId"
  31. },
  32. "fields": {
  33. "type": "list",
  34. "member": {
  35. "shape": "S4"
  36. }
  37. }
  38. }
  39. },
  40. "output": {
  41. "type": "structure",
  42. "required": [
  43. "errors",
  44. "fields"
  45. ],
  46. "members": {
  47. "errors": {
  48. "type": "list",
  49. "member": {
  50. "type": "structure",
  51. "required": [
  52. "errorCode",
  53. "id"
  54. ],
  55. "members": {
  56. "errorCode": {},
  57. "id": {},
  58. "message": {}
  59. }
  60. }
  61. },
  62. "fields": {
  63. "type": "list",
  64. "member": {
  65. "type": "structure",
  66. "required": [
  67. "fieldArn",
  68. "fieldId",
  69. "name",
  70. "namespace",
  71. "type"
  72. ],
  73. "members": {
  74. "createdTime": {
  75. "shape": "Sc"
  76. },
  77. "deleted": {
  78. "type": "boolean"
  79. },
  80. "description": {},
  81. "fieldArn": {},
  82. "fieldId": {},
  83. "lastModifiedTime": {
  84. "shape": "Sg"
  85. },
  86. "name": {},
  87. "namespace": {},
  88. "tags": {
  89. "shape": "Sj"
  90. },
  91. "type": {}
  92. }
  93. }
  94. }
  95. }
  96. }
  97. },
  98. "BatchPutFieldOptions": {
  99. "http": {
  100. "method": "PUT",
  101. "requestUri": "/domains/{domainId}/fields/{fieldId}/options",
  102. "responseCode": 200
  103. },
  104. "input": {
  105. "type": "structure",
  106. "required": [
  107. "domainId",
  108. "fieldId",
  109. "options"
  110. ],
  111. "members": {
  112. "domainId": {
  113. "location": "uri",
  114. "locationName": "domainId"
  115. },
  116. "fieldId": {
  117. "location": "uri",
  118. "locationName": "fieldId"
  119. },
  120. "options": {
  121. "type": "list",
  122. "member": {
  123. "shape": "Sn"
  124. }
  125. }
  126. }
  127. },
  128. "output": {
  129. "type": "structure",
  130. "members": {
  131. "errors": {
  132. "type": "list",
  133. "member": {
  134. "type": "structure",
  135. "required": [
  136. "errorCode",
  137. "message",
  138. "value"
  139. ],
  140. "members": {
  141. "errorCode": {},
  142. "message": {},
  143. "value": {}
  144. }
  145. }
  146. }
  147. }
  148. },
  149. "idempotent": true
  150. },
  151. "CreateCase": {
  152. "http": {
  153. "requestUri": "/domains/{domainId}/cases",
  154. "responseCode": 200
  155. },
  156. "input": {
  157. "type": "structure",
  158. "required": [
  159. "domainId",
  160. "fields",
  161. "templateId"
  162. ],
  163. "members": {
  164. "clientToken": {
  165. "idempotencyToken": true
  166. },
  167. "domainId": {
  168. "location": "uri",
  169. "locationName": "domainId"
  170. },
  171. "fields": {
  172. "type": "list",
  173. "member": {
  174. "shape": "Sx"
  175. }
  176. },
  177. "performedBy": {
  178. "shape": "S12"
  179. },
  180. "templateId": {}
  181. }
  182. },
  183. "output": {
  184. "type": "structure",
  185. "required": [
  186. "caseArn",
  187. "caseId"
  188. ],
  189. "members": {
  190. "caseArn": {},
  191. "caseId": {}
  192. }
  193. },
  194. "idempotent": true
  195. },
  196. "CreateDomain": {
  197. "http": {
  198. "requestUri": "/domains",
  199. "responseCode": 200
  200. },
  201. "input": {
  202. "type": "structure",
  203. "required": [
  204. "name"
  205. ],
  206. "members": {
  207. "name": {}
  208. }
  209. },
  210. "output": {
  211. "type": "structure",
  212. "required": [
  213. "domainArn",
  214. "domainId",
  215. "domainStatus"
  216. ],
  217. "members": {
  218. "domainArn": {},
  219. "domainId": {},
  220. "domainStatus": {}
  221. }
  222. },
  223. "idempotent": true
  224. },
  225. "CreateField": {
  226. "http": {
  227. "requestUri": "/domains/{domainId}/fields",
  228. "responseCode": 200
  229. },
  230. "input": {
  231. "type": "structure",
  232. "required": [
  233. "domainId",
  234. "name",
  235. "type"
  236. ],
  237. "members": {
  238. "description": {},
  239. "domainId": {
  240. "location": "uri",
  241. "locationName": "domainId"
  242. },
  243. "name": {},
  244. "type": {}
  245. }
  246. },
  247. "output": {
  248. "type": "structure",
  249. "required": [
  250. "fieldArn",
  251. "fieldId"
  252. ],
  253. "members": {
  254. "fieldArn": {},
  255. "fieldId": {}
  256. }
  257. },
  258. "idempotent": true
  259. },
  260. "CreateLayout": {
  261. "http": {
  262. "requestUri": "/domains/{domainId}/layouts",
  263. "responseCode": 200
  264. },
  265. "input": {
  266. "type": "structure",
  267. "required": [
  268. "content",
  269. "domainId",
  270. "name"
  271. ],
  272. "members": {
  273. "content": {
  274. "shape": "S1g"
  275. },
  276. "domainId": {
  277. "location": "uri",
  278. "locationName": "domainId"
  279. },
  280. "name": {}
  281. }
  282. },
  283. "output": {
  284. "type": "structure",
  285. "required": [
  286. "layoutArn",
  287. "layoutId"
  288. ],
  289. "members": {
  290. "layoutArn": {},
  291. "layoutId": {}
  292. }
  293. }
  294. },
  295. "CreateRelatedItem": {
  296. "http": {
  297. "requestUri": "/domains/{domainId}/cases/{caseId}/related-items/",
  298. "responseCode": 200
  299. },
  300. "input": {
  301. "type": "structure",
  302. "required": [
  303. "caseId",
  304. "content",
  305. "domainId",
  306. "type"
  307. ],
  308. "members": {
  309. "caseId": {
  310. "location": "uri",
  311. "locationName": "caseId"
  312. },
  313. "content": {
  314. "type": "structure",
  315. "members": {
  316. "comment": {
  317. "shape": "S1v"
  318. },
  319. "contact": {
  320. "type": "structure",
  321. "required": [
  322. "contactArn"
  323. ],
  324. "members": {
  325. "contactArn": {}
  326. }
  327. },
  328. "file": {
  329. "shape": "S20"
  330. }
  331. },
  332. "union": true
  333. },
  334. "domainId": {
  335. "location": "uri",
  336. "locationName": "domainId"
  337. },
  338. "performedBy": {
  339. "shape": "S12"
  340. },
  341. "type": {}
  342. }
  343. },
  344. "output": {
  345. "type": "structure",
  346. "required": [
  347. "relatedItemArn",
  348. "relatedItemId"
  349. ],
  350. "members": {
  351. "relatedItemArn": {},
  352. "relatedItemId": {}
  353. }
  354. },
  355. "idempotent": true
  356. },
  357. "CreateTemplate": {
  358. "http": {
  359. "requestUri": "/domains/{domainId}/templates",
  360. "responseCode": 200
  361. },
  362. "input": {
  363. "type": "structure",
  364. "required": [
  365. "domainId",
  366. "name"
  367. ],
  368. "members": {
  369. "description": {},
  370. "domainId": {
  371. "location": "uri",
  372. "locationName": "domainId"
  373. },
  374. "layoutConfiguration": {
  375. "shape": "S28"
  376. },
  377. "name": {},
  378. "requiredFields": {
  379. "shape": "S2a"
  380. },
  381. "status": {}
  382. }
  383. },
  384. "output": {
  385. "type": "structure",
  386. "required": [
  387. "templateArn",
  388. "templateId"
  389. ],
  390. "members": {
  391. "templateArn": {},
  392. "templateId": {}
  393. }
  394. },
  395. "idempotent": true
  396. },
  397. "DeleteDomain": {
  398. "http": {
  399. "method": "DELETE",
  400. "requestUri": "/domains/{domainId}",
  401. "responseCode": 200
  402. },
  403. "input": {
  404. "type": "structure",
  405. "required": [
  406. "domainId"
  407. ],
  408. "members": {
  409. "domainId": {
  410. "location": "uri",
  411. "locationName": "domainId"
  412. }
  413. }
  414. },
  415. "output": {
  416. "type": "structure",
  417. "members": {}
  418. },
  419. "idempotent": true
  420. },
  421. "DeleteField": {
  422. "http": {
  423. "method": "DELETE",
  424. "requestUri": "/domains/{domainId}/fields/{fieldId}",
  425. "responseCode": 200
  426. },
  427. "input": {
  428. "type": "structure",
  429. "required": [
  430. "domainId",
  431. "fieldId"
  432. ],
  433. "members": {
  434. "domainId": {
  435. "location": "uri",
  436. "locationName": "domainId"
  437. },
  438. "fieldId": {
  439. "location": "uri",
  440. "locationName": "fieldId"
  441. }
  442. }
  443. },
  444. "output": {
  445. "type": "structure",
  446. "members": {}
  447. },
  448. "idempotent": true
  449. },
  450. "DeleteLayout": {
  451. "http": {
  452. "method": "DELETE",
  453. "requestUri": "/domains/{domainId}/layouts/{layoutId}",
  454. "responseCode": 200
  455. },
  456. "input": {
  457. "type": "structure",
  458. "required": [
  459. "domainId",
  460. "layoutId"
  461. ],
  462. "members": {
  463. "domainId": {
  464. "location": "uri",
  465. "locationName": "domainId"
  466. },
  467. "layoutId": {
  468. "location": "uri",
  469. "locationName": "layoutId"
  470. }
  471. }
  472. },
  473. "output": {
  474. "type": "structure",
  475. "members": {}
  476. },
  477. "idempotent": true
  478. },
  479. "DeleteTemplate": {
  480. "http": {
  481. "method": "DELETE",
  482. "requestUri": "/domains/{domainId}/templates/{templateId}",
  483. "responseCode": 200
  484. },
  485. "input": {
  486. "type": "structure",
  487. "required": [
  488. "domainId",
  489. "templateId"
  490. ],
  491. "members": {
  492. "domainId": {
  493. "location": "uri",
  494. "locationName": "domainId"
  495. },
  496. "templateId": {
  497. "location": "uri",
  498. "locationName": "templateId"
  499. }
  500. }
  501. },
  502. "output": {
  503. "type": "structure",
  504. "members": {}
  505. },
  506. "idempotent": true
  507. },
  508. "GetCase": {
  509. "http": {
  510. "requestUri": "/domains/{domainId}/cases/{caseId}",
  511. "responseCode": 200
  512. },
  513. "input": {
  514. "type": "structure",
  515. "required": [
  516. "caseId",
  517. "domainId",
  518. "fields"
  519. ],
  520. "members": {
  521. "caseId": {
  522. "location": "uri",
  523. "locationName": "caseId"
  524. },
  525. "domainId": {
  526. "location": "uri",
  527. "locationName": "domainId"
  528. },
  529. "fields": {
  530. "type": "list",
  531. "member": {
  532. "shape": "S4"
  533. }
  534. },
  535. "nextToken": {}
  536. }
  537. },
  538. "output": {
  539. "type": "structure",
  540. "required": [
  541. "fields",
  542. "templateId"
  543. ],
  544. "members": {
  545. "fields": {
  546. "type": "list",
  547. "member": {
  548. "shape": "Sx"
  549. }
  550. },
  551. "nextToken": {},
  552. "tags": {
  553. "shape": "Sj"
  554. },
  555. "templateId": {}
  556. }
  557. }
  558. },
  559. "GetCaseAuditEvents": {
  560. "http": {
  561. "requestUri": "/domains/{domainId}/cases/{caseId}/audit-history",
  562. "responseCode": 200
  563. },
  564. "input": {
  565. "type": "structure",
  566. "required": [
  567. "caseId",
  568. "domainId"
  569. ],
  570. "members": {
  571. "caseId": {
  572. "location": "uri",
  573. "locationName": "caseId"
  574. },
  575. "domainId": {
  576. "location": "uri",
  577. "locationName": "domainId"
  578. },
  579. "maxResults": {
  580. "type": "integer"
  581. },
  582. "nextToken": {}
  583. }
  584. },
  585. "output": {
  586. "type": "structure",
  587. "required": [
  588. "auditEvents"
  589. ],
  590. "members": {
  591. "auditEvents": {
  592. "type": "list",
  593. "member": {
  594. "type": "structure",
  595. "required": [
  596. "eventId",
  597. "fields",
  598. "performedTime",
  599. "type"
  600. ],
  601. "members": {
  602. "eventId": {},
  603. "fields": {
  604. "type": "list",
  605. "member": {
  606. "type": "structure",
  607. "required": [
  608. "eventFieldId",
  609. "newValue"
  610. ],
  611. "members": {
  612. "eventFieldId": {},
  613. "newValue": {
  614. "shape": "S31"
  615. },
  616. "oldValue": {
  617. "shape": "S31"
  618. }
  619. }
  620. }
  621. },
  622. "performedBy": {
  623. "type": "structure",
  624. "required": [
  625. "iamPrincipalArn"
  626. ],
  627. "members": {
  628. "iamPrincipalArn": {},
  629. "user": {
  630. "shape": "S12"
  631. }
  632. }
  633. },
  634. "performedTime": {
  635. "type": "timestamp",
  636. "timestampFormat": "iso8601"
  637. },
  638. "relatedItemType": {},
  639. "type": {}
  640. }
  641. }
  642. },
  643. "nextToken": {}
  644. }
  645. }
  646. },
  647. "GetCaseEventConfiguration": {
  648. "http": {
  649. "requestUri": "/domains/{domainId}/case-event-configuration",
  650. "responseCode": 200
  651. },
  652. "input": {
  653. "type": "structure",
  654. "required": [
  655. "domainId"
  656. ],
  657. "members": {
  658. "domainId": {
  659. "location": "uri",
  660. "locationName": "domainId"
  661. }
  662. }
  663. },
  664. "output": {
  665. "type": "structure",
  666. "required": [
  667. "eventBridge"
  668. ],
  669. "members": {
  670. "eventBridge": {
  671. "shape": "S39"
  672. }
  673. }
  674. }
  675. },
  676. "GetDomain": {
  677. "http": {
  678. "requestUri": "/domains/{domainId}",
  679. "responseCode": 200
  680. },
  681. "input": {
  682. "type": "structure",
  683. "required": [
  684. "domainId"
  685. ],
  686. "members": {
  687. "domainId": {
  688. "location": "uri",
  689. "locationName": "domainId"
  690. }
  691. }
  692. },
  693. "output": {
  694. "type": "structure",
  695. "required": [
  696. "createdTime",
  697. "domainArn",
  698. "domainId",
  699. "domainStatus",
  700. "name"
  701. ],
  702. "members": {
  703. "createdTime": {
  704. "shape": "Sc"
  705. },
  706. "domainArn": {},
  707. "domainId": {},
  708. "domainStatus": {},
  709. "name": {},
  710. "tags": {
  711. "shape": "Sj"
  712. }
  713. }
  714. }
  715. },
  716. "GetLayout": {
  717. "http": {
  718. "requestUri": "/domains/{domainId}/layouts/{layoutId}",
  719. "responseCode": 200
  720. },
  721. "input": {
  722. "type": "structure",
  723. "required": [
  724. "domainId",
  725. "layoutId"
  726. ],
  727. "members": {
  728. "domainId": {
  729. "location": "uri",
  730. "locationName": "domainId"
  731. },
  732. "layoutId": {
  733. "location": "uri",
  734. "locationName": "layoutId"
  735. }
  736. }
  737. },
  738. "output": {
  739. "type": "structure",
  740. "required": [
  741. "content",
  742. "layoutArn",
  743. "layoutId",
  744. "name"
  745. ],
  746. "members": {
  747. "content": {
  748. "shape": "S1g"
  749. },
  750. "createdTime": {
  751. "shape": "Sc"
  752. },
  753. "deleted": {
  754. "type": "boolean"
  755. },
  756. "lastModifiedTime": {
  757. "shape": "Sg"
  758. },
  759. "layoutArn": {},
  760. "layoutId": {},
  761. "name": {},
  762. "tags": {
  763. "shape": "Sj"
  764. }
  765. }
  766. }
  767. },
  768. "GetTemplate": {
  769. "http": {
  770. "requestUri": "/domains/{domainId}/templates/{templateId}",
  771. "responseCode": 200
  772. },
  773. "input": {
  774. "type": "structure",
  775. "required": [
  776. "domainId",
  777. "templateId"
  778. ],
  779. "members": {
  780. "domainId": {
  781. "location": "uri",
  782. "locationName": "domainId"
  783. },
  784. "templateId": {
  785. "location": "uri",
  786. "locationName": "templateId"
  787. }
  788. }
  789. },
  790. "output": {
  791. "type": "structure",
  792. "required": [
  793. "name",
  794. "status",
  795. "templateArn",
  796. "templateId"
  797. ],
  798. "members": {
  799. "createdTime": {
  800. "shape": "Sc"
  801. },
  802. "deleted": {
  803. "type": "boolean"
  804. },
  805. "description": {},
  806. "lastModifiedTime": {
  807. "shape": "Sg"
  808. },
  809. "layoutConfiguration": {
  810. "shape": "S28"
  811. },
  812. "name": {},
  813. "requiredFields": {
  814. "shape": "S2a"
  815. },
  816. "status": {},
  817. "tags": {
  818. "shape": "Sj"
  819. },
  820. "templateArn": {},
  821. "templateId": {}
  822. }
  823. }
  824. },
  825. "ListCasesForContact": {
  826. "http": {
  827. "requestUri": "/domains/{domainId}/list-cases-for-contact",
  828. "responseCode": 200
  829. },
  830. "input": {
  831. "type": "structure",
  832. "required": [
  833. "contactArn",
  834. "domainId"
  835. ],
  836. "members": {
  837. "contactArn": {},
  838. "domainId": {
  839. "location": "uri",
  840. "locationName": "domainId"
  841. },
  842. "maxResults": {
  843. "type": "integer"
  844. },
  845. "nextToken": {}
  846. }
  847. },
  848. "output": {
  849. "type": "structure",
  850. "required": [
  851. "cases"
  852. ],
  853. "members": {
  854. "cases": {
  855. "type": "list",
  856. "member": {
  857. "type": "structure",
  858. "required": [
  859. "caseId",
  860. "templateId"
  861. ],
  862. "members": {
  863. "caseId": {},
  864. "templateId": {}
  865. }
  866. }
  867. },
  868. "nextToken": {}
  869. }
  870. }
  871. },
  872. "ListDomains": {
  873. "http": {
  874. "requestUri": "/domains-list",
  875. "responseCode": 200
  876. },
  877. "input": {
  878. "type": "structure",
  879. "members": {
  880. "maxResults": {
  881. "location": "querystring",
  882. "locationName": "maxResults",
  883. "type": "integer"
  884. },
  885. "nextToken": {
  886. "location": "querystring",
  887. "locationName": "nextToken"
  888. }
  889. }
  890. },
  891. "output": {
  892. "type": "structure",
  893. "required": [
  894. "domains"
  895. ],
  896. "members": {
  897. "domains": {
  898. "type": "list",
  899. "member": {
  900. "type": "structure",
  901. "required": [
  902. "domainArn",
  903. "domainId",
  904. "name"
  905. ],
  906. "members": {
  907. "domainArn": {},
  908. "domainId": {},
  909. "name": {}
  910. }
  911. }
  912. },
  913. "nextToken": {}
  914. }
  915. }
  916. },
  917. "ListFieldOptions": {
  918. "http": {
  919. "requestUri": "/domains/{domainId}/fields/{fieldId}/options-list",
  920. "responseCode": 200
  921. },
  922. "input": {
  923. "type": "structure",
  924. "required": [
  925. "domainId",
  926. "fieldId"
  927. ],
  928. "members": {
  929. "domainId": {
  930. "location": "uri",
  931. "locationName": "domainId"
  932. },
  933. "fieldId": {
  934. "location": "uri",
  935. "locationName": "fieldId"
  936. },
  937. "maxResults": {
  938. "location": "querystring",
  939. "locationName": "maxResults",
  940. "type": "integer"
  941. },
  942. "nextToken": {
  943. "location": "querystring",
  944. "locationName": "nextToken"
  945. },
  946. "values": {
  947. "location": "querystring",
  948. "locationName": "values",
  949. "type": "list",
  950. "member": {}
  951. }
  952. }
  953. },
  954. "output": {
  955. "type": "structure",
  956. "required": [
  957. "options"
  958. ],
  959. "members": {
  960. "nextToken": {},
  961. "options": {
  962. "type": "list",
  963. "member": {
  964. "shape": "Sn"
  965. }
  966. }
  967. }
  968. }
  969. },
  970. "ListFields": {
  971. "http": {
  972. "requestUri": "/domains/{domainId}/fields-list",
  973. "responseCode": 200
  974. },
  975. "input": {
  976. "type": "structure",
  977. "required": [
  978. "domainId"
  979. ],
  980. "members": {
  981. "domainId": {
  982. "location": "uri",
  983. "locationName": "domainId"
  984. },
  985. "maxResults": {
  986. "location": "querystring",
  987. "locationName": "maxResults",
  988. "type": "integer"
  989. },
  990. "nextToken": {
  991. "location": "querystring",
  992. "locationName": "nextToken"
  993. }
  994. }
  995. },
  996. "output": {
  997. "type": "structure",
  998. "required": [
  999. "fields"
  1000. ],
  1001. "members": {
  1002. "fields": {
  1003. "type": "list",
  1004. "member": {
  1005. "type": "structure",
  1006. "required": [
  1007. "fieldArn",
  1008. "fieldId",
  1009. "name",
  1010. "namespace",
  1011. "type"
  1012. ],
  1013. "members": {
  1014. "fieldArn": {},
  1015. "fieldId": {},
  1016. "name": {},
  1017. "namespace": {},
  1018. "type": {}
  1019. }
  1020. }
  1021. },
  1022. "nextToken": {}
  1023. }
  1024. }
  1025. },
  1026. "ListLayouts": {
  1027. "http": {
  1028. "requestUri": "/domains/{domainId}/layouts-list",
  1029. "responseCode": 200
  1030. },
  1031. "input": {
  1032. "type": "structure",
  1033. "required": [
  1034. "domainId"
  1035. ],
  1036. "members": {
  1037. "domainId": {
  1038. "location": "uri",
  1039. "locationName": "domainId"
  1040. },
  1041. "maxResults": {
  1042. "location": "querystring",
  1043. "locationName": "maxResults",
  1044. "type": "integer"
  1045. },
  1046. "nextToken": {
  1047. "location": "querystring",
  1048. "locationName": "nextToken"
  1049. }
  1050. }
  1051. },
  1052. "output": {
  1053. "type": "structure",
  1054. "required": [
  1055. "layouts"
  1056. ],
  1057. "members": {
  1058. "layouts": {
  1059. "type": "list",
  1060. "member": {
  1061. "type": "structure",
  1062. "required": [
  1063. "layoutArn",
  1064. "layoutId",
  1065. "name"
  1066. ],
  1067. "members": {
  1068. "layoutArn": {},
  1069. "layoutId": {},
  1070. "name": {}
  1071. }
  1072. }
  1073. },
  1074. "nextToken": {}
  1075. }
  1076. }
  1077. },
  1078. "ListTagsForResource": {
  1079. "http": {
  1080. "method": "GET",
  1081. "requestUri": "/tags/{arn}",
  1082. "responseCode": 200
  1083. },
  1084. "input": {
  1085. "type": "structure",
  1086. "required": [
  1087. "arn"
  1088. ],
  1089. "members": {
  1090. "arn": {
  1091. "location": "uri",
  1092. "locationName": "arn"
  1093. }
  1094. }
  1095. },
  1096. "output": {
  1097. "type": "structure",
  1098. "members": {
  1099. "tags": {
  1100. "shape": "Sj"
  1101. }
  1102. }
  1103. },
  1104. "idempotent": true
  1105. },
  1106. "ListTemplates": {
  1107. "http": {
  1108. "requestUri": "/domains/{domainId}/templates-list",
  1109. "responseCode": 200
  1110. },
  1111. "input": {
  1112. "type": "structure",
  1113. "required": [
  1114. "domainId"
  1115. ],
  1116. "members": {
  1117. "domainId": {
  1118. "location": "uri",
  1119. "locationName": "domainId"
  1120. },
  1121. "maxResults": {
  1122. "location": "querystring",
  1123. "locationName": "maxResults",
  1124. "type": "integer"
  1125. },
  1126. "nextToken": {
  1127. "location": "querystring",
  1128. "locationName": "nextToken"
  1129. },
  1130. "status": {
  1131. "location": "querystring",
  1132. "locationName": "status",
  1133. "type": "list",
  1134. "member": {}
  1135. }
  1136. }
  1137. },
  1138. "output": {
  1139. "type": "structure",
  1140. "required": [
  1141. "templates"
  1142. ],
  1143. "members": {
  1144. "nextToken": {},
  1145. "templates": {
  1146. "type": "list",
  1147. "member": {
  1148. "type": "structure",
  1149. "required": [
  1150. "name",
  1151. "status",
  1152. "templateArn",
  1153. "templateId"
  1154. ],
  1155. "members": {
  1156. "name": {},
  1157. "status": {},
  1158. "templateArn": {},
  1159. "templateId": {}
  1160. }
  1161. }
  1162. }
  1163. }
  1164. }
  1165. },
  1166. "PutCaseEventConfiguration": {
  1167. "http": {
  1168. "method": "PUT",
  1169. "requestUri": "/domains/{domainId}/case-event-configuration",
  1170. "responseCode": 200
  1171. },
  1172. "input": {
  1173. "type": "structure",
  1174. "required": [
  1175. "domainId",
  1176. "eventBridge"
  1177. ],
  1178. "members": {
  1179. "domainId": {
  1180. "location": "uri",
  1181. "locationName": "domainId"
  1182. },
  1183. "eventBridge": {
  1184. "shape": "S39"
  1185. }
  1186. }
  1187. },
  1188. "output": {
  1189. "type": "structure",
  1190. "members": {}
  1191. }
  1192. },
  1193. "SearchCases": {
  1194. "http": {
  1195. "requestUri": "/domains/{domainId}/cases-search",
  1196. "responseCode": 200
  1197. },
  1198. "input": {
  1199. "type": "structure",
  1200. "required": [
  1201. "domainId"
  1202. ],
  1203. "members": {
  1204. "domainId": {
  1205. "location": "uri",
  1206. "locationName": "domainId"
  1207. },
  1208. "fields": {
  1209. "type": "list",
  1210. "member": {
  1211. "shape": "S4"
  1212. }
  1213. },
  1214. "filter": {
  1215. "shape": "S4k"
  1216. },
  1217. "maxResults": {
  1218. "type": "integer"
  1219. },
  1220. "nextToken": {},
  1221. "searchTerm": {},
  1222. "sorts": {
  1223. "type": "list",
  1224. "member": {
  1225. "type": "structure",
  1226. "required": [
  1227. "fieldId",
  1228. "sortOrder"
  1229. ],
  1230. "members": {
  1231. "fieldId": {},
  1232. "sortOrder": {}
  1233. }
  1234. }
  1235. }
  1236. }
  1237. },
  1238. "output": {
  1239. "type": "structure",
  1240. "required": [
  1241. "cases"
  1242. ],
  1243. "members": {
  1244. "cases": {
  1245. "type": "list",
  1246. "member": {
  1247. "type": "structure",
  1248. "required": [
  1249. "caseId",
  1250. "fields",
  1251. "templateId"
  1252. ],
  1253. "members": {
  1254. "caseId": {},
  1255. "fields": {
  1256. "type": "list",
  1257. "member": {
  1258. "shape": "Sx"
  1259. }
  1260. },
  1261. "tags": {
  1262. "shape": "Sj"
  1263. },
  1264. "templateId": {}
  1265. }
  1266. }
  1267. },
  1268. "nextToken": {}
  1269. }
  1270. }
  1271. },
  1272. "SearchRelatedItems": {
  1273. "http": {
  1274. "requestUri": "/domains/{domainId}/cases/{caseId}/related-items-search",
  1275. "responseCode": 200
  1276. },
  1277. "input": {
  1278. "type": "structure",
  1279. "required": [
  1280. "caseId",
  1281. "domainId"
  1282. ],
  1283. "members": {
  1284. "caseId": {
  1285. "location": "uri",
  1286. "locationName": "caseId"
  1287. },
  1288. "domainId": {
  1289. "location": "uri",
  1290. "locationName": "domainId"
  1291. },
  1292. "filters": {
  1293. "type": "list",
  1294. "member": {
  1295. "type": "structure",
  1296. "members": {
  1297. "comment": {
  1298. "type": "structure",
  1299. "members": {}
  1300. },
  1301. "contact": {
  1302. "type": "structure",
  1303. "members": {
  1304. "channel": {
  1305. "type": "list",
  1306. "member": {}
  1307. },
  1308. "contactArn": {}
  1309. }
  1310. },
  1311. "file": {
  1312. "type": "structure",
  1313. "members": {
  1314. "fileArn": {}
  1315. }
  1316. }
  1317. },
  1318. "union": true
  1319. }
  1320. },
  1321. "maxResults": {
  1322. "type": "integer"
  1323. },
  1324. "nextToken": {}
  1325. }
  1326. },
  1327. "output": {
  1328. "type": "structure",
  1329. "required": [
  1330. "relatedItems"
  1331. ],
  1332. "members": {
  1333. "nextToken": {},
  1334. "relatedItems": {
  1335. "type": "list",
  1336. "member": {
  1337. "type": "structure",
  1338. "required": [
  1339. "associationTime",
  1340. "content",
  1341. "relatedItemId",
  1342. "type"
  1343. ],
  1344. "members": {
  1345. "associationTime": {
  1346. "type": "timestamp",
  1347. "timestampFormat": "iso8601"
  1348. },
  1349. "content": {
  1350. "type": "structure",
  1351. "members": {
  1352. "comment": {
  1353. "shape": "S1v"
  1354. },
  1355. "contact": {
  1356. "type": "structure",
  1357. "required": [
  1358. "channel",
  1359. "connectedToSystemTime",
  1360. "contactArn"
  1361. ],
  1362. "members": {
  1363. "channel": {},
  1364. "connectedToSystemTime": {
  1365. "type": "timestamp",
  1366. "timestampFormat": "iso8601"
  1367. },
  1368. "contactArn": {}
  1369. }
  1370. },
  1371. "file": {
  1372. "shape": "S20"
  1373. }
  1374. },
  1375. "union": true
  1376. },
  1377. "performedBy": {
  1378. "shape": "S12"
  1379. },
  1380. "relatedItemId": {},
  1381. "tags": {
  1382. "shape": "Sj"
  1383. },
  1384. "type": {}
  1385. }
  1386. }
  1387. }
  1388. }
  1389. }
  1390. },
  1391. "TagResource": {
  1392. "http": {
  1393. "requestUri": "/tags/{arn}",
  1394. "responseCode": 200
  1395. },
  1396. "input": {
  1397. "type": "structure",
  1398. "required": [
  1399. "arn",
  1400. "tags"
  1401. ],
  1402. "members": {
  1403. "arn": {
  1404. "location": "uri",
  1405. "locationName": "arn"
  1406. },
  1407. "tags": {
  1408. "shape": "Sj"
  1409. }
  1410. }
  1411. },
  1412. "idempotent": true
  1413. },
  1414. "UntagResource": {
  1415. "http": {
  1416. "method": "DELETE",
  1417. "requestUri": "/tags/{arn}",
  1418. "responseCode": 200
  1419. },
  1420. "input": {
  1421. "type": "structure",
  1422. "required": [
  1423. "arn",
  1424. "tagKeys"
  1425. ],
  1426. "members": {
  1427. "arn": {
  1428. "location": "uri",
  1429. "locationName": "arn"
  1430. },
  1431. "tagKeys": {
  1432. "location": "querystring",
  1433. "locationName": "tagKeys",
  1434. "type": "list",
  1435. "member": {}
  1436. }
  1437. }
  1438. },
  1439. "idempotent": true
  1440. },
  1441. "UpdateCase": {
  1442. "http": {
  1443. "method": "PUT",
  1444. "requestUri": "/domains/{domainId}/cases/{caseId}",
  1445. "responseCode": 200
  1446. },
  1447. "input": {
  1448. "type": "structure",
  1449. "required": [
  1450. "caseId",
  1451. "domainId",
  1452. "fields"
  1453. ],
  1454. "members": {
  1455. "caseId": {
  1456. "location": "uri",
  1457. "locationName": "caseId"
  1458. },
  1459. "domainId": {
  1460. "location": "uri",
  1461. "locationName": "domainId"
  1462. },
  1463. "fields": {
  1464. "type": "list",
  1465. "member": {
  1466. "shape": "Sx"
  1467. }
  1468. },
  1469. "performedBy": {
  1470. "shape": "S12"
  1471. }
  1472. }
  1473. },
  1474. "output": {
  1475. "type": "structure",
  1476. "members": {}
  1477. }
  1478. },
  1479. "UpdateField": {
  1480. "http": {
  1481. "method": "PUT",
  1482. "requestUri": "/domains/{domainId}/fields/{fieldId}",
  1483. "responseCode": 200
  1484. },
  1485. "input": {
  1486. "type": "structure",
  1487. "required": [
  1488. "domainId",
  1489. "fieldId"
  1490. ],
  1491. "members": {
  1492. "description": {},
  1493. "domainId": {
  1494. "location": "uri",
  1495. "locationName": "domainId"
  1496. },
  1497. "fieldId": {
  1498. "location": "uri",
  1499. "locationName": "fieldId"
  1500. },
  1501. "name": {}
  1502. }
  1503. },
  1504. "output": {
  1505. "type": "structure",
  1506. "members": {}
  1507. },
  1508. "idempotent": true
  1509. },
  1510. "UpdateLayout": {
  1511. "http": {
  1512. "method": "PUT",
  1513. "requestUri": "/domains/{domainId}/layouts/{layoutId}",
  1514. "responseCode": 200
  1515. },
  1516. "input": {
  1517. "type": "structure",
  1518. "required": [
  1519. "domainId",
  1520. "layoutId"
  1521. ],
  1522. "members": {
  1523. "content": {
  1524. "shape": "S1g"
  1525. },
  1526. "domainId": {
  1527. "location": "uri",
  1528. "locationName": "domainId"
  1529. },
  1530. "layoutId": {
  1531. "location": "uri",
  1532. "locationName": "layoutId"
  1533. },
  1534. "name": {}
  1535. }
  1536. },
  1537. "output": {
  1538. "type": "structure",
  1539. "members": {}
  1540. },
  1541. "idempotent": true
  1542. },
  1543. "UpdateTemplate": {
  1544. "http": {
  1545. "method": "PUT",
  1546. "requestUri": "/domains/{domainId}/templates/{templateId}",
  1547. "responseCode": 200
  1548. },
  1549. "input": {
  1550. "type": "structure",
  1551. "required": [
  1552. "domainId",
  1553. "templateId"
  1554. ],
  1555. "members": {
  1556. "description": {},
  1557. "domainId": {
  1558. "location": "uri",
  1559. "locationName": "domainId"
  1560. },
  1561. "layoutConfiguration": {
  1562. "shape": "S28"
  1563. },
  1564. "name": {},
  1565. "requiredFields": {
  1566. "shape": "S2a"
  1567. },
  1568. "status": {},
  1569. "templateId": {
  1570. "location": "uri",
  1571. "locationName": "templateId"
  1572. }
  1573. }
  1574. },
  1575. "output": {
  1576. "type": "structure",
  1577. "members": {}
  1578. },
  1579. "idempotent": true
  1580. }
  1581. },
  1582. "shapes": {
  1583. "S4": {
  1584. "type": "structure",
  1585. "required": [
  1586. "id"
  1587. ],
  1588. "members": {
  1589. "id": {}
  1590. }
  1591. },
  1592. "Sc": {
  1593. "type": "timestamp",
  1594. "timestampFormat": "iso8601"
  1595. },
  1596. "Sg": {
  1597. "type": "timestamp",
  1598. "timestampFormat": "iso8601"
  1599. },
  1600. "Sj": {
  1601. "type": "map",
  1602. "key": {},
  1603. "value": {}
  1604. },
  1605. "Sn": {
  1606. "type": "structure",
  1607. "required": [
  1608. "active",
  1609. "name",
  1610. "value"
  1611. ],
  1612. "members": {
  1613. "active": {
  1614. "type": "boolean"
  1615. },
  1616. "name": {},
  1617. "value": {}
  1618. }
  1619. },
  1620. "Sx": {
  1621. "type": "structure",
  1622. "required": [
  1623. "id",
  1624. "value"
  1625. ],
  1626. "members": {
  1627. "id": {},
  1628. "value": {
  1629. "type": "structure",
  1630. "members": {
  1631. "booleanValue": {
  1632. "type": "boolean"
  1633. },
  1634. "doubleValue": {
  1635. "type": "double"
  1636. },
  1637. "emptyValue": {
  1638. "shape": "S10"
  1639. },
  1640. "stringValue": {},
  1641. "userArnValue": {}
  1642. },
  1643. "union": true
  1644. }
  1645. }
  1646. },
  1647. "S10": {
  1648. "type": "structure",
  1649. "members": {}
  1650. },
  1651. "S12": {
  1652. "type": "structure",
  1653. "members": {
  1654. "userArn": {}
  1655. },
  1656. "union": true
  1657. },
  1658. "S1g": {
  1659. "type": "structure",
  1660. "members": {
  1661. "basic": {
  1662. "type": "structure",
  1663. "members": {
  1664. "moreInfo": {
  1665. "shape": "S1i"
  1666. },
  1667. "topPanel": {
  1668. "shape": "S1i"
  1669. }
  1670. }
  1671. }
  1672. },
  1673. "union": true
  1674. },
  1675. "S1i": {
  1676. "type": "structure",
  1677. "members": {
  1678. "sections": {
  1679. "type": "list",
  1680. "member": {
  1681. "type": "structure",
  1682. "members": {
  1683. "fieldGroup": {
  1684. "type": "structure",
  1685. "required": [
  1686. "fields"
  1687. ],
  1688. "members": {
  1689. "fields": {
  1690. "type": "list",
  1691. "member": {
  1692. "type": "structure",
  1693. "required": [
  1694. "id"
  1695. ],
  1696. "members": {
  1697. "id": {}
  1698. }
  1699. }
  1700. },
  1701. "name": {}
  1702. }
  1703. }
  1704. },
  1705. "union": true
  1706. }
  1707. }
  1708. }
  1709. },
  1710. "S1v": {
  1711. "type": "structure",
  1712. "required": [
  1713. "body",
  1714. "contentType"
  1715. ],
  1716. "members": {
  1717. "body": {},
  1718. "contentType": {}
  1719. }
  1720. },
  1721. "S20": {
  1722. "type": "structure",
  1723. "required": [
  1724. "fileArn"
  1725. ],
  1726. "members": {
  1727. "fileArn": {}
  1728. }
  1729. },
  1730. "S28": {
  1731. "type": "structure",
  1732. "members": {
  1733. "defaultLayout": {}
  1734. }
  1735. },
  1736. "S2a": {
  1737. "type": "list",
  1738. "member": {
  1739. "type": "structure",
  1740. "required": [
  1741. "fieldId"
  1742. ],
  1743. "members": {
  1744. "fieldId": {}
  1745. }
  1746. }
  1747. },
  1748. "S31": {
  1749. "type": "structure",
  1750. "members": {
  1751. "booleanValue": {
  1752. "type": "boolean"
  1753. },
  1754. "doubleValue": {
  1755. "type": "double"
  1756. },
  1757. "emptyValue": {
  1758. "shape": "S10"
  1759. },
  1760. "stringValue": {},
  1761. "userArnValue": {}
  1762. },
  1763. "union": true
  1764. },
  1765. "S39": {
  1766. "type": "structure",
  1767. "required": [
  1768. "enabled"
  1769. ],
  1770. "members": {
  1771. "enabled": {
  1772. "type": "boolean"
  1773. },
  1774. "includedData": {
  1775. "type": "structure",
  1776. "members": {
  1777. "caseData": {
  1778. "type": "structure",
  1779. "required": [
  1780. "fields"
  1781. ],
  1782. "members": {
  1783. "fields": {
  1784. "type": "list",
  1785. "member": {
  1786. "shape": "S4"
  1787. }
  1788. }
  1789. }
  1790. },
  1791. "relatedItemData": {
  1792. "type": "structure",
  1793. "required": [
  1794. "includeContent"
  1795. ],
  1796. "members": {
  1797. "includeContent": {
  1798. "type": "boolean"
  1799. }
  1800. }
  1801. }
  1802. }
  1803. }
  1804. }
  1805. },
  1806. "S4k": {
  1807. "type": "structure",
  1808. "members": {
  1809. "andAll": {
  1810. "type": "list",
  1811. "member": {
  1812. "shape": "S4k"
  1813. }
  1814. },
  1815. "field": {
  1816. "type": "structure",
  1817. "members": {
  1818. "contains": {
  1819. "shape": "Sx"
  1820. },
  1821. "equalTo": {
  1822. "shape": "Sx"
  1823. },
  1824. "greaterThan": {
  1825. "shape": "Sx"
  1826. },
  1827. "greaterThanOrEqualTo": {
  1828. "shape": "Sx"
  1829. },
  1830. "lessThan": {
  1831. "shape": "Sx"
  1832. },
  1833. "lessThanOrEqualTo": {
  1834. "shape": "Sx"
  1835. }
  1836. },
  1837. "union": true
  1838. },
  1839. "not": {
  1840. "shape": "S4k"
  1841. },
  1842. "orAll": {
  1843. "type": "list",
  1844. "member": {
  1845. "shape": "S4k"
  1846. }
  1847. }
  1848. },
  1849. "union": true
  1850. }
  1851. }
  1852. }