Skip to content

Commit a9f6248

Browse files
author
AWS
committed
Amazon Connect Cases Update: This release adds the ability to view audit history on a case and introduces a new parameter, performedBy, for CreateCase and UpdateCase API's.
1 parent 152139b commit a9f6248

File tree

3 files changed

+226
-5
lines changed

3 files changed

+226
-5
lines changed

‎.changes/next-release/feature-AmazonConnectCases-326b50a.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 the ability to view audit history on a case and introduces a new parameter, performedBy, for CreateCase and UpdateCase API's."
6+
}

‎services/connectcases/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
"input_token": "nextToken",
55
"output_token": "nextToken"
66
},
7+
"GetCaseAuditEvents": {
8+
"input_token": "nextToken",
9+
"output_token": "nextToken",
10+
"limit_key": "maxResults"
11+
},
712
"ListCasesForContact": {
813
"input_token": "nextToken",
914
"output_token": "nextToken",

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

Lines changed: 215 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
{"shape":"AccessDeniedException"},
6969
{"shape":"ConflictException"}
7070
],
71-
"documentation":"<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> <pre><code> &lt;ul&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;customer_id&lt;/code&gt; - You must provide the full customer profile ARN in this format: &lt;code&gt;arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;title&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;/ul&gt; </code></pre>",
71+
"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> <pre><code> &lt;p&gt;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.&lt;/p&gt; &lt;p&gt;The following fields are required when creating a case:&lt;/p&gt; &lt;ul&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;customer_id&lt;/code&gt; - You must provide the full customer profile ARN in this format: &lt;code&gt;arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt; &lt;code&gt;title&lt;/code&gt; &lt;/p&gt; &lt;/li&gt; &lt;/ul&gt; </code></pre>",
7272
"idempotent":true
7373
},
7474
"CreateDomain":{
@@ -211,6 +211,24 @@
211211
],
212212
"documentation":"<p>Returns information about a specific case if it exists. </p>"
213213
},
214+
"GetCaseAuditEvents":{
215+
"name":"GetCaseAuditEvents",
216+
"http":{
217+
"method":"POST",
218+
"requestUri":"/domains/{domainId}/cases/{caseId}/audit-history",
219+
"responseCode":200
220+
},
221+
"input":{"shape":"GetCaseAuditEventsRequest"},
222+
"output":{"shape":"GetCaseAuditEventsResponse"},
223+
"errors":[
224+
{"shape":"InternalServerException"},
225+
{"shape":"ResourceNotFoundException"},
226+
{"shape":"ValidationException"},
227+
{"shape":"ThrottlingException"},
228+
{"shape":"AccessDeniedException"}
229+
],
230+
"documentation":"<p>Returns the audit history about a specific case if it exists.</p>"
231+
},
214232
"GetCaseEventConfiguration":{
215233
"name":"GetCaseEventConfiguration",
216234
"http":{
@@ -515,7 +533,7 @@
515533
{"shape":"ThrottlingException"},
516534
{"shape":"AccessDeniedException"}
517535
],
518-
"documentation":"<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>"
536+
"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> <pre><code> &lt;p&gt;Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the &lt;code&gt;CreateCase&lt;/code&gt; input .&lt;/p&gt; &lt;p&gt;If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.&lt;/p&gt; </code></pre>"
519537
},
520538
"UpdateField":{
521539
"name":"UpdateField",
@@ -602,6 +620,131 @@
602620
"type":"timestamp",
603621
"timestampFormat":"iso8601"
604622
},
623+
"AuditEvent":{
624+
"type":"structure",
625+
"required":[
626+
"eventId",
627+
"fields",
628+
"performedTime",
629+
"type"
630+
],
631+
"members":{
632+
"eventId":{
633+
"shape":"AuditEventId",
634+
"documentation":"<p>Unique identifier of a case audit history event.</p>"
635+
},
636+
"fields":{
637+
"shape":"AuditEventFieldList",
638+
"documentation":"<p>A list of Case Audit History event fields.</p>"
639+
},
640+
"performedBy":{
641+
"shape":"AuditEventPerformedBy",
642+
"documentation":"<p>Information of the user which performed the audit.</p>"
643+
},
644+
"performedTime":{
645+
"shape":"AuditEventDateTime",
646+
"documentation":"<p>Time at which an Audit History event took place.</p>"
647+
},
648+
"relatedItemType":{
649+
"shape":"RelatedItemType",
650+
"documentation":"<p>The Type of the related item.</p>"
651+
},
652+
"type":{
653+
"shape":"AuditEventType",
654+
"documentation":"<p>The Type of an audit history event.</p>"
655+
}
656+
},
657+
"documentation":"<p>Represents the content of a particular audit event.</p>"
658+
},
659+
"AuditEventDateTime":{
660+
"type":"timestamp",
661+
"timestampFormat":"iso8601"
662+
},
663+
"AuditEventField":{
664+
"type":"structure",
665+
"required":[
666+
"eventFieldId",
667+
"newValue"
668+
],
669+
"members":{
670+
"eventFieldId":{
671+
"shape":"AuditEventFieldId",
672+
"documentation":"<p>Unique identifier of field in an Audit History entry.</p>"
673+
},
674+
"newValue":{
675+
"shape":"AuditEventFieldValueUnion",
676+
"documentation":"<p>Union of potential field value types.</p>"
677+
},
678+
"oldValue":{
679+
"shape":"AuditEventFieldValueUnion",
680+
"documentation":"<p>Union of potential field value types.</p>"
681+
}
682+
},
683+
"documentation":"<p>Fields for audit event.</p>"
684+
},
685+
"AuditEventFieldId":{
686+
"type":"string",
687+
"max":500,
688+
"min":1
689+
},
690+
"AuditEventFieldList":{
691+
"type":"list",
692+
"member":{"shape":"AuditEventField"}
693+
},
694+
"AuditEventFieldValueUnion":{
695+
"type":"structure",
696+
"members":{
697+
"booleanValue":{
698+
"shape":"Boolean",
699+
"documentation":"<p>Can be either null, or have a Boolean value type. Only one value can be provided.</p>"
700+
},
701+
"doubleValue":{
702+
"shape":"Double",
703+
"documentation":"<p>Can be either null, or have a Double value type. Only one value can be provided.</p>"
704+
},
705+
"emptyValue":{"shape":"EmptyFieldValue"},
706+
"stringValue":{
707+
"shape":"AuditEventFieldValueUnionStringValueString",
708+
"documentation":"<p>Can be either null, or have a String value type. Only one value can be provided.</p>"
709+
},
710+
"userArnValue":{
711+
"shape":"String",
712+
"documentation":"<p>Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.</p>"
713+
}
714+
},
715+
"documentation":"<p>Object to store union of Field values.</p> <important> <p>This data type is a UNION, so only one of the following members can be specified when used or returned.</p> </important>",
716+
"union":true
717+
},
718+
"AuditEventFieldValueUnionStringValueString":{
719+
"type":"string",
720+
"max":500,
721+
"min":0
722+
},
723+
"AuditEventId":{
724+
"type":"string",
725+
"max":500,
726+
"min":1
727+
},
728+
"AuditEventPerformedBy":{
729+
"type":"structure",
730+
"required":["iamPrincipalArn"],
731+
"members":{
732+
"iamPrincipalArn":{
733+
"shape":"IamPrincipalArn",
734+
"documentation":"<p>Unique identifier of an IAM role.</p>"
735+
},
736+
"user":{"shape":"UserUnion"}
737+
},
738+
"documentation":"<p>Information of the user which performed the audit.</p>"
739+
},
740+
"AuditEventType":{
741+
"type":"string",
742+
"enum":[
743+
"Case.Created",
744+
"Case.Updated",
745+
"RelatedItem.Created"
746+
]
747+
},
605748
"BasicLayout":{
606749
"type":"structure",
607750
"members":{
@@ -935,6 +1078,7 @@
9351078
"shape":"CreateCaseRequestFieldsList",
9361079
"documentation":"<p>An array of objects with field ID (matching ListFields/DescribeField) and value union data.</p>"
9371080
},
1081+
"performedBy":{"shape":"UserUnion"},
9381082
"templateId":{
9391083
"shape":"TemplateId",
9401084
"documentation":"<p>A unique identifier of a template.</p>"
@@ -1534,7 +1678,8 @@
15341678
"Boolean",
15351679
"DateTime",
15361680
"SingleSelect",
1537-
"Url"
1681+
"Url",
1682+
"User"
15381683
]
15391684
},
15401685
"FieldValue":{
@@ -1573,16 +1718,75 @@
15731718
"stringValue":{
15741719
"shape":"FieldValueUnionStringValueString",
15751720
"documentation":"<p>String value type.</p>"
1721+
},
1722+
"userArnValue":{
1723+
"shape":"String",
1724+
"documentation":"<p>Represents the user that performed the audit.</p>"
15761725
}
15771726
},
1578-
"documentation":"<p>Object to store union of Field values.</p>",
1727+
"documentation":"<p>Object to store union of Field values.</p> <note> <p>The <code>Summary</code> system field accepts 1500 characters while all other fields accept 500 characters.</p> </note>",
15791728
"union":true
15801729
},
15811730
"FieldValueUnionStringValueString":{
15821731
"type":"string",
15831732
"max":1500,
15841733
"min":0
15851734
},
1735+
"GetCaseAuditEventsRequest":{
1736+
"type":"structure",
1737+
"required":[
1738+
"caseId",
1739+
"domainId"
1740+
],
1741+
"members":{
1742+
"caseId":{
1743+
"shape":"CaseId",
1744+
"documentation":"<p>A unique identifier of the case.</p>",
1745+
"location":"uri",
1746+
"locationName":"caseId"
1747+
},
1748+
"domainId":{
1749+
"shape":"DomainId",
1750+
"documentation":"<p>The unique identifier of the Cases domain.</p>",
1751+
"location":"uri",
1752+
"locationName":"domainId"
1753+
},
1754+
"maxResults":{
1755+
"shape":"GetCaseAuditEventsRequestMaxResultsInteger",
1756+
"documentation":"<p>The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.</p>"
1757+
},
1758+
"nextToken":{
1759+
"shape":"NextToken",
1760+
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"
1761+
}
1762+
}
1763+
},
1764+
"GetCaseAuditEventsRequestMaxResultsInteger":{
1765+
"type":"integer",
1766+
"box":true,
1767+
"max":25,
1768+
"min":1
1769+
},
1770+
"GetCaseAuditEventsResponse":{
1771+
"type":"structure",
1772+
"required":["auditEvents"],
1773+
"members":{
1774+
"auditEvents":{
1775+
"shape":"GetCaseAuditEventsResponseAuditEventsList",
1776+
"documentation":"<p>A list of case audits where each represents a particular edit of the case.</p>"
1777+
},
1778+
"nextToken":{
1779+
"shape":"NextToken",
1780+
"documentation":"<p>The token for the next set of results. This is null if there are no more results to return.</p>"
1781+
}
1782+
}
1783+
},
1784+
"GetCaseAuditEventsResponseAuditEventsList":{
1785+
"type":"list",
1786+
"member":{"shape":"AuditEvent"},
1787+
"max":25,
1788+
"min":0
1789+
},
15861790
"GetCaseEventConfigurationRequest":{
15871791
"type":"structure",
15881792
"required":["domainId"],
@@ -1877,6 +2081,11 @@
18772081
}
18782082
}
18792083
},
2084+
"IamPrincipalArn":{
2085+
"type":"string",
2086+
"max":500,
2087+
"min":1
2088+
},
18802089
"Integer":{
18812090
"type":"integer",
18822091
"box":true
@@ -2842,7 +3051,8 @@
28423051
"fields":{
28433052
"shape":"UpdateCaseRequestFieldsList",
28443053
"documentation":"<p>An array of objects with <code>fieldId</code> (matching ListFields/DescribeField) and value union data, structured identical to <code>CreateCase</code>.</p>"
2845-
}
3054+
},
3055+
"performedBy":{"shape":"UserUnion"}
28463056
}
28473057
},
28483058
"UpdateCaseRequestFieldsList":{

0 commit comments

Comments
 (0)