Skip to content

Latest commit

 

History

History

amazonaws_swf

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@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: ""
});

.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": null
}, context)

Input

  • input object
    • closeStatusFilter
      • status required
    • closeTimeFilter
      • latestDate
      • oldestDate required
    • domain required
    • executionFilter
      • workflowId required
    • startTimeFilter
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

Output

CountOpenWorkflowExecutions

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

Input

  • input object
    • domain required
    • executionFilter
      • workflowId required
    • startTimeFilter required
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

Output

CountPendingActivityTasks

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

Input

  • input object
    • domain required
    • taskList required
      • name required

Output

CountPendingDecisionTasks

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

Input

  • input object
    • domain required
    • taskList required
      • name required

Output

DeprecateActivityType

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

Input

  • input object
    • activityType required
      • name required
      • version required
    • domain required

Output

Output schema unknown

DeprecateDomain

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

Input

  • input object
    • name required

Output

Output schema unknown

DeprecateWorkflowType

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

Input

  • input object
    • domain required
    • workflowType required
      • name required
      • version required

Output

Output schema unknown

DescribeActivityType

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

Input

  • input object
    • activityType required
      • name required
      • version required
    • domain required

Output

DescribeDomain

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

Input

  • input object
    • name required

Output

DescribeWorkflowExecution

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

Input

  • input object
    • domain required
    • execution required
      • runId required
      • workflowId required

Output

DescribeWorkflowType

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

Input

  • input object
    • domain required
    • workflowType required
      • name required
      • version required

Output

GetWorkflowExecutionHistory

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • domain required
    • execution required
      • runId required
      • workflowId required
    • maximumPageSize
    • nextPageToken
    • reverseOrder

Output

ListActivityTypes

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • domain required
    • maximumPageSize
    • name
    • nextPageToken
    • registrationStatus required
    • reverseOrder

Output

ListClosedWorkflowExecutions

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • closeStatusFilter
      • status required
    • closeTimeFilter
      • latestDate
      • oldestDate required
    • domain required
    • executionFilter
      • workflowId required
    • maximumPageSize
    • nextPageToken
    • reverseOrder
    • startTimeFilter
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

Output

ListDomains

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • maximumPageSize
    • nextPageToken
    • registrationStatus required
    • reverseOrder

Output

ListOpenWorkflowExecutions

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • domain required
    • executionFilter
      • workflowId required
    • maximumPageSize
    • nextPageToken
    • reverseOrder
    • startTimeFilter required
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

Output

ListTagsForResource

amazonaws_swf.ListTagsForResource({
  "resourceArn": null
}, context)

Input

  • input object
    • resourceArn required

Output

ListWorkflowTypes

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • domain required
    • maximumPageSize
    • name
    • nextPageToken
    • registrationStatus required
    • reverseOrder

Output

PollForActivityTask

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

Input

  • input object
    • domain required
    • identity
    • taskList required
      • name required

Output

PollForDecisionTask

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

Input

  • input object
    • maximumPageSize string
    • nextPageToken string
    • domain required
    • identity
    • maximumPageSize
    • nextPageToken
    • reverseOrder
    • taskList required
      • name required

Output

RecordActivityTaskHeartbeat

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

Input

  • input object
    • details
    • taskToken required

Output

RegisterActivityType

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

Input

  • input object
    • defaultTaskHeartbeatTimeout
    • defaultTaskList
      • name required
    • defaultTaskPriority
    • defaultTaskScheduleToCloseTimeout
    • defaultTaskScheduleToStartTimeout
    • defaultTaskStartToCloseTimeout
    • description
    • domain required
    • name required
    • version required

Output

Output schema unknown

RegisterDomain

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

Input

  • input object
    • tags
    • description
    • name required
    • workflowExecutionRetentionPeriodInDays required

Output

Output schema unknown

RegisterWorkflowType

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

Input

  • input object
    • defaultChildPolicy
    • defaultExecutionStartToCloseTimeout
    • defaultLambdaRole
    • defaultTaskList
      • name required
    • defaultTaskPriority
    • defaultTaskStartToCloseTimeout
    • description
    • domain required
    • name required
    • version required

Output

Output schema unknown

RequestCancelWorkflowExecution

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

Input

  • input object
    • domain required
    • runId
    • workflowId required

Output

Output schema unknown

RespondActivityTaskCanceled

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

Input

  • input object
    • details
    • taskToken required

Output

Output schema unknown

RespondActivityTaskCompleted

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

Input

  • input object
    • result
    • taskToken required

Output

Output schema unknown

RespondActivityTaskFailed

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

Input

  • input object
    • details
    • reason
    • taskToken required

Output

Output schema unknown

RespondDecisionTaskCompleted

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

Input

  • input object
    • decisions
    • executionContext
    • taskToken required

Output

Output schema unknown

SignalWorkflowExecution

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

Input

  • input object
    • domain required
    • input
    • runId
    • signalName required
    • workflowId required

Output

Output schema unknown

StartWorkflowExecution

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

Input

  • input object
    • childPolicy
    • domain required
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • tagList
    • taskList
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowId required
    • workflowType required
      • name required
      • version required

Output

TagResource

amazonaws_swf.TagResource({
  "resourceArn": null,
  "tags": null
}, context)

Input

  • input object

Output

Output schema unknown

TerminateWorkflowExecution

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

Input

  • input object
    • childPolicy
    • details
    • domain required
    • reason
    • runId
    • workflowId required

Output

Output schema unknown

UndeprecateActivityType

amazonaws_swf.UndeprecateActivityType({
  "domain": null,
  "activityType": null
}, context)

Input

  • input object
    • activityType required
      • name required
      • version required
    • domain required

Output

Output schema unknown

UndeprecateDomain

amazonaws_swf.UndeprecateDomain({
  "name": null
}, context)

Input

  • input object
    • name required

Output

Output schema unknown

UndeprecateWorkflowType

amazonaws_swf.UndeprecateWorkflowType({
  "domain": null,
  "workflowType": null
}, context)

Input

  • input object
    • domain required
    • workflowType required
      • name required
      • version required

Output

Output schema unknown

UntagResource

amazonaws_swf.UntagResource({
  "resourceArn": null,
  "tagKeys": null
}, context)

Input

  • input object

Output

Output schema unknown

Definitions

ActivityId

  • ActivityId string

ActivityTask

  • ActivityTask object: Unit of work sent to an activity worker.
    • activityId required
    • activityType required
      • name required
      • version required
    • input
    • startedEventId required
    • taskToken required
    • workflowExecution required
      • runId required
      • workflowId required

ActivityTaskCancelRequestedEventAttributes

  • ActivityTaskCancelRequestedEventAttributes object: Provides the details of the ActivityTaskCancelRequested event.
    • activityId required
    • decisionTaskCompletedEventId required

ActivityTaskCanceledEventAttributes

  • ActivityTaskCanceledEventAttributes object: Provides the details of the ActivityTaskCanceled event.
    • details
    • latestCancelRequestedEventId
    • scheduledEventId required
    • startedEventId required

ActivityTaskCompletedEventAttributes

  • ActivityTaskCompletedEventAttributes object: Provides the details of the ActivityTaskCompleted event.
    • result
    • scheduledEventId required
    • startedEventId required

ActivityTaskFailedEventAttributes

  • ActivityTaskFailedEventAttributes object: Provides the details of the ActivityTaskFailed event.
    • details
    • reason
    • scheduledEventId required
    • startedEventId required

ActivityTaskScheduledEventAttributes

  • ActivityTaskScheduledEventAttributes object: Provides the details of the ActivityTaskScheduled event.
    • activityId required
    • activityType required
      • name required
      • version required
    • control
    • decisionTaskCompletedEventId required
    • heartbeatTimeout
    • input
    • scheduleToCloseTimeout
    • scheduleToStartTimeout
    • startToCloseTimeout
    • taskList required
      • name required
    • taskPriority

ActivityTaskStartedEventAttributes

  • ActivityTaskStartedEventAttributes object: Provides the details of the ActivityTaskStarted event.
    • identity
    • scheduledEventId required

ActivityTaskStatus

  • ActivityTaskStatus object: Status information about an activity task.
    • cancelRequested required

ActivityTaskTimedOutEventAttributes

  • ActivityTaskTimedOutEventAttributes object: Provides the details of the ActivityTaskTimedOut event.
    • details
    • scheduledEventId required
    • startedEventId required
    • timeoutType required

ActivityTaskTimeoutType

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

ActivityType

  • ActivityType object: Represents an activity type.
    • name required
    • version required

ActivityTypeConfiguration

  • ActivityTypeConfiguration object: Configuration settings registered with the activity type.
    • defaultTaskHeartbeatTimeout
    • defaultTaskList
      • name required
    • defaultTaskPriority
    • defaultTaskScheduleToCloseTimeout
    • defaultTaskScheduleToStartTimeout
    • defaultTaskStartToCloseTimeout

ActivityTypeDetail

  • ActivityTypeDetail object: Detailed information about an activity type.
    • configuration required
      • defaultTaskHeartbeatTimeout
      • defaultTaskList
        • name required
      • defaultTaskPriority
      • defaultTaskScheduleToCloseTimeout
      • defaultTaskScheduleToStartTimeout
      • defaultTaskStartToCloseTimeout
    • typeInfo required
      • activityType required
        • name required
        • version required
      • creationDate required
      • deprecationDate
      • description
      • status required

ActivityTypeInfo

  • ActivityTypeInfo object: Detailed information about an activity type.
    • activityType required
      • name required
      • version required
    • creationDate required
    • deprecationDate
    • description
    • status required

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.

    • timerId required

CancelTimerFailedCause

  • CancelTimerFailedCause string (values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED)

CancelTimerFailedEventAttributes

  • CancelTimerFailedEventAttributes object: Provides the details of the CancelTimerFailed event.
    • cause required
    • decisionTaskCompletedEventId required
    • timerId required

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.

    • details

CancelWorkflowExecutionFailedCause

  • CancelWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED)

CancelWorkflowExecutionFailedEventAttributes

  • CancelWorkflowExecutionFailedEventAttributes object: Provides the details of the CancelWorkflowExecutionFailed event.
    • cause required
    • decisionTaskCompletedEventId required

Canceled

  • Canceled boolean

CauseMessage

  • CauseMessage string

ChildPolicy

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

ChildWorkflowExecutionCanceledEventAttributes

  • ChildWorkflowExecutionCanceledEventAttributes object: Provide details of the ChildWorkflowExecutionCanceled event.
    • details
    • initiatedEventId required
    • startedEventId required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

ChildWorkflowExecutionCompletedEventAttributes

  • ChildWorkflowExecutionCompletedEventAttributes object: Provides the details of the ChildWorkflowExecutionCompleted event.
    • initiatedEventId required
    • result
    • startedEventId required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

ChildWorkflowExecutionFailedEventAttributes

  • ChildWorkflowExecutionFailedEventAttributes object: Provides the details of the ChildWorkflowExecutionFailed event.
    • details
    • initiatedEventId required
    • reason
    • startedEventId required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

ChildWorkflowExecutionStartedEventAttributes

  • ChildWorkflowExecutionStartedEventAttributes object: Provides the details of the ChildWorkflowExecutionStarted event.
    • initiatedEventId required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

ChildWorkflowExecutionTerminatedEventAttributes

  • ChildWorkflowExecutionTerminatedEventAttributes object: Provides the details of the ChildWorkflowExecutionTerminated event.
    • initiatedEventId required
    • startedEventId required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

ChildWorkflowExecutionTimedOutEventAttributes

  • ChildWorkflowExecutionTimedOutEventAttributes object: Provides the details of the ChildWorkflowExecutionTimedOut event.
    • initiatedEventId required
    • startedEventId required
    • timeoutType required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

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.
    • status required

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.

    • result

CompleteWorkflowExecutionFailedCause

  • CompleteWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED)

CompleteWorkflowExecutionFailedEventAttributes

  • CompleteWorkflowExecutionFailedEventAttributes object: Provides the details of the CompleteWorkflowExecutionFailed event.
    • cause required
    • decisionTaskCompletedEventId required

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.

    • childPolicy
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • tagList
    • taskList
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowTypeVersion

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

  • ContinueAsNewWorkflowExecutionFailedEventAttributes object: Provides the details of the ContinueAsNewWorkflowExecutionFailed event.
    • cause required
    • decisionTaskCompletedEventId required

Count

  • Count integer

CountClosedWorkflowExecutionsInput

  • CountClosedWorkflowExecutionsInput object
    • closeStatusFilter
      • status required
    • closeTimeFilter
      • latestDate
      • oldestDate required
    • domain required
    • executionFilter
      • workflowId required
    • startTimeFilter
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

CountOpenWorkflowExecutionsInput

  • CountOpenWorkflowExecutionsInput object
    • domain required
    • executionFilter
      • workflowId required
    • startTimeFilter required
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

CountPendingActivityTasksInput

  • CountPendingActivityTasksInput object
    • domain required
    • taskList required
      • name required

CountPendingDecisionTasksInput

  • CountPendingDecisionTasksInput object
    • domain required
    • taskList required
      • name required

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

    • cancelTimerDecisionAttributes
      • timerId required
    • cancelWorkflowExecutionDecisionAttributes
      • details
    • completeWorkflowExecutionDecisionAttributes
      • result
    • continueAsNewWorkflowExecutionDecisionAttributes
      • childPolicy
      • executionStartToCloseTimeout
      • input
      • lambdaRole
      • tagList
      • taskList
        • name required
      • taskPriority
      • taskStartToCloseTimeout
      • workflowTypeVersion
    • decisionType required
    • failWorkflowExecutionDecisionAttributes
      • details
      • reason
    • recordMarkerDecisionAttributes
      • details
      • markerName required
    • requestCancelActivityTaskDecisionAttributes
      • activityId required
    • requestCancelExternalWorkflowExecutionDecisionAttributes
      • control
      • runId
      • workflowId required
    • scheduleActivityTaskDecisionAttributes
      • activityId required
      • activityType required
        • name required
        • version required
      • control
      • heartbeatTimeout
      • input
      • scheduleToCloseTimeout
      • scheduleToStartTimeout
      • startToCloseTimeout
      • taskList
        • name required
      • taskPriority
    • scheduleLambdaFunctionDecisionAttributes
      • control
      • id required
      • input
      • name required
      • startToCloseTimeout
    • signalExternalWorkflowExecutionDecisionAttributes
      • control
      • input
      • runId
      • signalName required
      • workflowId required
    • startChildWorkflowExecutionDecisionAttributes
      • childPolicy
      • control
      • executionStartToCloseTimeout
      • input
      • lambdaRole
      • tagList
      • taskList
        • name required
      • taskPriority
      • taskStartToCloseTimeout
      • workflowId required
      • workflowType required
        • name required
        • version required
    • startTimerDecisionAttributes
      • control
      • startToFireTimeout required
      • timerId required

DecisionList

DecisionTask

  • DecisionTask object: A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
    • events required
    • nextPageToken
    • previousStartedEventId
    • startedEventId required
    • taskToken required
    • workflowExecution required
      • runId required
      • workflowId required
    • workflowType required
      • name required
      • version required

DecisionTaskCompletedEventAttributes

  • DecisionTaskCompletedEventAttributes object: Provides the details of the DecisionTaskCompleted event.
    • executionContext
    • scheduledEventId required
    • startedEventId required

DecisionTaskScheduledEventAttributes

  • DecisionTaskScheduledEventAttributes object: Provides details about the DecisionTaskScheduled event.
    • startToCloseTimeout
    • taskList required
      • name required
    • taskPriority

DecisionTaskStartedEventAttributes

  • DecisionTaskStartedEventAttributes object: Provides the details of the DecisionTaskStarted event.
    • identity
    • scheduledEventId required

DecisionTaskTimedOutEventAttributes

  • DecisionTaskTimedOutEventAttributes object: Provides the details of the DecisionTaskTimedOut event.
    • scheduledEventId required
    • startedEventId required
    • timeoutType required

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

DeprecateActivityTypeInput

  • DeprecateActivityTypeInput object
    • activityType required
      • name required
      • version required
    • domain required

DeprecateDomainInput

  • DeprecateDomainInput object
    • name required

DeprecateWorkflowTypeInput

  • DeprecateWorkflowTypeInput object
    • domain required
    • workflowType required
      • name required
      • version required

DescribeActivityTypeInput

  • DescribeActivityTypeInput object
    • activityType required
      • name required
      • version required
    • domain required

DescribeDomainInput

  • DescribeDomainInput object
    • name required

DescribeWorkflowExecutionInput

  • DescribeWorkflowExecutionInput object
    • domain required
    • execution required
      • runId required
      • workflowId required

DescribeWorkflowTypeInput

  • DescribeWorkflowTypeInput object
    • domain required
    • workflowType required
      • name required
      • version required

Description

  • Description string

DomainAlreadyExistsFault

DomainConfiguration

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

DomainDeprecatedFault

DomainDetail

  • DomainDetail object: Contains details of a domain.
    • configuration required
      • workflowExecutionRetentionPeriodInDays required
    • domainInfo required
      • arn
      • description
      • name required
      • status required

DomainInfo

  • DomainInfo object: Contains general information about a domain.
    • arn
    • description
    • name required
    • status required

DomainInfoList

DomainInfos

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

DomainName

  • DomainName string

DurationInDays

  • DurationInDays string

DurationInSeconds

  • DurationInSeconds string

DurationInSecondsOptional

  • DurationInSecondsOptional 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.
    • latestDate
    • oldestDate required

ExternalWorkflowExecutionCancelRequestedEventAttributes

  • ExternalWorkflowExecutionCancelRequestedEventAttributes object: Provides the details of the ExternalWorkflowExecutionCancelRequested event.
    • initiatedEventId required
    • workflowExecution required
      • runId required
      • workflowId required

ExternalWorkflowExecutionSignaledEventAttributes

  • ExternalWorkflowExecutionSignaledEventAttributes object: Provides the details of the ExternalWorkflowExecutionSignaled event.
    • initiatedEventId required
    • workflowExecution required
      • runId required
      • workflowId required

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.

    • details
    • reason

FailWorkflowExecutionFailedCause

  • FailWorkflowExecutionFailedCause string (values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED)

FailWorkflowExecutionFailedEventAttributes

  • FailWorkflowExecutionFailedEventAttributes object: Provides the details of the FailWorkflowExecutionFailed event.
    • cause required
    • decisionTaskCompletedEventId required

FailureReason

  • FailureReason string

FunctionId

  • FunctionId string

FunctionInput

  • FunctionInput string

FunctionName

  • FunctionName string

GetWorkflowExecutionHistoryInput

  • GetWorkflowExecutionHistoryInput object
    • domain required
    • execution required
      • runId required
      • workflowId required
    • maximumPageSize
    • nextPageToken
    • reverseOrder

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.

    • activityTaskCancelRequestedEventAttributes
      • activityId required
      • decisionTaskCompletedEventId required
    • activityTaskCanceledEventAttributes
      • details
      • latestCancelRequestedEventId
      • scheduledEventId required
      • startedEventId required
    • activityTaskCompletedEventAttributes
      • result
      • scheduledEventId required
      • startedEventId required
    • activityTaskFailedEventAttributes
      • details
      • reason
      • scheduledEventId required
      • startedEventId required
    • activityTaskScheduledEventAttributes
      • activityId required
      • activityType required
        • name required
        • version required
      • control
      • decisionTaskCompletedEventId required
      • heartbeatTimeout
      • input
      • scheduleToCloseTimeout
      • scheduleToStartTimeout
      • startToCloseTimeout
      • taskList required
        • name required
      • taskPriority
    • activityTaskStartedEventAttributes
      • identity
      • scheduledEventId required
    • activityTaskTimedOutEventAttributes
      • details
      • scheduledEventId required
      • startedEventId required
      • timeoutType required
    • cancelTimerFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
      • timerId required
    • cancelWorkflowExecutionFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
    • childWorkflowExecutionCanceledEventAttributes
      • details
      • initiatedEventId required
      • startedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
      • workflowType required
        • name required
        • version required
    • childWorkflowExecutionCompletedEventAttributes
      • initiatedEventId required
      • result
      • startedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
      • workflowType required
        • name required
        • version required
    • childWorkflowExecutionFailedEventAttributes
      • details
      • initiatedEventId required
      • reason
      • startedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
      • workflowType required
        • name required
        • version required
    • childWorkflowExecutionStartedEventAttributes
      • initiatedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
      • workflowType required
        • name required
        • version required
    • childWorkflowExecutionTerminatedEventAttributes
      • initiatedEventId required
      • startedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
      • workflowType required
        • name required
        • version required
    • childWorkflowExecutionTimedOutEventAttributes
      • initiatedEventId required
      • startedEventId required
      • timeoutType required
      • workflowExecution required
        • runId required
        • workflowId required
      • workflowType required
        • name required
        • version required
    • completeWorkflowExecutionFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
    • continueAsNewWorkflowExecutionFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
    • decisionTaskCompletedEventAttributes
      • executionContext
      • scheduledEventId required
      • startedEventId required
    • decisionTaskScheduledEventAttributes
      • startToCloseTimeout
      • taskList required
        • name required
      • taskPriority
    • decisionTaskStartedEventAttributes
      • identity
      • scheduledEventId required
    • decisionTaskTimedOutEventAttributes
      • scheduledEventId required
      • startedEventId required
      • timeoutType required
    • eventId required
    • eventTimestamp required
    • eventType required
    • externalWorkflowExecutionCancelRequestedEventAttributes
      • initiatedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
    • externalWorkflowExecutionSignaledEventAttributes
      • initiatedEventId required
      • workflowExecution required
        • runId required
        • workflowId required
    • failWorkflowExecutionFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
    • lambdaFunctionCompletedEventAttributes
      • result
      • scheduledEventId required
      • startedEventId required
    • lambdaFunctionFailedEventAttributes
      • details
      • reason
      • scheduledEventId required
      • startedEventId required
    • lambdaFunctionScheduledEventAttributes
      • control
      • decisionTaskCompletedEventId required
      • id required
      • input
      • name required
      • startToCloseTimeout
    • lambdaFunctionStartedEventAttributes
      • scheduledEventId required
    • lambdaFunctionTimedOutEventAttributes
      • scheduledEventId required
      • startedEventId required
      • timeoutType
    • markerRecordedEventAttributes
      • decisionTaskCompletedEventId required
      • details
      • markerName required
    • recordMarkerFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
      • markerName required
    • requestCancelActivityTaskFailedEventAttributes
      • activityId required
      • cause required
      • decisionTaskCompletedEventId required
    • requestCancelExternalWorkflowExecutionFailedEventAttributes
      • cause required
      • control
      • decisionTaskCompletedEventId required
      • initiatedEventId required
      • runId
      • workflowId required
    • requestCancelExternalWorkflowExecutionInitiatedEventAttributes
      • control
      • decisionTaskCompletedEventId required
      • runId
      • workflowId required
    • scheduleActivityTaskFailedEventAttributes
      • activityId required
      • activityType required
        • name required
        • version required
      • cause required
      • decisionTaskCompletedEventId required
    • scheduleLambdaFunctionFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
      • id required
      • name required
    • signalExternalWorkflowExecutionFailedEventAttributes
      • cause required
      • control
      • decisionTaskCompletedEventId required
      • initiatedEventId required
      • runId
      • workflowId required
    • signalExternalWorkflowExecutionInitiatedEventAttributes
      • control
      • decisionTaskCompletedEventId required
      • input
      • runId
      • signalName required
      • workflowId required
    • startChildWorkflowExecutionFailedEventAttributes
      • cause required
      • control
      • decisionTaskCompletedEventId required
      • initiatedEventId required
      • workflowId required
      • workflowType required
        • name required
        • version required
    • startChildWorkflowExecutionInitiatedEventAttributes
      • childPolicy required
      • control
      • decisionTaskCompletedEventId required
      • executionStartToCloseTimeout
      • input
      • lambdaRole
      • tagList
      • taskList required
        • name required
      • taskPriority
      • taskStartToCloseTimeout
      • workflowId required
      • workflowType required
        • name required
        • version required
    • startLambdaFunctionFailedEventAttributes
      • cause
      • message
      • scheduledEventId
    • startTimerFailedEventAttributes
      • cause required
      • decisionTaskCompletedEventId required
      • timerId required
    • timerCanceledEventAttributes
      • decisionTaskCompletedEventId required
      • startedEventId required
      • timerId required
    • timerFiredEventAttributes
      • startedEventId required
      • timerId required
    • timerStartedEventAttributes
      • control
      • decisionTaskCompletedEventId required
      • startToFireTimeout required
      • timerId required
    • workflowExecutionCancelRequestedEventAttributes
      • cause
      • externalInitiatedEventId
      • externalWorkflowExecution
        • runId required
        • workflowId required
    • workflowExecutionCanceledEventAttributes
      • decisionTaskCompletedEventId required
      • details
    • workflowExecutionCompletedEventAttributes
      • decisionTaskCompletedEventId required
      • result
    • workflowExecutionContinuedAsNewEventAttributes
      • childPolicy required
      • decisionTaskCompletedEventId required
      • executionStartToCloseTimeout
      • input
      • lambdaRole
      • newExecutionRunId required
      • tagList
      • taskList required
        • name required
      • taskPriority
      • taskStartToCloseTimeout
      • workflowType required
        • name required
        • version required
    • workflowExecutionFailedEventAttributes
      • decisionTaskCompletedEventId required
      • details
      • reason
    • workflowExecutionSignaledEventAttributes
      • externalInitiatedEventId
      • externalWorkflowExecution
        • runId required
        • workflowId required
      • input
      • signalName required
    • workflowExecutionStartedEventAttributes
      • childPolicy required
      • continuedExecutionRunId
      • executionStartToCloseTimeout
      • input
      • lambdaRole
      • parentInitiatedEventId
      • parentWorkflowExecution
        • runId required
        • workflowId required
      • tagList
      • taskList required
        • name required
      • taskPriority
      • taskStartToCloseTimeout
      • workflowType required
        • name required
        • version required
    • workflowExecutionTerminatedEventAttributes
      • cause
      • childPolicy required
      • details
      • reason
    • workflowExecutionTimedOutEventAttributes
      • childPolicy required
      • timeoutType required

HistoryEventList

Identity

  • Identity string

LambdaFunctionCompletedEventAttributes

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

LambdaFunctionFailedEventAttributes

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

LambdaFunctionScheduledEventAttributes

  • LambdaFunctionScheduledEventAttributes object: Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.
    • control
    • decisionTaskCompletedEventId required
    • id required
    • input
    • name required
    • startToCloseTimeout

LambdaFunctionStartedEventAttributes

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

LambdaFunctionTimedOutEventAttributes

  • LambdaFunctionTimedOutEventAttributes object: Provides details of the LambdaFunctionTimedOut event.
    • scheduledEventId required
    • startedEventId required
    • timeoutType

LambdaFunctionTimeoutType

  • LambdaFunctionTimeoutType string (values: START_TO_CLOSE)

LimitExceededFault

LimitedData

  • LimitedData string

ListActivityTypesInput

  • ListActivityTypesInput object
    • domain required
    • maximumPageSize
    • name
    • nextPageToken
    • registrationStatus required
    • reverseOrder

ListClosedWorkflowExecutionsInput

  • ListClosedWorkflowExecutionsInput object
    • closeStatusFilter
      • status required
    • closeTimeFilter
      • latestDate
      • oldestDate required
    • domain required
    • executionFilter
      • workflowId required
    • maximumPageSize
    • nextPageToken
    • reverseOrder
    • startTimeFilter
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

ListDomainsInput

  • ListDomainsInput object
    • maximumPageSize
    • nextPageToken
    • registrationStatus required
    • reverseOrder

ListOpenWorkflowExecutionsInput

  • ListOpenWorkflowExecutionsInput object
    • domain required
    • executionFilter
      • workflowId required
    • maximumPageSize
    • nextPageToken
    • reverseOrder
    • startTimeFilter required
      • latestDate
      • oldestDate required
    • tagFilter
      • tag required
    • typeFilter
      • name required
      • version

ListTagsForResourceInput

  • ListTagsForResourceInput object
    • resourceArn required

ListTagsForResourceOutput

  • ListTagsForResourceOutput object

ListWorkflowTypesInput

  • ListWorkflowTypesInput object
    • domain required
    • maximumPageSize
    • name
    • nextPageToken
    • registrationStatus required
    • reverseOrder

MarkerName

  • MarkerName string

MarkerRecordedEventAttributes

  • MarkerRecordedEventAttributes object: Provides the details of the MarkerRecorded event.
    • decisionTaskCompletedEventId required
    • details
    • markerName required

Name

  • Name string

OpenDecisionTasksCount

  • OpenDecisionTasksCount integer

OperationNotPermittedFault

PageSize

  • PageSize integer

PageToken

  • PageToken string

PendingTaskCount

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

PollForActivityTaskInput

  • PollForActivityTaskInput object
    • domain required
    • identity
    • taskList required
      • name required

PollForDecisionTaskInput

  • PollForDecisionTaskInput object
    • domain required
    • identity
    • maximumPageSize
    • nextPageToken
    • reverseOrder
    • taskList required
      • name required

RecordActivityTaskHeartbeatInput

  • RecordActivityTaskHeartbeatInput object
    • details
    • taskToken required

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.

    • details
    • markerName required

RecordMarkerFailedCause

  • RecordMarkerFailedCause string (values: OPERATION_NOT_PERMITTED)

RecordMarkerFailedEventAttributes

  • RecordMarkerFailedEventAttributes object: Provides the details of the RecordMarkerFailed event.
    • cause required
    • decisionTaskCompletedEventId required
    • markerName required

RegisterActivityTypeInput

  • RegisterActivityTypeInput object
    • defaultTaskHeartbeatTimeout
    • defaultTaskList
      • name required
    • defaultTaskPriority
    • defaultTaskScheduleToCloseTimeout
    • defaultTaskScheduleToStartTimeout
    • defaultTaskStartToCloseTimeout
    • description
    • domain required
    • name required
    • version required

RegisterDomainInput

  • RegisterDomainInput object
    • tags
    • description
    • name required
    • workflowExecutionRetentionPeriodInDays required

RegisterWorkflowTypeInput

  • RegisterWorkflowTypeInput object
    • defaultChildPolicy
    • defaultExecutionStartToCloseTimeout
    • defaultLambdaRole
    • defaultTaskList
      • name required
    • defaultTaskPriority
    • defaultTaskStartToCloseTimeout
    • description
    • domain required
    • name required
    • version required

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.

    • activityId required

RequestCancelActivityTaskFailedCause

  • RequestCancelActivityTaskFailedCause string (values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED)

RequestCancelActivityTaskFailedEventAttributes

  • RequestCancelActivityTaskFailedEventAttributes object: Provides the details of the RequestCancelActivityTaskFailed event.
    • activityId required
    • cause required
    • decisionTaskCompletedEventId required

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.

    • control
    • runId
    • workflowId required

RequestCancelExternalWorkflowExecutionFailedCause

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

RequestCancelExternalWorkflowExecutionFailedEventAttributes

  • RequestCancelExternalWorkflowExecutionFailedEventAttributes object: Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.
    • cause required
    • control
    • decisionTaskCompletedEventId required
    • initiatedEventId required
    • runId
    • workflowId required

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

  • RequestCancelExternalWorkflowExecutionInitiatedEventAttributes object: Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.
    • control
    • decisionTaskCompletedEventId required
    • runId
    • workflowId required

RequestCancelWorkflowExecutionInput

  • RequestCancelWorkflowExecutionInput object
    • domain required
    • runId
    • workflowId required

ResourceTag

  • ResourceTag object:

    Tags are key-value pairs that can be associated with Amazon SWF state machines and activities.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    • key required
    • value

ResourceTagKey

  • ResourceTagKey string

ResourceTagKeyList

ResourceTagList

ResourceTagValue

  • ResourceTagValue string

RespondActivityTaskCanceledInput

  • RespondActivityTaskCanceledInput object
    • details
    • taskToken required

RespondActivityTaskCompletedInput

  • RespondActivityTaskCompletedInput object
    • result
    • taskToken required

RespondActivityTaskFailedInput

  • RespondActivityTaskFailedInput object
    • details
    • reason
    • taskToken required

RespondDecisionTaskCompletedInput

  • RespondDecisionTaskCompletedInput object: Input data for a TaskCompleted response to a decision task.
    • decisions
    • executionContext
    • taskToken required

ReverseOrder

  • ReverseOrder boolean

Run

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

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.

    • activityId required
    • activityType required
      • name required
      • version required
    • control
    • heartbeatTimeout
    • input
    • scheduleToCloseTimeout
    • scheduleToStartTimeout
    • startToCloseTimeout
    • taskList
      • name required
    • taskPriority

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

  • ScheduleActivityTaskFailedEventAttributes object: Provides the details of the ScheduleActivityTaskFailed event.
    • activityId required
    • activityType required
      • name required
      • version required
    • cause required
    • decisionTaskCompletedEventId required

ScheduleLambdaFunctionDecisionAttributes

  • ScheduleLambdaFunctionDecisionAttributes object: Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.
    • control
    • id required
    • input
    • name required
    • startToCloseTimeout

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

  • ScheduleLambdaFunctionFailedEventAttributes object: Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.
    • cause required
    • decisionTaskCompletedEventId required
    • id required
    • name required

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.

    • control
    • input
    • runId
    • signalName required
    • workflowId required

SignalExternalWorkflowExecutionFailedCause

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

SignalExternalWorkflowExecutionFailedEventAttributes

  • SignalExternalWorkflowExecutionFailedEventAttributes object: Provides the details of the SignalExternalWorkflowExecutionFailed event.
    • cause required
    • control
    • decisionTaskCompletedEventId required
    • initiatedEventId required
    • runId
    • workflowId required

SignalExternalWorkflowExecutionInitiatedEventAttributes

  • SignalExternalWorkflowExecutionInitiatedEventAttributes object: Provides the details of the SignalExternalWorkflowExecutionInitiated event.
    • control
    • decisionTaskCompletedEventId required
    • input
    • runId
    • signalName required
    • workflowId required

SignalName

  • SignalName string

SignalWorkflowExecutionInput

  • SignalWorkflowExecutionInput object
    • domain required
    • input
    • runId
    • signalName required
    • workflowId required

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.

    • childPolicy
    • control
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • tagList
    • taskList
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowId required
    • workflowType required
      • name required
      • version required

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

  • StartChildWorkflowExecutionFailedEventAttributes object: Provides the details of the StartChildWorkflowExecutionFailed event.
    • cause required
    • control
    • decisionTaskCompletedEventId required
    • initiatedEventId required
    • workflowId required
    • workflowType required
      • name required
      • version required

StartChildWorkflowExecutionInitiatedEventAttributes

  • StartChildWorkflowExecutionInitiatedEventAttributes object: Provides the details of the StartChildWorkflowExecutionInitiated event.
    • childPolicy required
    • control
    • decisionTaskCompletedEventId required
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • tagList
    • taskList required
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowId required
    • workflowType required
      • name required
      • version required

StartLambdaFunctionFailedCause

  • StartLambdaFunctionFailedCause string (values: ASSUME_ROLE_FAILED)

StartLambdaFunctionFailedEventAttributes

  • StartLambdaFunctionFailedEventAttributes object: Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.
    • cause
    • message
    • scheduledEventId

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.

    • control
    • startToFireTimeout required
    • timerId required

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.
    • cause required
    • decisionTaskCompletedEventId required
    • timerId required

StartWorkflowExecutionInput

  • StartWorkflowExecutionInput object
    • childPolicy
    • domain required
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • tagList
    • taskList
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowId required
    • workflowType required
      • name required
      • version required

Tag

  • Tag string

TagFilter

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

TagList

  • TagList array

TagResourceInput

  • TagResourceInput object

TaskList

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

TaskPriority

  • TaskPriority string

TaskToken

  • TaskToken string

TerminateReason

  • TerminateReason string

TerminateWorkflowExecutionInput

  • TerminateWorkflowExecutionInput object
    • childPolicy
    • details
    • domain required
    • reason
    • runId
    • workflowId required

TimerCanceledEventAttributes

  • TimerCanceledEventAttributes object: Provides the details of the TimerCanceled event.
    • decisionTaskCompletedEventId required
    • startedEventId required
    • timerId required

TimerFiredEventAttributes

  • TimerFiredEventAttributes object: Provides the details of the TimerFired event.
    • startedEventId required
    • timerId required

TimerId

  • TimerId string

TimerStartedEventAttributes

  • TimerStartedEventAttributes object: Provides the details of the TimerStarted event.
    • control
    • decisionTaskCompletedEventId required
    • startToFireTimeout required
    • timerId required

Timestamp

  • Timestamp string

TooManyTagsFault

Truncated

  • Truncated boolean

TypeAlreadyExistsFault

TypeDeprecatedFault

UndeprecateActivityTypeInput

  • UndeprecateActivityTypeInput object
    • activityType required
      • name required
      • version required
    • domain required

UndeprecateDomainInput

  • UndeprecateDomainInput object
    • name required

UndeprecateWorkflowTypeInput

  • UndeprecateWorkflowTypeInput object
    • domain required
    • workflowType required
      • name required
      • version required

UnknownResourceFault

UntagResourceInput

  • UntagResourceInput object

Version

  • Version string

VersionOptional

  • VersionOptional string

WorkflowExecution

  • WorkflowExecution object: Represents a workflow execution.
    • runId required
    • workflowId required

WorkflowExecutionAlreadyStartedFault

WorkflowExecutionCancelRequestedCause

  • WorkflowExecutionCancelRequestedCause string (values: CHILD_POLICY_APPLIED)

WorkflowExecutionCancelRequestedEventAttributes

  • WorkflowExecutionCancelRequestedEventAttributes object: Provides the details of the WorkflowExecutionCancelRequested event.
    • cause
    • externalInitiatedEventId
    • externalWorkflowExecution
      • runId required
      • workflowId required

WorkflowExecutionCanceledEventAttributes

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

WorkflowExecutionCompletedEventAttributes

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

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.
    • childPolicy required
    • executionStartToCloseTimeout required
    • lambdaRole
    • taskList required
      • name required
    • taskPriority
    • taskStartToCloseTimeout required

WorkflowExecutionContinuedAsNewEventAttributes

  • WorkflowExecutionContinuedAsNewEventAttributes object: Provides the details of the WorkflowExecutionContinuedAsNew event.
    • childPolicy required
    • decisionTaskCompletedEventId required
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • newExecutionRunId required
    • tagList
    • taskList required
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowType required
      • name required
      • version required

WorkflowExecutionCount

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

WorkflowExecutionDetail

  • WorkflowExecutionDetail object: Contains details about a workflow execution.
    • executionConfiguration required
      • childPolicy required
      • executionStartToCloseTimeout required
      • lambdaRole
      • taskList required
        • name required
      • taskPriority
      • taskStartToCloseTimeout required
    • executionInfo required
      • cancelRequested
      • closeStatus
      • closeTimestamp
      • execution required
        • runId required
        • workflowId required
      • executionStatus required
      • parent
        • runId required
        • workflowId required
      • startTimestamp required
      • tagList
      • workflowType required
        • name required
        • version required
    • latestActivityTaskTimestamp
    • latestExecutionContext
    • openCounts required
      • openActivityTasks required
      • openChildWorkflowExecutions required
      • openDecisionTasks required
      • openLambdaFunctions
      • openTimers required

WorkflowExecutionFailedEventAttributes

  • WorkflowExecutionFailedEventAttributes object: Provides the details of the WorkflowExecutionFailed event.
    • decisionTaskCompletedEventId required
    • details
    • reason

WorkflowExecutionFilter

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

WorkflowExecutionInfo

  • WorkflowExecutionInfo object: Contains information about a workflow execution.
    • cancelRequested
    • closeStatus
    • closeTimestamp
    • execution required
      • runId required
      • workflowId required
    • executionStatus required
    • parent
      • runId required
      • workflowId required
    • startTimestamp required
    • tagList
    • workflowType required
      • name required
      • version required

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.
    • openActivityTasks required
    • openChildWorkflowExecutions required
    • openDecisionTasks required
    • openLambdaFunctions
    • openTimers required

WorkflowExecutionSignaledEventAttributes

  • WorkflowExecutionSignaledEventAttributes object: Provides the details of the WorkflowExecutionSignaled event.
    • externalInitiatedEventId
    • externalWorkflowExecution
      • runId required
      • workflowId required
    • input
    • signalName required

WorkflowExecutionStartedEventAttributes

  • WorkflowExecutionStartedEventAttributes object: Provides details of WorkflowExecutionStarted event.
    • childPolicy required
    • continuedExecutionRunId
    • executionStartToCloseTimeout
    • input
    • lambdaRole
    • parentInitiatedEventId
    • parentWorkflowExecution
      • runId required
      • workflowId required
    • tagList
    • taskList required
      • name required
    • taskPriority
    • taskStartToCloseTimeout
    • workflowType required
      • name required
      • version required

WorkflowExecutionTerminatedCause

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

WorkflowExecutionTerminatedEventAttributes

  • WorkflowExecutionTerminatedEventAttributes object: Provides the details of the WorkflowExecutionTerminated event.
    • cause
    • childPolicy required
    • details
    • reason

WorkflowExecutionTimedOutEventAttributes

  • WorkflowExecutionTimedOutEventAttributes object: Provides the details of the WorkflowExecutionTimedOut event.
    • childPolicy required
    • timeoutType required

WorkflowExecutionTimeoutType

  • WorkflowExecutionTimeoutType string (values: START_TO_CLOSE)

WorkflowId

  • WorkflowId string

WorkflowRunId

  • WorkflowRunId string

WorkflowRunIdOptional

  • WorkflowRunIdOptional string

WorkflowType

  • WorkflowType object: Represents a workflow type.
    • name required
    • version required

WorkflowTypeConfiguration

  • WorkflowTypeConfiguration object: The configuration settings of a workflow type.
    • defaultChildPolicy
    • defaultExecutionStartToCloseTimeout
    • defaultLambdaRole
    • defaultTaskList
      • name required
    • defaultTaskPriority
    • defaultTaskStartToCloseTimeout

WorkflowTypeDetail

  • WorkflowTypeDetail object: Contains details about a workflow type.
    • configuration required
      • defaultChildPolicy
      • defaultExecutionStartToCloseTimeout
      • defaultLambdaRole
      • defaultTaskList
        • name required
      • defaultTaskPriority
      • defaultTaskStartToCloseTimeout
    • typeInfo required
      • creationDate required
      • deprecationDate
      • description
      • status required
      • workflowType required
        • name required
        • version required

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.
    • name required
    • version

WorkflowTypeInfo

  • WorkflowTypeInfo object: Contains information about a workflow type.
    • creationDate required
    • deprecationDate
    • description
    • status required
    • workflowType required
      • name required
      • version required

WorkflowTypeInfoList

WorkflowTypeInfos

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