Merge pull request #335 from umccr/feature/update-to-bclconvert-manager

merged as this is just for docs
umccr · May 30, 2024 · 52b2041 · 52b2041
2 parents b0337b4 + 50247c8
commit 52b2041
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/lib/workload/stateful/stacks/bclconvert-dynamo-db/README.md b/lib/workload/stateful/stacks/bclconvert-dynamo-db/README.md
@@ -1,6 +1,6 @@
 # BclConvert Manager DynamoDB Tables
 
-### ICAv2 Event Translator DynamoDB Table
+## BclConvert Manager Translator Table
 
 This table will record event translator process in BclConvert Manager.
 

diff --git a/lib/workload/stateless/stacks/bclconvert-manager/README.md b/lib/workload/stateless/stacks/bclconvert-manager/README.md
@@ -77,6 +77,32 @@ This event is icav2 event without EventBus pipe envelop. General Event Bridge ev
 
 The AWS lambda functions put translated event following ```WorkflowRunStateChange``` schema with the following event detail::
 
+(Non-SUCCEEDED Event without payload)
+
+```json5
+{
+ "version": "0",
+ "id": "f71aaaaa-5b36-40c2-f7dc-804ca6270cd6",
+ "detail-type": "WorkflowRunStateChange",
+ "source": "orcabus.bclconvertmanager",
+ "account": "123456789012",
+ "time": "2024-05-01T09:25:44Z",
+ "region": "ap-southeast-2",
+ "resources": [],
+ "detail": {
+ "portalRunId": '20xxxxxxxxxx',
+ "executionId": "valid_payload_id",
+ "timestamp": "2024-00-25T00:07:00Z",
+ "status": "INPROGRESS"
+ "workflowName": "BclConvert",
+ "workflowVersion": "4.2.7",
+ "workflowRunName": "123456_A1234_0000_TestingPattern",
+ }
+}
+```
+
+(SUCCEEDED Event)
+
 ```json5
 {
  "version": "0",