Skip to content

Commit 1e9f715

Browse files
author
AWS
committed
Amazon Connect Cases Update: This release adds DeleteCase and DeleteRelatedItem APIs, which enable deleting cases and comments, undoing contact association, and removing service level agreements (SLAs) from cases. Contact center admins can use these APIs to delete cases when requested by customers and correct agent errors.
1 parent 064a6d7 commit 1e9f715

File tree

2 files changed

+105
-2
lines changed

2 files changed

+105
-2
lines changed

‎.changes/next-release/feature-AmazonConnectCases-4f5eed0.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Connect Cases",
4+
"contributor": "",
5+
"description": "This release adds DeleteCase and DeleteRelatedItem APIs, which enable deleting cases and comments, undoing contact association, and removing service level agreements (SLAs) from cases. Contact center admins can use these APIs to delete cases when requested by customers and correct agent errors."
6+
}

‎services/connectcases/src/main/resources/codegen-resources/service-2.json

Lines changed: 99 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
{"shape":"AccessDeniedException"},
8989
{"shape":"ConflictException"}
9090
],
91-
"documentation":"<note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>",
91+
"documentation":"<p><note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul></p>",
9292
"idempotent":true
9393
},
9494
"CreateCaseRule":{
@@ -214,6 +214,25 @@
214214
"documentation":"<p>Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.</p> <p> Other template APIs are: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html\">DeleteTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html\">GetTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html\">ListTemplates</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html\">UpdateTemplate</a> </p> </li> </ul>",
215215
"idempotent":true
216216
},
217+
"DeleteCase":{
218+
"name":"DeleteCase",
219+
"http":{
220+
"method":"DELETE",
221+
"requestUri":"/domains/{domainId}/cases/{caseId}",
222+
"responseCode":200
223+
},
224+
"input":{"shape":"DeleteCaseRequest"},
225+
"output":{"shape":"DeleteCaseResponse"},
226+
"errors":[
227+
{"shape":"InternalServerException"},
228+
{"shape":"ResourceNotFoundException"},
229+
{"shape":"ValidationException"},
230+
{"shape":"ThrottlingException"},
231+
{"shape":"AccessDeniedException"}
232+
],
233+
"documentation":"<p> The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:</p> <ul> <li> <p>Retrieve related items</p> </li> <li> <p>Access audit history</p> </li> <li> <p>Perform any operations that require the CaseID</p> </li> </ul> <important> <p>This action is irreversible. Once you delete a case, you cannot recover its data.</p> </important>",
234+
"idempotent":true
235+
},
217236
"DeleteCaseRule":{
218237
"name":"DeleteCaseRule",
219238
"http":{
@@ -294,6 +313,25 @@
294313
"documentation":"<p>Deletes a layout from a cases template. You can delete up to 100 layouts per domain.</p> <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>",
295314
"idempotent":true
296315
},
316+
"DeleteRelatedItem":{
317+
"name":"DeleteRelatedItem",
318+
"http":{
319+
"method":"DELETE",
320+
"requestUri":"/domains/{domainId}/cases/{caseId}/related-items/{relatedItemId}",
321+
"responseCode":200
322+
},
323+
"input":{"shape":"DeleteRelatedItemRequest"},
324+
"output":{"shape":"DeleteRelatedItemResponse"},
325+
"errors":[
326+
{"shape":"InternalServerException"},
327+
{"shape":"ResourceNotFoundException"},
328+
{"shape":"ValidationException"},
329+
{"shape":"ThrottlingException"},
330+
{"shape":"AccessDeniedException"}
331+
],
332+
"documentation":"<p>Deletes the related item resource under a case.</p> <note> <p>This API cannot be used on a FILE type related attachment. To delete this type of file, use the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html\">DeleteAttachedFile</a> API</p> </note>",
333+
"idempotent":true
334+
},
297335
"DeleteTemplate":{
298336
"name":"DeleteTemplate",
299337
"http":{
@@ -673,7 +711,7 @@
673711
{"shape":"ThrottlingException"},
674712
{"shape":"AccessDeniedException"}
675713
],
676-
"documentation":"<note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>"
714+
"documentation":"<p><note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p></p>"
677715
},
678716
"UpdateCaseRule":{
679717
"name":"UpdateCaseRule",
@@ -1750,6 +1788,32 @@
17501788
"pattern":"^[a-zA-Z0-9_\\-\\.@:/ ]*[a-zA-Z0-9_\\-\\.@:/]$",
17511789
"sensitive":true
17521790
},
1791+
"DeleteCaseRequest":{
1792+
"type":"structure",
1793+
"required":[
1794+
"caseId",
1795+
"domainId"
1796+
],
1797+
"members":{
1798+
"caseId":{
1799+
"shape":"CaseId",
1800+
"documentation":"<p>A unique identifier of the case.</p>",
1801+
"location":"uri",
1802+
"locationName":"caseId"
1803+
},
1804+
"domainId":{
1805+
"shape":"DomainId",
1806+
"documentation":"<p>A unique identifier of the Cases domain.</p>",
1807+
"location":"uri",
1808+
"locationName":"domainId"
1809+
}
1810+
}
1811+
},
1812+
"DeleteCaseResponse":{
1813+
"type":"structure",
1814+
"members":{
1815+
}
1816+
},
17531817
"DeleteCaseRuleRequest":{
17541818
"type":"structure",
17551819
"required":[
@@ -1845,6 +1909,39 @@
18451909
"members":{
18461910
}
18471911
},
1912+
"DeleteRelatedItemRequest":{
1913+
"type":"structure",
1914+
"required":[
1915+
"caseId",
1916+
"domainId",
1917+
"relatedItemId"
1918+
],
1919+
"members":{
1920+
"caseId":{
1921+
"shape":"CaseId",
1922+
"documentation":"<p>A unique identifier of the case.</p>",
1923+
"location":"uri",
1924+
"locationName":"caseId"
1925+
},
1926+
"domainId":{
1927+
"shape":"DomainId",
1928+
"documentation":"<p>A unique identifier of the Cases domain.</p>",
1929+
"location":"uri",
1930+
"locationName":"domainId"
1931+
},
1932+
"relatedItemId":{
1933+
"shape":"RelatedItemId",
1934+
"documentation":"<p>A unique identifier of a related item.</p>",
1935+
"location":"uri",
1936+
"locationName":"relatedItemId"
1937+
}
1938+
}
1939+
},
1940+
"DeleteRelatedItemResponse":{
1941+
"type":"structure",
1942+
"members":{
1943+
}
1944+
},
18481945
"DeleteTemplateRequest":{
18491946
"type":"structure",
18501947
"required":[

0 commit comments

Comments
 (0)