2014/10/16 - Amazon Simple Workflow Service - 31 new api methods
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.
Warning
If the identified workflow execution was in progress, it is terminated immediately.
Note
If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.
Note
You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.terminate_workflow_execution(
domain='string',
workflowId='string',
runId='string',
reason='string',
details='string',
childPolicy='TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
)
string
[REQUIRED]
The domain of the workflow execution to terminate.
string
[REQUIRED]
The workflowId of the workflow execution to terminate.
string
The runId of the workflow execution to terminate.
string
An optional descriptive reason for terminating the workflow execution.
string
Optional details for terminating the workflow execution.
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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
Note
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, a fault will be returned.
None
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.register_domain(
name='string',
description='string',
workflowExecutionRetentionPeriodInDays='string'
)
string
[REQUIRED]
Name of the domain to register. The name must be unique.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
string
Textual description of the domain.
string
[REQUIRED]
Specifies the duration--in days --for which the record (including the history) of workflow executions in this domain should be kept by the service. After the retention period, the workflow execution will not be available in the results of visibility calls. If a duration of NONE is specified, the records for workflow executions in this domain are not retained at all.
None
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.describe_workflow_type(
domain='string',
workflowType={
'name': 'string',
'version': 'string'
}
)
string
[REQUIRED]
The name of the domain in which this workflow type is registered.
dict
[REQUIRED]
The workflow type to describe.
name (string) -- [REQUIRED]
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) -- [REQUIRED]
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
dict
Response Syntax
{
'typeInfo': {
'workflowType': {
'name': 'string',
'version': 'string'
},
'status': 'REGISTERED'|'DEPRECATED',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'deprecationDate': datetime(2015, 1, 1)
},
'configuration': {
'defaultTaskStartToCloseTimeout': 'string',
'defaultExecutionStartToCloseTimeout': 'string',
'defaultTaskList': {
'name': 'string'
},
'defaultChildPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
}
}
Response Structure
(dict) --
Contains details about a workflow type.
typeInfo (dict) --
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.
workflowType (dict) --
The workflow type this information is about.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
status (string) --
The current status of the workflow type.
description (string) --
The description of the type registered through RegisterWorkflowType.
creationDate (datetime) --
The date when this type was registered.
deprecationDate (datetime) --
If the type is in deprecated state, then it is set to the date when the type was deprecated.
configuration (dict) --
Configuration settings of the workflow type registered through RegisterWorkflowType
defaultTaskStartToCloseTimeout (string) --
The optional 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 does not 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
defaultExecutionStartToCloseTimeout (string) --
The optional 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
defaultTaskList (dict) --
The optional 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.
name (string) --
The name of the task list.
defaultChildPolicy (string) --
The optional 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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.count_open_workflow_executions(
domain='string',
startTimeFilter={
'oldestDate': datetime(2015, 1, 1),
'latestDate': datetime(2015, 1, 1)
},
typeFilter={
'name': 'string',
'version': 'string'
},
tagFilter={
'tag': 'string'
},
executionFilter={
'workflowId': 'string'
}
)
string
[REQUIRED]
The name of the domain containing the workflow executions to count.
dict
[REQUIRED]
Specifies the start time criteria that workflow executions must meet in order to be counted.
oldestDate (datetime) -- [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) --
Specifies the latest start or close date and time to return.
dict
Specifies the type of the workflow executions to be counted.
Note
executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
name (string) -- [REQUIRED]
Name of the workflow type. This field is required.
version (string) --
Version of the workflow type.
dict
If specified, only executions that have a tag that matches the filter are counted.
Note
executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
tag (string) -- [REQUIRED]
Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.
dict
If specified, only workflow executions matching the WorkflowId in the filter are counted.
Note
executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
workflowId (string) -- [REQUIRED]
The workflowId to pass of match the criteria of this filter.
dict
Response Syntax
{
'count': 123,
'truncated': True|False
}
Response Structure
(dict) --
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
count (integer) --
The number of workflow executions.
truncated (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.
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.
Warning
If the requested task does not 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.respond_activity_task_completed(
taskToken='string',
result='string'
)
string
[REQUIRED]
The taskToken of the ActivityTask.
Warning
The 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.
string
The result of the activity task. It is a free form string that is implementation specific.
None
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.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.list_open_workflow_executions(
domain='string',
startTimeFilter={
'oldestDate': datetime(2015, 1, 1),
'latestDate': datetime(2015, 1, 1)
},
typeFilter={
'name': 'string',
'version': 'string'
},
tagFilter={
'tag': 'string'
},
nextPageToken='string',
maximumPageSize=123,
reverseOrder=True|False,
executionFilter={
'workflowId': 'string'
}
)
string
[REQUIRED]
The name of the domain that contains the workflow executions to list.
dict
[REQUIRED]
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
oldestDate (datetime) -- [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) --
Specifies the latest start or close date and time to return.
dict
If specified, only executions of the type specified in the filter are returned.
Note
executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
name (string) -- [REQUIRED]
Name of the workflow type. This field is required.
version (string) --
Version of the workflow type.
dict
If specified, only executions that have the matching tag are listed.
Note
executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
tag (string) -- [REQUIRED]
Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.
string
If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.
integer
The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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.
dict
If specified, only workflow executions matching the workflow id specified in the filter are returned.
Note
executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
workflowId (string) -- [REQUIRED]
The workflowId to pass of match the criteria of this filter.
dict
Response Syntax
{
'executionInfos': [
{
'execution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'startTimestamp': datetime(2015, 1, 1),
'closeTimestamp': datetime(2015, 1, 1),
'executionStatus': 'OPEN'|'CLOSED',
'closeStatus': 'COMPLETED'|'FAILED'|'CANCELED'|'TERMINATED'|'CONTINUED_AS_NEW'|'TIMED_OUT',
'parent': {
'workflowId': 'string',
'runId': 'string'
},
'tagList': [
'string',
],
'cancelRequested': True|False
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
Contains a paginated list of information about workflow executions.
executionInfos (list) --
The list of workflow information structures.
(dict) --
Contains information about a workflow execution.
execution (dict) --
The workflow execution this information is about.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
startTimestamp (datetime) --
The time when the execution was started.
closeTimestamp (datetime) --
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
executionStatus (string) --
The current status of the execution.
closeStatus (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.
parent (dict) --
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
tagList (list) --
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.
(string) --
cancelRequested (boolean) --
Set to true if a cancellation is requested for this workflow execution.
nextPageToken (string) --
The token of the next page in the result. If set, the results have more than one page. The next page can be retrieved by repeating the request with this token and all other arguments unchanged.
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.count_closed_workflow_executions(
domain='string',
startTimeFilter={
'oldestDate': datetime(2015, 1, 1),
'latestDate': datetime(2015, 1, 1)
},
closeTimeFilter={
'oldestDate': datetime(2015, 1, 1),
'latestDate': datetime(2015, 1, 1)
},
executionFilter={
'workflowId': 'string'
},
typeFilter={
'name': 'string',
'version': 'string'
},
tagFilter={
'tag': 'string'
},
closeStatusFilter={
'status': 'COMPLETED'|'FAILED'|'CANCELED'|'TERMINATED'|'CONTINUED_AS_NEW'|'TIMED_OUT'
}
)
string
[REQUIRED]
The name of the domain containing the workflow executions to count.
dict
If specified, only workflow executions that meet the start time criteria of the filter are counted.
Note
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
oldestDate (datetime) -- [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) --
Specifies the latest start or close date and time to return.
dict
If specified, only workflow executions that meet the close time criteria of the filter are counted.
Note
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
oldestDate (datetime) -- [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) --
Specifies the latest start or close date and time to return.
dict
If specified, only workflow executions matching the WorkflowId in the filter are counted.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
workflowId (string) -- [REQUIRED]
The workflowId to pass of match the criteria of this filter.
dict
If specified, indicates the type of the workflow executions to be counted.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
name (string) -- [REQUIRED]
Name of the workflow type. This field is required.
version (string) --
Version of the workflow type.
dict
If specified, only executions that have a tag that matches the filter are counted.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
tag (string) -- [REQUIRED]
Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.
dict
If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED .
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
status (string) -- [REQUIRED]
The close status that must match the close status of an execution for it to meet the criteria of this filter. This field is required.
dict
Response Syntax
{
'count': 123,
'truncated': True|False
}
Response Structure
(dict) --
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
count (integer) --
The number of workflow executions.
truncated (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.
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.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.list_domains(
nextPageToken='string',
registrationStatus='REGISTERED'|'DEPRECATED',
maximumPageSize=123,
reverseOrder=True|False
)
string
If on a previous call to this method a NextPageToken was returned, the result has more than one page. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.
string
[REQUIRED]
Specifies the registration status of the domains to list.
integer
The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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 domains.
dict
Response Syntax
{
'domainInfos': [
{
'name': 'string',
'status': 'REGISTERED'|'DEPRECATED',
'description': 'string'
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
Contains a paginated collection of DomainInfo structures.
domainInfos (list) --
A list of DomainInfo structures.
(dict) --
Contains general information about a domain.
name (string) --
The name of the domain. This name is unique within the account.
status (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.
description (string) --
The description of the domain provided through RegisterDomain.
nextPageToken (string) --
Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.describe_activity_type(
domain='string',
activityType={
'name': 'string',
'version': 'string'
}
)
string
[REQUIRED]
The name of the domain in which the activity type is registered.
dict
[REQUIRED]
The activity type to describe.
name (string) -- [REQUIRED]
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) -- [REQUIRED]
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
dict
Response Syntax
{
'typeInfo': {
'activityType': {
'name': 'string',
'version': 'string'
},
'status': 'REGISTERED'|'DEPRECATED',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'deprecationDate': datetime(2015, 1, 1)
},
'configuration': {
'defaultTaskStartToCloseTimeout': 'string',
'defaultTaskHeartbeatTimeout': 'string',
'defaultTaskList': {
'name': 'string'
},
'defaultTaskScheduleToStartTimeout': 'string',
'defaultTaskScheduleToCloseTimeout': 'string'
}
}
Response Structure
(dict) --
Detailed information about an activity type.
typeInfo (dict) --
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.
activityType (dict) --
The ActivityType type structure representing the activity type.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
status (string) --
The current status of the activity type.
description (string) --
The description of the activity type provided in RegisterActivityType.
creationDate (datetime) --
The date and time this activity type was created through RegisterActivityType.
deprecationDate (datetime) --
If DEPRECATED, the date and time DeprecateActivityType was called.
configuration (dict) --
The configuration settings registered with the activity type.
defaultTaskStartToCloseTimeout (string) --
The optional 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
defaultTaskHeartbeatTimeout (string) --
The optional default maximum time, specified when registering the activity type, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat. You can override this default when scheduling 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
defaultTaskList (dict) --
The optional default task list specified for this activity type at registration. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
name (string) --
The name of the task list.
defaultTaskScheduleToStartTimeout (string) --
The optional 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
defaultTaskScheduleToCloseTimeout (string) --
The optional 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Registers a new activity type along with its configuration settings in the specified domain.
Warning
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.register_activity_type(
domain='string',
name='string',
version='string',
description='string',
defaultTaskStartToCloseTimeout='string',
defaultTaskHeartbeatTimeout='string',
defaultTaskList={
'name': 'string'
},
defaultTaskScheduleToStartTimeout='string',
defaultTaskScheduleToCloseTimeout='string'
)
string
[REQUIRED]
The name of the domain in which this activity is to be registered.
string
[REQUIRED]
The name of the activity type within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
string
[REQUIRED]
The version of the activity type.
Note
The activity type consists of the name and version, the combination of which must be unique within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
string
A textual description of the activity 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
dict
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 is not provided when a task is scheduled through the ScheduleActivityTask Decision.
name (string) -- [REQUIRED]
The name of the task list.
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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
None
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.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.get_workflow_execution_history(
domain='string',
execution={
'workflowId': 'string',
'runId': 'string'
},
nextPageToken='string',
maximumPageSize=123,
reverseOrder=True|False
)
string
[REQUIRED]
The name of the domain containing the workflow execution.
dict
[REQUIRED]
Specifies the workflow execution for which to return the history.
workflowId (string) -- [REQUIRED]
The user defined identifier associated with the workflow execution.
runId (string) -- [REQUIRED]
A system generated unique identifier for the workflow execution.
string
If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.
integer
Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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.
dict
Response Syntax
{
'events': [
{
'eventTimestamp': datetime(2015, 1, 1),
'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',
'eventId': 123,
'workflowExecutionStartedEventAttributes': {
'input': 'string',
'executionStartToCloseTimeout': 'string',
'taskStartToCloseTimeout': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'taskList': {
'name': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'tagList': [
'string',
],
'continuedExecutionRunId': 'string',
'parentWorkflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'parentInitiatedEventId': 123
},
'workflowExecutionCompletedEventAttributes': {
'result': 'string',
'decisionTaskCompletedEventId': 123
},
'completeWorkflowExecutionFailedEventAttributes': {
'cause': 'UNHANDLED_DECISION'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionFailedEventAttributes': {
'reason': 'string',
'details': 'string',
'decisionTaskCompletedEventId': 123
},
'failWorkflowExecutionFailedEventAttributes': {
'cause': 'UNHANDLED_DECISION'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionTimedOutEventAttributes': {
'timeoutType': 'START_TO_CLOSE',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
},
'workflowExecutionCanceledEventAttributes': {
'details': 'string',
'decisionTaskCompletedEventId': 123
},
'cancelWorkflowExecutionFailedEventAttributes': {
'cause': 'UNHANDLED_DECISION'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionContinuedAsNewEventAttributes': {
'input': 'string',
'decisionTaskCompletedEventId': 123,
'newExecutionRunId': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'taskStartToCloseTimeout': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'tagList': [
'string',
],
'workflowType': {
'name': 'string',
'version': 'string'
}
},
'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'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionTerminatedEventAttributes': {
'reason': 'string',
'details': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'cause': 'CHILD_POLICY_APPLIED'|'EVENT_LIMIT_EXCEEDED'|'OPERATOR_INITIATED'
},
'workflowExecutionCancelRequestedEventAttributes': {
'externalWorkflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'externalInitiatedEventId': 123,
'cause': 'CHILD_POLICY_APPLIED'
},
'decisionTaskScheduledEventAttributes': {
'taskList': {
'name': 'string'
},
'startToCloseTimeout': 'string'
},
'decisionTaskStartedEventAttributes': {
'identity': 'string',
'scheduledEventId': 123
},
'decisionTaskCompletedEventAttributes': {
'executionContext': 'string',
'scheduledEventId': 123,
'startedEventId': 123
},
'decisionTaskTimedOutEventAttributes': {
'timeoutType': 'START_TO_CLOSE',
'scheduledEventId': 123,
'startedEventId': 123
},
'activityTaskScheduledEventAttributes': {
'activityType': {
'name': 'string',
'version': 'string'
},
'activityId': 'string',
'input': 'string',
'control': 'string',
'scheduleToStartTimeout': 'string',
'scheduleToCloseTimeout': 'string',
'startToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'decisionTaskCompletedEventId': 123,
'heartbeatTimeout': 'string'
},
'activityTaskStartedEventAttributes': {
'identity': 'string',
'scheduledEventId': 123
},
'activityTaskCompletedEventAttributes': {
'result': 'string',
'scheduledEventId': 123,
'startedEventId': 123
},
'activityTaskFailedEventAttributes': {
'reason': 'string',
'details': 'string',
'scheduledEventId': 123,
'startedEventId': 123
},
'activityTaskTimedOutEventAttributes': {
'timeoutType': 'START_TO_CLOSE'|'SCHEDULE_TO_START'|'SCHEDULE_TO_CLOSE'|'HEARTBEAT',
'scheduledEventId': 123,
'startedEventId': 123,
'details': 'string'
},
'activityTaskCanceledEventAttributes': {
'details': 'string',
'scheduledEventId': 123,
'startedEventId': 123,
'latestCancelRequestedEventId': 123
},
'activityTaskCancelRequestedEventAttributes': {
'decisionTaskCompletedEventId': 123,
'activityId': 'string'
},
'workflowExecutionSignaledEventAttributes': {
'signalName': 'string',
'input': 'string',
'externalWorkflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'externalInitiatedEventId': 123
},
'markerRecordedEventAttributes': {
'markerName': 'string',
'details': 'string',
'decisionTaskCompletedEventId': 123
},
'recordMarkerFailedEventAttributes': {
'markerName': 'string',
'cause': 'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'timerStartedEventAttributes': {
'timerId': 'string',
'control': 'string',
'startToFireTimeout': 'string',
'decisionTaskCompletedEventId': 123
},
'timerFiredEventAttributes': {
'timerId': 'string',
'startedEventId': 123
},
'timerCanceledEventAttributes': {
'timerId': 'string',
'startedEventId': 123,
'decisionTaskCompletedEventId': 123
},
'startChildWorkflowExecutionInitiatedEventAttributes': {
'workflowId': 'string',
'workflowType': {
'name': 'string',
'version': 'string'
},
'control': 'string',
'input': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'decisionTaskCompletedEventId': 123,
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'taskStartToCloseTimeout': 'string',
'tagList': [
'string',
]
},
'childWorkflowExecutionStartedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'initiatedEventId': 123
},
'childWorkflowExecutionCompletedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'result': 'string',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionFailedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'reason': 'string',
'details': 'string',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionTimedOutEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'timeoutType': 'START_TO_CLOSE',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionCanceledEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'details': 'string',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionTerminatedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'initiatedEventId': 123,
'startedEventId': 123
},
'signalExternalWorkflowExecutionInitiatedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'signalName': 'string',
'input': 'string',
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'externalWorkflowExecutionSignaledEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'initiatedEventId': 123
},
'signalExternalWorkflowExecutionFailedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'cause': 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION'|'SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED'|'OPERATION_NOT_PERMITTED',
'initiatedEventId': 123,
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'externalWorkflowExecutionCancelRequestedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'initiatedEventId': 123
},
'requestCancelExternalWorkflowExecutionInitiatedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'requestCancelExternalWorkflowExecutionFailedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'cause': 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION'|'REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED'|'OPERATION_NOT_PERMITTED',
'initiatedEventId': 123,
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'scheduleActivityTaskFailedEventAttributes': {
'activityType': {
'name': 'string',
'version': 'string'
},
'activityId': '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': 123
},
'requestCancelActivityTaskFailedEventAttributes': {
'activityId': 'string',
'cause': 'ACTIVITY_ID_UNKNOWN'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'startTimerFailedEventAttributes': {
'timerId': 'string',
'cause': 'TIMER_ID_ALREADY_IN_USE'|'OPEN_TIMERS_LIMIT_EXCEEDED'|'TIMER_CREATION_RATE_EXCEEDED'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'cancelTimerFailedEventAttributes': {
'timerId': 'string',
'cause': 'TIMER_ID_UNKNOWN'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'startChildWorkflowExecutionFailedEventAttributes': {
'workflowType': {
'name': 'string',
'version': 'string'
},
'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',
'workflowId': 'string',
'initiatedEventId': 123,
'decisionTaskCompletedEventId': 123,
'control': 'string'
}
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
events (list) --
The list of history events.
(dict) --
Event within a workflow execution. A history event can be one of these types:
WorkflowExecutionStarted : The workflow execution was started.
WorkflowExecutionCompleted : The workflow execution was closed due to successful completion.
WorkflowExecutionFailed : The workflow execution closed due to a failure.
WorkflowExecutionTimedOut : The workflow execution was closed because a time out was exceeded.
WorkflowExecutionCanceled : The workflow execution was successfully canceled and closed.
WorkflowExecutionTerminated : The workflow execution was terminated.
WorkflowExecutionContinuedAsNew : The workflow execution was closed and a new execution of the same type was created with the same workflowId.
WorkflowExecutionCancelRequested : A request to cancel this workflow execution was made.
DecisionTaskScheduled : A decision task was scheduled for the workflow execution.
DecisionTaskStarted : The decision task was dispatched to a decider.
DecisionTaskCompleted : The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.
DecisionTaskTimedOut : The decision task timed out.
ActivityTaskScheduled : An activity task was scheduled for execution.
ScheduleActivityTaskFailed : Failed to process ScheduleActivityTask decision. This happens when the decision is not configured properly, for example the activity type specified is not registered.
ActivityTaskStarted : The scheduled activity task was dispatched to a worker.
ActivityTaskCompleted : An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.
ActivityTaskFailed : An activity worker failed an activity task by calling RespondActivityTaskFailed.
ActivityTaskTimedOut : The activity task timed out.
ActivityTaskCanceled : The activity task was successfully canceled.
ActivityTaskCancelRequested : A RequestCancelActivityTask decision was received by the system.
RequestCancelActivityTaskFailed : Failed to process RequestCancelActivityTask decision. This happens when the decision is not configured properly.
WorkflowExecutionSignaled : An external signal was received for the workflow execution.
MarkerRecorded : A marker was recorded in the workflow history as the result of a RecordMarker decision.
TimerStarted : A timer was started for the workflow execution due to a StartTimer decision.
StartTimerFailed : Failed to process StartTimer decision. This happens when the decision is not configured properly, for example a timer already exists with the specified timer Id.
TimerFired : A timer, previously started for this workflow execution, fired.
TimerCanceled : A timer, previously started for this workflow execution, was successfully canceled.
CancelTimerFailed : Failed to process CancelTimer decision. This happens when the decision is not configured properly, for example no timer exists with the specified timer Id.
StartChildWorkflowExecutionInitiated : A request was made to start a child workflow execution.
StartChildWorkflowExecutionFailed : Failed to process StartChildWorkflowExecution decision. This happens when the decision is not configured properly, for example the workflow type specified is not registered.
ChildWorkflowExecutionStarted : A child workflow execution was successfully started.
ChildWorkflowExecutionCompleted : A child workflow execution, started by this workflow execution, completed successfully and was closed.
ChildWorkflowExecutionFailed : A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.
ChildWorkflowExecutionTimedOut : A child workflow execution, started by this workflow execution, timed out and was closed.
ChildWorkflowExecutionCanceled : A child workflow execution, started by this workflow execution, was canceled and closed.
ChildWorkflowExecutionTerminated : A child workflow execution, started by this workflow execution, was terminated.
SignalExternalWorkflowExecutionInitiated : A request to signal an external workflow was made.
ExternalWorkflowExecutionSignaled : A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
SignalExternalWorkflowExecutionFailed : The request to signal an external workflow execution failed.
RequestCancelExternalWorkflowExecutionInitiated : A request was made to request the cancellation of an external workflow execution.
ExternalWorkflowExecutionCancelRequested : Request to cancel an external workflow execution was successfully delivered to the target execution.
RequestCancelExternalWorkflowExecutionFailed : Request to cancel an external workflow execution failed.
eventTimestamp (datetime) --
The date and time when the event occurred.
eventType (string) --
The type of the history event.
eventId (integer) --
The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.
workflowExecutionStartedEventAttributes (dict) --
If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
input (string) --
The input provided to the workflow execution (if any).
executionStartToCloseTimeout (string) --
The maximum duration for this workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskStartToCloseTimeout (string) --
The maximum duration of decision tasks for this workflow type.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
taskList (dict) --
The name of the task list for scheduling the decision tasks for this workflow execution.
name (string) --
The name of the task list.
workflowType (dict) --
The workflow type of this execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
tagList (list) --
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
(string) --
continuedExecutionRunId (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.
parentWorkflowExecution (dict) --
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
parentInitiatedEventId (integer) --
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.
workflowExecutionCompletedEventAttributes (dict) --
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
result (string) --
The result produced by the workflow execution upon successful completion.
decisionTaskCompletedEventId (integer) --
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 cause of events.
completeWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionFailedEventAttributes (dict) --
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
reason (string) --
The descriptive reason provided for the failure (if any).
details (string) --
The details of the failure (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events.
failWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionTimedOutEventAttributes (dict) --
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType (string) --
The type of timeout that caused this event.
childPolicy (string) --
The policy used for the child workflow executions of this workflow execution. The supported child policies are:
TERMINATE: the child executions will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
workflowExecutionCanceledEventAttributes (dict) --
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
details (string) --
Details for the cancellation (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events.
cancelWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionContinuedAsNewEventAttributes (dict) --
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.
input (string) --
The input provided to the new workflow execution.
decisionTaskCompletedEventId (integer) --
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 cause of events.
newExecutionRunId (string) --
The runId of the new workflow execution.
executionStartToCloseTimeout (string) --
The total duration allowed for the new workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskList (dict) --
Represents a task list.
name (string) --
The name of the task list.
taskStartToCloseTimeout (string) --
The maximum duration of decision tasks for the new workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
tagList (list) --
The list of tags associated with the new workflow execution.
(string) --
workflowType (dict) --
Represents a workflow type.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
continueAsNewWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionTerminatedEventAttributes (dict) --
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
reason (string) --
The reason provided for the termination (if any).
details (string) --
The details provided for the termination (if any).
childPolicy (string) --
The policy used for the child workflow executions of this workflow execution. The supported child policies are:
TERMINATE: the child executions will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
cause (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.
workflowExecutionCancelRequestedEventAttributes (dict) --
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
externalWorkflowExecution (dict) --
The external workflow execution for which the cancellation was requested.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
externalInitiatedEventId (integer) --
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.
cause (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.
decisionTaskScheduledEventAttributes (dict) --
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
taskList (dict) --
The name of the task list in which the decision task was scheduled.
name (string) --
The name of the task list.
startToCloseTimeout (string) --
The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
decisionTaskStartedEventAttributes (dict) --
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
identity (string) --
Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
scheduledEventId (integer) --
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.
decisionTaskCompletedEventAttributes (dict) --
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
executionContext (string) --
User defined context for the workflow execution.
scheduledEventId (integer) --
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 (integer) --
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.
decisionTaskTimedOutEventAttributes (dict) --
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType (string) --
The type of timeout that expired before the decision task could be completed.
scheduledEventId (integer) --
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 (integer) --
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.
activityTaskScheduledEventAttributes (dict) --
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
activityType (dict) --
The type of the activity task.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId (string) --
The unique id of the activity task.
input (string) --
The input provided to the activity task.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
scheduleToStartTimeout (string) --
The maximum amount of time the activity task can wait to be assigned to a worker.
scheduleToCloseTimeout (string) --
The maximum amount of time for this activity task.
startToCloseTimeout (string) --
The maximum amount of time a worker may take to process the activity task.
taskList (dict) --
The task list in which the activity task has been scheduled.
name (string) --
The name of the task list.
decisionTaskCompletedEventId (integer) --
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 (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 will be ignored.
activityTaskStartedEventAttributes (dict) --
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
identity (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 (integer) --
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.
activityTaskCompletedEventAttributes (dict) --
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
result (string) --
The results of the activity task (if any).
scheduledEventId (integer) --
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 (integer) --
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 (dict) --
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
reason (string) --
The reason provided for the failure (if any).
details (string) --
The details of the failure (if any).
scheduledEventId (integer) --
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 (integer) --
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.
activityTaskTimedOutEventAttributes (dict) --
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType (string) --
The type of the timeout that caused this event.
scheduledEventId (integer) --
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 (integer) --
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.
details (string) --
Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat .
activityTaskCanceledEventAttributes (dict) --
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
details (string) --
Details of the cancellation (if any).
scheduledEventId (integer) --
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 (integer) --
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.
latestCancelRequestedEventId (integer) --
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.
activityTaskCancelRequestedEventAttributes (dict) --
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
decisionTaskCompletedEventId (integer) --
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 cause of events.
activityId (string) --
The unique ID of the task.
workflowExecutionSignaledEventAttributes (dict) --
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
signalName (string) --
The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
input (string) --
Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
externalWorkflowExecution (dict) --
The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
externalInitiatedEventId (integer) --
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.
markerRecordedEventAttributes (dict) --
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.
markerName (string) --
The name of the marker.
details (string) --
Details of the marker (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events.
recordMarkerFailedEventAttributes (dict) --
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
markerName (string) --
The marker's name.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
timerStartedEventAttributes (dict) --
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The unique Id of the timer that was started.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
startToFireTimeout (string) --
The duration of time after which the timer will fire.
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
decisionTaskCompletedEventId (integer) --
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 cause of events.
timerFiredEventAttributes (dict) --
If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The unique Id of the timer that fired.
startedEventId (integer) --
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.
timerCanceledEventAttributes (dict) --
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The unique Id of the timer that was canceled.
startedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
startChildWorkflowExecutionInitiatedEventAttributes (dict) --
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the child workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
input (string) --
The inputs provided to the child workflow execution (if any).
executionStartToCloseTimeout (string) --
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskList (dict) --
The name of the task list used for the decision tasks of the child workflow execution.
name (string) --
The name of the task list.
decisionTaskCompletedEventId (integer) --
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.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
taskStartToCloseTimeout (string) --
The maximum duration allowed for the decision tasks for this workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
tagList (list) --
The list of tags to associated with the child workflow execution.
(string) --
childWorkflowExecutionStartedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was started.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
initiatedEventId (integer) --
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.
childWorkflowExecutionCompletedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was completed.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
result (string) --
The result of the child workflow execution (if any).
initiatedEventId (integer) --
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 (integer) --
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
childWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that failed.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
reason (string) --
The reason for the failure (if provided).
details (string) --
The details of the failure (if provided).
initiatedEventId (integer) --
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 (integer) --
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
childWorkflowExecutionTimedOutEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that timed out.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
timeoutType (string) --
The type of the timeout that caused the child workflow execution to time out.
initiatedEventId (integer) --
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 (integer) --
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.
childWorkflowExecutionCanceledEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was canceled.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
details (string) --
Details of the cancellation (if provided).
initiatedEventId (integer) --
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 (integer) --
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.
childWorkflowExecutionTerminatedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was terminated.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
initiatedEventId (integer) --
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 (integer) --
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.
signalExternalWorkflowExecutionInitiatedEventAttributes (dict) --
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow execution.
runId (string) --
The runId of the external workflow execution to send the signal to.
signalName (string) --
The name of the signal.
input (string) --
Input provided to the signal (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events leading up to this event.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent decision tasks.
externalWorkflowExecutionSignaledEventAttributes (dict) --
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The external workflow execution that the signal was delivered to.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
initiatedEventId (integer) --
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.
signalExternalWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow execution that the signal was being delivered to.
runId (string) --
The runId of the external workflow execution that the signal was being delivered to.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
initiatedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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 cause of events leading up to this event.
control (string) --
externalWorkflowExecutionCancelRequestedEventAttributes (dict) --
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The external workflow execution to which the cancellation request was delivered.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
initiatedEventId (integer) --
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.
requestCancelExternalWorkflowExecutionInitiatedEventAttributes (dict) --
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow execution to be canceled.
runId (string) --
The runId of the external workflow execution to be canceled.
decisionTaskCompletedEventId (integer) --
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 cause of events.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
requestCancelExternalWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow to which the cancel request was to be delivered.
runId (string) --
The runId of the external workflow execution.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
initiatedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
control (string) --
scheduleActivityTaskFailedEventAttributes (dict) --
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
activityType (dict) --
The activity type provided in the ScheduleActivityTask decision that failed.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId (string) --
The activityId provided in the ScheduleActivityTask decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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.
requestCancelActivityTaskFailedEventAttributes (dict) --
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
activityId (string) --
The activityId provided in the RequestCancelActivityTask decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
startTimerFailedEventAttributes (dict) --
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The timerId provided in the StartTimer decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
cancelTimerFailedEventAttributes (dict) --
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The timerId provided in the CancelTimer decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
startChildWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowType (dict) --
The workflow type provided in the StartChildWorkflowExecution Decision that failed.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
workflowId (string) --
The workflowId of the child workflow execution.
initiatedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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.
control (string) --
nextPageToken (string) --
The token for the next page. If set, the history consists of more than one page and the next page can be retrieved by repeating the request with this token and all other arguments unchanged.
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.respond_activity_task_failed(
taskToken='string',
reason='string',
details='string'
)
string
[REQUIRED]
The taskToken of the ActivityTask.
Warning
The 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.
string
Description of the error that may assist in diagnostics.
string
Optional detailed information about the failure.
None
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.count_pending_activity_tasks(
domain='string',
taskList={
'name': 'string'
}
)
string
[REQUIRED]
The name of the domain that contains the task list.
dict
[REQUIRED]
The name of the task list.
name (string) -- [REQUIRED]
The name of the task list.
dict
Response Syntax
{
'count': 123,
'truncated': True|False
}
Response Structure
(dict) --
Contains the count of tasks in a task list.
count (integer) --
The number of tasks in the task list.
truncated (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.
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 .
name : String constraint. The key is swf:workflowType.name .
version : String constraint. The key is swf:workflowType.version .
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.start_workflow_execution(
domain='string',
workflowId='string',
workflowType={
'name': 'string',
'version': 'string'
},
taskList={
'name': 'string'
},
input='string',
executionStartToCloseTimeout='string',
tagList=[
'string',
],
taskStartToCloseTimeout='string',
childPolicy='TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
)
string
[REQUIRED]
The name of the domain in which the workflow execution is created.
string
[REQUIRED]
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.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
dict
[REQUIRED]
The type of the workflow to start.
name (string) -- [REQUIRED]
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) -- [REQUIRED]
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
dict
The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
Note
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
name (string) -- [REQUIRED]
The name of the task list.
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.
string
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds. The valid values are integers greater than or equal to 0. Exceeding this limit will cause 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.
Note
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.
list
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.
(string) --
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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
Note
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
dict
Response Syntax
{
'runId': 'string'
}
Response Structure
(dict) --
Specifies the runId of a workflow execution.
runId (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.
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).
Note
If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.
Note
If the specified workflow execution is not 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.signal_workflow_execution(
domain='string',
workflowId='string',
runId='string',
signalName='string',
input='string'
)
string
[REQUIRED]
The name of the domain containing the workflow execution to signal.
string
[REQUIRED]
The workflowId of the workflow execution to signal.
string
The runId of the workflow execution to signal.
string
[REQUIRED]
The name of the signal. This name must be meaningful to the target workflow.
string
Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
None
Returns information about the specified workflow execution including its type and some statistics.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.describe_workflow_execution(
domain='string',
execution={
'workflowId': 'string',
'runId': 'string'
}
)
string
[REQUIRED]
The name of the domain containing the workflow execution.
dict
[REQUIRED]
The workflow execution to describe.
workflowId (string) -- [REQUIRED]
The user defined identifier associated with the workflow execution.
runId (string) -- [REQUIRED]
A system generated unique identifier for the workflow execution.
dict
Response Syntax
{
'executionInfo': {
'execution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'startTimestamp': datetime(2015, 1, 1),
'closeTimestamp': datetime(2015, 1, 1),
'executionStatus': 'OPEN'|'CLOSED',
'closeStatus': 'COMPLETED'|'FAILED'|'CANCELED'|'TERMINATED'|'CONTINUED_AS_NEW'|'TIMED_OUT',
'parent': {
'workflowId': 'string',
'runId': 'string'
},
'tagList': [
'string',
],
'cancelRequested': True|False
},
'executionConfiguration': {
'taskStartToCloseTimeout': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
},
'openCounts': {
'openActivityTasks': 123,
'openDecisionTasks': 123,
'openTimers': 123,
'openChildWorkflowExecutions': 123
},
'latestActivityTaskTimestamp': datetime(2015, 1, 1),
'latestExecutionContext': 'string'
}
Response Structure
(dict) --
Contains details about a workflow execution.
executionInfo (dict) --
Information about the workflow execution.
execution (dict) --
The workflow execution this information is about.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
startTimestamp (datetime) --
The time when the execution was started.
closeTimestamp (datetime) --
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
executionStatus (string) --
The current status of the execution.
closeStatus (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.
parent (dict) --
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
tagList (list) --
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.
(string) --
cancelRequested (boolean) --
Set to true if a cancellation is requested for this workflow execution.
executionConfiguration (dict) --
The configuration settings for this workflow execution including timeout values, tasklist etc.
taskStartToCloseTimeout (string) --
The maximum duration allowed for decision tasks for this workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
executionStartToCloseTimeout (string) --
The total duration for this workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskList (dict) --
The task list used for the decision tasks generated for this workflow execution.
name (string) --
The name of the task list.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
openCounts (dict) --
The number of tasks for this workflow execution. This includes open and closed tasks of all types.
openActivityTasks (integer) --
The count of activity tasks whose status is OPEN.
openDecisionTasks (integer) --
The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
openTimers (integer) --
The count of timers started by this workflow execution that have not fired yet.
openChildWorkflowExecutions (integer) --
The count of child workflow executions whose status is OPEN.
latestActivityTaskTimestamp (datetime) --
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 (string) --
The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext, which is a free form string, when closing a decision task using RespondDecisionTaskCompleted.
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.
Warning
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.register_workflow_type(
domain='string',
name='string',
version='string',
description='string',
defaultTaskStartToCloseTimeout='string',
defaultExecutionStartToCloseTimeout='string',
defaultTaskList={
'name': 'string'
},
defaultChildPolicy='TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
)
string
[REQUIRED]
The name of the domain in which to register the workflow type.
string
[REQUIRED]
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
string
[REQUIRED]
The version of the workflow type.
Note
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 start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
string
Textual description of the workflow 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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
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. The valid values are integers 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 will always cause the workflow execution to time out.
dict
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 is not provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
name (string) -- [REQUIRED]
The name of the task list.
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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
None
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.list_activity_types(
domain='string',
name='string',
registrationStatus='REGISTERED'|'DEPRECATED',
nextPageToken='string',
maximumPageSize=123,
reverseOrder=True|False
)
string
[REQUIRED]
The name of the domain in which the activity types have been registered.
string
If specified, only lists the activity types that have this name.
string
[REQUIRED]
Specifies the registration status of the activity types to list.
string
If on a previous call to this method a NextResultToken was returned, the results have more than one page. To get the next page of results, repeat the call with the nextPageToken and keep all other arguments unchanged.
integer
The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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 activity types.
dict
Response Syntax
{
'typeInfos': [
{
'activityType': {
'name': 'string',
'version': 'string'
},
'status': 'REGISTERED'|'DEPRECATED',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'deprecationDate': datetime(2015, 1, 1)
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
Contains a paginated list of activity type information structures.
typeInfos (list) --
List of activity type information.
(dict) --
Detailed information about an activity type.
activityType (dict) --
The ActivityType type structure representing the activity type.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
status (string) --
The current status of the activity type.
description (string) --
The description of the activity type provided in RegisterActivityType.
creationDate (datetime) --
The date and time this activity type was created through RegisterActivityType.
deprecationDate (datetime) --
If DEPRECATED, the date and time DeprecateActivityType was called.
nextPageToken (string) --
Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.
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 will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.deprecate_workflow_type(
domain='string',
workflowType={
'name': 'string',
'version': 'string'
}
)
string
[REQUIRED]
The name of the domain in which the workflow type is registered.
dict
[REQUIRED]
The workflow type to deprecate.
name (string) -- [REQUIRED]
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) -- [REQUIRED]
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
None
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 will continue to run.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.deprecate_activity_type(
domain='string',
activityType={
'name': 'string',
'version': 'string'
}
)
string
[REQUIRED]
The name of the domain in which the activity type is registered.
dict
[REQUIRED]
The activity type to deprecate.
name (string) -- [REQUIRED]
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) -- [REQUIRED]
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
None
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 will return 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.
Warning
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.poll_for_activity_task(
domain='string',
taskList={
'name': 'string'
},
identity='string'
)
string
[REQUIRED]
The name of the domain that contains the task lists being polled.
dict
[REQUIRED]
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 contain the literal string "arn".
name (string) -- [REQUIRED]
The name of the task list.
string
Identity of the worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
dict
Response Syntax
{
'taskToken': 'string',
'activityId': 'string',
'startedEventId': 123,
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'activityType': {
'name': 'string',
'version': 'string'
},
'input': 'string'
}
Response Structure
(dict) --
Unit of work sent to an activity worker.
taskToken (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.
activityId (string) --
The unique ID of the task.
startedEventId (integer) --
The id of the ActivityTaskStarted event recorded in the history.
workflowExecution (dict) --
The workflow execution that started this activity task.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
activityType (dict) --
The type of this activity task.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
input (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.
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.
Note
If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.request_cancel_workflow_execution(
domain='string',
workflowId='string',
runId='string'
)
string
[REQUIRED]
The name of the domain containing the workflow execution to cancel.
string
[REQUIRED]
The workflowId of the workflow execution to cancel.
string
The runId of the workflow execution to cancel.
None
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.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.list_closed_workflow_executions(
domain='string',
startTimeFilter={
'oldestDate': datetime(2015, 1, 1),
'latestDate': datetime(2015, 1, 1)
},
closeTimeFilter={
'oldestDate': datetime(2015, 1, 1),
'latestDate': datetime(2015, 1, 1)
},
executionFilter={
'workflowId': 'string'
},
closeStatusFilter={
'status': 'COMPLETED'|'FAILED'|'CANCELED'|'TERMINATED'|'CONTINUED_AS_NEW'|'TIMED_OUT'
},
typeFilter={
'name': 'string',
'version': 'string'
},
tagFilter={
'tag': 'string'
},
nextPageToken='string',
maximumPageSize=123,
reverseOrder=True|False
)
string
[REQUIRED]
The name of the domain that contains the workflow executions to list.
dict
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.
Note
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
oldestDate (datetime) -- [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) --
Specifies the latest start or close date and time to return.
dict
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.
Note
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
oldestDate (datetime) -- [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) --
Specifies the latest start or close date and time to return.
dict
If specified, only workflow executions matching the workflow id specified in the filter are returned.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
workflowId (string) -- [REQUIRED]
The workflowId to pass of match the criteria of this filter.
dict
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.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
status (string) -- [REQUIRED]
The close status that must match the close status of an execution for it to meet the criteria of this filter. This field is required.
dict
If specified, only executions of the type specified in the filter are returned.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
name (string) -- [REQUIRED]
Name of the workflow type. This field is required.
version (string) --
Version of the workflow type.
dict
If specified, only executions that have the matching tag are listed.
Note
closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
tag (string) -- [REQUIRED]
Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.
string
If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.
integer
The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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.
dict
Response Syntax
{
'executionInfos': [
{
'execution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'startTimestamp': datetime(2015, 1, 1),
'closeTimestamp': datetime(2015, 1, 1),
'executionStatus': 'OPEN'|'CLOSED',
'closeStatus': 'COMPLETED'|'FAILED'|'CANCELED'|'TERMINATED'|'CONTINUED_AS_NEW'|'TIMED_OUT',
'parent': {
'workflowId': 'string',
'runId': 'string'
},
'tagList': [
'string',
],
'cancelRequested': True|False
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
Contains a paginated list of information about workflow executions.
executionInfos (list) --
The list of workflow information structures.
(dict) --
Contains information about a workflow execution.
execution (dict) --
The workflow execution this information is about.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
startTimestamp (datetime) --
The time when the execution was started.
closeTimestamp (datetime) --
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
executionStatus (string) --
The current status of the execution.
closeStatus (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.
parent (dict) --
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
tagList (list) --
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.
(string) --
cancelRequested (boolean) --
Set to true if a cancellation is requested for this workflow execution.
nextPageToken (string) --
The token of the next page in the result. If set, the results have more than one page. The next page can be retrieved by repeating the request with this token and all other arguments unchanged.
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.
Warning
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
Warning
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.poll_for_decision_task(
domain='string',
taskList={
'name': 'string'
},
identity='string',
nextPageToken='string',
maximumPageSize=123,
reverseOrder=True|False
)
string
[REQUIRED]
The name of the domain containing the task lists to poll.
dict
[REQUIRED]
Specifies the task list to poll for decision 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 contain the literal string "arn".
name (string) -- [REQUIRED]
The name of the task list.
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.
string
If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.
Note
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 will not return a new decision task.
.
integer
The maximum number of history events returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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.
dict
Response Syntax
{
'taskToken': 'string',
'startedEventId': 123,
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'events': [
{
'eventTimestamp': datetime(2015, 1, 1),
'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',
'eventId': 123,
'workflowExecutionStartedEventAttributes': {
'input': 'string',
'executionStartToCloseTimeout': 'string',
'taskStartToCloseTimeout': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'taskList': {
'name': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'tagList': [
'string',
],
'continuedExecutionRunId': 'string',
'parentWorkflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'parentInitiatedEventId': 123
},
'workflowExecutionCompletedEventAttributes': {
'result': 'string',
'decisionTaskCompletedEventId': 123
},
'completeWorkflowExecutionFailedEventAttributes': {
'cause': 'UNHANDLED_DECISION'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionFailedEventAttributes': {
'reason': 'string',
'details': 'string',
'decisionTaskCompletedEventId': 123
},
'failWorkflowExecutionFailedEventAttributes': {
'cause': 'UNHANDLED_DECISION'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionTimedOutEventAttributes': {
'timeoutType': 'START_TO_CLOSE',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
},
'workflowExecutionCanceledEventAttributes': {
'details': 'string',
'decisionTaskCompletedEventId': 123
},
'cancelWorkflowExecutionFailedEventAttributes': {
'cause': 'UNHANDLED_DECISION'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionContinuedAsNewEventAttributes': {
'input': 'string',
'decisionTaskCompletedEventId': 123,
'newExecutionRunId': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'taskStartToCloseTimeout': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'tagList': [
'string',
],
'workflowType': {
'name': 'string',
'version': 'string'
}
},
'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'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'workflowExecutionTerminatedEventAttributes': {
'reason': 'string',
'details': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'cause': 'CHILD_POLICY_APPLIED'|'EVENT_LIMIT_EXCEEDED'|'OPERATOR_INITIATED'
},
'workflowExecutionCancelRequestedEventAttributes': {
'externalWorkflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'externalInitiatedEventId': 123,
'cause': 'CHILD_POLICY_APPLIED'
},
'decisionTaskScheduledEventAttributes': {
'taskList': {
'name': 'string'
},
'startToCloseTimeout': 'string'
},
'decisionTaskStartedEventAttributes': {
'identity': 'string',
'scheduledEventId': 123
},
'decisionTaskCompletedEventAttributes': {
'executionContext': 'string',
'scheduledEventId': 123,
'startedEventId': 123
},
'decisionTaskTimedOutEventAttributes': {
'timeoutType': 'START_TO_CLOSE',
'scheduledEventId': 123,
'startedEventId': 123
},
'activityTaskScheduledEventAttributes': {
'activityType': {
'name': 'string',
'version': 'string'
},
'activityId': 'string',
'input': 'string',
'control': 'string',
'scheduleToStartTimeout': 'string',
'scheduleToCloseTimeout': 'string',
'startToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'decisionTaskCompletedEventId': 123,
'heartbeatTimeout': 'string'
},
'activityTaskStartedEventAttributes': {
'identity': 'string',
'scheduledEventId': 123
},
'activityTaskCompletedEventAttributes': {
'result': 'string',
'scheduledEventId': 123,
'startedEventId': 123
},
'activityTaskFailedEventAttributes': {
'reason': 'string',
'details': 'string',
'scheduledEventId': 123,
'startedEventId': 123
},
'activityTaskTimedOutEventAttributes': {
'timeoutType': 'START_TO_CLOSE'|'SCHEDULE_TO_START'|'SCHEDULE_TO_CLOSE'|'HEARTBEAT',
'scheduledEventId': 123,
'startedEventId': 123,
'details': 'string'
},
'activityTaskCanceledEventAttributes': {
'details': 'string',
'scheduledEventId': 123,
'startedEventId': 123,
'latestCancelRequestedEventId': 123
},
'activityTaskCancelRequestedEventAttributes': {
'decisionTaskCompletedEventId': 123,
'activityId': 'string'
},
'workflowExecutionSignaledEventAttributes': {
'signalName': 'string',
'input': 'string',
'externalWorkflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'externalInitiatedEventId': 123
},
'markerRecordedEventAttributes': {
'markerName': 'string',
'details': 'string',
'decisionTaskCompletedEventId': 123
},
'recordMarkerFailedEventAttributes': {
'markerName': 'string',
'cause': 'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'timerStartedEventAttributes': {
'timerId': 'string',
'control': 'string',
'startToFireTimeout': 'string',
'decisionTaskCompletedEventId': 123
},
'timerFiredEventAttributes': {
'timerId': 'string',
'startedEventId': 123
},
'timerCanceledEventAttributes': {
'timerId': 'string',
'startedEventId': 123,
'decisionTaskCompletedEventId': 123
},
'startChildWorkflowExecutionInitiatedEventAttributes': {
'workflowId': 'string',
'workflowType': {
'name': 'string',
'version': 'string'
},
'control': 'string',
'input': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'decisionTaskCompletedEventId': 123,
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'taskStartToCloseTimeout': 'string',
'tagList': [
'string',
]
},
'childWorkflowExecutionStartedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'initiatedEventId': 123
},
'childWorkflowExecutionCompletedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'result': 'string',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionFailedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'reason': 'string',
'details': 'string',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionTimedOutEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'timeoutType': 'START_TO_CLOSE',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionCanceledEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'details': 'string',
'initiatedEventId': 123,
'startedEventId': 123
},
'childWorkflowExecutionTerminatedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'workflowType': {
'name': 'string',
'version': 'string'
},
'initiatedEventId': 123,
'startedEventId': 123
},
'signalExternalWorkflowExecutionInitiatedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'signalName': 'string',
'input': 'string',
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'externalWorkflowExecutionSignaledEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'initiatedEventId': 123
},
'signalExternalWorkflowExecutionFailedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'cause': 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION'|'SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED'|'OPERATION_NOT_PERMITTED',
'initiatedEventId': 123,
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'externalWorkflowExecutionCancelRequestedEventAttributes': {
'workflowExecution': {
'workflowId': 'string',
'runId': 'string'
},
'initiatedEventId': 123
},
'requestCancelExternalWorkflowExecutionInitiatedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'requestCancelExternalWorkflowExecutionFailedEventAttributes': {
'workflowId': 'string',
'runId': 'string',
'cause': 'UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION'|'REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED'|'OPERATION_NOT_PERMITTED',
'initiatedEventId': 123,
'decisionTaskCompletedEventId': 123,
'control': 'string'
},
'scheduleActivityTaskFailedEventAttributes': {
'activityType': {
'name': 'string',
'version': 'string'
},
'activityId': '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': 123
},
'requestCancelActivityTaskFailedEventAttributes': {
'activityId': 'string',
'cause': 'ACTIVITY_ID_UNKNOWN'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'startTimerFailedEventAttributes': {
'timerId': 'string',
'cause': 'TIMER_ID_ALREADY_IN_USE'|'OPEN_TIMERS_LIMIT_EXCEEDED'|'TIMER_CREATION_RATE_EXCEEDED'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'cancelTimerFailedEventAttributes': {
'timerId': 'string',
'cause': 'TIMER_ID_UNKNOWN'|'OPERATION_NOT_PERMITTED',
'decisionTaskCompletedEventId': 123
},
'startChildWorkflowExecutionFailedEventAttributes': {
'workflowType': {
'name': 'string',
'version': 'string'
},
'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',
'workflowId': 'string',
'initiatedEventId': 123,
'decisionTaskCompletedEventId': 123,
'control': 'string'
}
},
],
'nextPageToken': 'string',
'previousStartedEventId': 123
}
Response Structure
(dict) --
A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
taskToken (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.
startedEventId (integer) --
The id of the DecisionTaskStarted event recorded in the history.
workflowExecution (dict) --
The workflow execution for which this decision task was created.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the workflow execution for which this decision task was created.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
events (list) --
A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
(dict) --
Event within a workflow execution. A history event can be one of these types:
WorkflowExecutionStarted : The workflow execution was started.
WorkflowExecutionCompleted : The workflow execution was closed due to successful completion.
WorkflowExecutionFailed : The workflow execution closed due to a failure.
WorkflowExecutionTimedOut : The workflow execution was closed because a time out was exceeded.
WorkflowExecutionCanceled : The workflow execution was successfully canceled and closed.
WorkflowExecutionTerminated : The workflow execution was terminated.
WorkflowExecutionContinuedAsNew : The workflow execution was closed and a new execution of the same type was created with the same workflowId.
WorkflowExecutionCancelRequested : A request to cancel this workflow execution was made.
DecisionTaskScheduled : A decision task was scheduled for the workflow execution.
DecisionTaskStarted : The decision task was dispatched to a decider.
DecisionTaskCompleted : The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.
DecisionTaskTimedOut : The decision task timed out.
ActivityTaskScheduled : An activity task was scheduled for execution.
ScheduleActivityTaskFailed : Failed to process ScheduleActivityTask decision. This happens when the decision is not configured properly, for example the activity type specified is not registered.
ActivityTaskStarted : The scheduled activity task was dispatched to a worker.
ActivityTaskCompleted : An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.
ActivityTaskFailed : An activity worker failed an activity task by calling RespondActivityTaskFailed.
ActivityTaskTimedOut : The activity task timed out.
ActivityTaskCanceled : The activity task was successfully canceled.
ActivityTaskCancelRequested : A RequestCancelActivityTask decision was received by the system.
RequestCancelActivityTaskFailed : Failed to process RequestCancelActivityTask decision. This happens when the decision is not configured properly.
WorkflowExecutionSignaled : An external signal was received for the workflow execution.
MarkerRecorded : A marker was recorded in the workflow history as the result of a RecordMarker decision.
TimerStarted : A timer was started for the workflow execution due to a StartTimer decision.
StartTimerFailed : Failed to process StartTimer decision. This happens when the decision is not configured properly, for example a timer already exists with the specified timer Id.
TimerFired : A timer, previously started for this workflow execution, fired.
TimerCanceled : A timer, previously started for this workflow execution, was successfully canceled.
CancelTimerFailed : Failed to process CancelTimer decision. This happens when the decision is not configured properly, for example no timer exists with the specified timer Id.
StartChildWorkflowExecutionInitiated : A request was made to start a child workflow execution.
StartChildWorkflowExecutionFailed : Failed to process StartChildWorkflowExecution decision. This happens when the decision is not configured properly, for example the workflow type specified is not registered.
ChildWorkflowExecutionStarted : A child workflow execution was successfully started.
ChildWorkflowExecutionCompleted : A child workflow execution, started by this workflow execution, completed successfully and was closed.
ChildWorkflowExecutionFailed : A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.
ChildWorkflowExecutionTimedOut : A child workflow execution, started by this workflow execution, timed out and was closed.
ChildWorkflowExecutionCanceled : A child workflow execution, started by this workflow execution, was canceled and closed.
ChildWorkflowExecutionTerminated : A child workflow execution, started by this workflow execution, was terminated.
SignalExternalWorkflowExecutionInitiated : A request to signal an external workflow was made.
ExternalWorkflowExecutionSignaled : A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
SignalExternalWorkflowExecutionFailed : The request to signal an external workflow execution failed.
RequestCancelExternalWorkflowExecutionInitiated : A request was made to request the cancellation of an external workflow execution.
ExternalWorkflowExecutionCancelRequested : Request to cancel an external workflow execution was successfully delivered to the target execution.
RequestCancelExternalWorkflowExecutionFailed : Request to cancel an external workflow execution failed.
eventTimestamp (datetime) --
The date and time when the event occurred.
eventType (string) --
The type of the history event.
eventId (integer) --
The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.
workflowExecutionStartedEventAttributes (dict) --
If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
input (string) --
The input provided to the workflow execution (if any).
executionStartToCloseTimeout (string) --
The maximum duration for this workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskStartToCloseTimeout (string) --
The maximum duration of decision tasks for this workflow type.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
taskList (dict) --
The name of the task list for scheduling the decision tasks for this workflow execution.
name (string) --
The name of the task list.
workflowType (dict) --
The workflow type of this execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
tagList (list) --
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
(string) --
continuedExecutionRunId (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.
parentWorkflowExecution (dict) --
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
parentInitiatedEventId (integer) --
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.
workflowExecutionCompletedEventAttributes (dict) --
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
result (string) --
The result produced by the workflow execution upon successful completion.
decisionTaskCompletedEventId (integer) --
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 cause of events.
completeWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionFailedEventAttributes (dict) --
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
reason (string) --
The descriptive reason provided for the failure (if any).
details (string) --
The details of the failure (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events.
failWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionTimedOutEventAttributes (dict) --
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType (string) --
The type of timeout that caused this event.
childPolicy (string) --
The policy used for the child workflow executions of this workflow execution. The supported child policies are:
TERMINATE: the child executions will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
workflowExecutionCanceledEventAttributes (dict) --
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
details (string) --
Details for the cancellation (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events.
cancelWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionContinuedAsNewEventAttributes (dict) --
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.
input (string) --
The input provided to the new workflow execution.
decisionTaskCompletedEventId (integer) --
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 cause of events.
newExecutionRunId (string) --
The runId of the new workflow execution.
executionStartToCloseTimeout (string) --
The total duration allowed for the new workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskList (dict) --
Represents a task list.
name (string) --
The name of the task list.
taskStartToCloseTimeout (string) --
The maximum duration of decision tasks for the new workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
tagList (list) --
The list of tags associated with the new workflow execution.
(string) --
workflowType (dict) --
Represents a workflow type.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
continueAsNewWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause (string) --
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
workflowExecutionTerminatedEventAttributes (dict) --
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
reason (string) --
The reason provided for the termination (if any).
details (string) --
The details provided for the termination (if any).
childPolicy (string) --
The policy used for the child workflow executions of this workflow execution. The supported child policies are:
TERMINATE: the child executions will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
cause (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.
workflowExecutionCancelRequestedEventAttributes (dict) --
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
externalWorkflowExecution (dict) --
The external workflow execution for which the cancellation was requested.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
externalInitiatedEventId (integer) --
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.
cause (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.
decisionTaskScheduledEventAttributes (dict) --
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
taskList (dict) --
The name of the task list in which the decision task was scheduled.
name (string) --
The name of the task list.
startToCloseTimeout (string) --
The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
decisionTaskStartedEventAttributes (dict) --
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
identity (string) --
Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
scheduledEventId (integer) --
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.
decisionTaskCompletedEventAttributes (dict) --
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
executionContext (string) --
User defined context for the workflow execution.
scheduledEventId (integer) --
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 (integer) --
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.
decisionTaskTimedOutEventAttributes (dict) --
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType (string) --
The type of timeout that expired before the decision task could be completed.
scheduledEventId (integer) --
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 (integer) --
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.
activityTaskScheduledEventAttributes (dict) --
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
activityType (dict) --
The type of the activity task.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId (string) --
The unique id of the activity task.
input (string) --
The input provided to the activity task.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
scheduleToStartTimeout (string) --
The maximum amount of time the activity task can wait to be assigned to a worker.
scheduleToCloseTimeout (string) --
The maximum amount of time for this activity task.
startToCloseTimeout (string) --
The maximum amount of time a worker may take to process the activity task.
taskList (dict) --
The task list in which the activity task has been scheduled.
name (string) --
The name of the task list.
decisionTaskCompletedEventId (integer) --
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 (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 will be ignored.
activityTaskStartedEventAttributes (dict) --
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
identity (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 (integer) --
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.
activityTaskCompletedEventAttributes (dict) --
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
result (string) --
The results of the activity task (if any).
scheduledEventId (integer) --
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 (integer) --
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 (dict) --
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
reason (string) --
The reason provided for the failure (if any).
details (string) --
The details of the failure (if any).
scheduledEventId (integer) --
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 (integer) --
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.
activityTaskTimedOutEventAttributes (dict) --
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType (string) --
The type of the timeout that caused this event.
scheduledEventId (integer) --
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 (integer) --
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.
details (string) --
Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat .
activityTaskCanceledEventAttributes (dict) --
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
details (string) --
Details of the cancellation (if any).
scheduledEventId (integer) --
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 (integer) --
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.
latestCancelRequestedEventId (integer) --
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.
activityTaskCancelRequestedEventAttributes (dict) --
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
decisionTaskCompletedEventId (integer) --
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 cause of events.
activityId (string) --
The unique ID of the task.
workflowExecutionSignaledEventAttributes (dict) --
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
signalName (string) --
The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
input (string) --
Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
externalWorkflowExecution (dict) --
The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
externalInitiatedEventId (integer) --
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.
markerRecordedEventAttributes (dict) --
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.
markerName (string) --
The name of the marker.
details (string) --
Details of the marker (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events.
recordMarkerFailedEventAttributes (dict) --
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
markerName (string) --
The marker's name.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
timerStartedEventAttributes (dict) --
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The unique Id of the timer that was started.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
startToFireTimeout (string) --
The duration of time after which the timer will fire.
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
decisionTaskCompletedEventId (integer) --
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 cause of events.
timerFiredEventAttributes (dict) --
If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The unique Id of the timer that fired.
startedEventId (integer) --
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.
timerCanceledEventAttributes (dict) --
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The unique Id of the timer that was canceled.
startedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
startChildWorkflowExecutionInitiatedEventAttributes (dict) --
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the child workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
input (string) --
The inputs provided to the child workflow execution (if any).
executionStartToCloseTimeout (string) --
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
taskList (dict) --
The name of the task list used for the decision tasks of the child workflow execution.
name (string) --
The name of the task list.
decisionTaskCompletedEventId (integer) --
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.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
taskStartToCloseTimeout (string) --
The maximum duration allowed for the decision tasks for this workflow execution.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
tagList (list) --
The list of tags to associated with the child workflow execution.
(string) --
childWorkflowExecutionStartedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was started.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
initiatedEventId (integer) --
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.
childWorkflowExecutionCompletedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was completed.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
result (string) --
The result of the child workflow execution (if any).
initiatedEventId (integer) --
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 (integer) --
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
childWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that failed.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
reason (string) --
The reason for the failure (if provided).
details (string) --
The details of the failure (if provided).
initiatedEventId (integer) --
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 (integer) --
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
childWorkflowExecutionTimedOutEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that timed out.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
timeoutType (string) --
The type of the timeout that caused the child workflow execution to time out.
initiatedEventId (integer) --
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 (integer) --
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.
childWorkflowExecutionCanceledEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was canceled.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
details (string) --
Details of the cancellation (if provided).
initiatedEventId (integer) --
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 (integer) --
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.
childWorkflowExecutionTerminatedEventAttributes (dict) --
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The child workflow execution that was terminated.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
workflowType (dict) --
The type of the child workflow execution.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
initiatedEventId (integer) --
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 (integer) --
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.
signalExternalWorkflowExecutionInitiatedEventAttributes (dict) --
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow execution.
runId (string) --
The runId of the external workflow execution to send the signal to.
signalName (string) --
The name of the signal.
input (string) --
Input provided to the signal (if any).
decisionTaskCompletedEventId (integer) --
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 cause of events leading up to this event.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent decision tasks.
externalWorkflowExecutionSignaledEventAttributes (dict) --
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The external workflow execution that the signal was delivered to.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
initiatedEventId (integer) --
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.
signalExternalWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow execution that the signal was being delivered to.
runId (string) --
The runId of the external workflow execution that the signal was being delivered to.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
initiatedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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 cause of events leading up to this event.
control (string) --
externalWorkflowExecutionCancelRequestedEventAttributes (dict) --
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution (dict) --
The external workflow execution to which the cancellation request was delivered.
workflowId (string) --
The user defined identifier associated with the workflow execution.
runId (string) --
A system generated unique identifier for the workflow execution.
initiatedEventId (integer) --
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.
requestCancelExternalWorkflowExecutionInitiatedEventAttributes (dict) --
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow execution to be canceled.
runId (string) --
The runId of the external workflow execution to be canceled.
decisionTaskCompletedEventId (integer) --
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 cause of events.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
requestCancelExternalWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId (string) --
The workflowId of the external workflow to which the cancel request was to be delivered.
runId (string) --
The runId of the external workflow execution.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
initiatedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
control (string) --
scheduleActivityTaskFailedEventAttributes (dict) --
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
activityType (dict) --
The activity type provided in the ScheduleActivityTask decision that failed.
name (string) --
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) --
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId (string) --
The activityId provided in the ScheduleActivityTask decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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.
requestCancelActivityTaskFailedEventAttributes (dict) --
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
activityId (string) --
The activityId provided in the RequestCancelActivityTask decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
startTimerFailedEventAttributes (dict) --
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The timerId provided in the StartTimer decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
cancelTimerFailedEventAttributes (dict) --
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
timerId (string) --
The timerId provided in the CancelTimer decision that failed.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
decisionTaskCompletedEventId (integer) --
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 cause of events.
startChildWorkflowExecutionFailedEventAttributes (dict) --
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowType (dict) --
The workflow type provided in the StartChildWorkflowExecution Decision that failed.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
cause (string) --
The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes.
Note
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.
workflowId (string) --
The workflowId of the child workflow execution.
initiatedEventId (integer) --
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.
decisionTaskCompletedEventId (integer) --
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.
control (string) --
nextPageToken (string) --
Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.
previousStartedEventId (integer) --
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.
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 (optionally) 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 does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.
Note
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.
Note
This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
Warning
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.record_activity_task_heartbeat(
taskToken='string',
details='string'
)
string
[REQUIRED]
The taskToken of the ActivityTask.
Warning
The 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.
string
If specified, contains details about the progress of the task.
dict
Response Syntax
{
'cancelRequested': True|False
}
Response Structure
(dict) --
Status information about an activity task.
cancelRequested (boolean) --
Set to true if cancellation of the task is requested.
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.count_pending_decision_tasks(
domain='string',
taskList={
'name': 'string'
}
)
string
[REQUIRED]
The name of the domain that contains the task list.
dict
[REQUIRED]
The name of the task list.
name (string) -- [REQUIRED]
The name of the task list.
dict
Response Syntax
{
'count': 123,
'truncated': True|False
}
Response Structure
(dict) --
Contains the count of tasks in a task list.
count (integer) --
The number of tasks in the task list.
truncated (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.
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.list_workflow_types(
domain='string',
name='string',
registrationStatus='REGISTERED'|'DEPRECATED',
nextPageToken='string',
maximumPageSize=123,
reverseOrder=True|False
)
string
[REQUIRED]
The name of the domain in which the workflow types have been registered.
string
If specified, lists the workflow type with this name.
string
[REQUIRED]
Specifies the registration status of the workflow types to list.
string
If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.
integer
The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
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.
dict
Response Syntax
{
'typeInfos': [
{
'workflowType': {
'name': 'string',
'version': 'string'
},
'status': 'REGISTERED'|'DEPRECATED',
'description': 'string',
'creationDate': datetime(2015, 1, 1),
'deprecationDate': datetime(2015, 1, 1)
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
Contains a paginated list of information structures about workflow types.
typeInfos (list) --
The list of workflow type information.
(dict) --
Contains information about a workflow type.
workflowType (dict) --
The workflow type this information is about.
name (string) --
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) --
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
status (string) --
The current status of the workflow type.
description (string) --
The description of the type registered through RegisterWorkflowType.
creationDate (datetime) --
The date when this type was registered.
deprecationDate (datetime) --
If the type is in deprecated state, then it is set to the date when the type was deprecated.
nextPageToken (string) --
The token for the next page of type information. If set then the list consists of more than one page. You can retrieve the next page by repeating the request (that returned the structure) with the this token and all other arguments unchanged.
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.
Request Syntax
client.respond_decision_task_completed(
taskToken='string',
decisions=[
{
'decisionType': 'ScheduleActivityTask'|'RequestCancelActivityTask'|'CompleteWorkflowExecution'|'FailWorkflowExecution'|'CancelWorkflowExecution'|'ContinueAsNewWorkflowExecution'|'RecordMarker'|'StartTimer'|'CancelTimer'|'SignalExternalWorkflowExecution'|'RequestCancelExternalWorkflowExecution'|'StartChildWorkflowExecution',
'scheduleActivityTaskDecisionAttributes': {
'activityType': {
'name': 'string',
'version': 'string'
},
'activityId': 'string',
'control': 'string',
'input': 'string',
'scheduleToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'scheduleToStartTimeout': 'string',
'startToCloseTimeout': 'string',
'heartbeatTimeout': 'string'
},
'requestCancelActivityTaskDecisionAttributes': {
'activityId': 'string'
},
'completeWorkflowExecutionDecisionAttributes': {
'result': 'string'
},
'failWorkflowExecutionDecisionAttributes': {
'reason': 'string',
'details': 'string'
},
'cancelWorkflowExecutionDecisionAttributes': {
'details': 'string'
},
'continueAsNewWorkflowExecutionDecisionAttributes': {
'input': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'taskStartToCloseTimeout': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'tagList': [
'string',
],
'workflowTypeVersion': 'string'
},
'recordMarkerDecisionAttributes': {
'markerName': 'string',
'details': 'string'
},
'startTimerDecisionAttributes': {
'timerId': 'string',
'control': 'string',
'startToFireTimeout': 'string'
},
'cancelTimerDecisionAttributes': {
'timerId': 'string'
},
'signalExternalWorkflowExecutionDecisionAttributes': {
'workflowId': 'string',
'runId': 'string',
'signalName': 'string',
'input': 'string',
'control': 'string'
},
'requestCancelExternalWorkflowExecutionDecisionAttributes': {
'workflowId': 'string',
'runId': 'string',
'control': 'string'
},
'startChildWorkflowExecutionDecisionAttributes': {
'workflowType': {
'name': 'string',
'version': 'string'
},
'workflowId': 'string',
'control': 'string',
'input': 'string',
'executionStartToCloseTimeout': 'string',
'taskList': {
'name': 'string'
},
'taskStartToCloseTimeout': 'string',
'childPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
'tagList': [
'string',
]
}
},
],
executionContext='string'
)
string
[REQUIRED]
The taskToken from the DecisionTask.
Warning
The 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.
list
The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.
(dict) --
Specifies a decision made by the decider. A decision can be one of these types:
CancelTimer cancels a previously started timer and records a TimerCanceled event in the history.
CancelWorkflowExecution closes the workflow execution and records a WorkflowExecutionCanceled event in the history.
CompleteWorkflowExecution closes the workflow execution and records a WorkflowExecutionCompleted event in the history .
ContinueAsNewWorkflowExecution closes the workflow execution and starts a new workflow execution of the same type using the same workflow id and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.
FailWorkflowExecution closes the workflow execution and records a WorkflowExecutionFailed event in the history.
RecordMarker records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.
RequestCancelActivityTask attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it will be canceled. If the activity task was already assigned to a worker, then the worker will be informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.
RequestCancelExternalWorkflowExecution requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.
ScheduleActivityTask schedules an activity task.
SignalExternalWorkflowExecution requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.
StartChildWorkflowExecution requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.
StartTimer starts a timer for this workflow execution and records a TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.
Access Control
If you grant permission to use RespondDecisionTaskCompleted , you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Decision Failure
Decisions can fail for several reasons
The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and will therefore fail.
A limit on your account was reached.
The decision lacks sufficient permissions.
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions.
ScheduleActivityTaskFailed a ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision is not registered, is in a deprecated state, or the decision is not properly configured.
RequestCancelActivityTaskFailed a RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.
StartTimerFailed a StartTimer decision failed. This could happen if there is another open timer with the same timerId.
CancelTimerFailed a CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.
StartChildWorkflowExecutionFailed a StartChildWorkflowExecution decision failed. This could happen if the workflow type specified is not registered, is deprecated, or the decision is not properly configured.
SignalExternalWorkflowExecutionFailed a SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.
RequestCancelExternalWorkflowExecutionFailed a RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.
CancelWorkflowExecutionFailed a CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
CompleteWorkflowExecutionFailed a CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
ContinueAsNewWorkflowExecutionFailed a ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.
FailWorkflowExecutionFailed a FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
Note
A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution , FailWorkflowExecution , CancelWorkflowExecution and ContinueAsNewWorkflowExecution . An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.
How to Code a Decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
ScheduleActivityTaskDecisionAttributes
RequestCancelActivityTaskDecisionAttributes
CompleteWorkflowExecutionDecisionAttributes
FailWorkflowExecutionDecisionAttributes
CancelWorkflowExecutionDecisionAttributes
ContinueAsNewWorkflowExecutionDecisionAttributes
RecordMarkerDecisionAttributes
StartTimerDecisionAttributes
CancelTimerDecisionAttributes
SignalExternalWorkflowExecutionDecisionAttributes
RequestCancelExternalWorkflowExecutionDecisionAttributes
StartChildWorkflowExecutionDecisionAttributes
decisionType (string) -- [REQUIRED]
Specifies the type of the decision.
scheduleActivityTaskDecisionAttributes (dict) --
Provides details of the ScheduleActivityTask decision. It is not set for other decision types.
activityType (dict) -- [REQUIRED]
The type of the activity task to schedule. This field is required.
name (string) -- [REQUIRED]
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version (string) -- [REQUIRED]
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId (string) -- [REQUIRED]
The activityId of the activity task. This field is required.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
input (string) --
The input provided to the activity task.
scheduleToCloseTimeout (string) --
The maximum duration for this activity task.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.
taskList (dict) --
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.
Note
A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault will be returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
name (string) -- [REQUIRED]
The name of the task list.
scheduleToStartTimeout (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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.
startToCloseTimeout (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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.
heartbeatTimeout (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 will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
requestCancelActivityTaskDecisionAttributes (dict) --
Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.
activityId (string) -- [REQUIRED]
The activityId of the activity task to be canceled.
completeWorkflowExecutionDecisionAttributes (dict) --
Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.
result (string) --
The result of the workflow execution. The form of the result is implementation defined.
failWorkflowExecutionDecisionAttributes (dict) --
Provides details of the FailWorkflowExecution decision. It is not set for other decision types.
reason (string) --
A descriptive reason for the failure that may help in diagnostics.
details (string) --
Optional details of the failure.
cancelWorkflowExecutionDecisionAttributes (dict) --
Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.
details (string) --
Optional details of the cancellation.
continueAsNewWorkflowExecutionDecisionAttributes (dict) --
Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.
input (string) --
The input provided to the new workflow execution.
executionStartToCloseTimeout (string) --
If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
taskList (dict) --
Represents a task list.
name (string) -- [REQUIRED]
The name of the task list.
taskStartToCloseTimeout (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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
Note
A child policy for the new workflow execution must be specified either as a default registered for its workflow type or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.
tagList (list) --
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.
(string) --
workflowTypeVersion (string) --
recordMarkerDecisionAttributes (dict) --
Provides details of the RecordMarker decision. It is not set for other decision types.
markerName (string) -- [REQUIRED]
The name of the marker. This file is required.
details (string) --
Optional details of the marker.
startTimerDecisionAttributes (dict) --
Provides details of the StartTimer decision. It is not set for other decision types.
timerId (string) -- [REQUIRED]
The unique Id of the timer. This field is required.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
startToFireTimeout (string) -- [REQUIRED]
The duration to wait before firing the timer. This field is required.
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
cancelTimerDecisionAttributes (dict) --
Provides details of the CancelTimer decision. It is not set for other decision types.
timerId (string) -- [REQUIRED]
The unique Id of the timer to cancel. This field is required.
signalExternalWorkflowExecutionDecisionAttributes (dict) --
Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.
workflowId (string) -- [REQUIRED]
The workflowId of the workflow execution to be signaled. This field is required.
runId (string) --
The runId of the workflow execution to be signaled.
signalName (string) -- [REQUIRED]
The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.
input (string) --
Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent decision tasks.
requestCancelExternalWorkflowExecutionDecisionAttributes (dict) --
Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.
workflowId (string) -- [REQUIRED]
The workflowId of the external workflow execution to cancel. This field is required.
runId (string) --
The runId of the external workflow execution to cancel.
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
startChildWorkflowExecutionDecisionAttributes (dict) --
Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.
workflowType (dict) -- [REQUIRED]
The type of the workflow execution to be started. This field is required.
name (string) -- [REQUIRED]
The name of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) -- [REQUIRED]
The version of the workflow type. This field is required.
Note
The combination of workflow type name and version must be unique with in a domain.
workflowId (string) -- [REQUIRED]
The workflowId of the workflow execution. This field is required.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
control (string) --
Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
input (string) --
The input to be provided to the workflow execution.
executionStartToCloseTimeout (string) --
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
taskList (dict) --
The name of the task list to be used for decision tasks of the child workflow execution.
Note
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string "arn".
name (string) -- [REQUIRED]
The name of the task list.
taskStartToCloseTimeout (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 valid values are integers greater than or equal to 0 . An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
childPolicy (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 will be terminated.
REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON: no action will be taken. The child executions will continue to run.
Note
A child policy for the workflow execution being started must be specified either as a default registered for its workflow type or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.
tagList (list) --
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.
(string) --
string
User defined context to add to workflow execution.
None
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.describe_domain(
name='string'
)
string
[REQUIRED]
The name of the domain to describe.
dict
Response Syntax
{
'domainInfo': {
'name': 'string',
'status': 'REGISTERED'|'DEPRECATED',
'description': 'string'
},
'configuration': {
'workflowExecutionRetentionPeriodInDays': 'string'
}
}
Response Structure
(dict) --
Contains details of a domain.
domainInfo (dict) --
Contains general information about a domain.
name (string) --
The name of the domain. This name is unique within the account.
status (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.
description (string) --
The description of the domain provided through RegisterDomain.
configuration (dict) --
Contains the configuration settings of a domain.
workflowExecutionRetentionPeriodInDays (string) --
The retention period for workflow executions in this domain.
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 will continue to run.
Note
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.deprecate_domain(
name='string'
)
string
[REQUIRED]
The name of the domain to deprecate.
None
Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.
Warning
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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Request Syntax
client.respond_activity_task_canceled(
taskToken='string',
details='string'
)
string
[REQUIRED]
The taskToken of the ActivityTask.
Warning
The 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.
string
Optional information about the cancellation.
None