1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2022-10-03",
- "endpointPrefix": "cases",
- "jsonVersion": "1.1",
- "protocol": "rest-json",
- "serviceAbbreviation": "ConnectCases",
- "serviceFullName": "Amazon Connect Cases",
- "serviceId": "ConnectCases",
- "signatureVersion": "v4",
- "signingName": "cases",
- "uid": "connectcases-2022-10-03"
- },
- "operations": {
- "BatchGetField": {
- "http": {
- "requestUri": "/domains/{domainId}/fields-batch",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "fields"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fields": {
- "type": "list",
- "member": {
- "shape": "S4"
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "errors",
- "fields"
- ],
- "members": {
- "errors": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "errorCode",
- "id"
- ],
- "members": {
- "errorCode": {},
- "id": {},
- "message": {}
- }
- }
- },
- "fields": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "fieldArn",
- "fieldId",
- "name",
- "namespace",
- "type"
- ],
- "members": {
- "createdTime": {
- "shape": "Sc"
- },
- "deleted": {
- "type": "boolean"
- },
- "description": {},
- "fieldArn": {},
- "fieldId": {},
- "lastModifiedTime": {
- "shape": "Sg"
- },
- "name": {},
- "namespace": {},
- "tags": {
- "shape": "Sj"
- },
- "type": {}
- }
- }
- }
- }
- }
- },
- "BatchPutFieldOptions": {
- "http": {
- "method": "PUT",
- "requestUri": "/domains/{domainId}/fields/{fieldId}/options",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "fieldId",
- "options"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fieldId": {
- "location": "uri",
- "locationName": "fieldId"
- },
- "options": {
- "type": "list",
- "member": {
- "shape": "Sn"
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "errors": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "errorCode",
- "message",
- "value"
- ],
- "members": {
- "errorCode": {},
- "message": {},
- "value": {}
- }
- }
- }
- }
- },
- "idempotent": true
- },
- "CreateCase": {
- "http": {
- "requestUri": "/domains/{domainId}/cases",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "fields",
- "templateId"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fields": {
- "type": "list",
- "member": {
- "shape": "Sx"
- }
- },
- "performedBy": {
- "shape": "S12"
- },
- "templateId": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "caseArn",
- "caseId"
- ],
- "members": {
- "caseArn": {},
- "caseId": {}
- }
- },
- "idempotent": true
- },
- "CreateDomain": {
- "http": {
- "requestUri": "/domains",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "name"
- ],
- "members": {
- "name": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "domainArn",
- "domainId",
- "domainStatus"
- ],
- "members": {
- "domainArn": {},
- "domainId": {},
- "domainStatus": {}
- }
- },
- "idempotent": true
- },
- "CreateField": {
- "http": {
- "requestUri": "/domains/{domainId}/fields",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "name",
- "type"
- ],
- "members": {
- "description": {},
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "name": {},
- "type": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "fieldArn",
- "fieldId"
- ],
- "members": {
- "fieldArn": {},
- "fieldId": {}
- }
- },
- "idempotent": true
- },
- "CreateLayout": {
- "http": {
- "requestUri": "/domains/{domainId}/layouts",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "content",
- "domainId",
- "name"
- ],
- "members": {
- "content": {
- "shape": "S1g"
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "name": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "layoutArn",
- "layoutId"
- ],
- "members": {
- "layoutArn": {},
- "layoutId": {}
- }
- }
- },
- "CreateRelatedItem": {
- "http": {
- "requestUri": "/domains/{domainId}/cases/{caseId}/related-items/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "caseId",
- "content",
- "domainId",
- "type"
- ],
- "members": {
- "caseId": {
- "location": "uri",
- "locationName": "caseId"
- },
- "content": {
- "type": "structure",
- "members": {
- "comment": {
- "shape": "S1v"
- },
- "contact": {
- "type": "structure",
- "required": [
- "contactArn"
- ],
- "members": {
- "contactArn": {}
- }
- },
- "file": {
- "shape": "S20"
- }
- },
- "union": true
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "performedBy": {
- "shape": "S12"
- },
- "type": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "relatedItemArn",
- "relatedItemId"
- ],
- "members": {
- "relatedItemArn": {},
- "relatedItemId": {}
- }
- },
- "idempotent": true
- },
- "CreateTemplate": {
- "http": {
- "requestUri": "/domains/{domainId}/templates",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "name"
- ],
- "members": {
- "description": {},
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "layoutConfiguration": {
- "shape": "S28"
- },
- "name": {},
- "requiredFields": {
- "shape": "S2a"
- },
- "status": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "templateArn",
- "templateId"
- ],
- "members": {
- "templateArn": {},
- "templateId": {}
- }
- },
- "idempotent": true
- },
- "DeleteDomain": {
- "http": {
- "method": "DELETE",
- "requestUri": "/domains/{domainId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteField": {
- "http": {
- "method": "DELETE",
- "requestUri": "/domains/{domainId}/fields/{fieldId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "fieldId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fieldId": {
- "location": "uri",
- "locationName": "fieldId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteLayout": {
- "http": {
- "method": "DELETE",
- "requestUri": "/domains/{domainId}/layouts/{layoutId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "layoutId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "layoutId": {
- "location": "uri",
- "locationName": "layoutId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteTemplate": {
- "http": {
- "method": "DELETE",
- "requestUri": "/domains/{domainId}/templates/{templateId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "templateId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "templateId": {
- "location": "uri",
- "locationName": "templateId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "GetCase": {
- "http": {
- "requestUri": "/domains/{domainId}/cases/{caseId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "caseId",
- "domainId",
- "fields"
- ],
- "members": {
- "caseId": {
- "location": "uri",
- "locationName": "caseId"
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fields": {
- "type": "list",
- "member": {
- "shape": "S4"
- }
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "fields",
- "templateId"
- ],
- "members": {
- "fields": {
- "type": "list",
- "member": {
- "shape": "Sx"
- }
- },
- "nextToken": {},
- "tags": {
- "shape": "Sj"
- },
- "templateId": {}
- }
- }
- },
- "GetCaseAuditEvents": {
- "http": {
- "requestUri": "/domains/{domainId}/cases/{caseId}/audit-history",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "caseId",
- "domainId"
- ],
- "members": {
- "caseId": {
- "location": "uri",
- "locationName": "caseId"
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "auditEvents"
- ],
- "members": {
- "auditEvents": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "eventId",
- "fields",
- "performedTime",
- "type"
- ],
- "members": {
- "eventId": {},
- "fields": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "eventFieldId",
- "newValue"
- ],
- "members": {
- "eventFieldId": {},
- "newValue": {
- "shape": "S31"
- },
- "oldValue": {
- "shape": "S31"
- }
- }
- }
- },
- "performedBy": {
- "type": "structure",
- "required": [
- "iamPrincipalArn"
- ],
- "members": {
- "iamPrincipalArn": {},
- "user": {
- "shape": "S12"
- }
- }
- },
- "performedTime": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "relatedItemType": {},
- "type": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "GetCaseEventConfiguration": {
- "http": {
- "requestUri": "/domains/{domainId}/case-event-configuration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "eventBridge"
- ],
- "members": {
- "eventBridge": {
- "shape": "S39"
- }
- }
- }
- },
- "GetDomain": {
- "http": {
- "requestUri": "/domains/{domainId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "createdTime",
- "domainArn",
- "domainId",
- "domainStatus",
- "name"
- ],
- "members": {
- "createdTime": {
- "shape": "Sc"
- },
- "domainArn": {},
- "domainId": {},
- "domainStatus": {},
- "name": {},
- "tags": {
- "shape": "Sj"
- }
- }
- }
- },
- "GetLayout": {
- "http": {
- "requestUri": "/domains/{domainId}/layouts/{layoutId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "layoutId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "layoutId": {
- "location": "uri",
- "locationName": "layoutId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "content",
- "layoutArn",
- "layoutId",
- "name"
- ],
- "members": {
- "content": {
- "shape": "S1g"
- },
- "createdTime": {
- "shape": "Sc"
- },
- "deleted": {
- "type": "boolean"
- },
- "lastModifiedTime": {
- "shape": "Sg"
- },
- "layoutArn": {},
- "layoutId": {},
- "name": {},
- "tags": {
- "shape": "Sj"
- }
- }
- }
- },
- "GetTemplate": {
- "http": {
- "requestUri": "/domains/{domainId}/templates/{templateId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "templateId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "templateId": {
- "location": "uri",
- "locationName": "templateId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "name",
- "status",
- "templateArn",
- "templateId"
- ],
- "members": {
- "createdTime": {
- "shape": "Sc"
- },
- "deleted": {
- "type": "boolean"
- },
- "description": {},
- "lastModifiedTime": {
- "shape": "Sg"
- },
- "layoutConfiguration": {
- "shape": "S28"
- },
- "name": {},
- "requiredFields": {
- "shape": "S2a"
- },
- "status": {},
- "tags": {
- "shape": "Sj"
- },
- "templateArn": {},
- "templateId": {}
- }
- }
- },
- "ListCasesForContact": {
- "http": {
- "requestUri": "/domains/{domainId}/list-cases-for-contact",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "contactArn",
- "domainId"
- ],
- "members": {
- "contactArn": {},
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "cases"
- ],
- "members": {
- "cases": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "caseId",
- "templateId"
- ],
- "members": {
- "caseId": {},
- "templateId": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListDomains": {
- "http": {
- "requestUri": "/domains-list",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "domains"
- ],
- "members": {
- "domains": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "domainArn",
- "domainId",
- "name"
- ],
- "members": {
- "domainArn": {},
- "domainId": {},
- "name": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListFieldOptions": {
- "http": {
- "requestUri": "/domains/{domainId}/fields/{fieldId}/options-list",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "fieldId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fieldId": {
- "location": "uri",
- "locationName": "fieldId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "values": {
- "location": "querystring",
- "locationName": "values",
- "type": "list",
- "member": {}
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "options"
- ],
- "members": {
- "nextToken": {},
- "options": {
- "type": "list",
- "member": {
- "shape": "Sn"
- }
- }
- }
- }
- },
- "ListFields": {
- "http": {
- "requestUri": "/domains/{domainId}/fields-list",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "fields"
- ],
- "members": {
- "fields": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "fieldArn",
- "fieldId",
- "name",
- "namespace",
- "type"
- ],
- "members": {
- "fieldArn": {},
- "fieldId": {},
- "name": {},
- "namespace": {},
- "type": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListLayouts": {
- "http": {
- "requestUri": "/domains/{domainId}/layouts-list",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "layouts"
- ],
- "members": {
- "layouts": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "layoutArn",
- "layoutId",
- "name"
- ],
- "members": {
- "layoutArn": {},
- "layoutId": {},
- "name": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/tags/{arn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {
- "location": "uri",
- "locationName": "arn"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "tags": {
- "shape": "Sj"
- }
- }
- },
- "idempotent": true
- },
- "ListTemplates": {
- "http": {
- "requestUri": "/domains/{domainId}/templates-list",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "status": {
- "location": "querystring",
- "locationName": "status",
- "type": "list",
- "member": {}
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "templates"
- ],
- "members": {
- "nextToken": {},
- "templates": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "name",
- "status",
- "templateArn",
- "templateId"
- ],
- "members": {
- "name": {},
- "status": {},
- "templateArn": {},
- "templateId": {}
- }
- }
- }
- }
- }
- },
- "PutCaseEventConfiguration": {
- "http": {
- "method": "PUT",
- "requestUri": "/domains/{domainId}/case-event-configuration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "eventBridge"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "eventBridge": {
- "shape": "S39"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "SearchCases": {
- "http": {
- "requestUri": "/domains/{domainId}/cases-search",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId"
- ],
- "members": {
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fields": {
- "type": "list",
- "member": {
- "shape": "S4"
- }
- },
- "filter": {
- "shape": "S4k"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {},
- "searchTerm": {},
- "sorts": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "fieldId",
- "sortOrder"
- ],
- "members": {
- "fieldId": {},
- "sortOrder": {}
- }
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "cases"
- ],
- "members": {
- "cases": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "caseId",
- "fields",
- "templateId"
- ],
- "members": {
- "caseId": {},
- "fields": {
- "type": "list",
- "member": {
- "shape": "Sx"
- }
- },
- "tags": {
- "shape": "Sj"
- },
- "templateId": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "SearchRelatedItems": {
- "http": {
- "requestUri": "/domains/{domainId}/cases/{caseId}/related-items-search",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "caseId",
- "domainId"
- ],
- "members": {
- "caseId": {
- "location": "uri",
- "locationName": "caseId"
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "filters": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "comment": {
- "type": "structure",
- "members": {}
- },
- "contact": {
- "type": "structure",
- "members": {
- "channel": {
- "type": "list",
- "member": {}
- },
- "contactArn": {}
- }
- },
- "file": {
- "type": "structure",
- "members": {
- "fileArn": {}
- }
- }
- },
- "union": true
- }
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "relatedItems"
- ],
- "members": {
- "nextToken": {},
- "relatedItems": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "associationTime",
- "content",
- "relatedItemId",
- "type"
- ],
- "members": {
- "associationTime": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "content": {
- "type": "structure",
- "members": {
- "comment": {
- "shape": "S1v"
- },
- "contact": {
- "type": "structure",
- "required": [
- "channel",
- "connectedToSystemTime",
- "contactArn"
- ],
- "members": {
- "channel": {},
- "connectedToSystemTime": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "contactArn": {}
- }
- },
- "file": {
- "shape": "S20"
- }
- },
- "union": true
- },
- "performedBy": {
- "shape": "S12"
- },
- "relatedItemId": {},
- "tags": {
- "shape": "Sj"
- },
- "type": {}
- }
- }
- }
- }
- }
- },
- "TagResource": {
- "http": {
- "requestUri": "/tags/{arn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn",
- "tags"
- ],
- "members": {
- "arn": {
- "location": "uri",
- "locationName": "arn"
- },
- "tags": {
- "shape": "Sj"
- }
- }
- },
- "idempotent": true
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/tags/{arn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn",
- "tagKeys"
- ],
- "members": {
- "arn": {
- "location": "uri",
- "locationName": "arn"
- },
- "tagKeys": {
- "location": "querystring",
- "locationName": "tagKeys",
- "type": "list",
- "member": {}
- }
- }
- },
- "idempotent": true
- },
- "UpdateCase": {
- "http": {
- "method": "PUT",
- "requestUri": "/domains/{domainId}/cases/{caseId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "caseId",
- "domainId",
- "fields"
- ],
- "members": {
- "caseId": {
- "location": "uri",
- "locationName": "caseId"
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fields": {
- "type": "list",
- "member": {
- "shape": "Sx"
- }
- },
- "performedBy": {
- "shape": "S12"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "UpdateField": {
- "http": {
- "method": "PUT",
- "requestUri": "/domains/{domainId}/fields/{fieldId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "fieldId"
- ],
- "members": {
- "description": {},
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "fieldId": {
- "location": "uri",
- "locationName": "fieldId"
- },
- "name": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateLayout": {
- "http": {
- "method": "PUT",
- "requestUri": "/domains/{domainId}/layouts/{layoutId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "layoutId"
- ],
- "members": {
- "content": {
- "shape": "S1g"
- },
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "layoutId": {
- "location": "uri",
- "locationName": "layoutId"
- },
- "name": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateTemplate": {
- "http": {
- "method": "PUT",
- "requestUri": "/domains/{domainId}/templates/{templateId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "domainId",
- "templateId"
- ],
- "members": {
- "description": {},
- "domainId": {
- "location": "uri",
- "locationName": "domainId"
- },
- "layoutConfiguration": {
- "shape": "S28"
- },
- "name": {},
- "requiredFields": {
- "shape": "S2a"
- },
- "status": {},
- "templateId": {
- "location": "uri",
- "locationName": "templateId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- }
- },
- "shapes": {
- "S4": {
- "type": "structure",
- "required": [
- "id"
- ],
- "members": {
- "id": {}
- }
- },
- "Sc": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "Sg": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "Sj": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "Sn": {
- "type": "structure",
- "required": [
- "active",
- "name",
- "value"
- ],
- "members": {
- "active": {
- "type": "boolean"
- },
- "name": {},
- "value": {}
- }
- },
- "Sx": {
- "type": "structure",
- "required": [
- "id",
- "value"
- ],
- "members": {
- "id": {},
- "value": {
- "type": "structure",
- "members": {
- "booleanValue": {
- "type": "boolean"
- },
- "doubleValue": {
- "type": "double"
- },
- "emptyValue": {
- "shape": "S10"
- },
- "stringValue": {},
- "userArnValue": {}
- },
- "union": true
- }
- }
- },
- "S10": {
- "type": "structure",
- "members": {}
- },
- "S12": {
- "type": "structure",
- "members": {
- "userArn": {}
- },
- "union": true
- },
- "S1g": {
- "type": "structure",
- "members": {
- "basic": {
- "type": "structure",
- "members": {
- "moreInfo": {
- "shape": "S1i"
- },
- "topPanel": {
- "shape": "S1i"
- }
- }
- }
- },
- "union": true
- },
- "S1i": {
- "type": "structure",
- "members": {
- "sections": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "fieldGroup": {
- "type": "structure",
- "required": [
- "fields"
- ],
- "members": {
- "fields": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "id"
- ],
- "members": {
- "id": {}
- }
- }
- },
- "name": {}
- }
- }
- },
- "union": true
- }
- }
- }
- },
- "S1v": {
- "type": "structure",
- "required": [
- "body",
- "contentType"
- ],
- "members": {
- "body": {},
- "contentType": {}
- }
- },
- "S20": {
- "type": "structure",
- "required": [
- "fileArn"
- ],
- "members": {
- "fileArn": {}
- }
- },
- "S28": {
- "type": "structure",
- "members": {
- "defaultLayout": {}
- }
- },
- "S2a": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "fieldId"
- ],
- "members": {
- "fieldId": {}
- }
- }
- },
- "S31": {
- "type": "structure",
- "members": {
- "booleanValue": {
- "type": "boolean"
- },
- "doubleValue": {
- "type": "double"
- },
- "emptyValue": {
- "shape": "S10"
- },
- "stringValue": {},
- "userArnValue": {}
- },
- "union": true
- },
- "S39": {
- "type": "structure",
- "required": [
- "enabled"
- ],
- "members": {
- "enabled": {
- "type": "boolean"
- },
- "includedData": {
- "type": "structure",
- "members": {
- "caseData": {
- "type": "structure",
- "required": [
- "fields"
- ],
- "members": {
- "fields": {
- "type": "list",
- "member": {
- "shape": "S4"
- }
- }
- }
- },
- "relatedItemData": {
- "type": "structure",
- "required": [
- "includeContent"
- ],
- "members": {
- "includeContent": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "S4k": {
- "type": "structure",
- "members": {
- "andAll": {
- "type": "list",
- "member": {
- "shape": "S4k"
- }
- },
- "field": {
- "type": "structure",
- "members": {
- "contains": {
- "shape": "Sx"
- },
- "equalTo": {
- "shape": "Sx"
- },
- "greaterThan": {
- "shape": "Sx"
- },
- "greaterThanOrEqualTo": {
- "shape": "Sx"
- },
- "lessThan": {
- "shape": "Sx"
- },
- "lessThanOrEqualTo": {
- "shape": "Sx"
- }
- },
- "union": true
- },
- "not": {
- "shape": "S4k"
- },
- "orAll": {
- "type": "list",
- "member": {
- "shape": "S4k"
- }
- }
- },
- "union": true
- }
- }
- }
|