SDK for PHP 3.x

Client: Aws\Swf\SwfClient
Service ID: swf
Version: 2012-01-25

This page describes the parameters and results for the operations of the Amazon Simple Workflow Service (2012-01-25), and shows how to use the Aws\Swf\SwfClient object to call the described operations. This documentation is specific to the 2012-01-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CountClosedWorkflowExecutions ( array $params = [] )
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
CountOpenWorkflowExecutions ( array $params = [] )
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
CountPendingActivityTasks ( array $params = [] )
Returns the estimated number of activity tasks in the specified task list.
CountPendingDecisionTasks ( array $params = [] )
Returns the estimated number of decision tasks in the specified task list.
DeleteActivityType ( array $params = [] )
Deletes the specified activity type.
DeleteWorkflowType ( array $params = [] )
Deletes the specified workflow type.
DeprecateActivityType ( array $params = [] )
Deprecates the specified activity type.
DeprecateDomain ( array $params = [] )
Deprecates the specified domain.
DeprecateWorkflowType ( array $params = [] )
Deprecates the specified workflow type.
DescribeActivityType ( array $params = [] )
Returns information about the specified activity type.
DescribeDomain ( array $params = [] )
Returns information about the specified domain, including description and status.
DescribeWorkflowExecution ( array $params = [] )
Returns information about the specified workflow execution including its type and some statistics.
DescribeWorkflowType ( array $params = [] )
Returns information about the specified workflow type.
GetWorkflowExecutionHistory ( array $params = [] )
Returns the history of the specified workflow execution.
ListActivityTypes ( array $params = [] )
Returns information about all activities registered in the specified domain that match the specified name and registration status.
ListClosedWorkflowExecutions ( array $params = [] )
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
ListDomains ( array $params = [] )
Returns the list of domains registered in the account.
ListOpenWorkflowExecutions ( array $params = [] )
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
ListTagsForResource ( array $params = [] )
List tags for a given domain.
ListWorkflowTypes ( array $params = [] )
Returns information about workflow types in the specified domain.
PollForActivityTask ( array $params = [] )
Used by workers to get an ActivityTask from the specified activity taskList.
PollForDecisionTask ( array $params = [] )
Used by deciders to get a DecisionTask from the specified decision taskList.
RecordActivityTaskHeartbeat ( array $params = [] )
Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress.
RegisterActivityType ( array $params = [] )
Registers a new activity type along with its configuration settings in the specified domain.
RegisterDomain ( array $params = [] )
Registers a new domain.
RegisterWorkflowType ( array $params = [] )
Registers a new workflow type and its configuration settings in the specified domain.
RequestCancelWorkflowExecution ( array $params = [] )
Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId.
RespondActivityTaskCanceled ( array $params = [] )
Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled.
RespondActivityTaskCompleted ( array $params = [] )
Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided).
RespondActivityTaskFailed ( array $params = [] )
Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified).
RespondDecisionTaskCompleted ( array $params = [] )
Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed.
SignalWorkflowExecution ( array $params = [] )
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.
StartWorkflowExecution ( array $params = [] )
Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
TagResource ( array $params = [] )
Add a tag to a Amazon SWF domain.
TerminateWorkflowExecution ( array $params = [] )
Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId.
UndeprecateActivityType ( array $params = [] )
Undeprecates a previously deprecated activity type.
UndeprecateDomain ( array $params = [] )
Undeprecates a previously deprecated domain.
UndeprecateWorkflowType ( array $params = [] )
Undeprecates a previously deprecated workflow type.
UntagResource ( array $params = [] )
Remove a tag from a Amazon SWF domain.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetWorkflowExecutionHistory
ListActivityTypes
ListClosedWorkflowExecutions
ListDomains
ListOpenWorkflowExecutions
ListWorkflowTypes
PollForDecisionTask

Operations

CountClosedWorkflowExecutions

$result = $client->countClosedWorkflowExecutions([/* ... */]);
$promise = $client->countClosedWorkflowExecutionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->countClosedWorkflowExecutions([
    'closeStatusFilter' => [
        'status' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT', // REQUIRED
    ],
    'closeTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'startTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Members
closeStatusFilter
Type: CloseStatusFilter structure

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

closeTimeFilter
Type: ExecutionTimeFilter structure

If specified, only workflow executions that meet the close time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

domain
Required: Yes
Type: string

The name of the domain containing the workflow executions to count.

executionFilter
Type: WorkflowExecutionFilter structure

If specified, only workflow executions matching the WorkflowId in the filter are counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

startTimeFilter
Type: ExecutionTimeFilter structure

If specified, only workflow executions that meet the start time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

tagFilter
Type: TagFilter structure

If specified, only executions that have a tag that matches the filter are counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

typeFilter
Type: WorkflowTypeFilter structure

If specified, indicates the type of the workflow executions to be counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Members
count
Required: Yes
Type: int

The number of workflow executions.

truncated
Type: boolean

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.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

CountOpenWorkflowExecutions

$result = $client->countOpenWorkflowExecutions([/* ... */]);
$promise = $client->countOpenWorkflowExecutionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->countOpenWorkflowExecutions([
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'startTimeFilter' => [ // REQUIRED
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain containing the workflow executions to count.

executionFilter
Type: WorkflowExecutionFilter structure

If specified, only workflow executions matching the WorkflowId in the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

startTimeFilter
Required: Yes
Type: ExecutionTimeFilter structure

Specifies the start time criteria that workflow executions must meet in order to be counted.

tagFilter
Type: TagFilter structure

If specified, only executions that have a tag that matches the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

typeFilter
Type: WorkflowTypeFilter structure

Specifies the type of the workflow executions to be counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Members
count
Required: Yes
Type: int

The number of workflow executions.

truncated
Type: boolean

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.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

CountPendingActivityTasks

$result = $client->countPendingActivityTasks([/* ... */]);
$promise = $client->countPendingActivityTasksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->countPendingActivityTasks([
    'domain' => '<string>', // REQUIRED
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain that contains the task list.

taskList
Required: Yes
Type: TaskList structure

The name of the task list.

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Members
count
Required: Yes
Type: int

The number of tasks in the task list.

truncated
Type: boolean

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.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

CountPendingDecisionTasks

$result = $client->countPendingDecisionTasks([/* ... */]);
$promise = $client->countPendingDecisionTasksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->countPendingDecisionTasks([
    'domain' => '<string>', // REQUIRED
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain that contains the task list.

taskList
Required: Yes
Type: TaskList structure

The name of the task list.

Result Syntax

[
    'count' => <integer>,
    'truncated' => true || false,
]

Result Details

Members
count
Required: Yes
Type: int

The number of tasks in the task list.

truncated
Type: boolean

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.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeleteActivityType

$result = $client->deleteActivityType([/* ... */]);
$promise = $client->deleteActivityTypeAsync([/* ... */]);

Deletes the specified activity type.

Note: Prior to deletion, activity types must first be deprecated.

After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run.

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.

Parameter Syntax

$result = $client->deleteActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Members
activityType
Required: Yes
Type: ActivityType structure

The activity type to delete.

domain
Required: Yes
Type: string

The name of the domain in which the activity type is registered.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TypeNotDeprecatedFault:

Returned when the resource type has not been deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeleteWorkflowType

$result = $client->deleteWorkflowType([/* ... */]);
$promise = $client->deleteWorkflowTypeAsync([/* ... */]);

Deletes the specified workflow type.

Note: Prior to deletion, workflow types must first be deprecated.

After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted will continue to run.

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.

Parameter Syntax

$result = $client->deleteWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain in which the workflow type is registered.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TypeNotDeprecatedFault:

Returned when the resource type has not been deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeprecateActivityType

$result = $client->deprecateActivityType([/* ... */]);
$promise = $client->deprecateActivityTypeAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->deprecateActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Members
activityType
Required: Yes
Type: ActivityType structure

The activity type to deprecate.

domain
Required: Yes
Type: string

The name of the domain in which the activity type is registered.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TypeDeprecatedFault:

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

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeprecateDomain

$result = $client->deprecateDomain([/* ... */]);
$promise = $client->deprecateDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deprecateDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the domain to deprecate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

DomainDeprecatedFault:

Returned when the specified domain has been deprecated.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DeprecateWorkflowType

$result = $client->deprecateWorkflowType([/* ... */]);
$promise = $client->deprecateWorkflowTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deprecateWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain in which the workflow type is registered.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type to deprecate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TypeDeprecatedFault:

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

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeActivityType

$result = $client->describeActivityType([/* ... */]);
$promise = $client->describeActivityTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Members
activityType
Required: Yes
Type: ActivityType structure

The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

domain
Required: Yes
Type: string

The name of the domain in which the activity type is registered.

Result Syntax

[
    'configuration' => [
        'defaultTaskHeartbeatTimeout' => '<string>',
        'defaultTaskList' => [
            'name' => '<string>',
        ],
        'defaultTaskPriority' => '<string>',
        'defaultTaskScheduleToCloseTimeout' => '<string>',
        'defaultTaskScheduleToStartTimeout' => '<string>',
        'defaultTaskStartToCloseTimeout' => '<string>',
    ],
    'typeInfo' => [
        'activityType' => [
            'name' => '<string>',
            'version' => '<string>',
        ],
        'creationDate' => <DateTime>,
        'deprecationDate' => <DateTime>,
        'description' => '<string>',
        'status' => 'REGISTERED|DEPRECATED',
    ],
]

Result Details

Members
configuration
Required: Yes
Type: ActivityTypeConfiguration structure

The configuration settings registered with the activity type.

typeInfo
Required: Yes
Type: ActivityTypeInfo structure

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

  • REGISTERED – The type is registered and available. Workers supporting this type should be running.

  • DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeDomain

$result = $client->describeDomain([/* ... */]);
$promise = $client->describeDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the domain to describe.

Result Syntax

[
    'configuration' => [
        'workflowExecutionRetentionPeriodInDays' => '<string>',
    ],
    'domainInfo' => [
        'arn' => '<string>',
        'description' => '<string>',
        'name' => '<string>',
        'status' => 'REGISTERED|DEPRECATED',
    ],
]

Result Details

Members
configuration
Required: Yes
Type: DomainConfiguration structure

The domain configuration. Currently, this includes only the domain's retention period.

domainInfo
Required: Yes
Type: DomainInfo structure

The basic information about a domain, such as its name, status, and description.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeWorkflowExecution

$result = $client->describeWorkflowExecution([/* ... */]);
$promise = $client->describeWorkflowExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeWorkflowExecution([
    'domain' => '<string>', // REQUIRED
    'execution' => [ // REQUIRED
        'runId' => '<string>', // REQUIRED
        'workflowId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain containing the workflow execution.

execution
Required: Yes
Type: WorkflowExecution structure

The workflow execution to describe.

Result Syntax

[
    'executionConfiguration' => [
        'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
        'executionStartToCloseTimeout' => '<string>',
        'lambdaRole' => '<string>',
        'taskList' => [
            'name' => '<string>',
        ],
        'taskPriority' => '<string>',
        'taskStartToCloseTimeout' => '<string>',
    ],
    'executionInfo' => [
        'cancelRequested' => true || false,
        'closeStatus' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT',
        'closeTimestamp' => <DateTime>,
        'execution' => [
            'runId' => '<string>',
            'workflowId' => '<string>',
        ],
        'executionStatus' => 'OPEN|CLOSED',
        'parent' => [
            'runId' => '<string>',
            'workflowId' => '<string>',
        ],
        'startTimestamp' => <DateTime>,
        'tagList' => ['<string>', ...],
        'workflowType' => [
            'name' => '<string>',
            'version' => '<string>',
        ],
    ],
    'latestActivityTaskTimestamp' => <DateTime>,
    'latestExecutionContext' => '<string>',
    'openCounts' => [
        'openActivityTasks' => <integer>,
        'openChildWorkflowExecutions' => <integer>,
        'openDecisionTasks' => <integer>,
        'openLambdaFunctions' => <integer>,
        'openTimers' => <integer>,
    ],
]

Result Details

Members
executionConfiguration
Required: Yes
Type: WorkflowExecutionConfiguration structure

The configuration settings for this workflow execution including timeout values, tasklist etc.

executionInfo
Required: Yes
Type: WorkflowExecutionInfo structure

Information about the workflow execution.

latestActivityTaskTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

latestExecutionContext
Type: string

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

openCounts
Required: Yes
Type: WorkflowExecutionOpenCounts structure

The number of tasks for this workflow execution. This includes open and closed tasks of all types.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DescribeWorkflowType

$result = $client->describeWorkflowType([/* ... */]);
$promise = $client->describeWorkflowTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain in which this workflow type is registered.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type to describe.

Result Syntax

[
    'configuration' => [
        'defaultChildPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
        'defaultExecutionStartToCloseTimeout' => '<string>',
        'defaultLambdaRole' => '<string>',
        'defaultTaskList' => [
            'name' => '<string>',
        ],
        'defaultTaskPriority' => '<string>',
        'defaultTaskStartToCloseTimeout' => '<string>',
    ],
    'typeInfo' => [
        'creationDate' => <DateTime>,
        'deprecationDate' => <DateTime>,
        'description' => '<string>',
        'status' => 'REGISTERED|DEPRECATED',
        'workflowType' => [
            'name' => '<string>',
            'version' => '<string>',
        ],
    ],
]

Result Details

Members
configuration
Required: Yes
Type: WorkflowTypeConfiguration structure

Configuration settings of the workflow type registered through RegisterWorkflowType

typeInfo
Required: Yes
Type: WorkflowTypeInfo structure

General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

  • REGISTERED – The type is registered and available. Workers supporting this type should be running.

  • DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

GetWorkflowExecutionHistory

$result = $client->getWorkflowExecutionHistory([/* ... */]);
$promise = $client->getWorkflowExecutionHistoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getWorkflowExecutionHistory([
    'domain' => '<string>', // REQUIRED
    'execution' => [ // REQUIRED
        'runId' => '<string>', // REQUIRED
        'workflowId' => '<string>', // REQUIRED
    ],
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain containing the workflow execution.

execution
Required: Yes
Type: WorkflowExecution structure

Specifies the workflow execution for which to return the history.

maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

reverseOrder
Type: boolean

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Result Syntax

[
    'events' => [
        [
            'activityTaskCancelRequestedEventAttributes' => [
                'activityId' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'activityTaskCanceledEventAttributes' => [
                'details' => '<string>',
                'latestCancelRequestedEventId' => <integer>,
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskScheduledEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'heartbeatTimeout' => '<string>',
                'input' => '<string>',
                'scheduleToCloseTimeout' => '<string>',
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'activityTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'activityTaskTimedOutEventAttributes' => [
                'details' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START|SCHEDULE_TO_CLOSE|HEARTBEAT',
            ],
            'cancelTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'cancelWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'childWorkflowExecutionCanceledEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionCompletedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'result' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionFailedEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'reason' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionStartedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTerminatedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTimedOutEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'completeWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'continueAsNewWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|WORKFLOW_TYPE_DEPRECATED|WORKFLOW_TYPE_DOES_NOT_EXIST|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'decisionTaskCompletedEventAttributes' => [
                'executionContext' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskListScheduleToStartTimeout' => '<string>',
            ],
            'decisionTaskScheduledEventAttributes' => [
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'decisionTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'decisionTaskTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START',
            ],
            'eventId' => <integer>,
            'eventTimestamp' => <DateTime>,
            'eventType' => 'WorkflowExecutionStarted|WorkflowExecutionCancelRequested|WorkflowExecutionCompleted|CompleteWorkflowExecutionFailed|WorkflowExecutionFailed|FailWorkflowExecutionFailed|WorkflowExecutionTimedOut|WorkflowExecutionCanceled|CancelWorkflowExecutionFailed|WorkflowExecutionContinuedAsNew|ContinueAsNewWorkflowExecutionFailed|WorkflowExecutionTerminated|DecisionTaskScheduled|DecisionTaskStarted|DecisionTaskCompleted|DecisionTaskTimedOut|ActivityTaskScheduled|ScheduleActivityTaskFailed|ActivityTaskStarted|ActivityTaskCompleted|ActivityTaskFailed|ActivityTaskTimedOut|ActivityTaskCanceled|ActivityTaskCancelRequested|RequestCancelActivityTaskFailed|WorkflowExecutionSignaled|MarkerRecorded|RecordMarkerFailed|TimerStarted|StartTimerFailed|TimerFired|TimerCanceled|CancelTimerFailed|StartChildWorkflowExecutionInitiated|StartChildWorkflowExecutionFailed|ChildWorkflowExecutionStarted|ChildWorkflowExecutionCompleted|ChildWorkflowExecutionFailed|ChildWorkflowExecutionTimedOut|ChildWorkflowExecutionCanceled|ChildWorkflowExecutionTerminated|SignalExternalWorkflowExecutionInitiated|SignalExternalWorkflowExecutionFailed|ExternalWorkflowExecutionSignaled|RequestCancelExternalWorkflowExecutionInitiated|RequestCancelExternalWorkflowExecutionFailed|ExternalWorkflowExecutionCancelRequested|LambdaFunctionScheduled|LambdaFunctionStarted|LambdaFunctionCompleted|LambdaFunctionFailed|LambdaFunctionTimedOut|ScheduleLambdaFunctionFailed|StartLambdaFunctionFailed',
            'externalWorkflowExecutionCancelRequestedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'externalWorkflowExecutionSignaledEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'failWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'lambdaFunctionCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionScheduledEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'input' => '<string>',
                'name' => '<string>',
                'startToCloseTimeout' => '<string>',
            ],
            'lambdaFunctionStartedEventAttributes' => [
                'scheduledEventId' => <integer>,
            ],
            'lambdaFunctionTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
            ],
            'markerRecordedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'markerName' => '<string>',
            ],
            'recordMarkerFailedEventAttributes' => [
                'cause' => 'OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'markerName' => '<string>',
            ],
            'requestCancelActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'cause' => 'ACTIVITY_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'requestCancelExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'requestCancelExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'scheduleActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'cause' => 'ACTIVITY_TYPE_DEPRECATED|ACTIVITY_TYPE_DOES_NOT_EXIST|ACTIVITY_ID_ALREADY_IN_USE|OPEN_ACTIVITIES_LIMIT_EXCEEDED|ACTIVITY_CREATION_RATE_EXCEEDED|DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED|DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'scheduleLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ID_ALREADY_IN_USE|OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED|LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED|LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'name' => '<string>',
            ],
            'signalExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'signalExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'input' => '<string>',
                'runId' => '<string>',
                'signalName' => '<string>',
                'workflowId' => '<string>',
            ],
            'startChildWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'WORKFLOW_TYPE_DOES_NOT_EXIST|WORKFLOW_TYPE_DEPRECATED|OPEN_CHILDREN_LIMIT_EXCEEDED|OPEN_WORKFLOWS_LIMIT_EXCEEDED|CHILD_CREATION_RATE_EXCEEDED|WORKFLOW_ALREADY_RUNNING|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startChildWorkflowExecutionInitiatedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ASSUME_ROLE_FAILED',
                'message' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'startTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_ALREADY_IN_USE|OPEN_TIMERS_LIMIT_EXCEEDED|TIMER_CREATION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerFiredEventAttributes' => [
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerStartedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'startToFireTimeout' => '<string>',
                'timerId' => '<string>',
            ],
            'workflowExecutionCancelRequestedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED',
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'workflowExecutionCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
            ],
            'workflowExecutionCompletedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'result' => '<string>',
            ],
            'workflowExecutionContinuedAsNewEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'newExecutionRunId' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionFailedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionSignaledEventAttributes' => [
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'input' => '<string>',
                'signalName' => '<string>',
            ],
            'workflowExecutionStartedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'continuedExecutionRunId' => '<string>',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'parentInitiatedEventId' => <integer>,
                'parentWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionTerminatedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED|EVENT_LIMIT_EXCEEDED|OPERATOR_INITIATED',
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionTimedOutEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'timeoutType' => 'START_TO_CLOSE',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Members
events
Required: Yes
Type: Array of HistoryEvent structures

The list of history events.

nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListActivityTypes

$result = $client->listActivityTypes([/* ... */]);
$promise = $client->listActivityTypesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listActivityTypes([
    'domain' => '<string>', // REQUIRED
    'maximumPageSize' => <integer>,
    'name' => '<string>',
    'nextPageToken' => '<string>',
    'registrationStatus' => 'REGISTERED|DEPRECATED', // REQUIRED
    'reverseOrder' => true || false,
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain in which the activity types have been registered.

maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

name
Type: string

If specified, only lists the activity types that have this name.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

registrationStatus
Required: Yes
Type: string

Specifies the registration status of the activity types to list.

reverseOrder
Type: boolean

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

Result Syntax

[
    'nextPageToken' => '<string>',
    'typeInfos' => [
        [
            'activityType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
            'creationDate' => <DateTime>,
            'deprecationDate' => <DateTime>,
            'description' => '<string>',
            'status' => 'REGISTERED|DEPRECATED',
        ],
        // ...
    ],
]

Result Details

Members
nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

typeInfos
Required: Yes
Type: Array of ActivityTypeInfo structures

List of activity type information.

Errors

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UnknownResourceFault:

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.

ListClosedWorkflowExecutions

$result = $client->listClosedWorkflowExecutions([/* ... */]);
$promise = $client->listClosedWorkflowExecutionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listClosedWorkflowExecutions([
    'closeStatusFilter' => [
        'status' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT', // REQUIRED
    ],
    'closeTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
    'startTimeFilter' => [
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Members
closeStatusFilter
Type: CloseStatusFilter structure

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

closeTimeFilter
Type: ExecutionTimeFilter structure

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

domain
Required: Yes
Type: string

The name of the domain that contains the workflow executions to list.

executionFilter
Type: WorkflowExecutionFilter structure

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

reverseOrder
Type: boolean

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

startTimeFilter
Type: ExecutionTimeFilter structure

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

tagFilter
Type: TagFilter structure

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

typeFilter
Type: WorkflowTypeFilter structure

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Result Syntax

[
    'executionInfos' => [
        [
            'cancelRequested' => true || false,
            'closeStatus' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT',
            'closeTimestamp' => <DateTime>,
            'execution' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'executionStatus' => 'OPEN|CLOSED',
            'parent' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'startTimestamp' => <DateTime>,
            'tagList' => ['<string>', ...],
            'workflowType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Members
executionInfos
Required: Yes
Type: Array of WorkflowExecutionInfo structures

The list of workflow information structures.

nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listDomains([
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'registrationStatus' => 'REGISTERED|DEPRECATED', // REQUIRED
    'reverseOrder' => true || false,
]);

Parameter Details

Members
maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

registrationStatus
Required: Yes
Type: string

Specifies the registration status of the domains to list.

reverseOrder
Type: boolean

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Result Syntax

[
    'domainInfos' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'REGISTERED|DEPRECATED',
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Members
domainInfos
Required: Yes
Type: Array of DomainInfo structures

A list of DomainInfo structures.

nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Errors

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListOpenWorkflowExecutions

$result = $client->listOpenWorkflowExecutions([/* ... */]);
$promise = $client->listOpenWorkflowExecutionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listOpenWorkflowExecutions([
    'domain' => '<string>', // REQUIRED
    'executionFilter' => [
        'workflowId' => '<string>', // REQUIRED
    ],
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
    'startTimeFilter' => [ // REQUIRED
        'latestDate' => <integer || string || DateTime>,
        'oldestDate' => <integer || string || DateTime>, // REQUIRED
    ],
    'tagFilter' => [
        'tag' => '<string>', // REQUIRED
    ],
    'typeFilter' => [
        'name' => '<string>', // REQUIRED
        'version' => '<string>',
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain that contains the workflow executions to list.

executionFilter
Type: WorkflowExecutionFilter structure

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

reverseOrder
Type: boolean

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

startTimeFilter
Required: Yes
Type: ExecutionTimeFilter structure

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

tagFilter
Type: TagFilter structure

If specified, only executions that have the matching tag are listed.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

typeFilter
Type: WorkflowTypeFilter structure

If specified, only executions of the type specified in the filter are returned.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Result Syntax

[
    'executionInfos' => [
        [
            'cancelRequested' => true || false,
            'closeStatus' => 'COMPLETED|FAILED|CANCELED|TERMINATED|CONTINUED_AS_NEW|TIMED_OUT',
            'closeTimestamp' => <DateTime>,
            'execution' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'executionStatus' => 'OPEN|CLOSED',
            'parent' => [
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'startTimestamp' => <DateTime>,
            'tagList' => ['<string>', ...],
            'workflowType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
]

Result Details

Members
executionInfos
Required: Yes
Type: Array of WorkflowExecutionInfo structures

The list of workflow information structures.

nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List tags for a given domain.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Amazon SWF domain.

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
tags
Type: Array of ResourceTag structures

An array of tags associated with the domain.

Errors

UnknownResourceFault:

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.

LimitExceededFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

ListWorkflowTypes

$result = $client->listWorkflowTypes([/* ... */]);
$promise = $client->listWorkflowTypesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listWorkflowTypes([
    'domain' => '<string>', // REQUIRED
    'maximumPageSize' => <integer>,
    'name' => '<string>',
    'nextPageToken' => '<string>',
    'registrationStatus' => 'REGISTERED|DEPRECATED', // REQUIRED
    'reverseOrder' => true || false,
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain in which the workflow types have been registered.

maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

name
Type: string

If specified, lists the workflow type with this name.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

registrationStatus
Required: Yes
Type: string

Specifies the registration status of the workflow types to list.

reverseOrder
Type: boolean

When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

Result Syntax

[
    'nextPageToken' => '<string>',
    'typeInfos' => [
        [
            'creationDate' => <DateTime>,
            'deprecationDate' => <DateTime>,
            'description' => '<string>',
            'status' => 'REGISTERED|DEPRECATED',
            'workflowType' => [
                'name' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

typeInfos
Required: Yes
Type: Array of WorkflowTypeInfo structures

The list of workflow type information.

Errors

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UnknownResourceFault:

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.

PollForActivityTask

$result = $client->pollForActivityTask([/* ... */]);
$promise = $client->pollForActivityTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->pollForActivityTask([
    'domain' => '<string>', // REQUIRED
    'identity' => '<string>',
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain that contains the task lists being polled.

identity
Type: string

Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

taskList
Required: Yes
Type: TaskList structure

Specifies the task list to poll for activity tasks.

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 be the literal string arn.

Result Syntax

[
    'activityId' => '<string>',
    'activityType' => [
        'name' => '<string>',
        'version' => '<string>',
    ],
    'input' => '<string>',
    'startedEventId' => <integer>,
    'taskToken' => '<string>',
    'workflowExecution' => [
        'runId' => '<string>',
        'workflowId' => '<string>',
    ],
]

Result Details

Members
activityId
Required: Yes
Type: string

The unique ID of the task.

activityType
Required: Yes
Type: ActivityType structure

The type of this activity task.

input
Type: string

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

startedEventId
Required: Yes
Type: long (int|float)

The ID of the ActivityTaskStarted event recorded in the history.

taskToken
Required: Yes
Type: string

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The workflow execution that started this activity task.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

LimitExceededFault:

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.

PollForDecisionTask

$result = $client->pollForDecisionTask([/* ... */]);
$promise = $client->pollForDecisionTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->pollForDecisionTask([
    'domain' => '<string>', // REQUIRED
    'identity' => '<string>',
    'maximumPageSize' => <integer>,
    'nextPageToken' => '<string>',
    'reverseOrder' => true || false,
    'startAtPreviousStartedEvent' => true || false,
    'taskList' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain containing the task lists to poll.

identity
Type: string

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

maximumPageSize
Type: int

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

nextPageToken
Type: string

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

reverseOrder
Type: boolean

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

startAtPreviousStartedEvent
Type: boolean

When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.

taskList
Required: Yes
Type: TaskList structure

Specifies the task list to poll for decision tasks.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Result Syntax

[
    'events' => [
        [
            'activityTaskCancelRequestedEventAttributes' => [
                'activityId' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'activityTaskCanceledEventAttributes' => [
                'details' => '<string>',
                'latestCancelRequestedEventId' => <integer>,
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'activityTaskScheduledEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'heartbeatTimeout' => '<string>',
                'input' => '<string>',
                'scheduleToCloseTimeout' => '<string>',
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'activityTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'activityTaskTimedOutEventAttributes' => [
                'details' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START|SCHEDULE_TO_CLOSE|HEARTBEAT',
            ],
            'cancelTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'cancelWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'childWorkflowExecutionCanceledEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionCompletedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'result' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionFailedEventAttributes' => [
                'details' => '<string>',
                'initiatedEventId' => <integer>,
                'reason' => '<string>',
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionStartedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTerminatedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'childWorkflowExecutionTimedOutEventAttributes' => [
                'initiatedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'completeWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'continueAsNewWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|WORKFLOW_TYPE_DEPRECATED|WORKFLOW_TYPE_DOES_NOT_EXIST|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'decisionTaskCompletedEventAttributes' => [
                'executionContext' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskListScheduleToStartTimeout' => '<string>',
            ],
            'decisionTaskScheduledEventAttributes' => [
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
            ],
            'decisionTaskStartedEventAttributes' => [
                'identity' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'decisionTaskTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE|SCHEDULE_TO_START',
            ],
            'eventId' => <integer>,
            'eventTimestamp' => <DateTime>,
            'eventType' => 'WorkflowExecutionStarted|WorkflowExecutionCancelRequested|WorkflowExecutionCompleted|CompleteWorkflowExecutionFailed|WorkflowExecutionFailed|FailWorkflowExecutionFailed|WorkflowExecutionTimedOut|WorkflowExecutionCanceled|CancelWorkflowExecutionFailed|WorkflowExecutionContinuedAsNew|ContinueAsNewWorkflowExecutionFailed|WorkflowExecutionTerminated|DecisionTaskScheduled|DecisionTaskStarted|DecisionTaskCompleted|DecisionTaskTimedOut|ActivityTaskScheduled|ScheduleActivityTaskFailed|ActivityTaskStarted|ActivityTaskCompleted|ActivityTaskFailed|ActivityTaskTimedOut|ActivityTaskCanceled|ActivityTaskCancelRequested|RequestCancelActivityTaskFailed|WorkflowExecutionSignaled|MarkerRecorded|RecordMarkerFailed|TimerStarted|StartTimerFailed|TimerFired|TimerCanceled|CancelTimerFailed|StartChildWorkflowExecutionInitiated|StartChildWorkflowExecutionFailed|ChildWorkflowExecutionStarted|ChildWorkflowExecutionCompleted|ChildWorkflowExecutionFailed|ChildWorkflowExecutionTimedOut|ChildWorkflowExecutionCanceled|ChildWorkflowExecutionTerminated|SignalExternalWorkflowExecutionInitiated|SignalExternalWorkflowExecutionFailed|ExternalWorkflowExecutionSignaled|RequestCancelExternalWorkflowExecutionInitiated|RequestCancelExternalWorkflowExecutionFailed|ExternalWorkflowExecutionCancelRequested|LambdaFunctionScheduled|LambdaFunctionStarted|LambdaFunctionCompleted|LambdaFunctionFailed|LambdaFunctionTimedOut|ScheduleLambdaFunctionFailed|StartLambdaFunctionFailed',
            'externalWorkflowExecutionCancelRequestedEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'externalWorkflowExecutionSignaledEventAttributes' => [
                'initiatedEventId' => <integer>,
                'workflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'failWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNHANDLED_DECISION|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'lambdaFunctionCompletedEventAttributes' => [
                'result' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionFailedEventAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
            ],
            'lambdaFunctionScheduledEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'input' => '<string>',
                'name' => '<string>',
                'startToCloseTimeout' => '<string>',
            ],
            'lambdaFunctionStartedEventAttributes' => [
                'scheduledEventId' => <integer>,
            ],
            'lambdaFunctionTimedOutEventAttributes' => [
                'scheduledEventId' => <integer>,
                'startedEventId' => <integer>,
                'timeoutType' => 'START_TO_CLOSE',
            ],
            'markerRecordedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'markerName' => '<string>',
            ],
            'recordMarkerFailedEventAttributes' => [
                'cause' => 'OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'markerName' => '<string>',
            ],
            'requestCancelActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'cause' => 'ACTIVITY_ID_UNKNOWN|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'requestCancelExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'requestCancelExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'scheduleActivityTaskFailedEventAttributes' => [
                'activityId' => '<string>',
                'activityType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
                'cause' => 'ACTIVITY_TYPE_DEPRECATED|ACTIVITY_TYPE_DOES_NOT_EXIST|ACTIVITY_ID_ALREADY_IN_USE|OPEN_ACTIVITIES_LIMIT_EXCEEDED|ACTIVITY_CREATION_RATE_EXCEEDED|DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED|DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
            ],
            'scheduleLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ID_ALREADY_IN_USE|OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED|LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED|LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION',
                'decisionTaskCompletedEventId' => <integer>,
                'id' => '<string>',
                'name' => '<string>',
            ],
            'signalExternalWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION|SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'runId' => '<string>',
                'workflowId' => '<string>',
            ],
            'signalExternalWorkflowExecutionInitiatedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'input' => '<string>',
                'runId' => '<string>',
                'signalName' => '<string>',
                'workflowId' => '<string>',
            ],
            'startChildWorkflowExecutionFailedEventAttributes' => [
                'cause' => 'WORKFLOW_TYPE_DOES_NOT_EXIST|WORKFLOW_TYPE_DEPRECATED|OPEN_CHILDREN_LIMIT_EXCEEDED|OPEN_WORKFLOWS_LIMIT_EXCEEDED|CHILD_CREATION_RATE_EXCEEDED|WORKFLOW_ALREADY_RUNNING|DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_TASK_LIST_UNDEFINED|DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED|DEFAULT_CHILD_POLICY_UNDEFINED|OPERATION_NOT_PERMITTED',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'initiatedEventId' => <integer>,
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startChildWorkflowExecutionInitiatedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowId' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'startLambdaFunctionFailedEventAttributes' => [
                'cause' => 'ASSUME_ROLE_FAILED',
                'message' => '<string>',
                'scheduledEventId' => <integer>,
            ],
            'startTimerFailedEventAttributes' => [
                'cause' => 'TIMER_ID_ALREADY_IN_USE|OPEN_TIMERS_LIMIT_EXCEEDED|TIMER_CREATION_RATE_EXCEEDED|OPERATION_NOT_PERMITTED',
                'decisionTaskCompletedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerFiredEventAttributes' => [
                'startedEventId' => <integer>,
                'timerId' => '<string>',
            ],
            'timerStartedEventAttributes' => [
                'control' => '<string>',
                'decisionTaskCompletedEventId' => <integer>,
                'startToFireTimeout' => '<string>',
                'timerId' => '<string>',
            ],
            'workflowExecutionCancelRequestedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED',
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
            ],
            'workflowExecutionCanceledEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
            ],
            'workflowExecutionCompletedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'result' => '<string>',
            ],
            'workflowExecutionContinuedAsNewEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'decisionTaskCompletedEventId' => <integer>,
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'newExecutionRunId' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionFailedEventAttributes' => [
                'decisionTaskCompletedEventId' => <integer>,
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionSignaledEventAttributes' => [
                'externalInitiatedEventId' => <integer>,
                'externalWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'input' => '<string>',
                'signalName' => '<string>',
            ],
            'workflowExecutionStartedEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'continuedExecutionRunId' => '<string>',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'parentInitiatedEventId' => <integer>,
                'parentWorkflowExecution' => [
                    'runId' => '<string>',
                    'workflowId' => '<string>',
                ],
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>',
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowType' => [
                    'name' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'workflowExecutionTerminatedEventAttributes' => [
                'cause' => 'CHILD_POLICY_APPLIED|EVENT_LIMIT_EXCEEDED|OPERATOR_INITIATED',
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'workflowExecutionTimedOutEventAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'timeoutType' => 'START_TO_CLOSE',
            ],
        ],
        // ...
    ],
    'nextPageToken' => '<string>',
    'previousStartedEventId' => <integer>,
    'startedEventId' => <integer>,
    'taskToken' => '<string>',
    'workflowExecution' => [
        'runId' => '<string>',
        'workflowId' => '<string>',
    ],
    'workflowType' => [
        'name' => '<string>',
        'version' => '<string>',
    ],
]

Result Details

Members
events
Required: Yes
Type: Array of HistoryEvent structures

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

nextPageToken
Type: string

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

previousStartedEventId
Type: long (int|float)

The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

startedEventId
Required: Yes
Type: long (int|float)

The ID of the DecisionTaskStarted event recorded in the history.

taskToken
Required: Yes
Type: string

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The workflow execution for which this decision task was created.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the workflow execution for which this decision task was created.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

LimitExceededFault:

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.

RecordActivityTaskHeartbeat

$result = $client->recordActivityTaskHeartbeat([/* ... */]);
$promise = $client->recordActivityTaskHeartbeatAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->recordActivityTaskHeartbeat([
    'details' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
details
Type: string

If specified, contains details about the progress of the task.

taskToken
Required: Yes
Type: string

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Result Syntax

[
    'cancelRequested' => true || false,
]

Result Details

Members
cancelRequested
Required: Yes
Type: boolean

Set to true if cancellation of the task is requested.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RegisterActivityType

$result = $client->registerActivityType([/* ... */]);
$promise = $client->registerActivityTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerActivityType([
    'defaultTaskHeartbeatTimeout' => '<string>',
    'defaultTaskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'defaultTaskPriority' => '<string>',
    'defaultTaskScheduleToCloseTimeout' => '<string>',
    'defaultTaskScheduleToStartTimeout' => '<string>',
    'defaultTaskStartToCloseTimeout' => '<string>',
    'description' => '<string>',
    'domain' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
defaultTaskHeartbeatTimeout
Type: string

If set, specifies the default 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. This default can be overridden when scheduling an activity task using 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. You can use NONE to specify unlimited duration.

defaultTaskList
Type: TaskList structure

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

defaultTaskPriority
Type: string

The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

defaultTaskScheduleToCloseTimeout
Type: string

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

defaultTaskScheduleToStartTimeout
Type: string

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

defaultTaskStartToCloseTimeout
Type: string

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

description
Type: string

A textual description of the activity type.

domain
Required: Yes
Type: string

The name of the domain in which this activity is to be registered.

name
Required: Yes
Type: string

The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

version
Required: Yes
Type: string

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

LimitExceededFault:

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.

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RegisterDomain

$result = $client->registerDomain([/* ... */]);
$promise = $client->registerDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerDomain([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'workflowExecutionRetentionPeriodInDays' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

A text description of the domain.

name
Required: Yes
Type: string

Name of the domain to register. The name must be unique in the region that the domain is registered in.

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 be the literal string arn.

tags
Type: Array of ResourceTag structures

Tags to be added when registering a domain.

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

workflowExecutionRetentionPeriodInDays
Required: Yes
Type: string

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DomainAlreadyExistsFault:

Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.

LimitExceededFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

TooManyTagsFault:

You've exceeded the number of tags allowed for a domain.

RegisterWorkflowType

$result = $client->registerWorkflowType([/* ... */]);
$promise = $client->registerWorkflowTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerWorkflowType([
    'defaultChildPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
    'defaultExecutionStartToCloseTimeout' => '<string>',
    'defaultLambdaRole' => '<string>',
    'defaultTaskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'defaultTaskPriority' => '<string>',
    'defaultTaskStartToCloseTimeout' => '<string>',
    'description' => '<string>',
    'domain' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
defaultChildPolicy
Type: string

If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

defaultExecutionStartToCloseTimeout
Type: string

If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

defaultLambdaRole
Type: string

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

defaultTaskList
Type: TaskList structure

If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

defaultTaskPriority
Type: string

The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

defaultTaskStartToCloseTimeout
Type: string

If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

description
Type: string

Textual description of the workflow type.

domain
Required: Yes
Type: string

The name of the domain in which to register the workflow type.

name
Required: Yes
Type: string

The name of the workflow type.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

version
Required: Yes
Type: string

The version of the workflow type.

The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

LimitExceededFault:

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.

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RequestCancelWorkflowExecution

$result = $client->requestCancelWorkflowExecution([/* ... */]);
$promise = $client->requestCancelWorkflowExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->requestCancelWorkflowExecution([
    'domain' => '<string>', // REQUIRED
    'runId' => '<string>',
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain containing the workflow execution to cancel.

runId
Type: string

The runId of the workflow execution to cancel.

workflowId
Required: Yes
Type: string

The workflowId of the workflow execution to cancel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondActivityTaskCanceled

$result = $client->respondActivityTaskCanceled([/* ... */]);
$promise = $client->respondActivityTaskCanceledAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->respondActivityTaskCanceled([
    'details' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
details
Type: string

Information about the cancellation.

taskToken
Required: Yes
Type: string

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondActivityTaskCompleted

$result = $client->respondActivityTaskCompleted([/* ... */]);
$promise = $client->respondActivityTaskCompletedAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->respondActivityTaskCompleted([
    'result' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
result
Type: string

The result of the activity task. It is a free form string that is implementation specific.

taskToken
Required: Yes
Type: string

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondActivityTaskFailed

$result = $client->respondActivityTaskFailed([/* ... */]);
$promise = $client->respondActivityTaskFailedAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->respondActivityTaskFailed([
    'details' => '<string>',
    'reason' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
details
Type: string

Detailed information about the failure.

reason
Type: string

Description of the error that may assist in diagnostics.

taskToken
Required: Yes
Type: string

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

RespondDecisionTaskCompleted

$result = $client->respondDecisionTaskCompleted([/* ... */]);
$promise = $client->respondDecisionTaskCompletedAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->respondDecisionTaskCompleted([
    'decisions' => [
        [
            'cancelTimerDecisionAttributes' => [
                'timerId' => '<string>', // REQUIRED
            ],
            'cancelWorkflowExecutionDecisionAttributes' => [
                'details' => '<string>',
            ],
            'completeWorkflowExecutionDecisionAttributes' => [
                'result' => '<string>',
            ],
            'continueAsNewWorkflowExecutionDecisionAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>', // REQUIRED
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowTypeVersion' => '<string>',
            ],
            'decisionType' => 'ScheduleActivityTask|RequestCancelActivityTask|CompleteWorkflowExecution|FailWorkflowExecution|CancelWorkflowExecution|ContinueAsNewWorkflowExecution|RecordMarker|StartTimer|CancelTimer|SignalExternalWorkflowExecution|RequestCancelExternalWorkflowExecution|StartChildWorkflowExecution|ScheduleLambdaFunction', // REQUIRED
            'failWorkflowExecutionDecisionAttributes' => [
                'details' => '<string>',
                'reason' => '<string>',
            ],
            'recordMarkerDecisionAttributes' => [
                'details' => '<string>',
                'markerName' => '<string>', // REQUIRED
            ],
            'requestCancelActivityTaskDecisionAttributes' => [
                'activityId' => '<string>', // REQUIRED
            ],
            'requestCancelExternalWorkflowExecutionDecisionAttributes' => [
                'control' => '<string>',
                'runId' => '<string>',
                'workflowId' => '<string>', // REQUIRED
            ],
            'scheduleActivityTaskDecisionAttributes' => [
                'activityId' => '<string>', // REQUIRED
                'activityType' => [ // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'version' => '<string>', // REQUIRED
                ],
                'control' => '<string>',
                'heartbeatTimeout' => '<string>',
                'input' => '<string>',
                'scheduleToCloseTimeout' => '<string>',
                'scheduleToStartTimeout' => '<string>',
                'startToCloseTimeout' => '<string>',
                'taskList' => [
                    'name' => '<string>', // REQUIRED
                ],
                'taskPriority' => '<string>',
            ],
            'scheduleLambdaFunctionDecisionAttributes' => [
                'control' => '<string>',
                'id' => '<string>', // REQUIRED
                'input' => '<string>',
                'name' => '<string>', // REQUIRED
                'startToCloseTimeout' => '<string>',
            ],
            'signalExternalWorkflowExecutionDecisionAttributes' => [
                'control' => '<string>',
                'input' => '<string>',
                'runId' => '<string>',
                'signalName' => '<string>', // REQUIRED
                'workflowId' => '<string>', // REQUIRED
            ],
            'startChildWorkflowExecutionDecisionAttributes' => [
                'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
                'control' => '<string>',
                'executionStartToCloseTimeout' => '<string>',
                'input' => '<string>',
                'lambdaRole' => '<string>',
                'tagList' => ['<string>', ...],
                'taskList' => [
                    'name' => '<string>', // REQUIRED
                ],
                'taskPriority' => '<string>',
                'taskStartToCloseTimeout' => '<string>',
                'workflowId' => '<string>', // REQUIRED
                'workflowType' => [ // REQUIRED
                    'name' => '<string>', // REQUIRED
                    'version' => '<string>', // REQUIRED
                ],
            ],
            'startTimerDecisionAttributes' => [
                'control' => '<string>',
                'startToFireTimeout' => '<string>', // REQUIRED
                'timerId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'executionContext' => '<string>',
    'taskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'taskListScheduleToStartTimeout' => '<string>',
    'taskToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
decisions
Type: Array of Decision structures

The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

executionContext
Type: string

User defined context to add to workflow execution.

taskList
Type: TaskList structure

The task list to use for the future decision tasks of this workflow execution. This list overrides the original task list you specified while starting the workflow execution.

taskListScheduleToStartTimeout
Type: string

Specifies a timeout (in seconds) for the task list override. When this parameter is missing, the task list override is permanent. This parameter makes it possible to temporarily override the task list. If a decision task scheduled on the override task list is not started within the timeout, the decision task will time out. Amazon SWF will revert the override and schedule a new decision task to the original task list.

If a decision task scheduled on the override task list is started within the timeout, but not completed within the start-to-close timeout, Amazon SWF will also revert the override and schedule a new decision task to the original task list.

taskToken
Required: Yes
Type: string

The taskToken from the DecisionTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

SignalWorkflowExecution

$result = $client->signalWorkflowExecution([/* ... */]);
$promise = $client->signalWorkflowExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->signalWorkflowExecution([
    'domain' => '<string>', // REQUIRED
    'input' => '<string>',
    'runId' => '<string>',
    'signalName' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain containing the workflow execution to signal.

input
Type: string

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

runId
Type: string

The runId of the workflow execution to signal.

signalName
Required: Yes
Type: string

The name of the signal. This name must be meaningful to the target workflow.

workflowId
Required: Yes
Type: string

The workflowId of the workflow execution to signal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

StartWorkflowExecution

$result = $client->startWorkflowExecution([/* ... */]);
$promise = $client->startWorkflowExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startWorkflowExecution([
    'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
    'domain' => '<string>', // REQUIRED
    'executionStartToCloseTimeout' => '<string>',
    'input' => '<string>',
    'lambdaRole' => '<string>',
    'tagList' => ['<string>', ...],
    'taskList' => [
        'name' => '<string>', // REQUIRED
    ],
    'taskPriority' => '<string>',
    'taskStartToCloseTimeout' => '<string>',
    'workflowId' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
childPolicy
Type: string

If set, specifies the policy to use for the child workflow executions of this workflow 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 are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

domain
Required: Yes
Type: string

The name of the domain in which the workflow execution is created.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

executionStartToCloseTimeout
Type: string

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. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

input
Type: string

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

lambdaRole
Type: string

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

tagList
Type: Array of strings

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

taskList
Type: TaskList structure

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

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 is returned.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

taskPriority
Type: string

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

taskStartToCloseTimeout
Type: string

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. You can use NONE 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 is returned.

workflowId
Required: Yes
Type: string

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the workflow to start.

Result Syntax

[
    'runId' => '<string>',
]

Result Details

Members
runId
Type: string

The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

Errors

UnknownResourceFault:

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.

TypeDeprecatedFault:

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

WorkflowExecutionAlreadyStartedFault:

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

LimitExceededFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

DefaultUndefinedFault:

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

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

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add a tag to a Amazon SWF domain.

Amazon SWF supports a maximum of 50 tags per resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Amazon SWF domain.

tags
Required: Yes
Type: Array of ResourceTag structures

The list of tags to add to a domain.

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TooManyTagsFault:

You've exceeded the number of tags allowed for a domain.

LimitExceededFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

TerminateWorkflowExecution

$result = $client->terminateWorkflowExecution([/* ... */]);
$promise = $client->terminateWorkflowExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->terminateWorkflowExecution([
    'childPolicy' => 'TERMINATE|REQUEST_CANCEL|ABANDON',
    'details' => '<string>',
    'domain' => '<string>', // REQUIRED
    'reason' => '<string>',
    'runId' => '<string>',
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
childPolicy
Type: string

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

details
Type: string

Details for terminating the workflow execution.

domain
Required: Yes
Type: string

The domain of the workflow execution to terminate.

reason
Type: string

A descriptive reason for terminating the workflow execution.

runId
Type: string

The runId of the workflow execution to terminate.

workflowId
Required: Yes
Type: string

The workflowId of the workflow execution to terminate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UndeprecateActivityType

$result = $client->undeprecateActivityType([/* ... */]);
$promise = $client->undeprecateActivityTypeAsync([/* ... */]);

Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.

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.

Parameter Syntax

$result = $client->undeprecateActivityType([
    'activityType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'domain' => '<string>', // REQUIRED
]);

Parameter Details

Members
activityType
Required: Yes
Type: ActivityType structure

The activity type to undeprecate.

domain
Required: Yes
Type: string

The name of the domain of the deprecated activity type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UndeprecateDomain

$result = $client->undeprecateDomain([/* ... */]);
$promise = $client->undeprecateDomainAsync([/* ... */]);

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.

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.

Parameter Syntax

$result = $client->undeprecateDomain([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the domain of the deprecated workflow type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

DomainAlreadyExistsFault:

Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UndeprecateWorkflowType

$result = $client->undeprecateWorkflowType([/* ... */]);
$promise = $client->undeprecateWorkflowTypeAsync([/* ... */]);

Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.

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.

Parameter Syntax

$result = $client->undeprecateWorkflowType([
    'domain' => '<string>', // REQUIRED
    'workflowType' => [ // REQUIRED
        'name' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
domain
Required: Yes
Type: string

The name of the domain of the deprecated workflow type.

workflowType
Required: Yes
Type: WorkflowType structure

The name of the domain of the deprecated workflow type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

TypeAlreadyExistsFault:

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove a tag from a Amazon SWF domain.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Amazon SWF domain.

tagKeys
Required: Yes
Type: Array of strings

The list of tags to remove from the Amazon SWF domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnknownResourceFault:

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.

LimitExceededFault:

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.

OperationNotPermittedFault:

Returned when the caller doesn't have sufficient permissions to invoke the action.

Shapes

ActivityTaskCancelRequestedEventAttributes

Description

Provides the details of the ActivityTaskCancelRequested event.

Members
activityId
Required: Yes
Type: string

The unique ID of the task.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

Provides the details of the ActivityTaskCanceled event.

Members
details
Type: string

Details of the cancellation.

latestCancelRequestedEventId
Type: long (int|float)

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.

scheduledEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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

Description

Provides the details of the ActivityTaskCompleted event.

Members
result
Type: string

The results of the activity task.

scheduledEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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

Description

Provides the details of the ActivityTaskFailed event.

Members
details
Type: string

The details of the failure.

reason
Type: string

The reason provided for the failure.

scheduledEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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

Description

Provides the details of the ActivityTaskScheduled event.

Members
activityId
Required: Yes
Type: string

The unique ID of the activity task.

activityType
Required: Yes
Type: ActivityType structure

The type of the activity task.

control
Type: string

Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

heartbeatTimeout
Type: string

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 is ignored.

input
Type: string

The input provided to the activity task.

scheduleToCloseTimeout
Type: string

The maximum amount of time for this activity task.

scheduleToStartTimeout
Type: string

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

startToCloseTimeout
Type: string

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

taskList
Required: Yes
Type: TaskList structure

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

taskPriority
Type: string

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

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

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

ActivityTaskStartedEventAttributes

Description

Provides the details of the ActivityTaskStarted event.

Members
identity
Type: string

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

scheduledEventId
Required: Yes
Type: long (int|float)

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

Description

Provides the details of the ActivityTaskTimedOut event.

Members
details
Type: string

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

scheduledEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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.

timeoutType
Required: Yes
Type: string

The type of the timeout that caused this event.

ActivityType

Description

Represents an activity type.

Members
name
Required: Yes
Type: string

The name of this activity.

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

version
Required: Yes
Type: string

The version of this activity.

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

ActivityTypeConfiguration

Description

Configuration settings registered with the activity type.

Members
defaultTaskHeartbeatTimeout
Type: string

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. You can use NONE to specify unlimited duration.

defaultTaskList
Type: TaskList structure

The default task list specified for this activity type at registration. This default is used if a task list isn't 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.

defaultTaskPriority
Type: string

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

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

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

defaultTaskScheduleToCloseTimeout
Type: string

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. You can use NONE to specify unlimited duration.

defaultTaskScheduleToStartTimeout
Type: string

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. You can use NONE to specify unlimited duration.

defaultTaskStartToCloseTimeout
Type: string

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. You can use NONE to specify unlimited duration.

ActivityTypeInfo

Description

Detailed information about an activity type.

Members
activityType
Required: Yes
Type: ActivityType structure

The ActivityType type structure representing the activity type.

creationDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

deprecationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

If DEPRECATED, the date and time DeprecateActivityType was called.

description
Type: string

The description of the activity type provided in RegisterActivityType.

status
Required: Yes
Type: string

The current status of the activity type.

CancelTimerDecisionAttributes

Description

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.

Members
timerId
Required: Yes
Type: string

The unique ID of the timer to cancel.

CancelTimerFailedEventAttributes

Description

Provides the details of the CancelTimerFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

timerId
Required: Yes
Type: string

The timerId provided in the CancelTimer decision that failed.

CancelWorkflowExecutionDecisionAttributes

Description

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.

Members
details
Type: string

Details of the cancellation.

CancelWorkflowExecutionFailedEventAttributes

Description

Provides the details of the CancelWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

Provide details of the ChildWorkflowExecutionCanceled event.

Members
details
Type: string

Details of the cancellation (if provided).

initiatedEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The child workflow execution that was canceled.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

ChildWorkflowExecutionCompletedEventAttributes

Description

Provides the details of the ChildWorkflowExecutionCompleted event.

Members
initiatedEventId
Required: Yes
Type: long (int|float)

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.

result
Type: string

The result of the child workflow execution.

startedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The child workflow execution that was completed.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

ChildWorkflowExecutionFailedEventAttributes

Description

Provides the details of the ChildWorkflowExecutionFailed event.

Members
details
Type: string

The details of the failure (if provided).

initiatedEventId
Required: Yes
Type: long (int|float)

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.

reason
Type: string

The reason for the failure (if provided).

startedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The child workflow execution that failed.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

ChildWorkflowExecutionStartedEventAttributes

Description

Provides the details of the ChildWorkflowExecutionStarted event.

Members
initiatedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The child workflow execution that was started.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

ChildWorkflowExecutionTerminatedEventAttributes

Description

Provides the details of the ChildWorkflowExecutionTerminated event.

Members
initiatedEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The child workflow execution that was terminated.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

ChildWorkflowExecutionTimedOutEventAttributes

Description

Provides the details of the ChildWorkflowExecutionTimedOut event.

Members
initiatedEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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.

timeoutType
Required: Yes
Type: string

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

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The child workflow execution that timed out.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

CloseStatusFilter

Description

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

Members
status
Required: Yes
Type: string

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

CompleteWorkflowExecutionDecisionAttributes

Description

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.

Members
result
Type: string

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

CompleteWorkflowExecutionFailedEventAttributes

Description

Provides the details of the CompleteWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

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.

Members
childPolicy
Type: string

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 are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

executionStartToCloseTimeout
Type: string

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. You can use NONE 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 is returned.

input
Type: string

The input provided to the new workflow execution.

lambdaRole
Type: string

The IAM role to attach to the new (continued) execution.

tagList
Type: Array of strings

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.

taskList
Type: TaskList structure

The task list to use for the decisions of the new (continued) workflow execution.

taskPriority
Type: string

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 Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

taskStartToCloseTimeout
Type: string

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. You can use NONE 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 is returned.

workflowTypeVersion
Type: string

The version of the workflow to start.

ContinueAsNewWorkflowExecutionFailedEventAttributes

Description

Provides the details of the ContinueAsNewWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

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:

Members
cancelTimerDecisionAttributes

Provides the details of the CancelTimer decision. It isn't set for other decision types.

cancelWorkflowExecutionDecisionAttributes

Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.

completeWorkflowExecutionDecisionAttributes

Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.

continueAsNewWorkflowExecutionDecisionAttributes

Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.

decisionType
Required: Yes
Type: string

Specifies the type of the decision.

failWorkflowExecutionDecisionAttributes

Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.

recordMarkerDecisionAttributes

Provides the details of the RecordMarker decision. It isn't set for other decision types.

requestCancelActivityTaskDecisionAttributes

Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.

requestCancelExternalWorkflowExecutionDecisionAttributes

Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.

scheduleActivityTaskDecisionAttributes

Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.

scheduleLambdaFunctionDecisionAttributes

Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.

signalExternalWorkflowExecutionDecisionAttributes

Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.

startChildWorkflowExecutionDecisionAttributes

Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.

startTimerDecisionAttributes

Provides the details of the StartTimer decision. It isn't set for other decision types.

DecisionTaskCompletedEventAttributes

Description

Provides the details of the DecisionTaskCompleted event.

Members
executionContext
Type: string

User defined context for the workflow execution.

scheduledEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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.

taskList
Type: TaskList structure

Represents a task list.

taskListScheduleToStartTimeout
Type: string

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

DecisionTaskScheduledEventAttributes

Description

Provides details about the DecisionTaskScheduled event.

Members
scheduleToStartTimeout
Type: string

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

startToCloseTimeout
Type: string

The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

taskList
Required: Yes
Type: TaskList structure

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

taskPriority
Type: string

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

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

DecisionTaskStartedEventAttributes

Description

Provides the details of the DecisionTaskStarted event.

Members
identity
Type: string

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

scheduledEventId
Required: Yes
Type: long (int|float)

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

Description

Provides the details of the DecisionTaskTimedOut event.

Members
scheduledEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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.

timeoutType
Required: Yes
Type: string

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

DefaultUndefinedFault

Description

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

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

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

Members
message
Type: string

DomainAlreadyExistsFault

Description

Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

DomainConfiguration

Description

Contains the configuration settings of a domain.

Members
workflowExecutionRetentionPeriodInDays
Required: Yes
Type: string

The retention period for workflow executions in this domain.

DomainDeprecatedFault

Description

Returned when the specified domain has been deprecated.

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

DomainInfo

Description

Contains general information about a domain.

Members
arn
Type: string

The ARN of the domain.

description
Type: string

The description of the domain provided through RegisterDomain.

name
Required: Yes
Type: string

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

status
Required: Yes
Type: string

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

Description

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.

Members
latestDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

oldestDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ExternalWorkflowExecutionCancelRequestedEventAttributes

Description

Provides the details of the ExternalWorkflowExecutionCancelRequested event.

Members
initiatedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

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

ExternalWorkflowExecutionSignaledEventAttributes

Description

Provides the details of the ExternalWorkflowExecutionSignaled event.

Members
initiatedEventId
Required: Yes
Type: long (int|float)

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.

workflowExecution
Required: Yes
Type: WorkflowExecution structure

The external workflow execution that the signal was delivered to.

FailWorkflowExecutionDecisionAttributes

Description

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.

Members
details
Type: string

Details of the failure.

reason
Type: string

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

FailWorkflowExecutionFailedEventAttributes

Description

Provides the details of the FailWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

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.

Members
activityTaskCancelRequestedEventAttributes

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

activityTaskCanceledEventAttributes

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

activityTaskCompletedEventAttributes

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

activityTaskFailedEventAttributes

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

activityTaskScheduledEventAttributes

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

activityTaskStartedEventAttributes

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

activityTaskTimedOutEventAttributes

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

cancelTimerFailedEventAttributes

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

cancelWorkflowExecutionFailedEventAttributes

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

childWorkflowExecutionCanceledEventAttributes

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

childWorkflowExecutionCompletedEventAttributes

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

childWorkflowExecutionFailedEventAttributes

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

childWorkflowExecutionStartedEventAttributes

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

childWorkflowExecutionTerminatedEventAttributes

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

childWorkflowExecutionTimedOutEventAttributes

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

completeWorkflowExecutionFailedEventAttributes

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

continueAsNewWorkflowExecutionFailedEventAttributes

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

decisionTaskCompletedEventAttributes

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

decisionTaskScheduledEventAttributes

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

decisionTaskStartedEventAttributes

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

decisionTaskTimedOutEventAttributes

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

eventId
Required: Yes
Type: long (int|float)

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

eventTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the event occurred.

eventType
Required: Yes
Type: string

The type of the history event.

externalWorkflowExecutionCancelRequestedEventAttributes

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

externalWorkflowExecutionSignaledEventAttributes

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

failWorkflowExecutionFailedEventAttributes

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

lambdaFunctionCompletedEventAttributes

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

lambdaFunctionFailedEventAttributes

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

lambdaFunctionScheduledEventAttributes

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

lambdaFunctionStartedEventAttributes

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

lambdaFunctionTimedOutEventAttributes

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

markerRecordedEventAttributes

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

recordMarkerFailedEventAttributes

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

requestCancelActivityTaskFailedEventAttributes

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

requestCancelExternalWorkflowExecutionFailedEventAttributes

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

requestCancelExternalWorkflowExecutionInitiatedEventAttributes

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

scheduleActivityTaskFailedEventAttributes

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

scheduleLambdaFunctionFailedEventAttributes

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

signalExternalWorkflowExecutionFailedEventAttributes

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

signalExternalWorkflowExecutionInitiatedEventAttributes

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

startChildWorkflowExecutionFailedEventAttributes

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

startChildWorkflowExecutionInitiatedEventAttributes

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

startLambdaFunctionFailedEventAttributes

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

startTimerFailedEventAttributes

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

timerCanceledEventAttributes

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

timerFiredEventAttributes
Type: TimerFiredEventAttributes structure

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

timerStartedEventAttributes
Type: TimerStartedEventAttributes structure

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

workflowExecutionCancelRequestedEventAttributes

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

workflowExecutionCanceledEventAttributes

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

workflowExecutionCompletedEventAttributes

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

workflowExecutionContinuedAsNewEventAttributes

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

workflowExecutionFailedEventAttributes

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

workflowExecutionSignaledEventAttributes

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

workflowExecutionStartedEventAttributes

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

workflowExecutionTerminatedEventAttributes

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

workflowExecutionTimedOutEventAttributes

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

LambdaFunctionCompletedEventAttributes

Description

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

Members
result
Type: string

The results of the Lambda task.

scheduledEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

startedEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionFailedEventAttributes

Description

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

Members
details
Type: string

The details of the failure.

reason
Type: string

The reason provided for the failure.

scheduledEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

startedEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionScheduledEventAttributes

Description

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

Members
control
Type: string

Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

id
Required: Yes
Type: string

The unique ID of the Lambda task.

input
Type: string

The input provided to the Lambda task.

name
Required: Yes
Type: string

The name of the Lambda function.

startToCloseTimeout
Type: string

The maximum amount of time a worker can take to process the Lambda task.

LambdaFunctionStartedEventAttributes

Description

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

Members
scheduledEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

LambdaFunctionTimedOutEventAttributes

Description

Provides details of the LambdaFunctionTimedOut event.

Members
scheduledEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

startedEventId
Required: Yes
Type: long (int|float)

The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

timeoutType
Type: string

The type of the timeout that caused this event.

LimitExceededFault

Description

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.

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

MarkerRecordedEventAttributes

Description

Provides the details of the MarkerRecorded event.

Members
decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

details
Type: string

The details of the marker.

markerName
Required: Yes
Type: string

The name of the marker.

OperationNotPermittedFault

Description

Returned when the caller doesn't have sufficient permissions to invoke the action.

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

RecordMarkerDecisionAttributes

Description

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.

Members
details
Type: string

The details of the marker.

markerName
Required: Yes
Type: string

The name of the marker.

RecordMarkerFailedEventAttributes

Description

Provides the details of the RecordMarkerFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

markerName
Required: Yes
Type: string

The marker's name.

RequestCancelActivityTaskDecisionAttributes

Description

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.

Members
activityId
Required: Yes
Type: string

The activityId of the activity task to be canceled.

RequestCancelActivityTaskFailedEventAttributes

Description

Provides the details of the RequestCancelActivityTaskFailed event.

Members
activityId
Required: Yes
Type: string

The activityId provided in the RequestCancelActivityTask decision that failed.

cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

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.

Members
control
Type: string

The data attached to the event that can be used by the decider in subsequent workflow tasks.

runId
Type: string

The runId of the external workflow execution to cancel.

workflowId
Required: Yes
Type: string

The workflowId of the external workflow execution to cancel.

RequestCancelExternalWorkflowExecutionFailedEventAttributes

Description

Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

control
Type: string

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

initiatedEventId
Required: Yes
Type: long (int|float)

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.

runId
Type: string

The runId of the external workflow execution.

workflowId
Required: Yes
Type: string

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

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Description

Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.

Members
control
Type: string

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

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

runId
Type: string

The runId of the external workflow execution to be canceled.

workflowId
Required: Yes
Type: string

The workflowId of the external workflow execution to be canceled.

ResourceTag

Description

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

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

Members
key
Required: Yes
Type: string

The key of a tag.

value
Type: string

The value of a tag.

ScheduleActivityTaskDecisionAttributes

Description

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.

Members
activityId
Required: Yes
Type: string

The activityId of the activity task.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

activityType
Required: Yes
Type: ActivityType structure

The type of the activity task to schedule.

control
Type: string

Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

heartbeatTimeout
Type: string

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 is 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. You can use NONE to specify unlimited duration.

input
Type: string

The input provided to the activity task.

scheduleToCloseTimeout
Type: string

The maximum duration for this activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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 is returned.

scheduleToStartTimeout
Type: string

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. You can use NONE 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 is returned.

startToCloseTimeout
Type: string

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. You can use NONE 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 is returned.

taskList
Type: TaskList structure

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 is 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 is returned.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

taskPriority
Type: string

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 Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

ScheduleActivityTaskFailedEventAttributes

Description

Provides the details of the ScheduleActivityTaskFailed event.

Members
activityId
Required: Yes
Type: string

The activityId provided in the ScheduleActivityTask decision that failed.

activityType
Required: Yes
Type: ActivityType structure

The activity type provided in the ScheduleActivityTask decision that failed.

cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

Description

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

Members
control
Type: string

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

id
Required: Yes
Type: string

A string that identifies the Lambda function execution in the event history.

input
Type: string

The optional input data to be supplied to the Lambda function.

name
Required: Yes
Type: string

The name, or ARN, of the Lambda function to schedule.

startToCloseTimeout
Type: string

The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-900 (1s-15m).

If no value is supplied, then a default value of 900s is assumed.

ScheduleLambdaFunctionFailedEventAttributes

Description

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

Members
cause
Required: Yes
Type: string

The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

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.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

id
Required: Yes
Type: string

The ID provided in the ScheduleLambdaFunction decision that failed.

name
Required: Yes
Type: string

The name of the Lambda function.

SignalExternalWorkflowExecutionDecisionAttributes

Description

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.

Members
control
Type: string

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

input
Type: string

The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

runId
Type: string

The runId of the workflow execution to be signaled.

signalName
Required: Yes
Type: string

The name of the signal.The target workflow execution uses the signal name and input to process the signal.

workflowId
Required: Yes
Type: string

The workflowId of the workflow execution to be signaled.

SignalExternalWorkflowExecutionFailedEventAttributes

Description

Provides the details of the SignalExternalWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

control
Type: string

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

initiatedEventId
Required: Yes
Type: long (int|float)

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.

runId
Type: string

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

workflowId
Required: Yes
Type: string

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

SignalExternalWorkflowExecutionInitiatedEventAttributes

Description

Provides the details of the SignalExternalWorkflowExecutionInitiated event.

Members
control
Type: string

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

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

input
Type: string

The input provided to the signal.

runId
Type: string

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

signalName
Required: Yes
Type: string

The name of the signal.

workflowId
Required: Yes
Type: string

The workflowId of the external workflow execution.

StartChildWorkflowExecutionDecisionAttributes

Description

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.

Members
childPolicy
Type: string

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 are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

control
Type: string

The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

executionStartToCloseTimeout
Type: string

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. You can use NONE 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 is returned.

input
Type: string

The input to be provided to the workflow execution.

lambdaRole
Type: string

The IAM role attached to the child workflow execution.

tagList
Type: Array of strings

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.

taskList
Type: TaskList structure

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 is 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 be the literal string arn.

taskPriority
Type: string

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 Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

taskStartToCloseTimeout
Type: string

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. You can use NONE 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 is returned.

workflowId
Required: Yes
Type: string

The workflowId of the workflow execution.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the workflow execution to be started.

StartChildWorkflowExecutionFailedEventAttributes

Description

Provides the details of the StartChildWorkflowExecutionFailed event.

Members
cause
Required: Yes
Type: string

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

When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

control
Type: string

The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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 chain of events.

initiatedEventId
Required: Yes
Type: long (int|float)

When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.

When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.

workflowId
Required: Yes
Type: string

The workflowId of the child workflow execution.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type provided in the StartChildWorkflowExecution Decision that failed.

StartChildWorkflowExecutionInitiatedEventAttributes

Description

Provides the details of the StartChildWorkflowExecutionInitiated event.

Members
childPolicy
Required: Yes
Type: string

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 are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

control
Type: string

Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

executionStartToCloseTimeout
Type: string

The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

input
Type: string

The inputs provided to the child workflow execution.

lambdaRole
Type: string

The IAM role to attach to the child workflow execution.

tagList
Type: Array of strings

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

taskList
Required: Yes
Type: TaskList structure

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

taskPriority
Type: string

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

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

taskStartToCloseTimeout
Type: string

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. You can use NONE to specify unlimited duration.

workflowId
Required: Yes
Type: string

The workflowId of the child workflow execution.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the child workflow execution.

StartLambdaFunctionFailedEventAttributes

Description

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

Members
cause
Type: string

The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.

message
Type: string

A description that can help diagnose the cause of the fault.

scheduledEventId
Type: long (int|float)

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

StartTimerDecisionAttributes

Description

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.

Members
control
Type: string

The data attached to the event that can be used by the decider in subsequent workflow tasks.

startToFireTimeout
Required: Yes
Type: string

The duration to wait before firing the timer.

The duration is specified in seconds, an integer greater than or equal to 0.

timerId
Required: Yes
Type: string

The unique ID of the timer.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

StartTimerFailedEventAttributes

Description

Provides the details of the StartTimerFailed event.

Members
cause
Required: Yes
Type: string

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 in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

timerId
Required: Yes
Type: string

The timerId provided in the StartTimer decision that failed.

TagFilter

Description

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

Members
tag
Required: Yes
Type: string

Specifies the tag that must be associated with the execution for it to meet the filter criteria.

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

TaskList

Description

Represents a task list.

Members
name
Required: Yes
Type: string

The name of the task list.

TimerCanceledEventAttributes

Description

Provides the details of the TimerCanceled event.

Members
decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

startedEventId
Required: Yes
Type: long (int|float)

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

timerId
Required: Yes
Type: string

The unique ID of the timer that was canceled.

TimerFiredEventAttributes

Description

Provides the details of the TimerFired event.

Members
startedEventId
Required: Yes
Type: long (int|float)

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

timerId
Required: Yes
Type: string

The unique ID of the timer that fired.

TimerStartedEventAttributes

Description

Provides the details of the TimerStarted event.

Members
control
Type: string

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

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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

startToFireTimeout
Required: Yes
Type: string

The duration of time after which the timer fires.

The duration is specified in seconds, an integer greater than or equal to 0.

timerId
Required: Yes
Type: string

The unique ID of the timer that was started.

TooManyTagsFault

Description

You've exceeded the number of tags allowed for a domain.

Members
message
Type: string

TypeAlreadyExistsFault

Description

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

TypeDeprecatedFault

Description

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

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

TypeNotDeprecatedFault

Description

Returned when the resource type has not been deprecated.

Members
message
Type: string

UnknownResourceFault

Description

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.

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

WorkflowExecution

Description

Represents a workflow execution.

Members
runId
Required: Yes
Type: string

A system-generated unique identifier for the workflow execution.

workflowId
Required: Yes
Type: string

The user defined identifier associated with the workflow execution.

WorkflowExecutionAlreadyStartedFault

Description

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

Members
message
Type: string

A description that may help with diagnosing the cause of the fault.

WorkflowExecutionCancelRequestedEventAttributes

Description

Provides the details of the WorkflowExecutionCancelRequested event.

Members
cause
Type: string

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

externalInitiatedEventId
Type: long (int|float)

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

externalWorkflowExecution
Type: WorkflowExecution structure

The external workflow execution for which the cancellation was requested.

WorkflowExecutionCanceledEventAttributes

Description

Provides the details of the WorkflowExecutionCanceled event.

Members
decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

details
Type: string

The details of the cancellation.

WorkflowExecutionCompletedEventAttributes

Description

Provides the details of the WorkflowExecutionCompleted event.

Members
decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

result
Type: string

The result produced by the workflow execution upon successful completion.

WorkflowExecutionConfiguration

Description

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.

Members
childPolicy
Required: Yes
Type: string

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

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

executionStartToCloseTimeout
Required: Yes
Type: string

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

lambdaRole
Type: string

The IAM role attached to the child workflow execution.

taskList
Required: Yes
Type: TaskList structure

The task list used for the decision tasks generated for this workflow execution.

taskPriority
Type: string

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

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

taskStartToCloseTimeout
Required: Yes
Type: string

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

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

WorkflowExecutionContinuedAsNewEventAttributes

Description

Provides the details of the WorkflowExecutionContinuedAsNew event.

Members
childPolicy
Required: Yes
Type: string

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.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

executionStartToCloseTimeout
Type: string

The total duration allowed for the new workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

input
Type: string

The input provided to the new workflow execution.

lambdaRole
Type: string

The IAM role to attach to the new (continued) workflow execution.

newExecutionRunId
Required: Yes
Type: string

The runId of the new workflow execution.

tagList
Type: Array of strings

The list of tags associated with the new workflow execution.

taskList
Required: Yes
Type: TaskList structure

The task list to use for the decisions of the new (continued) workflow execution.

taskPriority
Type: string

The priority of the task to use for the decisions of the new (continued) workflow execution.

taskStartToCloseTimeout
Type: string

The maximum duration of decision tasks for the new workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type of this execution.

WorkflowExecutionFailedEventAttributes

Description

Provides the details of the WorkflowExecutionFailed event.

Members
decisionTaskCompletedEventId
Required: Yes
Type: long (int|float)

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.

details
Type: string

The details of the failure.

reason
Type: string

The descriptive reason provided for the failure.

WorkflowExecutionFilter

Description

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

Members
workflowId
Required: Yes
Type: string

The workflowId to pass of match the criteria of this filter.

WorkflowExecutionInfo

Description

Contains information about a workflow execution.

Members
cancelRequested
Type: boolean

Set to true if a cancellation is requested for this workflow execution.

closeStatus
Type: string

If the execution status is closed then this specifies how the execution was closed:

  • COMPLETED – the execution was successfully completed.

  • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

  • TERMINATED – the execution was force terminated.

  • FAILED – the execution failed to complete.

  • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

  • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

closeTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

execution
Required: Yes
Type: WorkflowExecution structure

The workflow execution this information is about.

executionStatus
Required: Yes
Type: string

The current status of the execution.

parent
Type: WorkflowExecution structure

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

startTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the execution was started.

tagList
Type: Array of strings

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

workflowType
Required: Yes
Type: WorkflowType structure

The type of the workflow execution.

WorkflowExecutionOpenCounts

Description

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

Members
openActivityTasks
Required: Yes
Type: int

The count of activity tasks whose status is OPEN.

openChildWorkflowExecutions
Required: Yes
Type: int

The count of child workflow executions whose status is OPEN.

openDecisionTasks
Required: Yes
Type: int

The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

openLambdaFunctions
Type: int

The count of Lambda tasks whose status is OPEN.

openTimers
Required: Yes
Type: int

The count of timers started by this workflow execution that have not fired yet.

WorkflowExecutionSignaledEventAttributes

Description

Provides the details of the WorkflowExecutionSignaled event.

Members
externalInitiatedEventId
Type: long (int|float)

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

externalWorkflowExecution
Type: WorkflowExecution structure

The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

input
Type: string

The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

signalName
Required: Yes
Type: string

The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

WorkflowExecutionStartedEventAttributes

Description

Provides details of WorkflowExecutionStarted event.

Members
childPolicy
Required: Yes
Type: string

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

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

continuedExecutionRunId
Type: string

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

executionStartToCloseTimeout
Type: string

The maximum duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

input
Type: string

The input provided to the workflow execution.

lambdaRole
Type: string

The IAM role attached to the workflow execution.

parentInitiatedEventId
Type: long (int|float)

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

parentWorkflowExecution
Type: WorkflowExecution structure

The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

tagList
Type: Array of strings

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

taskList
Required: Yes
Type: TaskList structure

The name of the task list for scheduling the decision tasks for this workflow execution.

taskPriority
Type: string

The priority of the decision tasks in the workflow execution.

taskStartToCloseTimeout
Type: string

The maximum duration of decision tasks for this workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type of this execution.

WorkflowExecutionTerminatedEventAttributes

Description

Provides the details of the WorkflowExecutionTerminated event.

Members
cause
Type: string

If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

childPolicy
Required: Yes
Type: string

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

details
Type: string

The details provided for the termination.

reason
Type: string

The reason provided for the termination.

WorkflowExecutionTimedOutEventAttributes

Description

Provides the details of the WorkflowExecutionTimedOut event.

Members
childPolicy
Required: Yes
Type: string

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

timeoutType
Required: Yes
Type: string

The type of timeout that caused this event.

WorkflowType

Description

Represents a workflow type.

Members
name
Required: Yes
Type: string

The name of the workflow type.

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

version
Required: Yes
Type: string

The version of the workflow type.

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

WorkflowTypeConfiguration

Description

The configuration settings of a workflow type.

Members
defaultChildPolicy
Type: string

The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

defaultExecutionStartToCloseTimeout
Type: string

The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

defaultLambdaRole
Type: string

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

defaultTaskList
Type: TaskList structure

The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

defaultTaskPriority
Type: string

The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

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

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

defaultTaskStartToCloseTimeout
Type: string

The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

WorkflowTypeFilter

Description

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

Members
name
Required: Yes
Type: string

Name of the workflow type.

version
Type: string

Version of the workflow type.

WorkflowTypeInfo

Description

Contains information about a workflow type.

Members
creationDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when this type was registered.

deprecationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

If the type is in deprecated state, then it is set to the date when the type was deprecated.

description
Type: string

The description of the type registered through RegisterWorkflowType.

status
Required: Yes
Type: string

The current status of the workflow type.

workflowType
Required: Yes
Type: WorkflowType structure

The workflow type this information is about.