Skip to main content

Command

Interfaces​

Type Aliases​

$Shape​

$Shape = object & { attributes?: undefined; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "scheduleActivityTaskCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes: $Shape; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "startTimerCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes: $Shape; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "completeWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes: $Shape; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "failWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes: $Shape; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "requestCancelActivityTaskCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes: $Shape; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "cancelTimerCommandAttributes"; cancelTimerCommandAttributes: $Shape; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "cancelWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes: $Shape; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "requestCancelExternalWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes: $Shape; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "recordMarkerCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes: $Shape; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "continueAsNewWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes: $Shape; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "startChildWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes: $Shape; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "signalExternalWorkflowExecutionCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes: $Shape; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "upsertWorkflowSearchAttributesCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes: $Shape; } | { attributes?: "protocolMessageCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes: $Shape; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "modifyWorkflowPropertiesCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes: $Shape; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "scheduleNexusOperationCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes?: null; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes: $Shape; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; } | { attributes?: "requestCancelNexusOperationCommandAttributes"; cancelTimerCommandAttributes?: null; cancelWorkflowExecutionCommandAttributes?: null; completeWorkflowExecutionCommandAttributes?: null; continueAsNewWorkflowExecutionCommandAttributes?: null; failWorkflowExecutionCommandAttributes?: null; modifyWorkflowPropertiesCommandAttributes?: null; protocolMessageCommandAttributes?: null; recordMarkerCommandAttributes?: null; requestCancelActivityTaskCommandAttributes?: null; requestCancelExternalWorkflowExecutionCommandAttributes?: null; requestCancelNexusOperationCommandAttributes: $Shape; scheduleActivityTaskCommandAttributes?: null; scheduleNexusOperationCommandAttributes?: null; signalExternalWorkflowExecutionCommandAttributes?: null; startChildWorkflowExecutionCommandAttributes?: null; startTimerCommandAttributes?: null; upsertWorkflowSearchAttributesCommandAttributes?: null; }

Narrowed shape of a Command.

Type Declaration​

cancelTimerCommandAttributes?​

optional cancelTimerCommandAttributes?: $Shape | null

cancelWorkflowExecutionCommandAttributes?​

optional cancelWorkflowExecutionCommandAttributes?: $Shape | null

commandType?​

optional commandType?: CommandType | null

completeWorkflowExecutionCommandAttributes?​

optional completeWorkflowExecutionCommandAttributes?: $Shape | null

continueAsNewWorkflowExecutionCommandAttributes?​

optional continueAsNewWorkflowExecutionCommandAttributes?: $Shape | null

eventGroupMarkers?​

optional eventGroupMarkers?: $Shape[] | null

failWorkflowExecutionCommandAttributes?​

optional failWorkflowExecutionCommandAttributes?: $Shape | null

modifyWorkflowPropertiesCommandAttributes?​

optional modifyWorkflowPropertiesCommandAttributes?: $Shape | null

protocolMessageCommandAttributes?​

optional protocolMessageCommandAttributes?: $Shape | null

recordMarkerCommandAttributes?​

optional recordMarkerCommandAttributes?: $Shape | null

requestCancelActivityTaskCommandAttributes?​

optional requestCancelActivityTaskCommandAttributes?: $Shape | null

requestCancelExternalWorkflowExecutionCommandAttributes?​

optional requestCancelExternalWorkflowExecutionCommandAttributes?: $Shape | null

requestCancelNexusOperationCommandAttributes?​

optional requestCancelNexusOperationCommandAttributes?: $Shape | null

scheduleActivityTaskCommandAttributes?​

optional scheduleActivityTaskCommandAttributes?: $Shape | null

scheduleNexusOperationCommandAttributes?​

optional scheduleNexusOperationCommandAttributes?: $Shape | null

signalExternalWorkflowExecutionCommandAttributes?​

optional signalExternalWorkflowExecutionCommandAttributes?: $Shape | null

startChildWorkflowExecutionCommandAttributes?​

optional startChildWorkflowExecutionCommandAttributes?: $Shape | null

startTimerCommandAttributes?​

optional startTimerCommandAttributes?: $Shape | null

upsertWorkflowSearchAttributesCommandAttributes?​

optional upsertWorkflowSearchAttributesCommandAttributes?: $Shape | null

userMetadata?​

optional userMetadata?: $Shape | null