AWS SDK Version 3 for .NET
API Reference

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

Classes

NameDescription
Class ActivityTask

Unit of work sent to an activity worker.

Class ActivityTaskCanceledEventAttributes

Provides the details of the ActivityTaskCanceled event.

Class ActivityTaskCancelRequestedEventAttributes

Provides the details of the ActivityTaskCancelRequested event.

Class ActivityTaskCompletedEventAttributes

Provides the details of the ActivityTaskCompleted event.

Class ActivityTaskFailedEventAttributes

Provides the details of the ActivityTaskFailed event.

Class ActivityTaskScheduledEventAttributes

Provides the details of the ActivityTaskScheduled event.

Class ActivityTaskStartedEventAttributes

Provides the details of the ActivityTaskStarted event.

Class ActivityTaskStatus

Status information about an activity task.

Class ActivityTaskTimedOutEventAttributes

Provides the details of the ActivityTaskTimedOut event.

Class ActivityType

Represents an activity type.

Class ActivityTypeConfiguration

Configuration settings registered with the activity type.

Class ActivityTypeDetail

Detailed information about an activity type.

Class ActivityTypeInfo

Detailed information about an activity type.

Class ActivityTypeInfos

Contains a paginated list of activity type information structures.

Class CancelTimerDecisionAttributes

Provides the details of the CancelTimer decision.

Access Control

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

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

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

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

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

Class CancelTimerFailedEventAttributes

Provides the details of the CancelTimerFailed event.

Class CancelWorkflowExecutionDecisionAttributes

Provides the details of the CancelWorkflowExecution decision.

Access Control

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

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

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

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

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

Class CancelWorkflowExecutionFailedEventAttributes

Provides the details of the CancelWorkflowExecutionFailed event.

Class ChildWorkflowExecutionCanceledEventAttributes

Provide details of the ChildWorkflowExecutionCanceled event.

Class ChildWorkflowExecutionCompletedEventAttributes

Provides the details of the ChildWorkflowExecutionCompleted event.

Class ChildWorkflowExecutionFailedEventAttributes

Provides the details of the ChildWorkflowExecutionFailed event.

Class ChildWorkflowExecutionStartedEventAttributes

Provides the details of the ChildWorkflowExecutionStarted event.

Class ChildWorkflowExecutionTerminatedEventAttributes

Provides the details of the ChildWorkflowExecutionTerminated event.

Class ChildWorkflowExecutionTimedOutEventAttributes

Provides the details of the ChildWorkflowExecutionTimedOut event.

Class CloseStatusFilter

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

Class CompleteWorkflowExecutionDecisionAttributes

Provides the details of the CompleteWorkflowExecution decision.

Access Control

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

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

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

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

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

Class CompleteWorkflowExecutionFailedEventAttributes

Provides the details of the CompleteWorkflowExecutionFailed event.

Class ContinueAsNewWorkflowExecutionDecisionAttributes

Provides the details of the ContinueAsNewWorkflowExecution decision.

Access Control

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

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

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

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

    • tag – A tag used to identify the workflow execution

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

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

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

Class ContinueAsNewWorkflowExecutionFailedEventAttributes

Provides the details of the ContinueAsNewWorkflowExecutionFailed event.

Class CountClosedWorkflowExecutionsRequest

Container for the parameters to the CountClosedWorkflowExecutions operation. Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

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

Class CountClosedWorkflowExecutionsResponse

Contains the response data from the CountClosedWorkflowExecutions operation.

Class CountOpenWorkflowExecutionsRequest

Container for the parameters to the CountOpenWorkflowExecutions operation. Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

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

Class CountOpenWorkflowExecutionsResponse

Contains the response data from the CountOpenWorkflowExecutions operation.

Class CountPendingActivityTasksRequest

Container for the parameters to the CountPendingActivityTasks operation. Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action'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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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

Class CountPendingActivityTasksResponse

Contains the response data from the CountPendingActivityTasks operation.

Class CountPendingDecisionTasksRequest

Container for the parameters to the CountPendingDecisionTasks operation. Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action'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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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

Class CountPendingDecisionTasksResponse

Contains the response data from the CountPendingDecisionTasks operation.

Class Decision

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

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

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

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

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

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

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

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

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

  • ScheduleActivityTask – Schedules an activity task.

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

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

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

Access Control

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

Decision Failure

Decisions can fail for several reasons

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

  • A limit on your account was reached.

  • The decision lacks sufficient permissions.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

How to Code a Decision

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

Class DecisionTask

A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

Class DecisionTaskCompletedEventAttributes

Provides the details of the DecisionTaskCompleted event.

Class DecisionTaskScheduledEventAttributes

Provides details about the DecisionTaskScheduled event.

Class DecisionTaskStartedEventAttributes

Provides the details of the DecisionTaskStarted event.

Class DecisionTaskTimedOutEventAttributes

Provides the details of the DecisionTaskTimedOut event.

Class DefaultUndefinedException

SimpleWorkflow exception

Class DeprecateActivityTypeRequest

Container for the parameters to the DeprecateActivityType operation. Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.

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

Class DeprecateActivityTypeResponse

This is the response object from the DeprecateActivityType operation.

Class DeprecateDomainRequest

Container for the parameters to the DeprecateDomain operation. Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

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

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

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

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

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

Class DeprecateDomainResponse

This is the response object from the DeprecateDomain operation.

Class DeprecateWorkflowTypeRequest

Container for the parameters to the DeprecateWorkflowType operation. Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

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

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

Class DeprecateWorkflowTypeResponse

This is the response object from the DeprecateWorkflowType operation.

Class DescribeActivityTypeRequest

Container for the parameters to the DescribeActivityType operation. Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action'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.

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

Class DescribeActivityTypeResponse

Contains the response data from the DescribeActivityType operation.

Class DescribeDomainRequest

Container for the parameters to the DescribeDomain operation. Returns information about the specified domain, including description and status.

Access Control

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

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

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

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

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

Class DescribeDomainResponse

Contains the response data from the DescribeDomain operation.

Class DescribeWorkflowExecutionRequest

Container for the parameters to the DescribeWorkflowExecution operation. Returns information about the specified workflow execution including its type and some statistics.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

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

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

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

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

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

Class DescribeWorkflowExecutionResponse

Contains the response data from the DescribeWorkflowExecution operation.

Class DescribeWorkflowTypeRequest

Container for the parameters to the DescribeWorkflowType operation. Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action'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.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

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

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

Class DescribeWorkflowTypeResponse

Contains the response data from the DescribeWorkflowType operation.

Class DomainAlreadyExistsException

SimpleWorkflow exception

Class DomainConfiguration

Contains the configuration settings of a domain.

Class DomainDeprecatedException

SimpleWorkflow exception

Class DomainDetail

Contains details of a domain.

Class DomainInfo

Contains general information about a domain.

Class DomainInfos

Contains a paginated collection of DomainInfo structures.

Class ExecutionTimeFilter

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.

Class ExternalWorkflowExecutionCancelRequestedEventAttributes

Provides the details of the ExternalWorkflowExecutionCancelRequested event.

Class ExternalWorkflowExecutionSignaledEventAttributes

Provides the details of the ExternalWorkflowExecutionSignaled event.

Class FailWorkflowExecutionDecisionAttributes

Provides the details of the FailWorkflowExecution decision.

Access Control

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

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

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

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

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

Class FailWorkflowExecutionFailedEventAttributes

Provides the details of the FailWorkflowExecutionFailed event.

Class GetWorkflowExecutionHistoryRequest

Container for the parameters to the GetWorkflowExecutionHistory operation. Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

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

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

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

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

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

Class GetWorkflowExecutionHistoryResponse

Contains the response data from the GetWorkflowExecutionHistory operation.

Class History

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

Class HistoryEvent

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

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

  • ActivityTaskCanceled – The activity task was successfully canceled.

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

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

  • ActivityTaskScheduled – An activity task was scheduled for execution.

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

  • ActivityTaskTimedOut – The activity task timed out.

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

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

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

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

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

  • ChildWorkflowExecutionStarted – A child workflow execution was successfully started.

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

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

  • CompleteWorkflowExecutionFailed – The workflow execution failed to complete.

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

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

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

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

  • DecisionTaskTimedOut – The decision task timed out.

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

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

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

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

  • RecordMarkerFailed – A RecordMarker decision was returned as failed.

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

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

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

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

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

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

  • StartActivityTaskFailed – A scheduled activity task failed to start.

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

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

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

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

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

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

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

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

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

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

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

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

  • WorkflowExecutionStarted – The workflow execution was started.

  • WorkflowExecutionTerminated – The workflow execution was terminated.

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

Class LambdaFunctionCompletedEventAttributes

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

Class LambdaFunctionFailedEventAttributes

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

Class LambdaFunctionScheduledEventAttributes

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

Class LambdaFunctionStartedEventAttributes

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

Class LambdaFunctionTimedOutEventAttributes

Provides details of the LambdaFunctionTimedOut event.

Class LimitExceededException

SimpleWorkflow exception

Class ListActivityTypesRequest

Container for the parameters to the ListActivityTypes operation. Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Access Control

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

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

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

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

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

Class ListActivityTypesResponse

Contains the response data from the ListActivityTypes operation.

Class ListClosedWorkflowExecutionsRequest

Container for the parameters to the ListClosedWorkflowExecutions operation. Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

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

Class ListClosedWorkflowExecutionsResponse

Contains the response data from the ListClosedWorkflowExecutions operation.

Class ListDomainsRequest

Container for the parameters to the ListDomains operation. Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

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

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.

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

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

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

Class ListDomainsResponse

Contains the response data from the ListDomains operation.

Class ListOpenWorkflowExecutionsRequest

Container for the parameters to the ListOpenWorkflowExecutions operation. Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.

    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

    • typeFilter.name: String constraint. The key is swf:typeFilter.name.

    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

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

Class ListOpenWorkflowExecutionsResponse

Contains the response data from the ListOpenWorkflowExecutions operation.

Class ListWorkflowTypesRequest

Container for the parameters to the ListWorkflowTypes operation. Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

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

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

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

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

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

Class ListWorkflowTypesResponse

Contains the response data from the ListWorkflowTypes operation.

Class MarkerRecordedEventAttributes

Provides the details of the MarkerRecorded event.

Class OperationNotPermittedException

SimpleWorkflow exception

Class PendingTaskCount

Contains the count of tasks in a task list.

Class PollForActivityTaskRequest

Container for the parameters to the PollForActivityTask operation. Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

Access Control

You can use IAM policies to control this action'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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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

Class PollForActivityTaskResponse

Contains the response data from the PollForActivityTask operation.

Class PollForDecisionTaskRequest

Container for the parameters to the PollForDecisionTask operation. Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

Access Control

You can use IAM policies to control this action'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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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

Class PollForDecisionTaskResponse

Contains the response data from the PollForDecisionTask operation.

Class RecordActivityTaskHeartbeatRequest

Container for the parameters to the RecordActivityTaskHeartbeat operation. Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

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

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

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

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

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

Class RecordActivityTaskHeartbeatResponse

Contains the response data from the RecordActivityTaskHeartbeat operation.

Class RecordMarkerDecisionAttributes

Provides the details of the RecordMarker decision.

Access Control

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

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

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

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

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

Class RecordMarkerFailedEventAttributes

Provides the details of the RecordMarkerFailed event.

Class RegisterActivityTypeRequest

Container for the parameters to the RegisterActivityType operation. Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

Access Control

You can use IAM policies to control this action'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.

    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

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

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

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

Class RegisterActivityTypeResponse

This is the response object from the RegisterActivityType operation.

Class RegisterDomainRequest

Container for the parameters to the RegisterDomain operation. Registers a new domain.

Access Control

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

  • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.

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

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

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

Class RegisterDomainResponse

This is the response object from the RegisterDomain operation.

Class RegisterWorkflowTypeRequest

Container for the parameters to the RegisterWorkflowType operation. Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action'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.

    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

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

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

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

Class RegisterWorkflowTypeResponse

This is the response object from the RegisterWorkflowType operation.

Class RequestCancelActivityTaskDecisionAttributes

Provides the details of the RequestCancelActivityTask decision.

Access Control

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

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

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

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

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

Class RequestCancelActivityTaskFailedEventAttributes

Provides the details of the RequestCancelActivityTaskFailed event.

Class RequestCancelExternalWorkflowExecutionDecisionAttributes

Provides the details of the RequestCancelExternalWorkflowExecution decision.

Access Control

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

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

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

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

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

Class RequestCancelExternalWorkflowExecutionFailedEventAttributes

Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.

Class RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.

Class RequestCancelWorkflowExecutionRequest

Container for the parameters to the RequestCancelWorkflowExecution operation. Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

Access Control

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

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

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

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

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

Class RequestCancelWorkflowExecutionResponse

This is the response object from the RequestCancelWorkflowExecution operation.

Class RespondActivityTaskCanceledRequest

Container for the parameters to the RespondActivityTaskCanceled operation. Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

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

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

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

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

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

Class RespondActivityTaskCanceledResponse

This is the response object from the RespondActivityTaskCanceled operation.

Class RespondActivityTaskCompletedRequest

Container for the parameters to the RespondActivityTaskCompleted operation. Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

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

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

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

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

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

Class RespondActivityTaskCompletedResponse

This is the response object from the RespondActivityTaskCompleted operation.

Class RespondActivityTaskFailedRequest

Container for the parameters to the RespondActivityTaskFailed operation. Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

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

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

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

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

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

Class RespondActivityTaskFailedResponse

This is the response object from the RespondActivityTaskFailed operation.

Class RespondDecisionTaskCompletedRequest

Container for the parameters to the RespondDecisionTaskCompleted operation. Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Class RespondDecisionTaskCompletedResponse

This is the response object from the RespondDecisionTaskCompleted operation.

Class Run

Specifies the runId of a workflow execution.

Class ScheduleActivityTaskDecisionAttributes

Provides the details of the ScheduleActivityTask decision.

Access Control

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

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

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

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

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

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

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

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

Class ScheduleActivityTaskFailedEventAttributes

Provides the details of the ScheduleActivityTaskFailed event.

Class ScheduleLambdaFunctionDecisionAttributes

Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.

Class ScheduleLambdaFunctionFailedEventAttributes

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

Class SignalExternalWorkflowExecutionDecisionAttributes

Provides the details of the SignalExternalWorkflowExecution decision.

Access Control

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

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

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

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

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

Class SignalExternalWorkflowExecutionFailedEventAttributes

Provides the details of the SignalExternalWorkflowExecutionFailed event.

Class SignalExternalWorkflowExecutionInitiatedEventAttributes

Provides the details of the SignalExternalWorkflowExecutionInitiated event.

Class SignalWorkflowExecutionRequest

Container for the parameters to the SignalWorkflowExecution operation. Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

If the specified workflow execution isn't open, this method fails with UnknownResource.

Access Control

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

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

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

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

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

Class SignalWorkflowExecutionResponse

This is the response object from the SignalWorkflowExecution operation.

Class StartChildWorkflowExecutionDecisionAttributes

Provides the details of the StartChildWorkflowExecution decision.

Access Control

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

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

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

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

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

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

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

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

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

Class StartChildWorkflowExecutionFailedEventAttributes

Provides the details of the StartChildWorkflowExecutionFailed event.

Class StartChildWorkflowExecutionInitiatedEventAttributes

Provides the details of the StartChildWorkflowExecutionInitiated event.

Class StartLambdaFunctionFailedEventAttributes

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

Class StartTimerDecisionAttributes

Provides the details of the StartTimer decision.

Access Control

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

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

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

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

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

Class StartTimerFailedEventAttributes

Provides the details of the StartTimerFailed event.

Class StartWorkflowExecutionRequest

Container for the parameters to the StartWorkflowExecution operation. Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action'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.0: The key is swf:tagList.member.0.

    • tagList.member.1: The key is swf:tagList.member.1.

    • tagList.member.2: The key is swf:tagList.member.2.

    • tagList.member.3: The key is swf:tagList.member.3.

    • tagList.member.4: The key is swf:tagList.member.4.

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

    • workflowType.name: String constraint. The key is swf:workflowType.name.

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

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

Class StartWorkflowExecutionResponse

Contains the response data from the StartWorkflowExecution operation.

Class TagFilter

Used to filter the workflow executions in visibility APIs based on a tag.

Class TaskList

Represents a task list.

Class TerminateWorkflowExecutionRequest

Container for the parameters to the TerminateWorkflowExecution operation. Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

If the identified workflow execution was in progress, it is terminated immediately.

If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

Access Control

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

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

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

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

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

Class TerminateWorkflowExecutionResponse

This is the response object from the TerminateWorkflowExecution operation.

Class TimerCanceledEventAttributes

Provides the details of the TimerCanceled event.

Class TimerFiredEventAttributes

Provides the details of the TimerFired event.

Class TimerStartedEventAttributes

Provides the details of the TimerStarted event.

Class TypeAlreadyExistsException

SimpleWorkflow exception

Class TypeDeprecatedException

SimpleWorkflow exception

Class UnknownResourceException

SimpleWorkflow exception

Class WorkflowExecution

Represents a workflow execution.

Class WorkflowExecutionAlreadyStartedException

SimpleWorkflow exception

Class WorkflowExecutionCanceledEventAttributes

Provides the details of the WorkflowExecutionCanceled event.

Class WorkflowExecutionCancelRequestedEventAttributes

Provides the details of the WorkflowExecutionCancelRequested event.

Class WorkflowExecutionCompletedEventAttributes

Provides the details of the WorkflowExecutionCompleted event.

Class WorkflowExecutionConfiguration

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

Class WorkflowExecutionContinuedAsNewEventAttributes

Provides the details of the WorkflowExecutionContinuedAsNew event.

Class WorkflowExecutionCount

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

Class WorkflowExecutionDetail

Contains details about a workflow execution.

Class WorkflowExecutionFailedEventAttributes

Provides the details of the WorkflowExecutionFailed event.

Class WorkflowExecutionFilter

Used to filter the workflow executions in visibility APIs by their workflowId.

Class WorkflowExecutionInfo

Contains information about a workflow execution.

Class WorkflowExecutionInfos

Contains a paginated list of information about workflow executions.

Class WorkflowExecutionOpenCounts

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

Class WorkflowExecutionSignaledEventAttributes

Provides the details of the WorkflowExecutionSignaled event.

Class WorkflowExecutionStartedEventAttributes

Provides details of WorkflowExecutionStarted event.

Class WorkflowExecutionTerminatedEventAttributes

Provides the details of the WorkflowExecutionTerminated event.

Class WorkflowExecutionTimedOutEventAttributes

Provides the details of the WorkflowExecutionTimedOut event.

Class WorkflowType

Represents a workflow type.

Class WorkflowTypeConfiguration

The configuration settings of a workflow type.

Class WorkflowTypeDetail

Contains details about a workflow type.

Class WorkflowTypeFilter

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

Class WorkflowTypeInfo

Contains information about a workflow type.

Class WorkflowTypeInfos

Contains a paginated list of information structures about workflow types.