Type Alias BatchExecutionEvents<TOutput>

Event types emitted by BatchExecution during its lifecycle.

type BatchExecutionEvents<TOutput> = {
    error: BatchExecutionFailedError;
    poll: WithRequestId<BatchResponse>;
    statusChange: [BatchExecutionStatus, WithRequestId<BatchResponse>];
    success: BatchExecutionResult<TOutput>;
}

Properties

Emitted when batch fails with the error object.

poll: WithRequestId<BatchResponse>

Emitted during polling with current status and progress. Includes requestId from the polling request.

statusChange: [BatchExecutionStatus, WithRequestId<BatchResponse>]

Emitted when batch status transitions to a new state, includes new status and response.

Emitted when batch completes successfully with the result object. Includes requestId from the final request.