as
@datafire/amazonaws_swf
npm i @datafire/amazonaws_swf
as

@datafire/amazonaws_swf

Integration registry for DataFire

by DataFire

5.0.0 (see all)License:MITTypeScript:Not Found
npm i @datafire/amazonaws_swf
Readme

@datafire/amazonaws_swf

Client library for Amazon Simple Workflow Service

Installation and Usage

npm install --save @datafire/amazonaws_swf
let amazonaws_swf = require('@datafire/amazonaws_swf').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_swf.CountClosedWorkflowExecutions({
  "domain": ""
}).then(data => {
  console.log(data);
});

Description

Amazon Simple Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

Actions

CountClosedWorkflowExecutions

amazonaws_swf.CountClosedWorkflowExecutions({
  "domain": ""
}, context)

Input

Output

CountOpenWorkflowExecutions

amazonaws_swf.CountOpenWorkflowExecutions({
  "domain": "",
  "startTimeFilter": {
    "oldestDate": ""
  }
}, context)

Input

Output

CountPendingActivityTasks

amazonaws_swf.CountPendingActivityTasks({
  "domain": "",
  "taskList": {
    "name": ""
  }
}, context)

Input

Output

CountPendingDecisionTasks

amazonaws_swf.CountPendingDecisionTasks({
  "domain": "",
  "taskList": {
    "name": ""
  }
}, context)

Input

Output

DeprecateActivityType

amazonaws_swf.DeprecateActivityType({
  "domain": "",
  "activityType": {
    "name": "",
    "version": ""
  }
}, context)

Input

Output

Output schema unknown

DeprecateDomain

amazonaws_swf.DeprecateDomain({
  "name": ""
}, context)

Input

Output

Output schema unknown

DeprecateWorkflowType

amazonaws_swf.DeprecateWorkflowType({
  "domain": "",
  "workflowType": {
    "name": "",
    "version": ""
  }
}, context)

Input

Output

Output schema unknown

DescribeActivityType

amazonaws_swf.DescribeActivityType({
  "domain": "",
  "activityType": {
    "name": "",
    "version": ""
  }
}, context)

Input

Output

DescribeDomain

amazonaws_swf.DescribeDomain({
  "name": ""
}, context)

Input

Output

DescribeWorkflowExecution

amazonaws_swf.DescribeWorkflowExecution({
  "domain": "",
  "execution": {
    "workflowId": "",
    "runId": ""
  }
}, context)

Input

Output

DescribeWorkflowType

amazonaws_swf.DescribeWorkflowType({
  "domain": "",
  "workflowType": {
    "name": "",
    "version": ""
  }
}, context)

Input

Output

GetWorkflowExecutionHistory

amazonaws_swf.GetWorkflowExecutionHistory({
  "domain": "",
  "execution": {
    "workflowId": "",
    "runId": ""
  }
}, context)

Input

Output

ListActivityTypes

amazonaws_swf.ListActivityTypes({
  "domain": "",
  "registrationStatus": ""
}, context)

Input

Output

ListClosedWorkflowExecutions

amazonaws_swf.ListClosedWorkflowExecutions({
  "domain": ""
}, context)

Input

Output

ListDomains

amazonaws_swf.ListDomains({
  "registrationStatus": ""
}, context)

Input

Output

ListOpenWorkflowExecutions

amazonaws_swf.ListOpenWorkflowExecutions({
  "domain": "",
  "startTimeFilter": {
    "oldestDate": ""
  }
}, context)

Input

Output

ListWorkflowTypes

amazonaws_swf.ListWorkflowTypes({
  "domain": "",
  "registrationStatus": ""
}, context)

Input

Output

PollForActivityTask

amazonaws_swf.PollForActivityTask({
  "domain": "",
  "taskList": {
    "name": ""
  }
}, context)

Input

Output

PollForDecisionTask

amazonaws_swf.PollForDecisionTask({
  "domain": "",
  "taskList": {
    "name": ""
  }
}, context)

Input

Output

RecordActivityTaskHeartbeat

amazonaws_swf.RecordActivityTaskHeartbeat({
  "taskToken": ""
}, context)

Input

Output

RegisterActivityType

amazonaws_swf.RegisterActivityType({
  "domain": "",
  "name": "",
  "version": ""
}, context)

Input

Output

Output schema unknown

RegisterDomain

amazonaws_swf.RegisterDomain({
  "name": "",
  "workflowExecutionRetentionPeriodInDays": ""
}, context)

Input

Output

Output schema unknown

RegisterWorkflowType

amazonaws_swf.RegisterWorkflowType({
  "domain": "",
  "name": "",
  "version": ""
}, context)

Input

Output

Output schema unknown

RequestCancelWorkflowExecution

amazonaws_swf.RequestCancelWorkflowExecution({
  "domain": "",
  "workflowId": ""
}, context)

Input

Output

Output schema unknown

RespondActivityTaskCanceled

amazonaws_swf.RespondActivityTaskCanceled({
  "taskToken": ""
}, context)

Input

Output

Output schema unknown

RespondActivityTaskCompleted

amazonaws_swf.RespondActivityTaskCompleted({
  "taskToken": ""
}, context)

Input

Output

Output schema unknown

RespondActivityTaskFailed

amazonaws_swf.RespondActivityTaskFailed({
  "taskToken": ""
}, context)

Input

Output

Output schema unknown

RespondDecisionTaskCompleted

amazonaws_swf.RespondDecisionTaskCompleted({
  "taskToken": ""
}, context)

Input

Output

Output schema unknown

SignalWorkflowExecution

amazonaws_swf.SignalWorkflowExecution({
  "domain": "",
  "workflowId": "",
  "signalName": ""
}, context)

Input

Output

Output schema unknown

StartWorkflowExecution

amazonaws_swf.StartWorkflowExecution({
  "domain": "",
  "workflowId": "",
  "workflowType": {
    "name": "",
    "version": ""
  }
}, context)

Input

Output

TerminateWorkflowExecution

amazonaws_swf.TerminateWorkflowExecution({
  "domain": "",
  "workflowId": ""
}, context)

Input

Output

Output schema unknown

Definitions

ActivityId

  • ActivityId string

ActivityTask

ActivityTaskCancelRequestedEventAttributes

  • ActivityTaskCancelRequestedEventAttributes object: Provides the details of the ActivityTaskCancelRequested event.

ActivityTaskCanceledEventAttributes

  • ActivityTaskCanceledEventAttributes object: Provides the details of the ActivityTaskCanceled event.

ActivityTaskCompletedEventAttributes

  • ActivityTaskCompletedEventAttributes object: Provides the details of the ActivityTaskCompleted event.

ActivityTaskFailedEventAttributes

  • ActivityTaskFailedEventAttributes object: Provides the details of the ActivityTaskFailed event.

ActivityTaskScheduledEventAttributes

ActivityTaskStartedEventAttributes

  • ActivityTaskStartedEventAttributes object: Provides the details of the ActivityTaskStarted event.

ActivityTaskStatus

  • ActivityTaskStatus object: Status information about an activity task.

ActivityTaskTimedOutEventAttributes

ActivityTaskTimeoutType

  • ActivityTaskTimeoutType string (values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT)

ActivityType

  • ActivityType object: Represents an activity type.

ActivityTypeConfiguration

ActivityTypeDetail

ActivityTypeInfo

ActivityTypeInfoList

ActivityTypeInfos

  • ActivityTypeInfos object: Contains a paginated list of activity type information structures.

Arn

  • Arn string

CancelTimerDecisionAttributes

  • CancelTimerDecisionAttributes object:

    Provides the details of the CancelTimer decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

CancelTimerFailedCause

  • CancelTimerFailedCause string (values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED)

CancelTimerFailedEventAttributes

  • CancelTimerFailedEventAttributes object: Provides the details of the CancelTimerFailed event.

CancelWorkflowExecutionDecisionAttributes

  • CancelWorkflowExecutionDecisionAttributes object:

    Provides the details of the CancelWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

CancelWorkflowExecutionFailedCause

  • CancelWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED)

CancelWorkflowExecutionFailedEventAttributes

  • CancelWorkflowExecutionFailedEventAttributes object: Provides the details of the CancelWorkflowExecutionFailed event.

Canceled

  • Canceled boolean

CauseMessage

  • CauseMessage string

ChildPolicy

  • ChildPolicy string (values: TERMINATE, REQUEST_CANCEL, ABANDON)

ChildWorkflowExecutionCanceledEventAttributes

  • ChildWorkflowExecutionCanceledEventAttributes object: Provide details of the ChildWorkflowExecutionCanceled event.

ChildWorkflowExecutionCompletedEventAttributes

  • ChildWorkflowExecutionCompletedEventAttributes object: Provides the details of the ChildWorkflowExecutionCompleted event.

ChildWorkflowExecutionFailedEventAttributes

ChildWorkflowExecutionStartedEventAttributes

  • ChildWorkflowExecutionStartedEventAttributes object: Provides the details of the ChildWorkflowExecutionStarted event.

ChildWorkflowExecutionTerminatedEventAttributes

  • ChildWorkflowExecutionTerminatedEventAttributes object: Provides the details of the ChildWorkflowExecutionTerminated event.

ChildWorkflowExecutionTimedOutEventAttributes

CloseStatus

  • CloseStatus string (values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT)

CloseStatusFilter

  • CloseStatusFilter object: Used to filter the closed workflow executions in visibility APIs by their close status.

CompleteWorkflowExecutionDecisionAttributes

  • CompleteWorkflowExecutionDecisionAttributes object:

    Provides the details of the CompleteWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

CompleteWorkflowExecutionFailedCause

  • CompleteWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED)

CompleteWorkflowExecutionFailedEventAttributes

  • CompleteWorkflowExecutionFailedEventAttributes object: Provides the details of the CompleteWorkflowExecutionFailed event.

ContinueAsNewWorkflowExecutionDecisionAttributes

  • ContinueAsNewWorkflowExecutionDecisionAttributes object:

    Provides the details of the ContinueAsNewWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tag – A tag used to identify the workflow execution

      • taskList – String constraint. The key is swf:taskList.name.

      • workflowType.version – String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

ContinueAsNewWorkflowExecutionFailedCause

  • ContinueAsNewWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, WORKFLOW_TYPE_DEPRECATED, WORKFLOW_TYPE_DOES_NOT_EXIST, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED)

ContinueAsNewWorkflowExecutionFailedEventAttributes

Count

  • Count integer

CountClosedWorkflowExecutionsInput

CountOpenWorkflowExecutionsInput

CountPendingActivityTasksInput

  • CountPendingActivityTasksInput object

CountPendingDecisionTasksInput

  • CountPendingDecisionTasksInput object

Data

  • Data string

Decision

  • Decision object:

    Specifies a decision made by the decider. A decision can be one of these types:

    • CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the history.

    • CancelWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCanceled event in the history.

    • CompleteWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCompleted event in the history .

    • ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.

    • FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed event in the history.

    • RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event.

    • RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.

    • RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.

    • ScheduleActivityTask – Schedules an activity task.

    • SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.

    • StartChildWorkflowExecution – Requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.

    • StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in the history. This timer fires after the specified delay and record a TimerFired event.

    Access Control

    If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    Decision Failure

    Decisions can fail for several reasons

    • The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.

    • A limit on your account was reached.

    • The decision lacks sufficient permissions.

    One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    • ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured.

    • RequestCancelActivityTaskFailed – A RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.

    • StartTimerFailed – A StartTimer decision failed. This could happen if there is another open timer with the same timerId.

    • CancelTimerFailed – A CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.

    • StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured.

    • SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

    • RequestCancelExternalWorkflowExecutionFailed – A RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

    • CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

    • CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

    • ContinueAsNewWorkflowExecutionFailed – A ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.

    • FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

    The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.

    A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault is returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.

    How to Code a Decision

    You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:

DecisionList

DecisionTask

DecisionTaskCompletedEventAttributes

  • DecisionTaskCompletedEventAttributes object: Provides the details of the DecisionTaskCompleted event.

DecisionTaskScheduledEventAttributes

DecisionTaskStartedEventAttributes

  • DecisionTaskStartedEventAttributes object: Provides the details of the DecisionTaskStarted event.

DecisionTaskTimedOutEventAttributes

  • DecisionTaskTimedOutEventAttributes object: Provides the details of the DecisionTaskTimedOut event.

DecisionTaskTimeoutType

  • DecisionTaskTimeoutType string (values: START_TO_CLOSE)

DecisionType

  • DecisionType string (values: ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution, ScheduleLambdaFunction)

DefaultUndefinedFault

  • DefaultUndefinedFault object:

    The StartWorkflowExecution API action was called without the required parameters set.

    Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type.

    If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.

DeprecateActivityTypeInput

DeprecateDomainInput

  • DeprecateDomainInput object

DeprecateWorkflowTypeInput

DescribeActivityTypeInput

DescribeDomainInput

  • DescribeDomainInput object

DescribeWorkflowExecutionInput

DescribeWorkflowTypeInput

Description

  • Description string

DomainAlreadyExistsFault

  • DomainAlreadyExistsFault object: Returned if the specified domain already exists. You get this fault even if the existing domain is in deprecated status.

DomainConfiguration

  • DomainConfiguration object: Contains the configuration settings of a domain.

DomainDeprecatedFault

  • DomainDeprecatedFault object: Returned when the specified domain has been deprecated.

DomainDetail

DomainInfo

DomainInfoList

DomainInfos

  • DomainInfos object: Contains a paginated collection of DomainInfo structures.

DomainName

  • DomainName string

DurationInDays

  • DurationInDays string

DurationInSeconds

  • DurationInSeconds string

DurationInSecondsOptional

  • DurationInSecondsOptional string

ErrorMessage

  • ErrorMessage string

EventId

  • EventId integer

EventType

  • EventType string (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)

ExecutionStatus

  • ExecutionStatus string (values: OPEN, CLOSED)

ExecutionTimeFilter

  • ExecutionTimeFilter object: Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: "oldestDate": 1325376070.

ExternalWorkflowExecutionCancelRequestedEventAttributes

  • ExternalWorkflowExecutionCancelRequestedEventAttributes object: Provides the details of the ExternalWorkflowExecutionCancelRequested event.

ExternalWorkflowExecutionSignaledEventAttributes

  • ExternalWorkflowExecutionSignaledEventAttributes object: Provides the details of the ExternalWorkflowExecutionSignaled event.

FailWorkflowExecutionDecisionAttributes

  • FailWorkflowExecutionDecisionAttributes object:

    Provides the details of the FailWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

FailWorkflowExecutionFailedCause

  • FailWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED)

FailWorkflowExecutionFailedEventAttributes

  • FailWorkflowExecutionFailedEventAttributes object: Provides the details of the FailWorkflowExecutionFailed event.

FailureReason

  • FailureReason string

FunctionId

  • FunctionId string

FunctionInput

  • FunctionInput string

FunctionName

  • FunctionName string

GetWorkflowExecutionHistoryInput

History

  • History object: Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

HistoryEvent

  • HistoryEvent object:

    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.

Downloads/wk

20

GitHub Stars

129

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

10

OPEN ISSUES

12

OPEN PRs

16
VersionTagPublished
5.0.0
latest
5yrs ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate