AWS omics documentation change
Summary
Added new 'CREATING' status to batch workflow lifecycle, updated status progression from CREATING → PENDING → SUBMITTING → INPROGRESS → PROCESSED, and updated event names from 'Batch Status Change' to 'RunBatch Status Change'
Security assessment
This change documents an additional status state in a workflow lifecycle and updates event naming conventions. There is no evidence of security vulnerability fixes, security incident response, or security feature additions. The changes appear to be routine documentation updates for workflow state management.
Diff
diff --git a/omics/latest/dev/workflows-batch.md b/omics/latest/dev/workflows-batch.md index 64d579265..099e8a847 100644 --- a//omics/latest/dev/workflows-batch.md +++ b//omics/latest/dev/workflows-batch.md @@ -68,0 +69,2 @@ With batch runs, you can: + * `CREATING` — Batch is being created. + @@ -281 +283 @@ The response returns a batch ID you use for all subsequent operations: - "status": "PENDING" + "status": "CREATING" @@ -289 +291 @@ The response returns a batch ID you use for all subsequent operations: -Watch the `status` field progress from `PENDING` → `SUBMITTING` → `INPROGRESS` → `PROCESSED`. The `submissionSummary` shows how many runs were submitted successfully, and `runSummary` shows execution progress. +Watch the `status` field progress from `CREATING` → `PENDING` → `SUBMITTING` → `INPROGRESS` → `PROCESSED`. The `submissionSummary` shows how many runs were submitted successfully, and `runSummary` shows execution progress. @@ -480 +482 @@ A successful request returns a batch ID and initial status: - "status": "PENDING", + "status": "CREATING", @@ -547 +549 @@ Batch-level tags (on the **StartRunBatch** request) are applied only to the batc -**StartRunBatch** validates common fields synchronously and returns immediately with a batch ID and status `PENDING`. Runs in a batch are submitted gradually and asynchronously at a controlled rate according to your throughput quotas. +**StartRunBatch** validates common fields synchronously and returns immediately with a batch ID and status `CREATING`. Runs in a batch are submitted gradually and asynchronously at a controlled rate according to your throughput quotas. @@ -553 +555,3 @@ The batch transitions through the following states during normal processing: - 1. `PENDING` — Batch created, run configurations being validated. + 1. `CREATING` — Batch is being created. + + 2. `PENDING` — Batch created, run configurations being validated. @@ -555 +559 @@ The batch transitions through the following states during normal processing: - 2. `SUBMITTING` — Validation complete, individual runs being submitted. + 3. `SUBMITTING` — Validation complete, individual runs being submitted. @@ -557 +561 @@ The batch transitions through the following states during normal processing: - 3. `INPROGRESS` — All run submissions attempted, runs are executing. + 4. `INPROGRESS` — All run submissions attempted, runs are executing. @@ -559 +563 @@ The batch transitions through the following states during normal processing: - 4. `PROCESSED` — All runs have reached a terminal state. + 5. `PROCESSED` — All runs have reached a terminal state. @@ -836 +840 @@ Event name | Emitted when -Batch Status Change | The batch transitions to a new status (`PENDING`, `SUBMITTING`, `INPROGRESS`, `STOPPING`, `CANCELLED`, `PROCESSED`, `FAILED`, `RUNS_DELETING`, `RUNS_DELETED`) +RunBatch Status Change | The batch transitions to a new status (`CREATING`, `PENDING`, `SUBMITTING`, `INPROGRESS`, `STOPPING`, `CANCELLED`, `PROCESSED`, `FAILED`, `RUNS_DELETING`, `RUNS_DELETED`) @@ -879 +883 @@ Field | Type | Description - "detail-type": "Batch Status Change", + "detail-type": "RunBatch Status Change", @@ -911 +915 @@ Field | Type | Description - "detail-type": "Batch Status Change", + "detail-type": "RunBatch Status Change", @@ -936 +940 @@ The following event pattern matches when any batch reaches a terminal state: - "detail-type": ["Batch Status Change"], + "detail-type": ["RunBatch Status Change"],