AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SWF::Types::HistoryEvent

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Event within a workflow execution. A history event can be one of these types:

  • ActivityTaskCancelRequested – A RequestCancelActivityTask decision was received by the system.

  • ActivityTaskCanceled – The activity task was successfully canceled.

  • ActivityTaskCompleted – An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.

  • ActivityTaskFailed – An activity worker failed an activity task by calling RespondActivityTaskFailed.

  • ActivityTaskScheduled – An activity task was scheduled for execution.

  • ActivityTaskStarted – The scheduled activity task was dispatched to a worker.

  • ActivityTaskTimedOut – The activity task timed out.

  • CancelTimerFailed – Failed to process CancelTimer decision. This happens when the decision isn't configured properly, for example no timer exists with the specified timer Id.

  • CancelWorkflowExecutionFailed – A request to cancel a workflow execution failed.

  • ChildWorkflowExecutionCanceled – A child workflow execution, started by this workflow execution, was canceled and closed.

  • ChildWorkflowExecutionCompleted – A child workflow execution, started by this workflow execution, completed successfully and was closed.

  • ChildWorkflowExecutionFailed – A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.

  • ChildWorkflowExecutionStarted – A child workflow execution was successfully started.

  • ChildWorkflowExecutionTerminated – A child workflow execution, started by this workflow execution, was terminated.

  • ChildWorkflowExecutionTimedOut – A child workflow execution, started by this workflow execution, timed out and was closed.

  • CompleteWorkflowExecutionFailed – The workflow execution failed to complete.

  • ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to complete after being continued as a new workflow execution.

  • DecisionTaskCompleted – The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.

  • DecisionTaskScheduled – A decision task was scheduled for the workflow execution.

  • DecisionTaskStarted – The decision task was dispatched to a decider.

  • DecisionTaskTimedOut – The decision task timed out.

  • ExternalWorkflowExecutionCancelRequested – Request to cancel an external workflow execution was successfully delivered to the target execution.

  • ExternalWorkflowExecutionSignaled – A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.

  • FailWorkflowExecutionFailed – A request to mark a workflow execution as failed, itself failed.

  • MarkerRecorded – A marker was recorded in the workflow history as the result of a RecordMarker decision.

  • RecordMarkerFailed – A RecordMarker decision was returned as failed.

  • RequestCancelActivityTaskFailed – Failed to process RequestCancelActivityTask decision. This happens when the decision isn't configured properly.

  • RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external workflow execution failed.

  • RequestCancelExternalWorkflowExecutionInitiated – A request was made to request the cancellation of an external workflow execution.

  • ScheduleActivityTaskFailed – Failed to process ScheduleActivityTask decision. This happens when the decision isn't configured properly, for example the activity type specified isn't registered.

  • SignalExternalWorkflowExecutionFailed – The request to signal an external workflow execution failed.

  • SignalExternalWorkflowExecutionInitiated – A request to signal an external workflow was made.

  • StartActivityTaskFailed – A scheduled activity task failed to start.

  • StartChildWorkflowExecutionFailed – Failed to process StartChildWorkflowExecution decision. This happens when the decision isn't configured properly, for example the workflow type specified isn't registered.

  • StartChildWorkflowExecutionInitiated – A request was made to start a child workflow execution.

  • StartTimerFailed – Failed to process StartTimer decision. This happens when the decision isn't configured properly, for example a timer already exists with the specified timer Id.

  • TimerCanceled – A timer, previously started for this workflow execution, was successfully canceled.

  • TimerFired – A timer, previously started for this workflow execution, fired.

  • TimerStarted – A timer was started for the workflow execution due to a StartTimer decision.

  • WorkflowExecutionCancelRequested – A request to cancel this workflow execution was made.

  • WorkflowExecutionCanceled – The workflow execution was successfully canceled and closed.

  • WorkflowExecutionCompleted – The workflow execution was closed due to successful completion.

  • WorkflowExecutionContinuedAsNew – The workflow execution was closed and a new execution of the same type was created with the same workflowId.

  • WorkflowExecutionFailed – The workflow execution closed due to a failure.

  • WorkflowExecutionSignaled – An external signal was received for the workflow execution.

  • WorkflowExecutionStarted – The workflow execution was started.

  • WorkflowExecutionTerminated – The workflow execution was terminated.

  • WorkflowExecutionTimedOut – The workflow execution was closed because a time out was exceeded.

Instance Attribute Summary collapse

Instance Attribute Details

#activity_task_cancel_requested_event_attributesTypes::ActivityTaskCancelRequestedEventAttributes

If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#activity_task_canceled_event_attributesTypes::ActivityTaskCanceledEventAttributes

If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#activity_task_completed_event_attributesTypes::ActivityTaskCompletedEventAttributes

If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#activity_task_failed_event_attributesTypes::ActivityTaskFailedEventAttributes

If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#activity_task_scheduled_event_attributesTypes::ActivityTaskScheduledEventAttributes

If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#activity_task_started_event_attributesTypes::ActivityTaskStartedEventAttributes

If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#activity_task_timed_out_event_attributesTypes::ActivityTaskTimedOutEventAttributes

If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#cancel_timer_failed_event_attributesTypes::CancelTimerFailedEventAttributes

If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#cancel_workflow_execution_failed_event_attributesTypes::CancelWorkflowExecutionFailedEventAttributes

If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#child_workflow_execution_canceled_event_attributesTypes::ChildWorkflowExecutionCanceledEventAttributes

If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#child_workflow_execution_completed_event_attributesTypes::ChildWorkflowExecutionCompletedEventAttributes

If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#child_workflow_execution_failed_event_attributesTypes::ChildWorkflowExecutionFailedEventAttributes

If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#child_workflow_execution_started_event_attributesTypes::ChildWorkflowExecutionStartedEventAttributes

If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#child_workflow_execution_terminated_event_attributesTypes::ChildWorkflowExecutionTerminatedEventAttributes

If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#child_workflow_execution_timed_out_event_attributesTypes::ChildWorkflowExecutionTimedOutEventAttributes

If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#complete_workflow_execution_failed_event_attributesTypes::CompleteWorkflowExecutionFailedEventAttributes

If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#continue_as_new_workflow_execution_failed_event_attributesTypes::ContinueAsNewWorkflowExecutionFailedEventAttributes

If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#decision_task_completed_event_attributesTypes::DecisionTaskCompletedEventAttributes

If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#decision_task_scheduled_event_attributesTypes::DecisionTaskScheduledEventAttributes

If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#decision_task_started_event_attributesTypes::DecisionTaskStartedEventAttributes

If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#decision_task_timed_out_event_attributesTypes::DecisionTaskTimedOutEventAttributes

If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#event_idInteger

The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

Returns:

  • (Integer)

    The system generated ID of the event.

#event_timestampTime

The date and time when the event occurred.

Returns:

  • (Time)

    The date and time when the event occurred.

#event_typeString

The type of the history event.

Possible values:

  • WorkflowExecutionStarted
  • WorkflowExecutionCancelRequested
  • WorkflowExecutionCompleted
  • CompleteWorkflowExecutionFailed
  • WorkflowExecutionFailed
  • FailWorkflowExecutionFailed
  • WorkflowExecutionTimedOut
  • WorkflowExecutionCanceled
  • CancelWorkflowExecutionFailed
  • WorkflowExecutionContinuedAsNew
  • ContinueAsNewWorkflowExecutionFailed
  • WorkflowExecutionTerminated
  • DecisionTaskScheduled
  • DecisionTaskStarted
  • DecisionTaskCompleted
  • DecisionTaskTimedOut
  • ActivityTaskScheduled
  • ScheduleActivityTaskFailed
  • ActivityTaskStarted
  • ActivityTaskCompleted
  • ActivityTaskFailed
  • ActivityTaskTimedOut
  • ActivityTaskCanceled
  • ActivityTaskCancelRequested
  • RequestCancelActivityTaskFailed
  • WorkflowExecutionSignaled
  • MarkerRecorded
  • RecordMarkerFailed
  • TimerStarted
  • StartTimerFailed
  • TimerFired
  • TimerCanceled
  • CancelTimerFailed
  • StartChildWorkflowExecutionInitiated
  • StartChildWorkflowExecutionFailed
  • ChildWorkflowExecutionStarted
  • ChildWorkflowExecutionCompleted
  • ChildWorkflowExecutionFailed
  • ChildWorkflowExecutionTimedOut
  • ChildWorkflowExecutionCanceled
  • ChildWorkflowExecutionTerminated
  • SignalExternalWorkflowExecutionInitiated
  • SignalExternalWorkflowExecutionFailed
  • ExternalWorkflowExecutionSignaled
  • RequestCancelExternalWorkflowExecutionInitiated
  • RequestCancelExternalWorkflowExecutionFailed
  • ExternalWorkflowExecutionCancelRequested
  • LambdaFunctionScheduled
  • LambdaFunctionStarted
  • LambdaFunctionCompleted
  • LambdaFunctionFailed
  • LambdaFunctionTimedOut
  • ScheduleLambdaFunctionFailed
  • StartLambdaFunctionFailed

Returns:

  • (String)

    The type of the history event.

#external_workflow_execution_cancel_requested_event_attributesTypes::ExternalWorkflowExecutionCancelRequestedEventAttributes

If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#external_workflow_execution_signaled_event_attributesTypes::ExternalWorkflowExecutionSignaledEventAttributes

If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#fail_workflow_execution_failed_event_attributesTypes::FailWorkflowExecutionFailedEventAttributes

If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#lambda_function_completed_event_attributesTypes::LambdaFunctionCompletedEventAttributes

Provides the details of the LambdaFunctionCompleted event. It isn\'t set for other event types.

Returns:

#lambda_function_failed_event_attributesTypes::LambdaFunctionFailedEventAttributes

Provides the details of the LambdaFunctionFailed event. It isn\'t set for other event types.

Returns:

#lambda_function_scheduled_event_attributesTypes::LambdaFunctionScheduledEventAttributes

Provides the details of the LambdaFunctionScheduled event. It isn\'t set for other event types.

Returns:

#lambda_function_started_event_attributesTypes::LambdaFunctionStartedEventAttributes

Provides the details of the LambdaFunctionStarted event. It isn\'t set for other event types.

Returns:

#lambda_function_timed_out_event_attributesTypes::LambdaFunctionTimedOutEventAttributes

Provides the details of the LambdaFunctionTimedOut event. It isn\'t set for other event types.

Returns:

#marker_recorded_event_attributesTypes::MarkerRecordedEventAttributes

If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#record_marker_failed_event_attributesTypes::RecordMarkerFailedEventAttributes

If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#request_cancel_activity_task_failed_event_attributesTypes::RequestCancelActivityTaskFailedEventAttributes

If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#request_cancel_external_workflow_execution_failed_event_attributesTypes::RequestCancelExternalWorkflowExecutionFailedEventAttributes

If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#request_cancel_external_workflow_execution_initiated_event_attributesTypes::RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#schedule_activity_task_failed_event_attributesTypes::ScheduleActivityTaskFailedEventAttributes

If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#schedule_lambda_function_failed_event_attributesTypes::ScheduleLambdaFunctionFailedEventAttributes

Provides the details of the ScheduleLambdaFunctionFailed event. It isn\'t set for other event types.

Returns:

#signal_external_workflow_execution_failed_event_attributesTypes::SignalExternalWorkflowExecutionFailedEventAttributes

If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#signal_external_workflow_execution_initiated_event_attributesTypes::SignalExternalWorkflowExecutionInitiatedEventAttributes

If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#start_child_workflow_execution_failed_event_attributesTypes::StartChildWorkflowExecutionFailedEventAttributes

If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#start_child_workflow_execution_initiated_event_attributesTypes::StartChildWorkflowExecutionInitiatedEventAttributes

If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#start_lambda_function_failed_event_attributesTypes::StartLambdaFunctionFailedEventAttributes

Provides the details of the StartLambdaFunctionFailed event. It isn\'t set for other event types.

Returns:

#start_timer_failed_event_attributesTypes::StartTimerFailedEventAttributes

If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#timer_canceled_event_attributesTypes::TimerCanceledEventAttributes

If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#timer_fired_event_attributesTypes::TimerFiredEventAttributes

If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#timer_started_event_attributesTypes::TimerStartedEventAttributes

If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_cancel_requested_event_attributesTypes::WorkflowExecutionCancelRequestedEventAttributes

If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_canceled_event_attributesTypes::WorkflowExecutionCanceledEventAttributes

If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_completed_event_attributesTypes::WorkflowExecutionCompletedEventAttributes

If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_continued_as_new_event_attributesTypes::WorkflowExecutionContinuedAsNewEventAttributes

If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_failed_event_attributesTypes::WorkflowExecutionFailedEventAttributes

If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_signaled_event_attributesTypes::WorkflowExecutionSignaledEventAttributes

If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_started_event_attributesTypes::WorkflowExecutionStartedEventAttributes

If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_terminated_event_attributesTypes::WorkflowExecutionTerminatedEventAttributes

If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns:

#workflow_execution_timed_out_event_attributesTypes::WorkflowExecutionTimedOutEventAttributes

If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn\'t set for other event types.

Returns: