amazonka-swf-1.3.5: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF

Contents

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.

See: AWS API Reference

Synopsis

Service Configuration

sWF :: Service Source

API version '2012-01-25' of the Amazon Simple Workflow Service SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by SWF.

DomainAlreadyExistsFault

_DomainAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.

LimitExceededFault

_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source

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.

WorkflowExecutionAlreadyStartedFault

_WorkflowExecutionAlreadyStartedFault :: AsError a => Getting (First ServiceError) a ServiceError Source

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

OperationNotPermittedFault

_OperationNotPermittedFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned when the caller does not have sufficient permissions to invoke the action.

UnknownResourceFault

_UnknownResourceFault :: AsError a => Getting (First ServiceError) a ServiceError Source

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.

DefaultUndefinedFault

_DefaultUndefinedFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for DefaultUndefinedFault' errors.

TypeDeprecatedFault

_TypeDeprecatedFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned when the specified activity or workflow type was already deprecated.

TypeAlreadyExistsFault

_TypeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if the type already exists in the specified domain. You will 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.

DomainDeprecatedFault

_DomainDeprecatedFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned when the specified domain has been deprecated.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

ListOpenWorkflowExecutions (Paginated)

RegisterActivityType

ListActivityTypes (Paginated)

CountPendingActivityTasks

RegisterWorkflowType

ListWorkflowTypes (Paginated)

RespondActivityTaskFailed

CountOpenWorkflowExecutions

DescribeWorkflowType

DeprecateWorkflowType

RequestCancelWorkflowExecution

RegisterDomain

RespondDecisionTaskCompleted

PollForActivityTask

RespondActivityTaskCompleted

DescribeWorkflowExecution

SignalWorkflowExecution

CountPendingDecisionTasks

ListClosedWorkflowExecutions (Paginated)

RecordActivityTaskHeartbeat

DescribeDomain

GetWorkflowExecutionHistory (Paginated)

DeprecateDomain

TerminateWorkflowExecution

DescribeActivityType

DeprecateActivityType

CountClosedWorkflowExecutions

RespondActivityTaskCanceled

StartWorkflowExecution

PollForDecisionTask (Paginated)

ListDomains (Paginated)

Types

ActivityTaskTimeoutType

CancelTimerFailedCause

CancelWorkflowExecutionFailedCause

ChildPolicy

CloseStatus

CompleteWorkflowExecutionFailedCause

ContinueAsNewWorkflowExecutionFailedCause

DecisionTaskTimeoutType

DecisionType

EventType

data EventType Source

Constructors

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

ExecutionStatus

FailWorkflowExecutionFailedCause

LambdaFunctionTimeoutType

RecordMarkerFailedCause

RegistrationStatus

RequestCancelActivityTaskFailedCause

RequestCancelExternalWorkflowExecutionFailedCause

ScheduleActivityTaskFailedCause

ScheduleLambdaFunctionFailedCause

SignalExternalWorkflowExecutionFailedCause

StartChildWorkflowExecutionFailedCause

StartLambdaFunctionFailedCause

StartTimerFailedCause

WorkflowExecutionCancelRequestedCause

WorkflowExecutionTerminatedCause

WorkflowExecutionTimeoutType

ActivityTaskCancelRequestedEventAttributes

atcreaDecisionTaskCompletedEventId :: Lens' ActivityTaskCancelRequestedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskCanceledEventAttributes

activityTaskCanceledEventAttributes Source

Creates a value of ActivityTaskCanceledEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aLatestCancelRequestedEventId :: Lens' ActivityTaskCanceledEventAttributes (Maybe Integer) Source

If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

aDetails :: Lens' ActivityTaskCanceledEventAttributes (Maybe Text) Source

Details of the cancellation (if any).

aScheduledEventId :: Lens' ActivityTaskCanceledEventAttributes Integer Source

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

aStartedEventId :: Lens' ActivityTaskCanceledEventAttributes Integer Source

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskCompletedEventAttributes

activityTaskCompletedEventAttributes Source

Creates a value of ActivityTaskCompletedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atceaResult :: Lens' ActivityTaskCompletedEventAttributes (Maybe Text) Source

The results of the activity task (if any).

atceaScheduledEventId :: Lens' ActivityTaskCompletedEventAttributes Integer Source

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

atceaStartedEventId :: Lens' ActivityTaskCompletedEventAttributes Integer Source

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskFailedEventAttributes

activityTaskFailedEventAttributes Source

Creates a value of ActivityTaskFailedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atfeaReason :: Lens' ActivityTaskFailedEventAttributes (Maybe Text) Source

The reason provided for the failure (if any).

atfeaDetails :: Lens' ActivityTaskFailedEventAttributes (Maybe Text) Source

The details of the failure (if any).

atfeaScheduledEventId :: Lens' ActivityTaskFailedEventAttributes Integer Source

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

atfeaStartedEventId :: Lens' ActivityTaskFailedEventAttributes Integer Source

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskScheduledEventAttributes

atseaControl :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

atseaHeartbeatTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.

atseaScheduleToCloseTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

The maximum amount of time for this activity task.

atseaInput :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

The input provided to the activity task.

atseaTaskPriority :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.

Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

atseaScheduleToStartTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

The maximum amount of time the activity task can wait to be assigned to a worker.

atseaStartToCloseTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source

The maximum amount of time a worker may take to process the activity task.

atseaTaskList :: Lens' ActivityTaskScheduledEventAttributes TaskList Source

The task list in which the activity task has been scheduled.

atseaDecisionTaskCompletedEventId :: Lens' ActivityTaskScheduledEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskStartedEventAttributes

activityTaskStartedEventAttributes Source

Creates a value of ActivityTaskStartedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atseaIdentity :: Lens' ActivityTaskStartedEventAttributes (Maybe Text) Source

Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

atseaScheduledEventId :: Lens' ActivityTaskStartedEventAttributes Integer Source

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityTaskTimedOutEventAttributes

attoeaDetails :: Lens' ActivityTaskTimedOutEventAttributes (Maybe Text) Source

Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

attoeaScheduledEventId :: Lens' ActivityTaskTimedOutEventAttributes Integer Source

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

attoeaStartedEventId :: Lens' ActivityTaskTimedOutEventAttributes Integer Source

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ActivityType

activityType Source

Creates a value of ActivityType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atName :: Lens' ActivityType Text Source

The name of this activity.

The combination of activity type name and version must be unique within a domain.

atVersion :: Lens' ActivityType Text Source

The version of this activity.

The combination of activity type name and version must be unique with in a domain.

ActivityTypeConfiguration

atcDefaultTaskScheduleToStartTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source

Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

atcDefaultTaskList :: Lens' ActivityTypeConfiguration (Maybe TaskList) Source

Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.

atcDefaultTaskPriority :: Lens' ActivityTypeConfiguration (Maybe Text) Source

Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be used as the default priority. This default can be overridden when scheduling an activity task.

Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

atcDefaultTaskHeartbeatTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source

Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

atcDefaultTaskScheduleToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source

Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

atcDefaultTaskStartToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source

Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

ActivityTypeInfo

activityTypeInfo Source

Creates a value of ActivityTypeInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atiDeprecationDate :: Lens' ActivityTypeInfo (Maybe UTCTime) Source

If DEPRECATED, the date and time DeprecateActivityType was called.

atiDescription :: Lens' ActivityTypeInfo (Maybe Text) Source

The description of the activity type provided in RegisterActivityType.

atiActivityType :: Lens' ActivityTypeInfo ActivityType Source

The ActivityType type structure representing the activity type.

atiStatus :: Lens' ActivityTypeInfo RegistrationStatus Source

The current status of the activity type.

atiCreationDate :: Lens' ActivityTypeInfo UTCTime Source

The date and time this activity type was created through RegisterActivityType.

CancelTimerDecisionAttributes

data CancelTimerDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: cancelTimerDecisionAttributes smart constructor.

cancelTimerDecisionAttributes Source

Creates a value of CancelTimerDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ctdaTimerId :: Lens' CancelTimerDecisionAttributes Text Source

Required. The unique ID of the timer to cancel.

CancelTimerFailedEventAttributes

ctfeaTimerId :: Lens' CancelTimerFailedEventAttributes Text Source

The timerId provided in the CancelTimer decision that failed.

ctfeaCause :: Lens' CancelTimerFailedEventAttributes CancelTimerFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

ctfeaDecisionTaskCompletedEventId :: Lens' CancelTimerFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

CancelWorkflowExecutionDecisionAttributes

data CancelWorkflowExecutionDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: cancelWorkflowExecutionDecisionAttributes smart constructor.

cancelWorkflowExecutionDecisionAttributes :: CancelWorkflowExecutionDecisionAttributes Source

Creates a value of CancelWorkflowExecutionDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

CancelWorkflowExecutionFailedEventAttributes

cCause :: Lens' CancelWorkflowExecutionFailedEventAttributes CancelWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

cDecisionTaskCompletedEventId :: Lens' CancelWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionCanceledEventAttributes

cDetails :: Lens' ChildWorkflowExecutionCanceledEventAttributes (Maybe Text) Source

Details of the cancellation (if provided).

cInitiatedEventId :: Lens' ChildWorkflowExecutionCanceledEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cStartedEventId :: Lens' ChildWorkflowExecutionCanceledEventAttributes Integer Source

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionCompletedEventAttributes

cweceaResult :: Lens' ChildWorkflowExecutionCompletedEventAttributes (Maybe Text) Source

The result of the child workflow execution (if any).

cweceaInitiatedEventId :: Lens' ChildWorkflowExecutionCompletedEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cweceaStartedEventId :: Lens' ChildWorkflowExecutionCompletedEventAttributes Integer Source

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionFailedEventAttributes

cwefeaReason :: Lens' ChildWorkflowExecutionFailedEventAttributes (Maybe Text) Source

The reason for the failure (if provided).

cwefeaDetails :: Lens' ChildWorkflowExecutionFailedEventAttributes (Maybe Text) Source

The details of the failure (if provided).

cwefeaInitiatedEventId :: Lens' ChildWorkflowExecutionFailedEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cwefeaStartedEventId :: Lens' ChildWorkflowExecutionFailedEventAttributes Integer Source

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionStartedEventAttributes

cweseaInitiatedEventId :: Lens' ChildWorkflowExecutionStartedEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionTerminatedEventAttributes

cweteaInitiatedEventId :: Lens' ChildWorkflowExecutionTerminatedEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cweteaStartedEventId :: Lens' ChildWorkflowExecutionTerminatedEventAttributes Integer Source

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ChildWorkflowExecutionTimedOutEventAttributes

cwetoeaTimeoutType :: Lens' ChildWorkflowExecutionTimedOutEventAttributes WorkflowExecutionTimeoutType Source

The type of the timeout that caused the child workflow execution to time out.

cwetoeaInitiatedEventId :: Lens' ChildWorkflowExecutionTimedOutEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cwetoeaStartedEventId :: Lens' ChildWorkflowExecutionTimedOutEventAttributes Integer Source

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

CloseStatusFilter

data CloseStatusFilter Source

Used to filter the closed workflow executions in visibility APIs by their close status.

See: closeStatusFilter smart constructor.

closeStatusFilter Source

Creates a value of CloseStatusFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csfStatus :: Lens' CloseStatusFilter CloseStatus Source

Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.

CompleteWorkflowExecutionDecisionAttributes

data CompleteWorkflowExecutionDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: completeWorkflowExecutionDecisionAttributes smart constructor.

completeWorkflowExecutionDecisionAttributes :: CompleteWorkflowExecutionDecisionAttributes Source

Creates a value of CompleteWorkflowExecutionDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cwedaResult :: Lens' CompleteWorkflowExecutionDecisionAttributes (Maybe Text) Source

The result of the workflow execution. The form of the result is implementation defined.

CompleteWorkflowExecutionFailedEventAttributes

cwefeaCause :: Lens' CompleteWorkflowExecutionFailedEventAttributes CompleteWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

cwefeaDecisionTaskCompletedEventId :: Lens' CompleteWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ContinueAsNewWorkflowExecutionDecisionAttributes

data ContinueAsNewWorkflowExecutionDecisionAttributes Source

Provides 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: Optional.. 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: continueAsNewWorkflowExecutionDecisionAttributes smart constructor.

canwedaTagList :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes [Text] Source

The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

canwedaTaskStartToCloseTimeout :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source

Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

canwedaLambdaRole :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.

canwedaInput :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source

The input provided to the new workflow execution.

canwedaExecutionStartToCloseTimeout :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source

If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.

canwedaTaskPriority :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source

Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

canwedaChildPolicy :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe ChildPolicy) Source

If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.

ContinueAsNewWorkflowExecutionFailedEventAttributes

canwefeaCause :: Lens' ContinueAsNewWorkflowExecutionFailedEventAttributes ContinueAsNewWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

canwefeaDecisionTaskCompletedEventId :: Lens' ContinueAsNewWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Decision

data Decision Source

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 do not 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 will be canceled. If the activity task was already assigned to a worker, then the worker will be 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.
  • ScheduleLambdaFunction: schedules a AWS Lambda function.
  • 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 will fire 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.

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 will therefore fail.
  • 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.

  • ScheduleActivityTaskFailed: a ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision is not registered, is in a deprecated state, or the decision is not properly configured.
  • ScheduleLambdaFunctionFailed: a ScheduleLambdaFunctionFailed decision failed. This could happen if the AWS Lambda function specified in the decision does not exist, or the AWS Lambda service's limits are exceeded.
  • 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 is not registered, is deprecated, or the decision is not 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 will be 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
  • ScheduleLambdaFunctionDecisionAttributes
  • RequestCancelActivityTaskDecisionAttributes
  • CompleteWorkflowExecutionDecisionAttributes
  • FailWorkflowExecutionDecisionAttributes
  • CancelWorkflowExecutionDecisionAttributes
  • ContinueAsNewWorkflowExecutionDecisionAttributes
  • RecordMarkerDecisionAttributes
  • StartTimerDecisionAttributes
  • CancelTimerDecisionAttributes
  • SignalExternalWorkflowExecutionDecisionAttributes
  • RequestCancelExternalWorkflowExecutionDecisionAttributes
  • StartChildWorkflowExecutionDecisionAttributes

See: decision smart constructor.

dScheduleActivityTaskDecisionAttributes :: Lens' Decision (Maybe ScheduleActivityTaskDecisionAttributes) Source

Provides details of the ScheduleActivityTask decision. It is not set for other decision types.

dStartTimerDecisionAttributes :: Lens' Decision (Maybe StartTimerDecisionAttributes) Source

Provides details of the StartTimer decision. It is not set for other decision types.

dRecordMarkerDecisionAttributes :: Lens' Decision (Maybe RecordMarkerDecisionAttributes) Source

Provides details of the RecordMarker decision. It is not set for other decision types.

dFailWorkflowExecutionDecisionAttributes :: Lens' Decision (Maybe FailWorkflowExecutionDecisionAttributes) Source

Provides details of the FailWorkflowExecution decision. It is not set for other decision types.

dCancelTimerDecisionAttributes :: Lens' Decision (Maybe CancelTimerDecisionAttributes) Source

Provides details of the CancelTimer decision. It is not set for other decision types.

dDecisionType :: Lens' Decision DecisionType Source

Specifies the type of the decision.

DecisionTaskCompletedEventAttributes

decisionTaskCompletedEventAttributes Source

Creates a value of DecisionTaskCompletedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtceaExecutionContext :: Lens' DecisionTaskCompletedEventAttributes (Maybe Text) Source

User defined context for the workflow execution.

dtceaScheduledEventId :: Lens' DecisionTaskCompletedEventAttributes Integer Source

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

dtceaStartedEventId :: Lens' DecisionTaskCompletedEventAttributes Integer Source

The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

DecisionTaskScheduledEventAttributes

decisionTaskScheduledEventAttributes Source

Creates a value of DecisionTaskScheduledEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtseaTaskPriority :: Lens' DecisionTaskScheduledEventAttributes (Maybe Text) Source

Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

dtseaStartToCloseTimeout :: Lens' DecisionTaskScheduledEventAttributes (Maybe Text) Source

The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

dtseaTaskList :: Lens' DecisionTaskScheduledEventAttributes TaskList Source

The name of the task list in which the decision task was scheduled.

DecisionTaskStartedEventAttributes

decisionTaskStartedEventAttributes Source

Creates a value of DecisionTaskStartedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtseaIdentity :: Lens' DecisionTaskStartedEventAttributes (Maybe Text) Source

Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

dtseaScheduledEventId :: Lens' DecisionTaskStartedEventAttributes Integer Source

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

DecisionTaskTimedOutEventAttributes

dttoeaTimeoutType :: Lens' DecisionTaskTimedOutEventAttributes DecisionTaskTimeoutType Source

The type of timeout that expired before the decision task could be completed.

dttoeaScheduledEventId :: Lens' DecisionTaskTimedOutEventAttributes Integer Source

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

dttoeaStartedEventId :: Lens' DecisionTaskTimedOutEventAttributes Integer Source

The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

DomainConfiguration

domainConfiguration Source

Creates a value of DomainConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dcWorkflowExecutionRetentionPeriodInDays :: Lens' DomainConfiguration Text Source

The retention period for workflow executions in this domain.

DomainInfo

data DomainInfo Source

Contains general information about a domain.

See: domainInfo smart constructor.

domainInfo Source

Creates a value of DomainInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

diDescription :: Lens' DomainInfo (Maybe Text) Source

The description of the domain provided through RegisterDomain.

diName :: Lens' DomainInfo Text Source

The name of the domain. This name is unique within the account.

diStatus :: Lens' DomainInfo RegistrationStatus Source

The status of the domain:

  • REGISTERED: The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
  • DEPRECATED: The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

ExecutionTimeFilter

data ExecutionTimeFilter Source

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.'

See: executionTimeFilter smart constructor.

executionTimeFilter Source

Creates a value of ExecutionTimeFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

etfLatestDate :: Lens' ExecutionTimeFilter (Maybe UTCTime) Source

Specifies the latest start or close date and time to return.

etfOldestDate :: Lens' ExecutionTimeFilter UTCTime Source

Specifies the oldest start or close date and time to return.

ExternalWorkflowExecutionCancelRequestedEventAttributes

ewecreaWorkflowExecution :: Lens' ExternalWorkflowExecutionCancelRequestedEventAttributes WorkflowExecution Source

The external workflow execution to which the cancellation request was delivered.

ewecreaInitiatedEventId :: Lens' ExternalWorkflowExecutionCancelRequestedEventAttributes Integer Source

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ExternalWorkflowExecutionSignaledEventAttributes

eweseaWorkflowExecution :: Lens' ExternalWorkflowExecutionSignaledEventAttributes WorkflowExecution Source

The external workflow execution that the signal was delivered to.

eweseaInitiatedEventId :: Lens' ExternalWorkflowExecutionSignaledEventAttributes Integer Source

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

FailWorkflowExecutionDecisionAttributes

data FailWorkflowExecutionDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: failWorkflowExecutionDecisionAttributes smart constructor.

failWorkflowExecutionDecisionAttributes :: FailWorkflowExecutionDecisionAttributes Source

Creates a value of FailWorkflowExecutionDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fwedaReason :: Lens' FailWorkflowExecutionDecisionAttributes (Maybe Text) Source

A descriptive reason for the failure that may help in diagnostics.

FailWorkflowExecutionFailedEventAttributes

fwefeaCause :: Lens' FailWorkflowExecutionFailedEventAttributes FailWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

fwefeaDecisionTaskCompletedEventId :: Lens' FailWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

HistoryEvent

data HistoryEvent Source

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

  • WorkflowExecutionStarted: The workflow execution was started.
  • WorkflowExecutionCompleted: The workflow execution was closed due to successful completion.
  • WorkflowExecutionFailed: The workflow execution closed due to a failure.
  • WorkflowExecutionTimedOut: The workflow execution was closed because a time out was exceeded.
  • WorkflowExecutionCanceled: The workflow execution was successfully canceled and closed.
  • WorkflowExecutionTerminated: The workflow execution was terminated.
  • WorkflowExecutionContinuedAsNew: The workflow execution was closed and a new execution of the same type was created with the same workflowId.
  • WorkflowExecutionCancelRequested: A request to cancel this workflow execution was made.
  • DecisionTaskScheduled: A decision task was scheduled for the workflow execution.
  • DecisionTaskStarted: The decision task was dispatched to a decider.
  • DecisionTaskCompleted: The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.
  • DecisionTaskTimedOut: The decision task timed out.
  • ActivityTaskScheduled: An activity task was scheduled for execution.
  • ScheduleActivityTaskFailed: Failed to process ScheduleActivityTask decision. This happens when the decision is not configured properly, for example the activity type specified is not registered.
  • ActivityTaskStarted: The scheduled activity task was dispatched to a worker.
  • ActivityTaskCompleted: An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.
  • ActivityTaskFailed: An activity worker failed an activity task by calling RespondActivityTaskFailed.
  • ActivityTaskTimedOut: The activity task timed out.
  • ActivityTaskCanceled: The activity task was successfully canceled.
  • ActivityTaskCancelRequested: A RequestCancelActivityTask decision was received by the system.
  • RequestCancelActivityTaskFailed: Failed to process RequestCancelActivityTask decision. This happens when the decision is not configured properly.
  • WorkflowExecutionSignaled: An external signal was received for the workflow execution.
  • MarkerRecorded: A marker was recorded in the workflow history as the result of a RecordMarker decision.
  • TimerStarted: A timer was started for the workflow execution due to a StartTimer decision.
  • StartTimerFailed: Failed to process StartTimer decision. This happens when the decision is not configured properly, for example a timer already exists with the specified timer ID.
  • TimerFired: A timer, previously started for this workflow execution, fired.
  • TimerCanceled: A timer, previously started for this workflow execution, was successfully canceled.
  • CancelTimerFailed: Failed to process CancelTimer decision. This happens when the decision is not configured properly, for example no timer exists with the specified timer ID.
  • StartChildWorkflowExecutionInitiated: A request was made to start a child workflow execution.
  • StartChildWorkflowExecutionFailed: Failed to process StartChildWorkflowExecution decision. This happens when the decision is not configured properly, for example the workflow type specified is not registered.
  • ChildWorkflowExecutionStarted: A child workflow execution was successfully started.
  • 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.
  • ChildWorkflowExecutionTimedOut: A child workflow execution, started by this workflow execution, timed out and was closed.
  • ChildWorkflowExecutionCanceled: A child workflow execution, started by this workflow execution, was canceled and closed.
  • ChildWorkflowExecutionTerminated: A child workflow execution, started by this workflow execution, was terminated.
  • SignalExternalWorkflowExecutionInitiated: A request to signal an external workflow was made.
  • ExternalWorkflowExecutionSignaled: A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
  • SignalExternalWorkflowExecutionFailed: The request to signal an external workflow execution failed.
  • RequestCancelExternalWorkflowExecutionInitiated: A request was made to request the cancellation of an external workflow execution.
  • ExternalWorkflowExecutionCancelRequested: Request to cancel an external workflow execution was successfully delivered to the target execution.
  • RequestCancelExternalWorkflowExecutionFailed: Request to cancel an external workflow execution failed.
  • LambdaFunctionScheduled: An AWS Lambda function was scheduled for execution.
  • LambdaFunctionStarted: The scheduled function was invoked in the AWS Lambda service.
  • LambdaFunctionCompleted: The AWS Lambda function successfully completed.
  • LambdaFunctionFailed: The AWS Lambda function execution failed.
  • LambdaFunctionTimedOut: The AWS Lambda function execution timed out.
  • ScheduleLambdaFunctionFailed: Failed to process ScheduleLambdaFunction decision. This happens when the workflow execution does not have the proper IAM role attached to invoke AWS Lambda functions.
  • StartLambdaFunctionFailed: Failed to invoke the scheduled function in the AWS Lambda service. This happens when the AWS Lambda service is not available in the current region, or received too many requests.

See: historyEvent smart constructor.

historyEvent Source

Creates a value of HistoryEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

heWorkflowExecutionCancelRequestedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionCancelRequestedEventAttributes) Source

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

heRecordMarkerFailedEventAttributes :: Lens' HistoryEvent (Maybe RecordMarkerFailedEventAttributes) Source

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

heRequestCancelExternalWorkflowExecutionInitiatedEventAttributes :: Lens' HistoryEvent (Maybe RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) Source

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

heDecisionTaskScheduledEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskScheduledEventAttributes) Source

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

heWorkflowExecutionCompletedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionCompletedEventAttributes) Source

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

heStartTimerFailedEventAttributes :: Lens' HistoryEvent (Maybe StartTimerFailedEventAttributes) Source

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

heActivityTaskScheduledEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskScheduledEventAttributes) Source

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

heScheduleActivityTaskFailedEventAttributes :: Lens' HistoryEvent (Maybe ScheduleActivityTaskFailedEventAttributes) Source

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

heChildWorkflowExecutionCompletedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionCompletedEventAttributes) Source

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

heMarkerRecordedEventAttributes :: Lens' HistoryEvent (Maybe MarkerRecordedEventAttributes) Source

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

heCompleteWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe CompleteWorkflowExecutionFailedEventAttributes) Source

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

heRequestCancelExternalWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe RequestCancelExternalWorkflowExecutionFailedEventAttributes) Source

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

heTimerCanceledEventAttributes :: Lens' HistoryEvent (Maybe TimerCanceledEventAttributes) Source

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

heWorkflowExecutionStartedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionStartedEventAttributes) Source

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

heActivityTaskCompletedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskCompletedEventAttributes) Source

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

heDecisionTaskTimedOutEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskTimedOutEventAttributes) Source

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

heCancelTimerFailedEventAttributes :: Lens' HistoryEvent (Maybe CancelTimerFailedEventAttributes) Source

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

heChildWorkflowExecutionStartedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionStartedEventAttributes) Source

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

heActivityTaskCanceledEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskCanceledEventAttributes) Source

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

heActivityTaskTimedOutEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskTimedOutEventAttributes) Source

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

heDecisionTaskStartedEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskStartedEventAttributes) Source

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

heWorkflowExecutionTerminatedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionTerminatedEventAttributes) Source

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

heChildWorkflowExecutionCanceledEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionCanceledEventAttributes) Source

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

heRequestCancelActivityTaskFailedEventAttributes :: Lens' HistoryEvent (Maybe RequestCancelActivityTaskFailedEventAttributes) Source

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

heChildWorkflowExecutionTimedOutEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionTimedOutEventAttributes) Source

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

heCancelWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe CancelWorkflowExecutionFailedEventAttributes) Source

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

heStartChildWorkflowExecutionInitiatedEventAttributes :: Lens' HistoryEvent (Maybe StartChildWorkflowExecutionInitiatedEventAttributes) Source

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

heSignalExternalWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe SignalExternalWorkflowExecutionFailedEventAttributes) Source

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

heActivityTaskStartedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskStartedEventAttributes) Source

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

heChildWorkflowExecutionTerminatedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionTerminatedEventAttributes) Source

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

heWorkflowExecutionCanceledEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionCanceledEventAttributes) Source

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

heTimerStartedEventAttributes :: Lens' HistoryEvent (Maybe TimerStartedEventAttributes) Source

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

heActivityTaskCancelRequestedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskCancelRequestedEventAttributes) Source

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

heWorkflowExecutionTimedOutEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionTimedOutEventAttributes) Source

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

heWorkflowExecutionSignaledEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionSignaledEventAttributes) Source

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

heTimerFiredEventAttributes :: Lens' HistoryEvent (Maybe TimerFiredEventAttributes) Source

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

heActivityTaskFailedEventAttributes :: Lens' HistoryEvent (Maybe ActivityTaskFailedEventAttributes) Source

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

heExternalWorkflowExecutionSignaledEventAttributes :: Lens' HistoryEvent (Maybe ExternalWorkflowExecutionSignaledEventAttributes) Source

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

heDecisionTaskCompletedEventAttributes :: Lens' HistoryEvent (Maybe DecisionTaskCompletedEventAttributes) Source

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

heStartChildWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe StartChildWorkflowExecutionFailedEventAttributes) Source

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

heChildWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe ChildWorkflowExecutionFailedEventAttributes) Source

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

heFailWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe FailWorkflowExecutionFailedEventAttributes) Source

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

heContinueAsNewWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe ContinueAsNewWorkflowExecutionFailedEventAttributes) Source

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

heSignalExternalWorkflowExecutionInitiatedEventAttributes :: Lens' HistoryEvent (Maybe SignalExternalWorkflowExecutionInitiatedEventAttributes) Source

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

heWorkflowExecutionFailedEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionFailedEventAttributes) Source

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

heWorkflowExecutionContinuedAsNewEventAttributes :: Lens' HistoryEvent (Maybe WorkflowExecutionContinuedAsNewEventAttributes) Source

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

heExternalWorkflowExecutionCancelRequestedEventAttributes :: Lens' HistoryEvent (Maybe ExternalWorkflowExecutionCancelRequestedEventAttributes) Source

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

heEventTimestamp :: Lens' HistoryEvent UTCTime Source

The date and time when the event occurred.

heEventType :: Lens' HistoryEvent EventType Source

The type of the history event.

heEventId :: Lens' HistoryEvent Integer Source

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

LambdaFunctionCompletedEventAttributes

lambdaFunctionCompletedEventAttributes Source

Creates a value of LambdaFunctionCompletedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lfceaResult :: Lens' LambdaFunctionCompletedEventAttributes (Maybe Text) Source

The result of the function execution (if any).

lfceaScheduledEventId :: Lens' LambdaFunctionCompletedEventAttributes Integer Source

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

LambdaFunctionFailedEventAttributes

lambdaFunctionFailedEventAttributes Source

Creates a value of LambdaFunctionFailedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lffeaReason :: Lens' LambdaFunctionFailedEventAttributes (Maybe Text) Source

The reason provided for the failure (if any).

lffeaDetails :: Lens' LambdaFunctionFailedEventAttributes (Maybe Text) Source

The details of the failure (if any).

lffeaScheduledEventId :: Lens' LambdaFunctionFailedEventAttributes Integer Source

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

LambdaFunctionScheduledEventAttributes

lfseaInput :: Lens' LambdaFunctionScheduledEventAttributes (Maybe Text) Source

Input provided to the AWS Lambda function.

lfseaStartToCloseTimeout :: Lens' LambdaFunctionScheduledEventAttributes (Maybe Text) Source

The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.

lfseaId :: Lens' LambdaFunctionScheduledEventAttributes Text Source

The unique Amazon SWF ID for the AWS Lambda task.

lfseaName :: Lens' LambdaFunctionScheduledEventAttributes Text Source

The name of the scheduled AWS Lambda function.

lfseaDecisionTaskCompletedEventId :: Lens' LambdaFunctionScheduledEventAttributes Integer Source

The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

LambdaFunctionStartedEventAttributes

lambdaFunctionStartedEventAttributes Source

Creates a value of LambdaFunctionStartedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lfseaScheduledEventId :: Lens' LambdaFunctionStartedEventAttributes Integer Source

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

LambdaFunctionTimedOutEventAttributes

lambdaFunctionTimedOutEventAttributes Source

Creates a value of LambdaFunctionTimedOutEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lftoeaScheduledEventId :: Lens' LambdaFunctionTimedOutEventAttributes Integer Source

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

MarkerRecordedEventAttributes

markerRecordedEventAttributes Source

Creates a value of MarkerRecordedEventAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mreaDetails :: Lens' MarkerRecordedEventAttributes (Maybe Text) Source

Details of the marker (if any).

mreaDecisionTaskCompletedEventId :: Lens' MarkerRecordedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

PendingTaskCount

pendingTaskCount Source

Creates a value of PendingTaskCount with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ptcTruncated :: Lens' PendingTaskCount (Maybe Bool) Source

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

ptcCount :: Lens' PendingTaskCount Natural Source

The number of tasks in the task list.

RecordMarkerDecisionAttributes

data RecordMarkerDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: recordMarkerDecisionAttributes smart constructor.

recordMarkerDecisionAttributes Source

Creates a value of RecordMarkerDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rmdaDetails :: Lens' RecordMarkerDecisionAttributes (Maybe Text) Source

Optional. details of the marker.

rmdaMarkerName :: Lens' RecordMarkerDecisionAttributes Text Source

Required. The name of the marker.

RecordMarkerFailedEventAttributes

rmfeaCause :: Lens' RecordMarkerFailedEventAttributes RecordMarkerFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

rmfeaDecisionTaskCompletedEventId :: Lens' RecordMarkerFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

RequestCancelActivityTaskDecisionAttributes

data RequestCancelActivityTaskDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: requestCancelActivityTaskDecisionAttributes smart constructor.

requestCancelActivityTaskDecisionAttributes Source

Creates a value of RequestCancelActivityTaskDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rcatdaActivityId :: Lens' RequestCancelActivityTaskDecisionAttributes Text Source

The activityId of the activity task to be canceled.

RequestCancelActivityTaskFailedEventAttributes

rcatfeaCause :: Lens' RequestCancelActivityTaskFailedEventAttributes RequestCancelActivityTaskFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

rcatfeaDecisionTaskCompletedEventId :: Lens' RequestCancelActivityTaskFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

RequestCancelExternalWorkflowExecutionDecisionAttributes

data RequestCancelExternalWorkflowExecutionDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: requestCancelExternalWorkflowExecutionDecisionAttributes smart constructor.

rcewedaControl :: Lens' RequestCancelExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

rcewedaRunId :: Lens' RequestCancelExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source

The runId of the external workflow execution to cancel.

rcewedaWorkflowId :: Lens' RequestCancelExternalWorkflowExecutionDecisionAttributes Text Source

Required. The workflowId of the external workflow execution to cancel.

RequestCancelExternalWorkflowExecutionFailedEventAttributes

rcewefeaWorkflowId :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes Text Source

The workflowId of the external workflow to which the cancel request was to be delivered.

rcewefeaCause :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes RequestCancelExternalWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

rcewefeaInitiatedEventId :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes Integer Source

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

rcewefeaDecisionTaskCompletedEventId :: Lens' RequestCancelExternalWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

rceweieaControl :: Lens' RequestCancelExternalWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

rceweieaRunId :: Lens' RequestCancelExternalWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

The runId of the external workflow execution to be canceled.

rceweieaWorkflowId :: Lens' RequestCancelExternalWorkflowExecutionInitiatedEventAttributes Text Source

The workflowId of the external workflow execution to be canceled.

rceweieaDecisionTaskCompletedEventId :: Lens' RequestCancelExternalWorkflowExecutionInitiatedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ScheduleActivityTaskDecisionAttributes

data ScheduleActivityTaskDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: scheduleActivityTaskDecisionAttributes smart constructor.

satdaControl :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

satdaHeartbeatTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

satdaScheduleToCloseTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

The maximum duration for this activity task.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.

satdaInput :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

The input provided to the activity task.

satdaTaskList :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe TaskList) Source

If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.

A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), \/ (slash), '|' (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.

satdaTaskPriority :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

satdaScheduleToStartTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.

satdaStartToCloseTimeout :: Lens' ScheduleActivityTaskDecisionAttributes (Maybe Text) Source

If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.

satdaActivityType :: Lens' ScheduleActivityTaskDecisionAttributes ActivityType Source

Required. The type of the activity task to schedule.

satdaActivityId :: Lens' ScheduleActivityTaskDecisionAttributes Text Source

Required. The activityId of the activity task.

The specified string must not start or end with whitespace. It must not contain a : (colon), \/ (slash), '|' (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.

ScheduleActivityTaskFailedEventAttributes

satfeaCause :: Lens' ScheduleActivityTaskFailedEventAttributes ScheduleActivityTaskFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

satfeaDecisionTaskCompletedEventId :: Lens' ScheduleActivityTaskFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

ScheduleLambdaFunctionDecisionAttributes

data ScheduleLambdaFunctionDecisionAttributes Source

Provides details of the ScheduleLambdaFunction 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: scheduleLambdaFunctionDecisionAttributes smart constructor.

scheduleLambdaFunctionDecisionAttributes Source

Creates a value of ScheduleLambdaFunctionDecisionAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

slfdaInput :: Lens' ScheduleLambdaFunctionDecisionAttributes (Maybe Text) Source

The input provided to the AWS Lambda function.

slfdaStartToCloseTimeout :: Lens' ScheduleLambdaFunctionDecisionAttributes (Maybe Text) Source

If set, specifies the maximum duration the function may take to execute.

slfdaId :: Lens' ScheduleLambdaFunctionDecisionAttributes Text Source

Required. The SWF id of the AWS Lambda task.

The specified string must not start or end with whitespace. It must not contain a : (colon), \/ (slash), '|' (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.

slfdaName :: Lens' ScheduleLambdaFunctionDecisionAttributes Text Source

Required. The name of the AWS Lambda function to invoke.

ScheduleLambdaFunctionFailedEventAttributes

slffeaId :: Lens' ScheduleLambdaFunctionFailedEventAttributes Text Source

The unique Amazon SWF ID of the AWS Lambda task.

slffeaName :: Lens' ScheduleLambdaFunctionFailedEventAttributes Text Source

The name of the scheduled AWS Lambda function.

slffeaCause :: Lens' ScheduleLambdaFunctionFailedEventAttributes ScheduleLambdaFunctionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

slffeaDecisionTaskCompletedEventId :: Lens' ScheduleLambdaFunctionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

SignalExternalWorkflowExecutionDecisionAttributes

data SignalExternalWorkflowExecutionDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: signalExternalWorkflowExecutionDecisionAttributes smart constructor.

sewedaControl :: Lens' SignalExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.

sewedaInput :: Lens' SignalExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source

Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.

sewedaRunId :: Lens' SignalExternalWorkflowExecutionDecisionAttributes (Maybe Text) Source

The runId of the workflow execution to be signaled.

sewedaWorkflowId :: Lens' SignalExternalWorkflowExecutionDecisionAttributes Text Source

Required. The workflowId of the workflow execution to be signaled.

sewedaSignalName :: Lens' SignalExternalWorkflowExecutionDecisionAttributes Text Source

Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.

SignalExternalWorkflowExecutionFailedEventAttributes

sewefeaRunId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes (Maybe Text) Source

The runId of the external workflow execution that the signal was being delivered to.

sewefeaWorkflowId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes Text Source

The workflowId of the external workflow execution that the signal was being delivered to.

sewefeaCause :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes SignalExternalWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

sewefeaInitiatedEventId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes Integer Source

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

sewefeaDecisionTaskCompletedEventId :: Lens' SignalExternalWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

SignalExternalWorkflowExecutionInitiatedEventAttributes

seweieaControl :: Lens' SignalExternalWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

Optional. data attached to the event that can be used by the decider in subsequent decision tasks.

seweieaRunId :: Lens' SignalExternalWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

The runId of the external workflow execution to send the signal to.

seweieaDecisionTaskCompletedEventId :: Lens' SignalExternalWorkflowExecutionInitiatedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

StartChildWorkflowExecutionDecisionAttributes

data StartChildWorkflowExecutionDecisionAttributes Source

Provides 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: startChildWorkflowExecutionDecisionAttributes smart constructor.

scwedaControl :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.

scwedaTagList :: Lens' StartChildWorkflowExecutionDecisionAttributes [Text] Source

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

scwedaTaskStartToCloseTimeout :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

scwedaLambdaRole :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.

scwedaInput :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source

The input to be provided to the workflow execution.

scwedaExecutionStartToCloseTimeout :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.

scwedaTaskList :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe TaskList) Source

The name of the task list to be used for decision tasks of the child workflow execution.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), \/ (slash), '|' (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.

scwedaTaskPriority :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe Text) Source

Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

scwedaChildPolicy :: Lens' StartChildWorkflowExecutionDecisionAttributes (Maybe ChildPolicy) Source

Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.

scwedaWorkflowType :: Lens' StartChildWorkflowExecutionDecisionAttributes WorkflowType Source

Required. The type of the workflow execution to be started.

scwedaWorkflowId :: Lens' StartChildWorkflowExecutionDecisionAttributes Text Source

Required. The workflowId of the workflow execution.

The specified string must not start or end with whitespace. It must not contain a : (colon), \/ (slash), '|' (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.

StartChildWorkflowExecutionFailedEventAttributes

scwefeaCause :: Lens' StartChildWorkflowExecutionFailedEventAttributes StartChildWorkflowExecutionFailedCause Source

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

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.

scwefeaWorkflowId :: Lens' StartChildWorkflowExecutionFailedEventAttributes Text Source

The workflowId of the child workflow execution.

scwefeaInitiatedEventId :: Lens' StartChildWorkflowExecutionFailedEventAttributes Integer Source

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

scwefeaDecisionTaskCompletedEventId :: Lens' StartChildWorkflowExecutionFailedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

StartChildWorkflowExecutionInitiatedEventAttributes

scweieaControl :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

scweieaTagList :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes [Text] Source

The list of tags to associated with the child workflow execution.

scweieaTaskStartToCloseTimeout :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

The maximum duration allowed for the decision tasks for this workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

scweieaLambdaRole :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

scweieaInput :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

The inputs provided to the child workflow execution (if any).

scweieaExecutionStartToCloseTimeout :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

scweieaTaskPriority :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source

Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's MIN_VALUE (-2147483648) to MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

scweieaTaskList :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes TaskList Source

The name of the task list used for the decision tasks of the child workflow execution.

scweieaDecisionTaskCompletedEventId :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes Integer Source

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

scweieaChildPolicy :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes ChildPolicy Source

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.

StartLambdaFunctionFailedEventAttributes