❤
npm
Sign UpSign In

@datafire/amazonaws_swf

5.0.0 • Public • Published

@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:

    • ScheduleActivityTaskDecisionAttributes

    • RequestCancelActivityTaskDecisionAttributes

    • CompleteWorkflowExecutionDecisionAttributes

    • FailWorkflowExecutionDecisionAttributes

    • CancelWorkflowExecutionDecisionAttributes

    • ContinueAsNewWorkflowExecutionDecisionAttributes

    • RecordMarkerDecisionAttributes

    • StartTimerDecisionAttributes

    • CancelTimerDecisionAttributes

    • SignalExternalWorkflowExecutionDecisionAttributes

    • RequestCancelExternalWorkflowExecutionDecisionAttributes

    • StartChildWorkflowExecutionDecisionAttributes

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

HistoryEventList

Identity

  • Identity string

LambdaFunctionCompletedEventAttributes

  • LambdaFunctionCompletedEventAttributes object: Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

LambdaFunctionFailedEventAttributes

  • LambdaFunctionFailedEventAttributes object: Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

LambdaFunctionScheduledEventAttributes

LambdaFunctionStartedEventAttributes

  • LambdaFunctionStartedEventAttributes object: Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.
    • scheduledEventId required EventId

LambdaFunctionTimedOutEventAttributes

  • LambdaFunctionTimedOutEventAttributes object: Provides details of the LambdaFunctionTimedOut event.

LambdaFunctionTimeoutType

  • LambdaFunctionTimeoutType string (values: START_TO_CLOSE)

LimitExceededFault

  • LimitExceededFault object: Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

LimitedData

  • LimitedData string

ListActivityTypesInput

ListClosedWorkflowExecutionsInput

ListDomainsInput

ListOpenWorkflowExecutionsInput

ListWorkflowTypesInput

MarkerName

  • MarkerName string

MarkerRecordedEventAttributes

  • MarkerRecordedEventAttributes object: Provides the details of the MarkerRecorded event.

Name

  • Name string

OpenDecisionTasksCount

  • OpenDecisionTasksCount integer

OperationNotPermittedFault

  • OperationNotPermittedFault object: Returned when the caller doesn't have sufficient permissions to invoke the action.

PageSize

  • PageSize integer

PageToken

  • PageToken string

PendingTaskCount

  • PendingTaskCount object: Contains the count of tasks in a task list.

PollForActivityTaskInput

PollForDecisionTaskInput

RecordActivityTaskHeartbeatInput

RecordMarkerDecisionAttributes

  • RecordMarkerDecisionAttributes object:

    Provides the details of the RecordMarker 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.

RecordMarkerFailedCause

  • RecordMarkerFailedCause string (values: OPERATION_NOT_PERMITTED)

RecordMarkerFailedEventAttributes

  • RecordMarkerFailedEventAttributes object: Provides the details of the RecordMarkerFailed event.

RegisterActivityTypeInput

RegisterDomainInput

RegisterWorkflowTypeInput

RegistrationStatus

  • RegistrationStatus string (values: REGISTERED, DEPRECATED)

RequestCancelActivityTaskDecisionAttributes

  • RequestCancelActivityTaskDecisionAttributes object:

    Provides the details of the RequestCancelActivityTask 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.

RequestCancelActivityTaskFailedCause

  • RequestCancelActivityTaskFailedCause string (values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED)

RequestCancelActivityTaskFailedEventAttributes

RequestCancelExternalWorkflowExecutionDecisionAttributes

  • RequestCancelExternalWorkflowExecutionDecisionAttributes object:

    Provides the details of the RequestCancelExternalWorkflowExecution 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.

RequestCancelExternalWorkflowExecutionFailedCause

  • RequestCancelExternalWorkflowExecutionFailedCause string (values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED)

RequestCancelExternalWorkflowExecutionFailedEventAttributes

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

  • RequestCancelExternalWorkflowExecutionInitiatedEventAttributes object: Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.

RequestCancelWorkflowExecutionInput

RespondActivityTaskCanceledInput

  • RespondActivityTaskCanceledInput object

RespondActivityTaskCompletedInput

  • RespondActivityTaskCompletedInput object

RespondActivityTaskFailedInput

RespondDecisionTaskCompletedInput

  • RespondDecisionTaskCompletedInput object: Input data for a TaskCompleted response to a decision task.

ReverseOrder

  • ReverseOrder boolean

Run

  • Run object: Specifies the runId of a workflow execution.

ScheduleActivityTaskDecisionAttributes

  • ScheduleActivityTaskDecisionAttributes object:

    Provides the details of the ScheduleActivityTask 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.

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

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

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

    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.

ScheduleActivityTaskFailedCause

  • ScheduleActivityTaskFailedCause string (values: ACTIVITY_TYPE_DEPRECATED, ACTIVITY_TYPE_DOES_NOT_EXIST, ACTIVITY_ID_ALREADY_IN_USE, OPEN_ACTIVITIES_LIMIT_EXCEEDED, ACTIVITY_CREATION_RATE_EXCEEDED, DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED, DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED, OPERATION_NOT_PERMITTED)

ScheduleActivityTaskFailedEventAttributes

ScheduleLambdaFunctionDecisionAttributes

  • ScheduleLambdaFunctionDecisionAttributes object: Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.

ScheduleLambdaFunctionFailedCause

  • ScheduleLambdaFunctionFailedCause string (values: ID_ALREADY_IN_USE, OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED, LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED, LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION)

ScheduleLambdaFunctionFailedEventAttributes

SignalExternalWorkflowExecutionDecisionAttributes

  • SignalExternalWorkflowExecutionDecisionAttributes object:

    Provides the details of the SignalExternalWorkflowExecution 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.

SignalExternalWorkflowExecutionFailedCause

  • SignalExternalWorkflowExecutionFailedCause string (values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED)

SignalExternalWorkflowExecutionFailedEventAttributes

SignalExternalWorkflowExecutionInitiatedEventAttributes

  • SignalExternalWorkflowExecutionInitiatedEventAttributes object: Provides the details of the SignalExternalWorkflowExecutionInitiated event.

SignalName

  • SignalName string

SignalWorkflowExecutionInput

StartChildWorkflowExecutionDecisionAttributes

  • StartChildWorkflowExecutionDecisionAttributes object:

    Provides the details of the StartChildWorkflowExecution 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.

      • tagList.member.N – The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive.

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

      • workflowType.name – String constraint. The key is swf:workflowType.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.

StartChildWorkflowExecutionFailedCause

  • StartChildWorkflowExecutionFailedCause string (values: WORKFLOW_TYPE_DOES_NOT_EXIST, WORKFLOW_TYPE_DEPRECATED, OPEN_CHILDREN_LIMIT_EXCEEDED, OPEN_WORKFLOWS_LIMIT_EXCEEDED, CHILD_CREATION_RATE_EXCEEDED, WORKFLOW_ALREADY_RUNNING, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED)

StartChildWorkflowExecutionFailedEventAttributes

StartChildWorkflowExecutionInitiatedEventAttributes

StartLambdaFunctionFailedCause

  • StartLambdaFunctionFailedCause string (values: ASSUME_ROLE_FAILED)

StartLambdaFunctionFailedEventAttributes

StartTimerDecisionAttributes

  • StartTimerDecisionAttributes object:

    Provides the details of the StartTimer 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.

StartTimerFailedCause

  • StartTimerFailedCause string (values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED)

StartTimerFailedEventAttributes

  • StartTimerFailedEventAttributes object: Provides the details of the StartTimerFailed event.

StartWorkflowExecutionInput

Tag

  • Tag string

TagFilter

  • TagFilter object: Used to filter the workflow executions in visibility APIs based on a tag.
    • tag required Tag

TagList

  • TagList array

TaskList

  • TaskList object: Represents a task list.
    • name required Name

TaskPriority

  • TaskPriority string

TaskToken

  • TaskToken string

TerminateReason

  • TerminateReason string

TerminateWorkflowExecutionInput

TimerCanceledEventAttributes

  • TimerCanceledEventAttributes object: Provides the details of the TimerCanceled event.

TimerFiredEventAttributes

  • TimerFiredEventAttributes object: Provides the details of the TimerFired event.

TimerId

  • TimerId string

TimerStartedEventAttributes

  • TimerStartedEventAttributes object: Provides the details of the TimerStarted event.

Timestamp

  • Timestamp string

Truncated

  • Truncated boolean

TypeAlreadyExistsFault

  • TypeAlreadyExistsFault object: Returned if the type already exists in the specified domain. You get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.

TypeDeprecatedFault

  • TypeDeprecatedFault object: Returned when the specified activity or workflow type was already deprecated.

UnknownResourceFault

  • UnknownResourceFault object: Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

Version

  • Version string

VersionOptional

  • VersionOptional string

WorkflowExecution

  • WorkflowExecution object: Represents a workflow execution.

WorkflowExecutionAlreadyStartedFault

  • WorkflowExecutionAlreadyStartedFault object: Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.

WorkflowExecutionCancelRequestedCause

  • WorkflowExecutionCancelRequestedCause string (values: CHILD_POLICY_APPLIED)

WorkflowExecutionCancelRequestedEventAttributes

WorkflowExecutionCanceledEventAttributes

  • WorkflowExecutionCanceledEventAttributes object: Provides the details of the WorkflowExecutionCanceled event.
    • decisionTaskCompletedEventId required EventId
    • details Data

WorkflowExecutionCompletedEventAttributes

  • WorkflowExecutionCompletedEventAttributes object: Provides the details of the WorkflowExecutionCompleted event.
    • decisionTaskCompletedEventId required EventId
    • result Data

WorkflowExecutionConfiguration

  • WorkflowExecutionConfiguration object: The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

WorkflowExecutionContinuedAsNewEventAttributes

WorkflowExecutionCount

  • WorkflowExecutionCount object: Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

WorkflowExecutionDetail

WorkflowExecutionFailedEventAttributes

  • WorkflowExecutionFailedEventAttributes object: Provides the details of the WorkflowExecutionFailed event.

WorkflowExecutionFilter

  • WorkflowExecutionFilter object: Used to filter the workflow executions in visibility APIs by their workflowId.

WorkflowExecutionInfo

WorkflowExecutionInfoList

WorkflowExecutionInfos

  • WorkflowExecutionInfos object: Contains a paginated list of information about workflow executions.

WorkflowExecutionOpenCounts

  • WorkflowExecutionOpenCounts object: Contains the counts of open tasks, child workflow executions and timers for a workflow execution.

WorkflowExecutionSignaledEventAttributes

  • WorkflowExecutionSignaledEventAttributes object: Provides the details of the WorkflowExecutionSignaled event.

WorkflowExecutionStartedEventAttributes

WorkflowExecutionTerminatedCause

  • WorkflowExecutionTerminatedCause string (values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED)

WorkflowExecutionTerminatedEventAttributes

WorkflowExecutionTimedOutEventAttributes

WorkflowExecutionTimeoutType

  • WorkflowExecutionTimeoutType string (values: START_TO_CLOSE)

WorkflowId

  • WorkflowId string

WorkflowRunId

  • WorkflowRunId string

WorkflowRunIdOptional

  • WorkflowRunIdOptional string

WorkflowType

  • WorkflowType object: Represents a workflow type.

WorkflowTypeConfiguration

WorkflowTypeDetail

WorkflowTypeFilter

  • WorkflowTypeFilter object: Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.

WorkflowTypeInfo

WorkflowTypeInfoList

WorkflowTypeInfos

  • WorkflowTypeInfos object: Contains a paginated list of information structures about workflow types.

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_swf

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

0

Version

5.0.0

License

MIT

Unpacked Size

491 kB

Total Files

5

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware