AWS connect documentation change

Service: connect · 2025-05-01 · Documentation low

File: connect/latest/adminguide/case-event-streams-sample.md

Summary

Added example payload for custom entity case events and removed commented enum values from eventType fields

Security assessment

The changes add documentation for custom entity actions in event payloads and clean up formatting. While the 'performedBy' section now shows IAM principal ARN structure, this is standard configuration documentation rather than addressing a security vulnerability or introducing new security features. No evidence of patching vulnerabilities or security incidents mentioned.

Diff

diff --git a/connect/latest/adminguide/case-event-streams-sample.md b/connect/latest/adminguide/case-event-streams-sample.md
index ff5a55074..0778da3cd 100644
--- a//connect/latest/adminguide/case-event-streams-sample.md
+++ b//connect/latest/adminguide/case-event-streams-sample.md
@@ -5 +5 @@
-Example case event payload for the case resourceExample case event payload for the related-item resource
+Example case event payload for the case resourceExample case event payload for the related-item resourceExample case event payload for the case resource performed by custom entity
@@ -32 +32 @@ Amazon Connect Cases default limits guarantee that the payload will be less than
-            "eventType": "CASE.UPDATED", //(or "CASE.CREATED" or "CASE.DELETED")
+            "eventType": "CASE.UPDATED",
@@ -92 +92 @@ Amazon Connect Cases default limits guarantee that the payload will be less than
-            "eventType": "RELATED_ITEM.CREATED", //(or "RELATED_ITEM.UPDATED" or "CASE.RELATED_ITEM.DELETED")
+            "eventType": "RELATED_ITEM.CREATED",
@@ -102 +102 @@ Amazon Connect Cases default limits guarantee that the payload will be less than
-                "relatedItemType": "Comment", // (OR Contact)
+                "relatedItemType": "Comment",
@@ -120,0 +121,59 @@ Amazon Connect Cases default limits guarantee that the payload will be less than
+## Example case event payload for the case resource performed by custom entity
+    
+    
+    // Given the limits on the "includedData" configuration
+    // this payload is guaranteed to less than 256KB at launch.
+    {
+        "version": "0",
+        "id": "event ID",
+        "detail-type": "Amazon Connect Cases Change",
+        "source": "aws.cases",
+        "account": "your AWS account ID",
+        "time": "2022-03-16T23:43:26Z",
+        "region": "The AWS Region of your Amazon Connect instance",
+        "resources": [
+            "arn:aws:cases:your Amazon Connect AWS Region:your AWS account ID:domain/case domain ID",
+            "arn:aws:cases:your Amazon Connect AWS Region:your AWS account ID:domain/case domain ID/case/case ID"
+        ],
+        "detail": {
+            "version": "0",
+            "eventType": "CASE.UPDATED",
+            "approximateChangeTime": "2022-03-16T23:16:57.893Z",  // Can be used for ordering
+            "changedFieldIds": ["status", "last_updated_datetime"],
+            "performedBy": {
+                "user": {
+                    "customEntity": "your custom entity"        
+                },
+                "iamPrincipalArn": "arn:aws:iam::your Amazon Connect AWS Region:role/role name"
+            },       
+            "case": {
+                "caseId": "case ID",
+                "templateId": "template ID",
+                "createdDateTime": "2022-03-16T23:16:57.893Z",
+                
+                // This section contains only non-null field values for the 
+                // fields that customers have configured in the "includedData".
+               
+                // Field values included in this section reflects the case
+                // after this particular change is applied.
+                "fields": {
+                    "status": {
+                        "value": {
+                            "stringValue": "open"
+                       }
+                    },
+                    "case_reason": {
+                        "value": {
+                            "stringValue": "Shipment lost"
+                        }
+                    },
+                    "custom-field-uuid-1": {
+                        "value": {
+                            "stringValue": "Customer didn't receive the product"
+                        }
+                    }
+                }
+            }
+        }
+    }                
+