git-off

swf.d.ts (240478B)

1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare class SWF extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: SWF.Types.ClientConfiguration)
13 config: Config & SWF.Types.ClientConfiguration;
14 /**
15 * Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
16 */
17 countClosedWorkflowExecutions(params: SWF.Types.CountClosedWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request<SWF.Types.WorkflowExecutionCount, AWSError>;
18 /**
19 * Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
20 */
21 countClosedWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request<SWF.Types.WorkflowExecutionCount, AWSError>;
22 /**
23 * Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
24 */
25 countOpenWorkflowExecutions(params: SWF.Types.CountOpenWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request<SWF.Types.WorkflowExecutionCount, AWSError>;
26 /**
27 * Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
28 */
29 countOpenWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request<SWF.Types.WorkflowExecutionCount, AWSError>;
30 /**
31 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
32 */
33 countPendingActivityTasks(params: SWF.Types.CountPendingActivityTasksInput, callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request<SWF.Types.PendingTaskCount, AWSError>;
34 /**
35 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
36 */
37 countPendingActivityTasks(callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request<SWF.Types.PendingTaskCount, AWSError>;
38 /**
39 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
40 */
41 countPendingDecisionTasks(params: SWF.Types.CountPendingDecisionTasksInput, callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request<SWF.Types.PendingTaskCount, AWSError>;
42 /**
43 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
44 */
45 countPendingDecisionTasks(callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request<SWF.Types.PendingTaskCount, AWSError>;
46 /**
47 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
48 */
49 deprecateActivityType(params: SWF.Types.DeprecateActivityTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
52 */
53 deprecateActivityType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
56 */
57 deprecateDomain(params: SWF.Types.DeprecateDomainInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58 /**
59 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
60 */
61 deprecateDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62 /**
63 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
64 */
65 deprecateWorkflowType(params: SWF.Types.DeprecateWorkflowTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66 /**
67 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
68 */
69 deprecateWorkflowType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70 /**
71 * Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
72 */
73 describeActivityType(params: SWF.Types.DescribeActivityTypeInput, callback?: (err: AWSError, data: SWF.Types.ActivityTypeDetail) => void): Request<SWF.Types.ActivityTypeDetail, AWSError>;
74 /**
75 * Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
76 */
77 describeActivityType(callback?: (err: AWSError, data: SWF.Types.ActivityTypeDetail) => void): Request<SWF.Types.ActivityTypeDetail, AWSError>;
78 /**
79 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
80 */
81 describeDomain(params: SWF.Types.DescribeDomainInput, callback?: (err: AWSError, data: SWF.Types.DomainDetail) => void): Request<SWF.Types.DomainDetail, AWSError>;
82 /**
83 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
84 */
85 describeDomain(callback?: (err: AWSError, data: SWF.Types.DomainDetail) => void): Request<SWF.Types.DomainDetail, AWSError>;
86 /**
87 * Returns information about the specified workflow execution including its type and some statistics. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
88 */
89 describeWorkflowExecution(params: SWF.Types.DescribeWorkflowExecutionInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionDetail) => void): Request<SWF.Types.WorkflowExecutionDetail, AWSError>;
90 /**
91 * Returns information about the specified workflow execution including its type and some statistics. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
92 */
93 describeWorkflowExecution(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionDetail) => void): Request<SWF.Types.WorkflowExecutionDetail, AWSError>;
94 /**
95 * 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, and so on. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
96 */
97 describeWorkflowType(params: SWF.Types.DescribeWorkflowTypeInput, callback?: (err: AWSError, data: SWF.Types.WorkflowTypeDetail) => void): Request<SWF.Types.WorkflowTypeDetail, AWSError>;
98 /**
99 * 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, and so on. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
100 */
101 describeWorkflowType(callback?: (err: AWSError, data: SWF.Types.WorkflowTypeDetail) => void): Request<SWF.Types.WorkflowTypeDetail, AWSError>;
102 /**
103 * Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
104 */
105 getWorkflowExecutionHistory(params: SWF.Types.GetWorkflowExecutionHistoryInput, callback?: (err: AWSError, data: SWF.Types.History) => void): Request<SWF.Types.History, AWSError>;
106 /**
107 * Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
108 */
109 getWorkflowExecutionHistory(callback?: (err: AWSError, data: SWF.Types.History) => void): Request<SWF.Types.History, AWSError>;
110 /**
111 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
112 */
113 listActivityTypes(params: SWF.Types.ListActivityTypesInput, callback?: (err: AWSError, data: SWF.Types.ActivityTypeInfos) => void): Request<SWF.Types.ActivityTypeInfos, AWSError>;
114 /**
115 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
116 */
117 listActivityTypes(callback?: (err: AWSError, data: SWF.Types.ActivityTypeInfos) => void): Request<SWF.Types.ActivityTypeInfos, AWSError>;
118 /**
119 * Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
120 */
121 listClosedWorkflowExecutions(params: SWF.Types.ListClosedWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request<SWF.Types.WorkflowExecutionInfos, AWSError>;
122 /**
123 * Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
124 */
125 listClosedWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request<SWF.Types.WorkflowExecutionInfos, AWSError>;
126 /**
127 * Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
128 */
129 listDomains(params: SWF.Types.ListDomainsInput, callback?: (err: AWSError, data: SWF.Types.DomainInfos) => void): Request<SWF.Types.DomainInfos, AWSError>;
130 /**
131 * Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
132 */
133 listDomains(callback?: (err: AWSError, data: SWF.Types.DomainInfos) => void): Request<SWF.Types.DomainInfos, AWSError>;
134 /**
135 * Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
136 */
137 listOpenWorkflowExecutions(params: SWF.Types.ListOpenWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request<SWF.Types.WorkflowExecutionInfos, AWSError>;
138 /**
139 * Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
140 */
141 listOpenWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request<SWF.Types.WorkflowExecutionInfos, AWSError>;
142 /**
143 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
144 */
145 listWorkflowTypes(params: SWF.Types.ListWorkflowTypesInput, callback?: (err: AWSError, data: SWF.Types.WorkflowTypeInfos) => void): Request<SWF.Types.WorkflowTypeInfos, AWSError>;
146 /**
147 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
148 */
149 listWorkflowTypes(callback?: (err: AWSError, data: SWF.Types.WorkflowTypeInfos) => void): Request<SWF.Types.WorkflowTypeInfos, AWSError>;
150 /**
151 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
152 */
153 pollForActivityTask(params: SWF.Types.PollForActivityTaskInput, callback?: (err: AWSError, data: SWF.Types.ActivityTask) => void): Request<SWF.Types.ActivityTask, AWSError>;
154 /**
155 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
156 */
157 pollForActivityTask(callback?: (err: AWSError, data: SWF.Types.ActivityTask) => void): Request<SWF.Types.ActivityTask, AWSError>;
158 /**
159 * Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string. Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
160 */
161 pollForDecisionTask(params: SWF.Types.PollForDecisionTaskInput, callback?: (err: AWSError, data: SWF.Types.DecisionTask) => void): Request<SWF.Types.DecisionTask, AWSError>;
162 /**
163 * Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string. Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
164 */
165 pollForDecisionTask(callback?: (err: AWSError, data: SWF.Types.DecisionTask) => void): Request<SWF.Types.DecisionTask, AWSError>;
166 /**
167 * 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. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
168 */
169 recordActivityTaskHeartbeat(params: SWF.Types.RecordActivityTaskHeartbeatInput, callback?: (err: AWSError, data: SWF.Types.ActivityTaskStatus) => void): Request<SWF.Types.ActivityTaskStatus, AWSError>;
170 /**
171 * 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. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
172 */
173 recordActivityTaskHeartbeat(callback?: (err: AWSError, data: SWF.Types.ActivityTaskStatus) => void): Request<SWF.Types.ActivityTaskStatus, AWSError>;
174 /**
175 * Registers a new activity type along with its configuration settings in the specified domain. A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
176 */
177 registerActivityType(params: SWF.Types.RegisterActivityTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
178 /**
179 * Registers a new activity type along with its configuration settings in the specified domain. A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
180 */
181 registerActivityType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
182 /**
183 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
184 */
185 registerDomain(params: SWF.Types.RegisterDomainInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
186 /**
187 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
188 */
189 registerDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
190 /**
191 * Registers a new workflow type and its configuration settings in the specified domain. The retention period for the workflow history is set by the RegisterDomain action. If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
192 */
193 registerWorkflowType(params: SWF.Types.RegisterWorkflowTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
194 /**
195 * Registers a new workflow type and its configuration settings in the specified domain. The retention period for the workflow history is set by the RegisterDomain action. If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
196 */
197 registerWorkflowType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
198 /**
199 * Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
200 */
201 requestCancelWorkflowExecution(params: SWF.Types.RequestCancelWorkflowExecutionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
202 /**
203 * Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
204 */
205 requestCancelWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
206 /**
207 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
208 */
209 respondActivityTaskCanceled(params: SWF.Types.RespondActivityTaskCanceledInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
210 /**
211 * 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. 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
212 */
213 respondActivityTaskCanceled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
214 /**
215 * Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history. If the requested task 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
216 */
217 respondActivityTaskCompleted(params: SWF.Types.RespondActivityTaskCompletedInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
218 /**
219 * Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history. If the requested task 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
220 */
221 respondActivityTaskCompleted(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
222 /**
223 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
224 */
225 respondActivityTaskFailed(params: SWF.Types.RespondActivityTaskFailedInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
226 /**
227 * 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
228 */
229 respondActivityTaskFailed(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
230 /**
231 * 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.
232 */
233 respondDecisionTaskCompleted(params: SWF.Types.RespondDecisionTaskCompletedInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
234 /**
235 * 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.
236 */
237 respondDecisionTaskCompleted(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
238 /**
239 * Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
240 */
241 signalWorkflowExecution(params: SWF.Types.SignalWorkflowExecutionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
242 /**
243 * Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
244 */
245 signalWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
246 /**
247 * Starts an execution of the workflow type in the specified domain using the provided workflowId and input data. This action returns the newly started workflow execution. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0. tagList.member.1: The key is swf:tagList.member.1. tagList.member.2: The key is swf:tagList.member.2. tagList.member.3: The key is swf:tagList.member.3. tagList.member.4: The key is swf:tagList.member.4. taskList: String constraint. The key is swf:taskList.name. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
248 */
249 startWorkflowExecution(params: SWF.Types.StartWorkflowExecutionInput, callback?: (err: AWSError, data: SWF.Types.Run) => void): Request<SWF.Types.Run, AWSError>;
250 /**
251 * Starts an execution of the workflow type in the specified domain using the provided workflowId and input data. This action returns the newly started workflow execution. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0. tagList.member.1: The key is swf:tagList.member.1. tagList.member.2: The key is swf:tagList.member.2. tagList.member.3: The key is swf:tagList.member.3. tagList.member.4: The key is swf:tagList.member.4. taskList: String constraint. The key is swf:taskList.name. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
252 */
253 startWorkflowExecution(callback?: (err: AWSError, data: SWF.Types.Run) => void): Request<SWF.Types.Run, AWSError>;
254 /**
255 * Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. If the identified workflow execution was in progress, it is terminated immediately. If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
256 */
257 terminateWorkflowExecution(params: SWF.Types.TerminateWorkflowExecutionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
258 /**
259 * Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. If the identified workflow execution was in progress, it is terminated immediately. If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
260 */
261 terminateWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
262 }
263 declare namespace SWF.Types {
264 export type ActivityId = string;
265 export interface ActivityTask {
266 /**
267 * 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.
268 */
269 taskToken: TaskToken;
270 /**
271 * The unique ID of the task.
272 */
273 activityId: ActivityId;
274 /**
275 * The ID of the ActivityTaskStarted event recorded in the history.
276 */
277 startedEventId: EventId;
278 /**
279 * The workflow execution that started this activity task.
280 */
281 workflowExecution: WorkflowExecution;
282 /**
283 * The type of this activity task.
284 */
285 activityType: ActivityType;
286 /**
287 * 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.
288 */
289 input?: Data;
290 }
291 export interface ActivityTaskCancelRequestedEventAttributes {
292 /**
293 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
294 */
295 decisionTaskCompletedEventId: EventId;
296 /**
297 * The unique ID of the task.
298 */
299 activityId: ActivityId;
300 }
301 export interface ActivityTaskCanceledEventAttributes {
302 /**
303 * Details of the cancellation (if any).
304 */
305 details?: Data;
306 /**
307 * 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.
308 */
309 scheduledEventId: EventId;
310 /**
311 * 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.
312 */
313 startedEventId: EventId;
314 /**
315 * 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.
316 */
317 latestCancelRequestedEventId?: EventId;
318 }
319 export interface ActivityTaskCompletedEventAttributes {
320 /**
321 * The results of the activity task (if any).
322 */
323 result?: Data;
324 /**
325 * 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.
326 */
327 scheduledEventId: EventId;
328 /**
329 * 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.
330 */
331 startedEventId: EventId;
332 }
333 export interface ActivityTaskFailedEventAttributes {
334 /**
335 * The reason provided for the failure (if any).
336 */
337 reason?: FailureReason;
338 /**
339 * The details of the failure (if any).
340 */
341 details?: Data;
342 /**
343 * 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.
344 */
345 scheduledEventId: EventId;
346 /**
347 * 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.
348 */
349 startedEventId: EventId;
350 }
351 export interface ActivityTaskScheduledEventAttributes {
352 /**
353 * The type of the activity task.
354 */
355 activityType: ActivityType;
356 /**
357 * The unique ID of the activity task.
358 */
359 activityId: ActivityId;
360 /**
361 * The input provided to the activity task.
362 */
363 input?: Data;
364 /**
365 * 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.
366 */
367 control?: Data;
368 /**
369 * The maximum amount of time the activity task can wait to be assigned to a worker.
370 */
371 scheduleToStartTimeout?: DurationInSecondsOptional;
372 /**
373 * The maximum amount of time for this activity task.
374 */
375 scheduleToCloseTimeout?: DurationInSecondsOptional;
376 /**
377 * The maximum amount of time a worker may take to process the activity task.
378 */
379 startToCloseTimeout?: DurationInSecondsOptional;
380 /**
381 * The task list in which the activity task has been scheduled.
382 */
383 taskList: TaskList;
384 /**
385 * Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
386 */
387 taskPriority?: TaskPriority;
388 /**
389 * 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.
390 */
391 decisionTaskCompletedEventId: EventId;
392 /**
393 * 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.
394 */
395 heartbeatTimeout?: DurationInSecondsOptional;
396 }
397 export interface ActivityTaskStartedEventAttributes {
398 /**
399 * Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.
400 */
401 identity?: Identity;
402 /**
403 * 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.
404 */
405 scheduledEventId: EventId;
406 }
407 export interface ActivityTaskStatus {
408 /**
409 * Set to true if cancellation of the task is requested.
410 */
411 cancelRequested: Canceled;
412 }
413 export interface ActivityTaskTimedOutEventAttributes {
414 /**
415 * The type of the timeout that caused this event.
416 */
417 timeoutType: ActivityTaskTimeoutType;
418 /**
419 * 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.
420 */
421 scheduledEventId: EventId;
422 /**
423 * 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.
424 */
425 startedEventId: EventId;
426 /**
427 * Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.
428 */
429 details?: LimitedData;
430 }
431 export type ActivityTaskTimeoutType = "START_TO_CLOSE"|"SCHEDULE_TO_START"|"SCHEDULE_TO_CLOSE"|"HEARTBEAT"|string;
432 export interface ActivityType {
433 /**
434 * The name of this activity. The combination of activity type name and version must be unique within a domain.
435 */
436 name: Name;
437 /**
438 * The version of this activity. The combination of activity type name and version must be unique with in a domain.
439 */
440 version: Version;
441 }
442 export interface ActivityTypeConfiguration {
443 /**
444 * Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
445 */
446 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
447 /**
448 * Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat. You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
449 */
450 defaultTaskHeartbeatTimeout?: DurationInSecondsOptional;
451 /**
452 * Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.
453 */
454 defaultTaskList?: TaskList;
455 /**
456 * Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be used as the default priority. This default can be overridden when scheduling an activity task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
457 */
458 defaultTaskPriority?: TaskPriority;
459 /**
460 * Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
461 */
462 defaultTaskScheduleToStartTimeout?: DurationInSecondsOptional;
463 /**
464 * Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
465 */
466 defaultTaskScheduleToCloseTimeout?: DurationInSecondsOptional;
467 }
468 export interface ActivityTypeDetail {
469 /**
470 * 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.
471 */
472 typeInfo: ActivityTypeInfo;
473 /**
474 * The configuration settings registered with the activity type.
475 */
476 configuration: ActivityTypeConfiguration;
477 }
478 export interface ActivityTypeInfo {
479 /**
480 * The ActivityType type structure representing the activity type.
481 */
482 activityType: ActivityType;
483 /**
484 * The current status of the activity type.
485 */
486 status: RegistrationStatus;
487 /**
488 * The description of the activity type provided in RegisterActivityType.
489 */
490 description?: Description;
491 /**
492 * The date and time this activity type was created through RegisterActivityType.
493 */
494 creationDate: Timestamp;
495 /**
496 * If DEPRECATED, the date and time DeprecateActivityType was called.
497 */
498 deprecationDate?: Timestamp;
499 }
500 export type ActivityTypeInfoList = ActivityTypeInfo[];
501 export interface ActivityTypeInfos {
502 /**
503 * List of activity type information.
504 */
505 typeInfos: ActivityTypeInfoList;
506 /**
507 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
508 */
509 nextPageToken?: PageToken;
510 }
511 export type Arn = string;
512 export interface CancelTimerDecisionAttributes {
513 /**
514 * Required. The unique ID of the timer to cancel.
515 */
516 timerId: TimerId;
517 }
518 export type CancelTimerFailedCause = "TIMER_ID_UNKNOWN"|"OPERATION_NOT_PERMITTED"|string;
519 export interface CancelTimerFailedEventAttributes {
520 /**
521 * The timerId provided in the CancelTimer decision that failed.
522 */
523 timerId: TimerId;
524 /**
525 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
526 */
527 cause: CancelTimerFailedCause;
528 /**
529 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
530 */
531 decisionTaskCompletedEventId: EventId;
532 }
533 export interface CancelWorkflowExecutionDecisionAttributes {
534 /**
535 * Optional. details of the cancellation.
536 */
537 details?: Data;
538 }
539 export type CancelWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string;
540 export interface CancelWorkflowExecutionFailedEventAttributes {
541 /**
542 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
543 */
544 cause: CancelWorkflowExecutionFailedCause;
545 /**
546 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
547 */
548 decisionTaskCompletedEventId: EventId;
549 }
550 export type Canceled = boolean;
551 export type CauseMessage = string;
552 export type ChildPolicy = "TERMINATE"|"REQUEST_CANCEL"|"ABANDON"|string;
553 export interface ChildWorkflowExecutionCanceledEventAttributes {
554 /**
555 * The child workflow execution that was canceled.
556 */
557 workflowExecution: WorkflowExecution;
558 /**
559 * The type of the child workflow execution.
560 */
561 workflowType: WorkflowType;
562 /**
563 * Details of the cancellation (if provided).
564 */
565 details?: Data;
566 /**
567 * 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.
568 */
569 initiatedEventId: EventId;
570 /**
571 * 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.
572 */
573 startedEventId: EventId;
574 }
575 export interface ChildWorkflowExecutionCompletedEventAttributes {
576 /**
577 * The child workflow execution that was completed.
578 */
579 workflowExecution: WorkflowExecution;
580 /**
581 * The type of the child workflow execution.
582 */
583 workflowType: WorkflowType;
584 /**
585 * The result of the child workflow execution (if any).
586 */
587 result?: Data;
588 /**
589 * 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.
590 */
591 initiatedEventId: EventId;
592 /**
593 * 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.
594 */
595 startedEventId: EventId;
596 }
597 export interface ChildWorkflowExecutionFailedEventAttributes {
598 /**
599 * The child workflow execution that failed.
600 */
601 workflowExecution: WorkflowExecution;
602 /**
603 * The type of the child workflow execution.
604 */
605 workflowType: WorkflowType;
606 /**
607 * The reason for the failure (if provided).
608 */
609 reason?: FailureReason;
610 /**
611 * The details of the failure (if provided).
612 */
613 details?: Data;
614 /**
615 * 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.
616 */
617 initiatedEventId: EventId;
618 /**
619 * 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.
620 */
621 startedEventId: EventId;
622 }
623 export interface ChildWorkflowExecutionStartedEventAttributes {
624 /**
625 * The child workflow execution that was started.
626 */
627 workflowExecution: WorkflowExecution;
628 /**
629 * The type of the child workflow execution.
630 */
631 workflowType: WorkflowType;
632 /**
633 * 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.
634 */
635 initiatedEventId: EventId;
636 }
637 export interface ChildWorkflowExecutionTerminatedEventAttributes {
638 /**
639 * The child workflow execution that was terminated.
640 */
641 workflowExecution: WorkflowExecution;
642 /**
643 * The type of the child workflow execution.
644 */
645 workflowType: WorkflowType;
646 /**
647 * 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.
648 */
649 initiatedEventId: EventId;
650 /**
651 * 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.
652 */
653 startedEventId: EventId;
654 }
655 export interface ChildWorkflowExecutionTimedOutEventAttributes {
656 /**
657 * The child workflow execution that timed out.
658 */
659 workflowExecution: WorkflowExecution;
660 /**
661 * The type of the child workflow execution.
662 */
663 workflowType: WorkflowType;
664 /**
665 * The type of the timeout that caused the child workflow execution to time out.
666 */
667 timeoutType: WorkflowExecutionTimeoutType;
668 /**
669 * 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.
670 */
671 initiatedEventId: EventId;
672 /**
673 * 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.
674 */
675 startedEventId: EventId;
676 }
677 export type CloseStatus = "COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"|string;
678 export interface CloseStatusFilter {
679 /**
680 * Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.
681 */
682 status: CloseStatus;
683 }
684 export interface CompleteWorkflowExecutionDecisionAttributes {
685 /**
686 * The result of the workflow execution. The form of the result is implementation defined.
687 */
688 result?: Data;
689 }
690 export type CompleteWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string;
691 export interface CompleteWorkflowExecutionFailedEventAttributes {
692 /**
693 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
694 */
695 cause: CompleteWorkflowExecutionFailedCause;
696 /**
697 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
698 */
699 decisionTaskCompletedEventId: EventId;
700 }
701 export interface ContinueAsNewWorkflowExecutionDecisionAttributes {
702 /**
703 * The input provided to the new workflow execution.
704 */
705 input?: Data;
706 /**
707 * If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
708 */
709 executionStartToCloseTimeout?: DurationInSecondsOptional;
710 taskList?: TaskList;
711 /**
712 * Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
713 */
714 taskPriority?: TaskPriority;
715 /**
716 * Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
717 */
718 taskStartToCloseTimeout?: DurationInSecondsOptional;
719 /**
720 * If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE: the child executions will be terminated. REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON: no action will be taken. The child executions will continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
721 */
722 childPolicy?: ChildPolicy;
723 /**
724 * 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.
725 */
726 tagList?: TagList;
727 workflowTypeVersion?: Version;
728 /**
729 * The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions. In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
730 */
731 lambdaRole?: Arn;
732 }
733 export type ContinueAsNewWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"WORKFLOW_TYPE_DEPRECATED"|"WORKFLOW_TYPE_DOES_NOT_EXIST"|"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_TASK_LIST_UNDEFINED"|"DEFAULT_CHILD_POLICY_UNDEFINED"|"CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
734 export interface ContinueAsNewWorkflowExecutionFailedEventAttributes {
735 /**
736 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
737 */
738 cause: ContinueAsNewWorkflowExecutionFailedCause;
739 /**
740 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
741 */
742 decisionTaskCompletedEventId: EventId;
743 }
744 export type Count = number;
745 export interface CountClosedWorkflowExecutionsInput {
746 /**
747 * The name of the domain containing the workflow executions to count.
748 */
749 domain: DomainName;
750 /**
751 * If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
752 */
753 startTimeFilter?: ExecutionTimeFilter;
754 /**
755 * If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
756 */
757 closeTimeFilter?: ExecutionTimeFilter;
758 /**
759 * If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
760 */
761 executionFilter?: WorkflowExecutionFilter;
762 /**
763 * If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
764 */
765 typeFilter?: WorkflowTypeFilter;
766 /**
767 * If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
768 */
769 tagFilter?: TagFilter;
770 /**
771 * If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
772 */
773 closeStatusFilter?: CloseStatusFilter;
774 }
775 export interface CountOpenWorkflowExecutionsInput {
776 /**
777 * The name of the domain containing the workflow executions to count.
778 */
779 domain: DomainName;
780 /**
781 * Specifies the start time criteria that workflow executions must meet in order to be counted.
782 */
783 startTimeFilter: ExecutionTimeFilter;
784 /**
785 * Specifies the type of the workflow executions to be counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
786 */
787 typeFilter?: WorkflowTypeFilter;
788 /**
789 * If specified, only executions that have a tag that matches the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
790 */
791 tagFilter?: TagFilter;
792 /**
793 * If specified, only workflow executions matching the WorkflowId in the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
794 */
795 executionFilter?: WorkflowExecutionFilter;
796 }
797 export interface CountPendingActivityTasksInput {
798 /**
799 * The name of the domain that contains the task list.
800 */
801 domain: DomainName;
802 /**
803 * The name of the task list.
804 */
805 taskList: TaskList;
806 }
807 export interface CountPendingDecisionTasksInput {
808 /**
809 * The name of the domain that contains the task list.
810 */
811 domain: DomainName;
812 /**
813 * The name of the task list.
814 */
815 taskList: TaskList;
816 }
817 export type Data = string;
818 export interface Decision {
819 /**
820 * Specifies the type of the decision.
821 */
822 decisionType: DecisionType;
823 /**
824 * Provides details of the ScheduleActivityTask decision. It is not set for other decision types.
825 */
826 scheduleActivityTaskDecisionAttributes?: ScheduleActivityTaskDecisionAttributes;
827 /**
828 * Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.
829 */
830 requestCancelActivityTaskDecisionAttributes?: RequestCancelActivityTaskDecisionAttributes;
831 /**
832 * Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.
833 */
834 completeWorkflowExecutionDecisionAttributes?: CompleteWorkflowExecutionDecisionAttributes;
835 /**
836 * Provides details of the FailWorkflowExecution decision. It is not set for other decision types.
837 */
838 failWorkflowExecutionDecisionAttributes?: FailWorkflowExecutionDecisionAttributes;
839 /**
840 * Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.
841 */
842 cancelWorkflowExecutionDecisionAttributes?: CancelWorkflowExecutionDecisionAttributes;
843 /**
844 * Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.
845 */
846 continueAsNewWorkflowExecutionDecisionAttributes?: ContinueAsNewWorkflowExecutionDecisionAttributes;
847 /**
848 * Provides details of the RecordMarker decision. It is not set for other decision types.
849 */
850 recordMarkerDecisionAttributes?: RecordMarkerDecisionAttributes;
851 /**
852 * Provides details of the StartTimer decision. It is not set for other decision types.
853 */
854 startTimerDecisionAttributes?: StartTimerDecisionAttributes;
855 /**
856 * Provides details of the CancelTimer decision. It is not set for other decision types.
857 */
858 cancelTimerDecisionAttributes?: CancelTimerDecisionAttributes;
859 /**
860 * Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.
861 */
862 signalExternalWorkflowExecutionDecisionAttributes?: SignalExternalWorkflowExecutionDecisionAttributes;
863 /**
864 * Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.
865 */
866 requestCancelExternalWorkflowExecutionDecisionAttributes?: RequestCancelExternalWorkflowExecutionDecisionAttributes;
867 /**
868 * Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.
869 */
870 startChildWorkflowExecutionDecisionAttributes?: StartChildWorkflowExecutionDecisionAttributes;
871 scheduleLambdaFunctionDecisionAttributes?: ScheduleLambdaFunctionDecisionAttributes;
872 }
873 export type DecisionList = Decision[];
874 export interface DecisionTask {
875 /**
876 * 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.
877 */
878 taskToken: TaskToken;
879 /**
880 * The ID of the DecisionTaskStarted event recorded in the history.
881 */
882 startedEventId: EventId;
883 /**
884 * The workflow execution for which this decision task was created.
885 */
886 workflowExecution: WorkflowExecution;
887 /**
888 * The type of the workflow execution for which this decision task was created.
889 */
890 workflowType: WorkflowType;
891 /**
892 * A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
893 */
894 events: HistoryEventList;
895 /**
896 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
897 */
898 nextPageToken?: PageToken;
899 /**
900 * 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.
901 */
902 previousStartedEventId?: EventId;
903 }
904 export interface DecisionTaskCompletedEventAttributes {
905 /**
906 * User defined context for the workflow execution.
907 */
908 executionContext?: Data;
909 /**
910 * 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.
911 */
912 scheduledEventId: EventId;
913 /**
914 * 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.
915 */
916 startedEventId: EventId;
917 }
918 export interface DecisionTaskScheduledEventAttributes {
919 /**
920 * The name of the task list in which the decision task was scheduled.
921 */
922 taskList: TaskList;
923 /**
924 * Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
925 */
926 taskPriority?: TaskPriority;
927 /**
928 * The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
929 */
930 startToCloseTimeout?: DurationInSecondsOptional;
931 }
932 export interface DecisionTaskStartedEventAttributes {
933 /**
934 * Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
935 */
936 identity?: Identity;
937 /**
938 * 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.
939 */
940 scheduledEventId: EventId;
941 }
942 export interface DecisionTaskTimedOutEventAttributes {
943 /**
944 * The type of timeout that expired before the decision task could be completed.
945 */
946 timeoutType: DecisionTaskTimeoutType;
947 /**
948 * 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.
949 */
950 scheduledEventId: EventId;
951 /**
952 * 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.
953 */
954 startedEventId: EventId;
955 }
956 export type DecisionTaskTimeoutType = "START_TO_CLOSE"|string;
957 export type DecisionType = "ScheduleActivityTask"|"RequestCancelActivityTask"|"CompleteWorkflowExecution"|"FailWorkflowExecution"|"CancelWorkflowExecution"|"ContinueAsNewWorkflowExecution"|"RecordMarker"|"StartTimer"|"CancelTimer"|"SignalExternalWorkflowExecution"|"RequestCancelExternalWorkflowExecution"|"StartChildWorkflowExecution"|"ScheduleLambdaFunction"|string;
958 export interface DeprecateActivityTypeInput {
959 /**
960 * The name of the domain in which the activity type is registered.
961 */
962 domain: DomainName;
963 /**
964 * The activity type to deprecate.
965 */
966 activityType: ActivityType;
967 }
968 export interface DeprecateDomainInput {
969 /**
970 * The name of the domain to deprecate.
971 */
972 name: DomainName;
973 }
974 export interface DeprecateWorkflowTypeInput {
975 /**
976 * The name of the domain in which the workflow type is registered.
977 */
978 domain: DomainName;
979 /**
980 * The workflow type to deprecate.
981 */
982 workflowType: WorkflowType;
983 }
984 export interface DescribeActivityTypeInput {
985 /**
986 * The name of the domain in which the activity type is registered.
987 */
988 domain: DomainName;
989 /**
990 * The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.
991 */
992 activityType: ActivityType;
993 }
994 export interface DescribeDomainInput {
995 /**
996 * The name of the domain to describe.
997 */
998 name: DomainName;
999 }
1000 export interface DescribeWorkflowExecutionInput {
1001 /**
1002 * The name of the domain containing the workflow execution.
1003 */
1004 domain: DomainName;
1005 /**
1006 * The workflow execution to describe.
1007 */
1008 execution: WorkflowExecution;
1009 }
1010 export interface DescribeWorkflowTypeInput {
1011 /**
1012 * The name of the domain in which this workflow type is registered.
1013 */
1014 domain: DomainName;
1015 /**
1016 * The workflow type to describe.
1017 */
1018 workflowType: WorkflowType;
1019 }
1020 export type Description = string;
1021 export interface DomainConfiguration {
1022 /**
1023 * The retention period for workflow executions in this domain.
1024 */
1025 workflowExecutionRetentionPeriodInDays: DurationInDays;
1026 }
1027 export interface DomainDetail {
1028 domainInfo: DomainInfo;
1029 configuration: DomainConfiguration;
1030 }
1031 export interface DomainInfo {
1032 /**
1033 * The name of the domain. This name is unique within the account.
1034 */
1035 name: DomainName;
1036 /**
1037 * 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.
1038 */
1039 status: RegistrationStatus;
1040 /**
1041 * The description of the domain provided through RegisterDomain.
1042 */
1043 description?: Description;
1044 }
1045 export type DomainInfoList = DomainInfo[];
1046 export interface DomainInfos {
1047 /**
1048 * A list of DomainInfo structures.
1049 */
1050 domainInfos: DomainInfoList;
1051 /**
1052 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1053 */
1054 nextPageToken?: PageToken;
1055 }
1056 export type DomainName = string;
1057 export type DurationInDays = string;
1058 export type DurationInSeconds = string;
1059 export type DurationInSecondsOptional = string;
1060 export type ErrorMessage = string;
1061 export type EventId = number;
1062 export type EventType = "WorkflowExecutionStarted"|"WorkflowExecutionCancelRequested"|"WorkflowExecutionCompleted"|"CompleteWorkflowExecutionFailed"|"WorkflowExecutionFailed"|"FailWorkflowExecutionFailed"|"WorkflowExecutionTimedOut"|"WorkflowExecutionCanceled"|"CancelWorkflowExecutionFailed"|"WorkflowExecutionContinuedAsNew"|"ContinueAsNewWorkflowExecutionFailed"|"WorkflowExecutionTerminated"|"DecisionTaskScheduled"|"DecisionTaskStarted"|"DecisionTaskCompleted"|"DecisionTaskTimedOut"|"ActivityTaskScheduled"|"ScheduleActivityTaskFailed"|"ActivityTaskStarted"|"ActivityTaskCompleted"|"ActivityTaskFailed"|"ActivityTaskTimedOut"|"ActivityTaskCanceled"|"ActivityTaskCancelRequested"|"RequestCancelActivityTaskFailed"|"WorkflowExecutionSignaled"|"MarkerRecorded"|"RecordMarkerFailed"|"TimerStarted"|"StartTimerFailed"|"TimerFired"|"TimerCanceled"|"CancelTimerFailed"|"StartChildWorkflowExecutionInitiated"|"StartChildWorkflowExecutionFailed"|"ChildWorkflowExecutionStarted"|"ChildWorkflowExecutionCompleted"|"ChildWorkflowExecutionFailed"|"ChildWorkflowExecutionTimedOut"|"ChildWorkflowExecutionCanceled"|"ChildWorkflowExecutionTerminated"|"SignalExternalWorkflowExecutionInitiated"|"SignalExternalWorkflowExecutionFailed"|"ExternalWorkflowExecutionSignaled"|"RequestCancelExternalWorkflowExecutionInitiated"|"RequestCancelExternalWorkflowExecutionFailed"|"ExternalWorkflowExecutionCancelRequested"|"LambdaFunctionScheduled"|"LambdaFunctionStarted"|"LambdaFunctionCompleted"|"LambdaFunctionFailed"|"LambdaFunctionTimedOut"|"ScheduleLambdaFunctionFailed"|"StartLambdaFunctionFailed"|string;
1063 export type ExecutionStatus = "OPEN"|"CLOSED"|string;
1064 export interface ExecutionTimeFilter {
1065 /**
1066 * Specifies the oldest start or close date and time to return.
1067 */
1068 oldestDate: Timestamp;
1069 /**
1070 * Specifies the latest start or close date and time to return.
1071 */
1072 latestDate?: Timestamp;
1073 }
1074 export interface ExternalWorkflowExecutionCancelRequestedEventAttributes {
1075 /**
1076 * The external workflow execution to which the cancellation request was delivered.
1077 */
1078 workflowExecution: WorkflowExecution;
1079 /**
1080 * 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.
1081 */
1082 initiatedEventId: EventId;
1083 }
1084 export interface ExternalWorkflowExecutionSignaledEventAttributes {
1085 /**
1086 * The external workflow execution that the signal was delivered to.
1087 */
1088 workflowExecution: WorkflowExecution;
1089 /**
1090 * 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.
1091 */
1092 initiatedEventId: EventId;
1093 }
1094 export interface FailWorkflowExecutionDecisionAttributes {
1095 /**
1096 * A descriptive reason for the failure that may help in diagnostics.
1097 */
1098 reason?: FailureReason;
1099 /**
1100 * Optional. Details of the failure.
1101 */
1102 details?: Data;
1103 }
1104 export type FailWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string;
1105 export interface FailWorkflowExecutionFailedEventAttributes {
1106 /**
1107 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
1108 */
1109 cause: FailWorkflowExecutionFailedCause;
1110 /**
1111 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1112 */
1113 decisionTaskCompletedEventId: EventId;
1114 }
1115 export type FailureReason = string;
1116 export type FunctionId = string;
1117 export type FunctionInput = string;
1118 export type FunctionName = string;
1119 export interface GetWorkflowExecutionHistoryInput {
1120 /**
1121 * The name of the domain containing the workflow execution.
1122 */
1123 domain: DomainName;
1124 /**
1125 * Specifies the workflow execution for which to return the history.
1126 */
1127 execution: WorkflowExecution;
1128 /**
1129 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1130 */
1131 nextPageToken?: PageToken;
1132 /**
1133 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1134 */
1135 maximumPageSize?: PageSize;
1136 /**
1137 * 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.
1138 */
1139 reverseOrder?: ReverseOrder;
1140 }
1141 export interface History {
1142 /**
1143 * The list of history events.
1144 */
1145 events: HistoryEventList;
1146 /**
1147 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1148 */
1149 nextPageToken?: PageToken;
1150 }
1151 export interface HistoryEvent {
1152 /**
1153 * The date and time when the event occurred.
1154 */
1155 eventTimestamp: Timestamp;
1156 /**
1157 * The type of the history event.
1158 */
1159 eventType: EventType;
1160 /**
1161 * The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.
1162 */
1163 eventId: EventId;
1164 /**
1165 * 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.
1166 */
1167 workflowExecutionStartedEventAttributes?: WorkflowExecutionStartedEventAttributes;
1168 /**
1169 * 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.
1170 */
1171 workflowExecutionCompletedEventAttributes?: WorkflowExecutionCompletedEventAttributes;
1172 /**
1173 * 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.
1174 */
1175 completeWorkflowExecutionFailedEventAttributes?: CompleteWorkflowExecutionFailedEventAttributes;
1176 /**
1177 * 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.
1178 */
1179 workflowExecutionFailedEventAttributes?: WorkflowExecutionFailedEventAttributes;
1180 /**
1181 * 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.
1182 */
1183 failWorkflowExecutionFailedEventAttributes?: FailWorkflowExecutionFailedEventAttributes;
1184 /**
1185 * 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.
1186 */
1187 workflowExecutionTimedOutEventAttributes?: WorkflowExecutionTimedOutEventAttributes;
1188 /**
1189 * 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.
1190 */
1191 workflowExecutionCanceledEventAttributes?: WorkflowExecutionCanceledEventAttributes;
1192 /**
1193 * 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.
1194 */
1195 cancelWorkflowExecutionFailedEventAttributes?: CancelWorkflowExecutionFailedEventAttributes;
1196 /**
1197 * 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.
1198 */
1199 workflowExecutionContinuedAsNewEventAttributes?: WorkflowExecutionContinuedAsNewEventAttributes;
1200 /**
1201 * 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.
1202 */
1203 continueAsNewWorkflowExecutionFailedEventAttributes?: ContinueAsNewWorkflowExecutionFailedEventAttributes;
1204 /**
1205 * 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.
1206 */
1207 workflowExecutionTerminatedEventAttributes?: WorkflowExecutionTerminatedEventAttributes;
1208 /**
1209 * 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.
1210 */
1211 workflowExecutionCancelRequestedEventAttributes?: WorkflowExecutionCancelRequestedEventAttributes;
1212 /**
1213 * 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.
1214 */
1215 decisionTaskScheduledEventAttributes?: DecisionTaskScheduledEventAttributes;
1216 /**
1217 * 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.
1218 */
1219 decisionTaskStartedEventAttributes?: DecisionTaskStartedEventAttributes;
1220 /**
1221 * 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.
1222 */
1223 decisionTaskCompletedEventAttributes?: DecisionTaskCompletedEventAttributes;
1224 /**
1225 * 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.
1226 */
1227 decisionTaskTimedOutEventAttributes?: DecisionTaskTimedOutEventAttributes;
1228 /**
1229 * 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.
1230 */
1231 activityTaskScheduledEventAttributes?: ActivityTaskScheduledEventAttributes;
1232 /**
1233 * 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.
1234 */
1235 activityTaskStartedEventAttributes?: ActivityTaskStartedEventAttributes;
1236 /**
1237 * 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.
1238 */
1239 activityTaskCompletedEventAttributes?: ActivityTaskCompletedEventAttributes;
1240 /**
1241 * 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.
1242 */
1243 activityTaskFailedEventAttributes?: ActivityTaskFailedEventAttributes;
1244 /**
1245 * 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.
1246 */
1247 activityTaskTimedOutEventAttributes?: ActivityTaskTimedOutEventAttributes;
1248 /**
1249 * 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.
1250 */
1251 activityTaskCanceledEventAttributes?: ActivityTaskCanceledEventAttributes;
1252 /**
1253 * 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.
1254 */
1255 activityTaskCancelRequestedEventAttributes?: ActivityTaskCancelRequestedEventAttributes;
1256 /**
1257 * 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.
1258 */
1259 workflowExecutionSignaledEventAttributes?: WorkflowExecutionSignaledEventAttributes;
1260 /**
1261 * 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.
1262 */
1263 markerRecordedEventAttributes?: MarkerRecordedEventAttributes;
1264 /**
1265 * 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.
1266 */
1267 recordMarkerFailedEventAttributes?: RecordMarkerFailedEventAttributes;
1268 /**
1269 * 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.
1270 */
1271 timerStartedEventAttributes?: TimerStartedEventAttributes;
1272 /**
1273 * 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.
1274 */
1275 timerFiredEventAttributes?: TimerFiredEventAttributes;
1276 /**
1277 * 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.
1278 */
1279 timerCanceledEventAttributes?: TimerCanceledEventAttributes;
1280 /**
1281 * 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.
1282 */
1283 startChildWorkflowExecutionInitiatedEventAttributes?: StartChildWorkflowExecutionInitiatedEventAttributes;
1284 /**
1285 * 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.
1286 */
1287 childWorkflowExecutionStartedEventAttributes?: ChildWorkflowExecutionStartedEventAttributes;
1288 /**
1289 * 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.
1290 */
1291 childWorkflowExecutionCompletedEventAttributes?: ChildWorkflowExecutionCompletedEventAttributes;
1292 /**
1293 * 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.
1294 */
1295 childWorkflowExecutionFailedEventAttributes?: ChildWorkflowExecutionFailedEventAttributes;
1296 /**
1297 * 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.
1298 */
1299 childWorkflowExecutionTimedOutEventAttributes?: ChildWorkflowExecutionTimedOutEventAttributes;
1300 /**
1301 * 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.
1302 */
1303 childWorkflowExecutionCanceledEventAttributes?: ChildWorkflowExecutionCanceledEventAttributes;
1304 /**
1305 * 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.
1306 */
1307 childWorkflowExecutionTerminatedEventAttributes?: ChildWorkflowExecutionTerminatedEventAttributes;
1308 /**
1309 * 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.
1310 */
1311 signalExternalWorkflowExecutionInitiatedEventAttributes?: SignalExternalWorkflowExecutionInitiatedEventAttributes;
1312 /**
1313 * 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.
1314 */
1315 externalWorkflowExecutionSignaledEventAttributes?: ExternalWorkflowExecutionSignaledEventAttributes;
1316 /**
1317 * 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.
1318 */
1319 signalExternalWorkflowExecutionFailedEventAttributes?: SignalExternalWorkflowExecutionFailedEventAttributes;
1320 /**
1321 * 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.
1322 */
1323 externalWorkflowExecutionCancelRequestedEventAttributes?: ExternalWorkflowExecutionCancelRequestedEventAttributes;
1324 /**
1325 * 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.
1326 */
1327 requestCancelExternalWorkflowExecutionInitiatedEventAttributes?: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes;
1328 /**
1329 * 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.
1330 */
1331 requestCancelExternalWorkflowExecutionFailedEventAttributes?: RequestCancelExternalWorkflowExecutionFailedEventAttributes;
1332 /**
1333 * 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.
1334 */
1335 scheduleActivityTaskFailedEventAttributes?: ScheduleActivityTaskFailedEventAttributes;
1336 /**
1337 * 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.
1338 */
1339 requestCancelActivityTaskFailedEventAttributes?: RequestCancelActivityTaskFailedEventAttributes;
1340 /**
1341 * 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.
1342 */
1343 startTimerFailedEventAttributes?: StartTimerFailedEventAttributes;
1344 /**
1345 * 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.
1346 */
1347 cancelTimerFailedEventAttributes?: CancelTimerFailedEventAttributes;
1348 /**
1349 * 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.
1350 */
1351 startChildWorkflowExecutionFailedEventAttributes?: StartChildWorkflowExecutionFailedEventAttributes;
1352 lambdaFunctionScheduledEventAttributes?: LambdaFunctionScheduledEventAttributes;
1353 lambdaFunctionStartedEventAttributes?: LambdaFunctionStartedEventAttributes;
1354 lambdaFunctionCompletedEventAttributes?: LambdaFunctionCompletedEventAttributes;
1355 lambdaFunctionFailedEventAttributes?: LambdaFunctionFailedEventAttributes;
1356 lambdaFunctionTimedOutEventAttributes?: LambdaFunctionTimedOutEventAttributes;
1357 scheduleLambdaFunctionFailedEventAttributes?: ScheduleLambdaFunctionFailedEventAttributes;
1358 startLambdaFunctionFailedEventAttributes?: StartLambdaFunctionFailedEventAttributes;
1359 }
1360 export type HistoryEventList = HistoryEvent[];
1361 export type Identity = string;
1362 export interface LambdaFunctionCompletedEventAttributes {
1363 /**
1364 * The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1365 */
1366 scheduledEventId: EventId;
1367 /**
1368 * The ID of the LambdaFunctionStarted event recorded in the history.
1369 */
1370 startedEventId: EventId;
1371 /**
1372 * The result of the function execution (if any).
1373 */
1374 result?: Data;
1375 }
1376 export interface LambdaFunctionFailedEventAttributes {
1377 /**
1378 * The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1379 */
1380 scheduledEventId: EventId;
1381 /**
1382 * The ID of the LambdaFunctionStarted event recorded in the history.
1383 */
1384 startedEventId: EventId;
1385 /**
1386 * The reason provided for the failure (if any).
1387 */
1388 reason?: FailureReason;
1389 /**
1390 * The details of the failure (if any).
1391 */
1392 details?: Data;
1393 }
1394 export interface LambdaFunctionScheduledEventAttributes {
1395 /**
1396 * The unique Amazon SWF ID for the AWS Lambda task.
1397 */
1398 id: FunctionId;
1399 /**
1400 * The name of the scheduled AWS Lambda function.
1401 */
1402 name: FunctionName;
1403 /**
1404 * Input provided to the AWS Lambda function.
1405 */
1406 input?: FunctionInput;
1407 /**
1408 * The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.
1409 */
1410 startToCloseTimeout?: DurationInSecondsOptional;
1411 /**
1412 * The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1413 */
1414 decisionTaskCompletedEventId: EventId;
1415 }
1416 export interface LambdaFunctionStartedEventAttributes {
1417 /**
1418 * The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1419 */
1420 scheduledEventId: EventId;
1421 }
1422 export interface LambdaFunctionTimedOutEventAttributes {
1423 /**
1424 * The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1425 */
1426 scheduledEventId: EventId;
1427 /**
1428 * The ID of the LambdaFunctionStarted event recorded in the history.
1429 */
1430 startedEventId: EventId;
1431 /**
1432 * The type of the timeout that caused this event.
1433 */
1434 timeoutType?: LambdaFunctionTimeoutType;
1435 }
1436 export type LambdaFunctionTimeoutType = "START_TO_CLOSE"|string;
1437 export type LimitedData = string;
1438 export interface ListActivityTypesInput {
1439 /**
1440 * The name of the domain in which the activity types have been registered.
1441 */
1442 domain: DomainName;
1443 /**
1444 * If specified, only lists the activity types that have this name.
1445 */
1446 name?: Name;
1447 /**
1448 * Specifies the registration status of the activity types to list.
1449 */
1450 registrationStatus: RegistrationStatus;
1451 /**
1452 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1453 */
1454 nextPageToken?: PageToken;
1455 /**
1456 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1457 */
1458 maximumPageSize?: PageSize;
1459 /**
1460 * When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.
1461 */
1462 reverseOrder?: ReverseOrder;
1463 }
1464 export interface ListClosedWorkflowExecutionsInput {
1465 /**
1466 * The name of the domain that contains the workflow executions to list.
1467 */
1468 domain: DomainName;
1469 /**
1470 * If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
1471 */
1472 startTimeFilter?: ExecutionTimeFilter;
1473 /**
1474 * If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
1475 */
1476 closeTimeFilter?: ExecutionTimeFilter;
1477 /**
1478 * If specified, only workflow executions matching the workflow ID specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1479 */
1480 executionFilter?: WorkflowExecutionFilter;
1481 /**
1482 * If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1483 */
1484 closeStatusFilter?: CloseStatusFilter;
1485 /**
1486 * If specified, only executions of the type specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1487 */
1488 typeFilter?: WorkflowTypeFilter;
1489 /**
1490 * If specified, only executions that have the matching tag are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1491 */
1492 tagFilter?: TagFilter;
1493 /**
1494 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1495 */
1496 nextPageToken?: PageToken;
1497 /**
1498 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1499 */
1500 maximumPageSize?: PageSize;
1501 /**
1502 * 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.
1503 */
1504 reverseOrder?: ReverseOrder;
1505 }
1506 export interface ListDomainsInput {
1507 /**
1508 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1509 */
1510 nextPageToken?: PageToken;
1511 /**
1512 * Specifies the registration status of the domains to list.
1513 */
1514 registrationStatus: RegistrationStatus;
1515 /**
1516 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1517 */
1518 maximumPageSize?: PageSize;
1519 /**
1520 * When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.
1521 */
1522 reverseOrder?: ReverseOrder;
1523 }
1524 export interface ListOpenWorkflowExecutionsInput {
1525 /**
1526 * The name of the domain that contains the workflow executions to list.
1527 */
1528 domain: DomainName;
1529 /**
1530 * Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
1531 */
1532 startTimeFilter: ExecutionTimeFilter;
1533 /**
1534 * If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1535 */
1536 typeFilter?: WorkflowTypeFilter;
1537 /**
1538 * If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1539 */
1540 tagFilter?: TagFilter;
1541 /**
1542 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1543 */
1544 nextPageToken?: PageToken;
1545 /**
1546 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1547 */
1548 maximumPageSize?: PageSize;
1549 /**
1550 * 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.
1551 */
1552 reverseOrder?: ReverseOrder;
1553 /**
1554 * If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
1555 */
1556 executionFilter?: WorkflowExecutionFilter;
1557 }
1558 export interface ListWorkflowTypesInput {
1559 /**
1560 * The name of the domain in which the workflow types have been registered.
1561 */
1562 domain: DomainName;
1563 /**
1564 * If specified, lists the workflow type with this name.
1565 */
1566 name?: Name;
1567 /**
1568 * Specifies the registration status of the workflow types to list.
1569 */
1570 registrationStatus: RegistrationStatus;
1571 /**
1572 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
1573 */
1574 nextPageToken?: PageToken;
1575 /**
1576 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1577 */
1578 maximumPageSize?: PageSize;
1579 /**
1580 * 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.
1581 */
1582 reverseOrder?: ReverseOrder;
1583 }
1584 export type MarkerName = string;
1585 export interface MarkerRecordedEventAttributes {
1586 /**
1587 * The name of the marker.
1588 */
1589 markerName: MarkerName;
1590 /**
1591 * Details of the marker (if any).
1592 */
1593 details?: Data;
1594 /**
1595 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1596 */
1597 decisionTaskCompletedEventId: EventId;
1598 }
1599 export type Name = string;
1600 export type OpenDecisionTasksCount = number;
1601 export type PageSize = number;
1602 export type PageToken = string;
1603 export interface PendingTaskCount {
1604 /**
1605 * The number of tasks in the task list.
1606 */
1607 count: Count;
1608 /**
1609 * 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.
1610 */
1611 truncated?: Truncated;
1612 }
1613 export interface PollForActivityTaskInput {
1614 /**
1615 * The name of the domain that contains the task lists being polled.
1616 */
1617 domain: DomainName;
1618 /**
1619 * 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 quotarnquot.
1620 */
1621 taskList: TaskList;
1622 /**
1623 * Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
1624 */
1625 identity?: Identity;
1626 }
1627 export interface PollForDecisionTaskInput {
1628 /**
1629 * The name of the domain containing the task lists to poll.
1630 */
1631 domain: DomainName;
1632 /**
1633 * 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 quotarnquot.
1634 */
1635 taskList: TaskList;
1636 /**
1637 * 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.
1638 */
1639 identity?: Identity;
1640 /**
1641 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. 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..
1642 */
1643 nextPageToken?: PageToken;
1644 /**
1645 * The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
1646 */
1647 maximumPageSize?: PageSize;
1648 /**
1649 * 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.
1650 */
1651 reverseOrder?: ReverseOrder;
1652 }
1653 export interface RecordActivityTaskHeartbeatInput {
1654 /**
1655 * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
1656 */
1657 taskToken: TaskToken;
1658 /**
1659 * If specified, contains details about the progress of the task.
1660 */
1661 details?: LimitedData;
1662 }
1663 export interface RecordMarkerDecisionAttributes {
1664 /**
1665 * Required. The name of the marker.
1666 */
1667 markerName: MarkerName;
1668 /**
1669 * Optional. details of the marker.
1670 */
1671 details?: Data;
1672 }
1673 export type RecordMarkerFailedCause = "OPERATION_NOT_PERMITTED"|string;
1674 export interface RecordMarkerFailedEventAttributes {
1675 /**
1676 * The marker's name.
1677 */
1678 markerName: MarkerName;
1679 /**
1680 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
1681 */
1682 cause: RecordMarkerFailedCause;
1683 /**
1684 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1685 */
1686 decisionTaskCompletedEventId: EventId;
1687 }
1688 export interface RegisterActivityTypeInput {
1689 /**
1690 * The name of the domain in which this activity is to be registered.
1691 */
1692 domain: DomainName;
1693 /**
1694 * 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 quotarnquot.
1695 */
1696 name: Name;
1697 /**
1698 * The version of the activity type. The activity type consists of the name and version, the combination of which must be unique within the domain. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
1699 */
1700 version: Version;
1701 /**
1702 * A textual description of the activity type.
1703 */
1704 description?: Description;
1705 /**
1706 * If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
1707 */
1708 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
1709 /**
1710 * If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
1711 */
1712 defaultTaskHeartbeatTimeout?: DurationInSecondsOptional;
1713 /**
1714 * 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.
1715 */
1716 defaultTaskList?: TaskList;
1717 /**
1718 * The default task priority to assign to the activity type. If not assigned, then "0" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
1719 */
1720 defaultTaskPriority?: TaskPriority;
1721 /**
1722 * If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
1723 */
1724 defaultTaskScheduleToStartTimeout?: DurationInSecondsOptional;
1725 /**
1726 * If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
1727 */
1728 defaultTaskScheduleToCloseTimeout?: DurationInSecondsOptional;
1729 }
1730 export interface RegisterDomainInput {
1731 /**
1732 * Name of the domain to register. The name must be unique in the region that the domain is registered in. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
1733 */
1734 name: DomainName;
1735 /**
1736 * A text description of the domain.
1737 */
1738 description?: Description;
1739 /**
1740 * The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls. If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted. The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
1741 */
1742 workflowExecutionRetentionPeriodInDays: DurationInDays;
1743 }
1744 export interface RegisterWorkflowTypeInput {
1745 /**
1746 * The name of the domain in which to register the workflow type.
1747 */
1748 domain: DomainName;
1749 /**
1750 * 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 quotarnquot.
1751 */
1752 name: Name;
1753 /**
1754 * The version of the workflow type. The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
1755 */
1756 version: Version;
1757 /**
1758 * Textual description of the workflow type.
1759 */
1760 description?: Description;
1761 /**
1762 * If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
1763 */
1764 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
1765 /**
1766 * If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision. The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.
1767 */
1768 defaultExecutionStartToCloseTimeout?: DurationInSecondsOptional;
1769 /**
1770 * 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.
1771 */
1772 defaultTaskList?: TaskList;
1773 /**
1774 * The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
1775 */
1776 defaultTaskPriority?: TaskPriority;
1777 /**
1778 * 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.
1779 */
1780 defaultChildPolicy?: ChildPolicy;
1781 /**
1782 * The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution and ContinueAsNewWorkflowExecution decision.
1783 */
1784 defaultLambdaRole?: Arn;
1785 }
1786 export type RegistrationStatus = "REGISTERED"|"DEPRECATED"|string;
1787 export interface RequestCancelActivityTaskDecisionAttributes {
1788 /**
1789 * The activityId of the activity task to be canceled.
1790 */
1791 activityId: ActivityId;
1792 }
1793 export type RequestCancelActivityTaskFailedCause = "ACTIVITY_ID_UNKNOWN"|"OPERATION_NOT_PERMITTED"|string;
1794 export interface RequestCancelActivityTaskFailedEventAttributes {
1795 /**
1796 * The activityId provided in the RequestCancelActivityTask decision that failed.
1797 */
1798 activityId: ActivityId;
1799 /**
1800 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
1801 */
1802 cause: RequestCancelActivityTaskFailedCause;
1803 /**
1804 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1805 */
1806 decisionTaskCompletedEventId: EventId;
1807 }
1808 export interface RequestCancelExternalWorkflowExecutionDecisionAttributes {
1809 /**
1810 * Required. The workflowId of the external workflow execution to cancel.
1811 */
1812 workflowId: WorkflowId;
1813 /**
1814 * The runId of the external workflow execution to cancel.
1815 */
1816 runId?: RunIdOptional;
1817 /**
1818 * Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
1819 */
1820 control?: Data;
1821 }
1822 export type RequestCancelExternalWorkflowExecutionFailedCause = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"|"REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
1823 export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes {
1824 /**
1825 * The workflowId of the external workflow to which the cancel request was to be delivered.
1826 */
1827 workflowId: WorkflowId;
1828 /**
1829 * The runId of the external workflow execution.
1830 */
1831 runId?: RunIdOptional;
1832 /**
1833 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
1834 */
1835 cause: RequestCancelExternalWorkflowExecutionFailedCause;
1836 /**
1837 * 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.
1838 */
1839 initiatedEventId: EventId;
1840 /**
1841 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1842 */
1843 decisionTaskCompletedEventId: EventId;
1844 control?: Data;
1845 }
1846 export interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributes {
1847 /**
1848 * The workflowId of the external workflow execution to be canceled.
1849 */
1850 workflowId: WorkflowId;
1851 /**
1852 * The runId of the external workflow execution to be canceled.
1853 */
1854 runId?: RunIdOptional;
1855 /**
1856 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
1857 */
1858 decisionTaskCompletedEventId: EventId;
1859 /**
1860 * Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
1861 */
1862 control?: Data;
1863 }
1864 export interface RequestCancelWorkflowExecutionInput {
1865 /**
1866 * The name of the domain containing the workflow execution to cancel.
1867 */
1868 domain: DomainName;
1869 /**
1870 * The workflowId of the workflow execution to cancel.
1871 */
1872 workflowId: WorkflowId;
1873 /**
1874 * The runId of the workflow execution to cancel.
1875 */
1876 runId?: RunIdOptional;
1877 }
1878 export interface RespondActivityTaskCanceledInput {
1879 /**
1880 * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
1881 */
1882 taskToken: TaskToken;
1883 /**
1884 * Optional. Information about the cancellation.
1885 */
1886 details?: Data;
1887 }
1888 export interface RespondActivityTaskCompletedInput {
1889 /**
1890 * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
1891 */
1892 taskToken: TaskToken;
1893 /**
1894 * The result of the activity task. It is a free form string that is implementation specific.
1895 */
1896 result?: Data;
1897 }
1898 export interface RespondActivityTaskFailedInput {
1899 /**
1900 * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
1901 */
1902 taskToken: TaskToken;
1903 /**
1904 * Description of the error that may assist in diagnostics.
1905 */
1906 reason?: FailureReason;
1907 /**
1908 * Optional. Detailed information about the failure.
1909 */
1910 details?: Data;
1911 }
1912 export interface RespondDecisionTaskCompletedInput {
1913 /**
1914 * The taskToken from the DecisionTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
1915 */
1916 taskToken: TaskToken;
1917 /**
1918 * The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the decision structure for details.
1919 */
1920 decisions?: DecisionList;
1921 /**
1922 * User defined context to add to workflow execution.
1923 */
1924 executionContext?: Data;
1925 }
1926 export type ReverseOrder = boolean;
1927 export interface Run {
1928 /**
1929 * 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.
1930 */
1931 runId?: RunId;
1932 }
1933 export type RunId = string;
1934 export type RunIdOptional = string;
1935 export interface ScheduleActivityTaskDecisionAttributes {
1936 /**
1937 * Required. The type of the activity task to schedule.
1938 */
1939 activityType: ActivityType;
1940 /**
1941 * Required. The activityId of the activity task. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
1942 */
1943 activityId: ActivityId;
1944 /**
1945 * 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.
1946 */
1947 control?: Data;
1948 /**
1949 * The input provided to the activity task.
1950 */
1951 input?: Data;
1952 /**
1953 * The maximum duration for this activity task. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.
1954 */
1955 scheduleToCloseTimeout?: DurationInSecondsOptional;
1956 /**
1957 * If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used. A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
1958 */
1959 taskList?: TaskList;
1960 /**
1961 * Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
1962 */
1963 taskPriority?: TaskPriority;
1964 /**
1965 * Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.
1966 */
1967 scheduleToStartTimeout?: DurationInSecondsOptional;
1968 /**
1969 * If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.
1970 */
1971 startToCloseTimeout?: DurationInSecondsOptional;
1972 /**
1973 * If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
1974 */
1975 heartbeatTimeout?: DurationInSecondsOptional;
1976 }
1977 export type ScheduleActivityTaskFailedCause = "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"|string;
1978 export interface ScheduleActivityTaskFailedEventAttributes {
1979 /**
1980 * The activity type provided in the ScheduleActivityTask decision that failed.
1981 */
1982 activityType: ActivityType;
1983 /**
1984 * The activityId provided in the ScheduleActivityTask decision that failed.
1985 */
1986 activityId: ActivityId;
1987 /**
1988 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
1989 */
1990 cause: ScheduleActivityTaskFailedCause;
1991 /**
1992 * 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.
1993 */
1994 decisionTaskCompletedEventId: EventId;
1995 }
1996 export interface ScheduleLambdaFunctionDecisionAttributes {
1997 /**
1998 * Required. The SWF id of the AWS Lambda task. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
1999 */
2000 id: FunctionId;
2001 /**
2002 * Required. The name of the AWS Lambda function to invoke.
2003 */
2004 name: FunctionName;
2005 /**
2006 * The input provided to the AWS Lambda function.
2007 */
2008 input?: FunctionInput;
2009 /**
2010 * If set, specifies the maximum duration the function may take to execute.
2011 */
2012 startToCloseTimeout?: DurationInSecondsOptional;
2013 }
2014 export type ScheduleLambdaFunctionFailedCause = "ID_ALREADY_IN_USE"|"OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED"|"LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED"|"LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"|string;
2015 export interface ScheduleLambdaFunctionFailedEventAttributes {
2016 /**
2017 * The unique Amazon SWF ID of the AWS Lambda task.
2018 */
2019 id: FunctionId;
2020 /**
2021 * The name of the scheduled AWS Lambda function.
2022 */
2023 name: FunctionName;
2024 /**
2025 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
2026 */
2027 cause: ScheduleLambdaFunctionFailedCause;
2028 /**
2029 * The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2030 */
2031 decisionTaskCompletedEventId: EventId;
2032 }
2033 export interface SignalExternalWorkflowExecutionDecisionAttributes {
2034 /**
2035 * Required. The workflowId of the workflow execution to be signaled.
2036 */
2037 workflowId: WorkflowId;
2038 /**
2039 * The runId of the workflow execution to be signaled.
2040 */
2041 runId?: RunIdOptional;
2042 /**
2043 * Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.
2044 */
2045 signalName: SignalName;
2046 /**
2047 * Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.
2048 */
2049 input?: Data;
2050 /**
2051 * Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.
2052 */
2053 control?: Data;
2054 }
2055 export type SignalExternalWorkflowExecutionFailedCause = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"|"SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
2056 export interface SignalExternalWorkflowExecutionFailedEventAttributes {
2057 /**
2058 * The workflowId of the external workflow execution that the signal was being delivered to.
2059 */
2060 workflowId: WorkflowId;
2061 /**
2062 * The runId of the external workflow execution that the signal was being delivered to.
2063 */
2064 runId?: RunIdOptional;
2065 /**
2066 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
2067 */
2068 cause: SignalExternalWorkflowExecutionFailedCause;
2069 /**
2070 * 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.
2071 */
2072 initiatedEventId: EventId;
2073 /**
2074 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2075 */
2076 decisionTaskCompletedEventId: EventId;
2077 control?: Data;
2078 }
2079 export interface SignalExternalWorkflowExecutionInitiatedEventAttributes {
2080 /**
2081 * The workflowId of the external workflow execution.
2082 */
2083 workflowId: WorkflowId;
2084 /**
2085 * The runId of the external workflow execution to send the signal to.
2086 */
2087 runId?: RunIdOptional;
2088 /**
2089 * The name of the signal.
2090 */
2091 signalName: SignalName;
2092 /**
2093 * Input provided to the signal (if any).
2094 */
2095 input?: Data;
2096 /**
2097 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2098 */
2099 decisionTaskCompletedEventId: EventId;
2100 /**
2101 * Optional. data attached to the event that can be used by the decider in subsequent decision tasks.
2102 */
2103 control?: Data;
2104 }
2105 export type SignalName = string;
2106 export interface SignalWorkflowExecutionInput {
2107 /**
2108 * The name of the domain containing the workflow execution to signal.
2109 */
2110 domain: DomainName;
2111 /**
2112 * The workflowId of the workflow execution to signal.
2113 */
2114 workflowId: WorkflowId;
2115 /**
2116 * The runId of the workflow execution to signal.
2117 */
2118 runId?: RunIdOptional;
2119 /**
2120 * The name of the signal. This name must be meaningful to the target workflow.
2121 */
2122 signalName: SignalName;
2123 /**
2124 * Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
2125 */
2126 input?: Data;
2127 }
2128 export interface StartChildWorkflowExecutionDecisionAttributes {
2129 /**
2130 * Required. The type of the workflow execution to be started.
2131 */
2132 workflowType: WorkflowType;
2133 /**
2134 * Required. The workflowId of the workflow execution. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
2135 */
2136 workflowId: WorkflowId;
2137 /**
2138 * 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.
2139 */
2140 control?: Data;
2141 /**
2142 * The input to be provided to the workflow execution.
2143 */
2144 input?: Data;
2145 /**
2146 * The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
2147 */
2148 executionStartToCloseTimeout?: DurationInSecondsOptional;
2149 /**
2150 * The name of the task list to be used for decision tasks of the child workflow execution. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
2151 */
2152 taskList?: TaskList;
2153 /**
2154 * Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
2155 */
2156 taskPriority?: TaskPriority;
2157 /**
2158 * Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
2159 */
2160 taskStartToCloseTimeout?: DurationInSecondsOptional;
2161 /**
2162 * Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE: the child executions will be terminated. REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON: no action will be taken. The child executions will continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
2163 */
2164 childPolicy?: ChildPolicy;
2165 /**
2166 * 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.
2167 */
2168 tagList?: TagList;
2169 /**
2170 * The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions. In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
2171 */
2172 lambdaRole?: Arn;
2173 }
2174 export type StartChildWorkflowExecutionFailedCause = "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"|string;
2175 export interface StartChildWorkflowExecutionFailedEventAttributes {
2176 /**
2177 * The workflow type provided in the StartChildWorkflowExecution decision that failed.
2178 */
2179 workflowType: WorkflowType;
2180 /**
2181 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
2182 */
2183 cause: StartChildWorkflowExecutionFailedCause;
2184 /**
2185 * The workflowId of the child workflow execution.
2186 */
2187 workflowId: WorkflowId;
2188 /**
2189 * 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.
2190 */
2191 initiatedEventId: EventId;
2192 /**
2193 * 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.
2194 */
2195 decisionTaskCompletedEventId: EventId;
2196 control?: Data;
2197 }
2198 export interface StartChildWorkflowExecutionInitiatedEventAttributes {
2199 /**
2200 * The workflowId of the child workflow execution.
2201 */
2202 workflowId: WorkflowId;
2203 /**
2204 * The type of the child workflow execution.
2205 */
2206 workflowType: WorkflowType;
2207 /**
2208 * 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.
2209 */
2210 control?: Data;
2211 /**
2212 * The inputs provided to the child workflow execution (if any).
2213 */
2214 input?: Data;
2215 /**
2216 * The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2217 */
2218 executionStartToCloseTimeout?: DurationInSecondsOptional;
2219 /**
2220 * The name of the task list used for the decision tasks of the child workflow execution.
2221 */
2222 taskList: TaskList;
2223 /**
2224 * Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
2225 */
2226 taskPriority?: TaskPriority;
2227 /**
2228 * 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.
2229 */
2230 decisionTaskCompletedEventId: EventId;
2231 /**
2232 * 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.
2233 */
2234 childPolicy: ChildPolicy;
2235 /**
2236 * The maximum duration allowed for the decision tasks for this workflow execution. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2237 */
2238 taskStartToCloseTimeout?: DurationInSecondsOptional;
2239 /**
2240 * The list of tags to associated with the child workflow execution.
2241 */
2242 tagList?: TagList;
2243 /**
2244 * The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
2245 */
2246 lambdaRole?: Arn;
2247 }
2248 export type StartLambdaFunctionFailedCause = "ASSUME_ROLE_FAILED"|string;
2249 export interface StartLambdaFunctionFailedEventAttributes {
2250 /**
2251 * The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2252 */
2253 scheduledEventId?: EventId;
2254 /**
2255 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
2256 */
2257 cause?: StartLambdaFunctionFailedCause;
2258 /**
2259 * The error message (if any).
2260 */
2261 message?: CauseMessage;
2262 }
2263 export interface StartTimerDecisionAttributes {
2264 /**
2265 * Required. The unique ID of the timer. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
2266 */
2267 timerId: TimerId;
2268 /**
2269 * Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
2270 */
2271 control?: Data;
2272 /**
2273 * Required. The duration to wait before firing the timer. The duration is specified in seconds; an integer greater than or equal to 0.
2274 */
2275 startToFireTimeout: DurationInSeconds;
2276 }
2277 export type StartTimerFailedCause = "TIMER_ID_ALREADY_IN_USE"|"OPEN_TIMERS_LIMIT_EXCEEDED"|"TIMER_CREATION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
2278 export interface StartTimerFailedEventAttributes {
2279 /**
2280 * The timerId provided in the StartTimer decision that failed.
2281 */
2282 timerId: TimerId;
2283 /**
2284 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
2285 */
2286 cause: StartTimerFailedCause;
2287 /**
2288 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2289 */
2290 decisionTaskCompletedEventId: EventId;
2291 }
2292 export interface StartWorkflowExecutionInput {
2293 /**
2294 * The name of the domain in which the workflow execution is created.
2295 */
2296 domain: DomainName;
2297 /**
2298 * 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 quotarnquot.
2299 */
2300 workflowId: WorkflowId;
2301 /**
2302 * The type of the workflow to start.
2303 */
2304 workflowType: WorkflowType;
2305 /**
2306 * The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string quotarnquot.
2307 */
2308 taskList?: TaskList;
2309 /**
2310 * The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
2311 */
2312 taskPriority?: TaskPriority;
2313 /**
2314 * 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.
2315 */
2316 input?: Data;
2317 /**
2318 * The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit 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. 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.
2319 */
2320 executionStartToCloseTimeout?: DurationInSecondsOptional;
2321 /**
2322 * 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.
2323 */
2324 tagList?: TagList;
2325 /**
2326 * Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
2327 */
2328 taskStartToCloseTimeout?: DurationInSecondsOptional;
2329 /**
2330 * 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. 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.
2331 */
2332 childPolicy?: ChildPolicy;
2333 /**
2334 * The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions. In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
2335 */
2336 lambdaRole?: Arn;
2337 }
2338 export type Tag = string;
2339 export interface TagFilter {
2340 /**
2341 * Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.
2342 */
2343 tag: Tag;
2344 }
2345 export type TagList = Tag[];
2346 export interface TaskList {
2347 /**
2348 * The name of the task list.
2349 */
2350 name: Name;
2351 }
2352 export type TaskPriority = string;
2353 export type TaskToken = string;
2354 export type TerminateReason = string;
2355 export interface TerminateWorkflowExecutionInput {
2356 /**
2357 * The domain of the workflow execution to terminate.
2358 */
2359 domain: DomainName;
2360 /**
2361 * The workflowId of the workflow execution to terminate.
2362 */
2363 workflowId: WorkflowId;
2364 /**
2365 * The runId of the workflow execution to terminate.
2366 */
2367 runId?: RunIdOptional;
2368 /**
2369 * Optional. A descriptive reason for terminating the workflow execution.
2370 */
2371 reason?: TerminateReason;
2372 /**
2373 * Optional. Details for terminating the workflow execution.
2374 */
2375 details?: Data;
2376 /**
2377 * 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. 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.
2378 */
2379 childPolicy?: ChildPolicy;
2380 }
2381 export interface TimerCanceledEventAttributes {
2382 /**
2383 * The unique ID of the timer that was canceled.
2384 */
2385 timerId: TimerId;
2386 /**
2387 * 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.
2388 */
2389 startedEventId: EventId;
2390 /**
2391 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2392 */
2393 decisionTaskCompletedEventId: EventId;
2394 }
2395 export interface TimerFiredEventAttributes {
2396 /**
2397 * The unique ID of the timer that fired.
2398 */
2399 timerId: TimerId;
2400 /**
2401 * 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.
2402 */
2403 startedEventId: EventId;
2404 }
2405 export type TimerId = string;
2406 export interface TimerStartedEventAttributes {
2407 /**
2408 * The unique ID of the timer that was started.
2409 */
2410 timerId: TimerId;
2411 /**
2412 * Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
2413 */
2414 control?: Data;
2415 /**
2416 * The duration of time after which the timer will fire. The duration is specified in seconds; an integer greater than or equal to 0.
2417 */
2418 startToFireTimeout: DurationInSeconds;
2419 /**
2420 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2421 */
2422 decisionTaskCompletedEventId: EventId;
2423 }
2424 export type Timestamp = Date;
2425 export type Truncated = boolean;
2426 export type Version = string;
2427 export type VersionOptional = string;
2428 export interface WorkflowExecution {
2429 /**
2430 * The user defined identifier associated with the workflow execution.
2431 */
2432 workflowId: WorkflowId;
2433 /**
2434 * A system-generated unique identifier for the workflow execution.
2435 */
2436 runId: RunId;
2437 }
2438 export type WorkflowExecutionCancelRequestedCause = "CHILD_POLICY_APPLIED"|string;
2439 export interface WorkflowExecutionCancelRequestedEventAttributes {
2440 /**
2441 * The external workflow execution for which the cancellation was requested.
2442 */
2443 externalWorkflowExecution?: WorkflowExecution;
2444 /**
2445 * 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.
2446 */
2447 externalInitiatedEventId?: EventId;
2448 /**
2449 * 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.
2450 */
2451 cause?: WorkflowExecutionCancelRequestedCause;
2452 }
2453 export interface WorkflowExecutionCanceledEventAttributes {
2454 /**
2455 * Details for the cancellation (if any).
2456 */
2457 details?: Data;
2458 /**
2459 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2460 */
2461 decisionTaskCompletedEventId: EventId;
2462 }
2463 export interface WorkflowExecutionCompletedEventAttributes {
2464 /**
2465 * The result produced by the workflow execution upon successful completion.
2466 */
2467 result?: Data;
2468 /**
2469 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2470 */
2471 decisionTaskCompletedEventId: EventId;
2472 }
2473 export interface WorkflowExecutionConfiguration {
2474 /**
2475 * The maximum duration allowed for decision tasks for this workflow execution. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2476 */
2477 taskStartToCloseTimeout: DurationInSeconds;
2478 /**
2479 * The total duration for this workflow execution. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2480 */
2481 executionStartToCloseTimeout: DurationInSeconds;
2482 /**
2483 * The task list used for the decision tasks generated for this workflow execution.
2484 */
2485 taskList: TaskList;
2486 /**
2487 * The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
2488 */
2489 taskPriority?: TaskPriority;
2490 /**
2491 * 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.
2492 */
2493 childPolicy: ChildPolicy;
2494 /**
2495 * The IAM role used by this workflow execution when invoking AWS Lambda functions.
2496 */
2497 lambdaRole?: Arn;
2498 }
2499 export interface WorkflowExecutionContinuedAsNewEventAttributes {
2500 /**
2501 * The input provided to the new workflow execution.
2502 */
2503 input?: Data;
2504 /**
2505 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2506 */
2507 decisionTaskCompletedEventId: EventId;
2508 /**
2509 * The runId of the new workflow execution.
2510 */
2511 newExecutionRunId: RunId;
2512 /**
2513 * The total duration allowed for the new workflow execution. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2514 */
2515 executionStartToCloseTimeout?: DurationInSecondsOptional;
2516 taskList: TaskList;
2517 taskPriority?: TaskPriority;
2518 /**
2519 * The maximum duration of decision tasks for the new workflow execution. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2520 */
2521 taskStartToCloseTimeout?: DurationInSecondsOptional;
2522 /**
2523 * 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.
2524 */
2525 childPolicy: ChildPolicy;
2526 /**
2527 * The list of tags associated with the new workflow execution.
2528 */
2529 tagList?: TagList;
2530 workflowType: WorkflowType;
2531 /**
2532 * The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
2533 */
2534 lambdaRole?: Arn;
2535 }
2536 export interface WorkflowExecutionCount {
2537 /**
2538 * The number of workflow executions.
2539 */
2540 count: Count;
2541 /**
2542 * 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.
2543 */
2544 truncated?: Truncated;
2545 }
2546 export interface WorkflowExecutionDetail {
2547 /**
2548 * Information about the workflow execution.
2549 */
2550 executionInfo: WorkflowExecutionInfo;
2551 /**
2552 * The configuration settings for this workflow execution including timeout values, tasklist etc.
2553 */
2554 executionConfiguration: WorkflowExecutionConfiguration;
2555 /**
2556 * The number of tasks for this workflow execution. This includes open and closed tasks of all types.
2557 */
2558 openCounts: WorkflowExecutionOpenCounts;
2559 /**
2560 * 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.
2561 */
2562 latestActivityTaskTimestamp?: Timestamp;
2563 /**
2564 * The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.
2565 */
2566 latestExecutionContext?: Data;
2567 }
2568 export interface WorkflowExecutionFailedEventAttributes {
2569 /**
2570 * The descriptive reason provided for the failure (if any).
2571 */
2572 reason?: FailureReason;
2573 /**
2574 * The details of the failure (if any).
2575 */
2576 details?: Data;
2577 /**
2578 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
2579 */
2580 decisionTaskCompletedEventId: EventId;
2581 }
2582 export interface WorkflowExecutionFilter {
2583 /**
2584 * The workflowId to pass of match the criteria of this filter.
2585 */
2586 workflowId: WorkflowId;
2587 }
2588 export interface WorkflowExecutionInfo {
2589 /**
2590 * The workflow execution this information is about.
2591 */
2592 execution: WorkflowExecution;
2593 /**
2594 * The type of the workflow execution.
2595 */
2596 workflowType: WorkflowType;
2597 /**
2598 * The time when the execution was started.
2599 */
2600 startTimestamp: Timestamp;
2601 /**
2602 * The time when the workflow execution was closed. Set only if the execution status is CLOSED.
2603 */
2604 closeTimestamp?: Timestamp;
2605 /**
2606 * The current status of the execution.
2607 */
2608 executionStatus: ExecutionStatus;
2609 /**
2610 * 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.
2611 */
2612 closeStatus?: CloseStatus;
2613 /**
2614 * If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
2615 */
2616 parent?: WorkflowExecution;
2617 /**
2618 * 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.
2619 */
2620 tagList?: TagList;
2621 /**
2622 * Set to true if a cancellation is requested for this workflow execution.
2623 */
2624 cancelRequested?: Canceled;
2625 }
2626 export type WorkflowExecutionInfoList = WorkflowExecutionInfo[];
2627 export interface WorkflowExecutionInfos {
2628 /**
2629 * The list of workflow information structures.
2630 */
2631 executionInfos: WorkflowExecutionInfoList;
2632 /**
2633 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
2634 */
2635 nextPageToken?: PageToken;
2636 }
2637 export interface WorkflowExecutionOpenCounts {
2638 /**
2639 * The count of activity tasks whose status is OPEN.
2640 */
2641 openActivityTasks: Count;
2642 /**
2643 * The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
2644 */
2645 openDecisionTasks: OpenDecisionTasksCount;
2646 /**
2647 * The count of timers started by this workflow execution that have not fired yet.
2648 */
2649 openTimers: Count;
2650 /**
2651 * The count of child workflow executions whose status is OPEN.
2652 */
2653 openChildWorkflowExecutions: Count;
2654 /**
2655 * The count of AWS Lambda functions that are currently executing.
2656 */
2657 openLambdaFunctions?: Count;
2658 }
2659 export interface WorkflowExecutionSignaledEventAttributes {
2660 /**
2661 * The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
2662 */
2663 signalName: SignalName;
2664 /**
2665 * Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
2666 */
2667 input?: Data;
2668 /**
2669 * The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
2670 */
2671 externalWorkflowExecution?: WorkflowExecution;
2672 /**
2673 * 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.
2674 */
2675 externalInitiatedEventId?: EventId;
2676 }
2677 export interface WorkflowExecutionStartedEventAttributes {
2678 /**
2679 * The input provided to the workflow execution (if any).
2680 */
2681 input?: Data;
2682 /**
2683 * The maximum duration for this workflow execution. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2684 */
2685 executionStartToCloseTimeout?: DurationInSecondsOptional;
2686 /**
2687 * The maximum duration of decision tasks for this workflow type. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2688 */
2689 taskStartToCloseTimeout?: DurationInSecondsOptional;
2690 /**
2691 * 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.
2692 */
2693 childPolicy: ChildPolicy;
2694 /**
2695 * The name of the task list for scheduling the decision tasks for this workflow execution.
2696 */
2697 taskList: TaskList;
2698 /**
2699 * The workflow type of this execution.
2700 */
2701 workflowType: WorkflowType;
2702 /**
2703 * The list of tags associated with this workflow execution. An execution can have up to 5 tags.
2704 */
2705 tagList?: TagList;
2706 taskPriority?: TaskPriority;
2707 /**
2708 * 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.
2709 */
2710 continuedExecutionRunId?: RunIdOptional;
2711 /**
2712 * The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
2713 */
2714 parentWorkflowExecution?: WorkflowExecution;
2715 /**
2716 * 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.
2717 */
2718 parentInitiatedEventId?: EventId;
2719 /**
2720 * The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
2721 */
2722 lambdaRole?: Arn;
2723 }
2724 export type WorkflowExecutionTerminatedCause = "CHILD_POLICY_APPLIED"|"EVENT_LIMIT_EXCEEDED"|"OPERATOR_INITIATED"|string;
2725 export interface WorkflowExecutionTerminatedEventAttributes {
2726 /**
2727 * The reason provided for the termination (if any).
2728 */
2729 reason?: TerminateReason;
2730 /**
2731 * The details provided for the termination (if any).
2732 */
2733 details?: Data;
2734 /**
2735 * 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.
2736 */
2737 childPolicy: ChildPolicy;
2738 /**
2739 * 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.
2740 */
2741 cause?: WorkflowExecutionTerminatedCause;
2742 }
2743 export interface WorkflowExecutionTimedOutEventAttributes {
2744 /**
2745 * The type of timeout that caused this event.
2746 */
2747 timeoutType: WorkflowExecutionTimeoutType;
2748 /**
2749 * 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.
2750 */
2751 childPolicy: ChildPolicy;
2752 }
2753 export type WorkflowExecutionTimeoutType = "START_TO_CLOSE"|string;
2754 export type WorkflowId = string;
2755 export interface WorkflowType {
2756 /**
2757 * Required. The name of the workflow type. The combination of workflow type name and version must be unique with in a domain.
2758 */
2759 name: Name;
2760 /**
2761 * Required. The version of the workflow type. The combination of workflow type name and version must be unique with in a domain.
2762 */
2763 version: Version;
2764 }
2765 export interface WorkflowTypeConfiguration {
2766 /**
2767 * Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task 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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2768 */
2769 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
2770 /**
2771 * Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
2772 */
2773 defaultExecutionStartToCloseTimeout?: DurationInSecondsOptional;
2774 /**
2775 * Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
2776 */
2777 defaultTaskList?: TaskList;
2778 /**
2779 * Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
2780 */
2781 defaultTaskPriority?: TaskPriority;
2782 /**
2783 * Optional. 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.
2784 */
2785 defaultChildPolicy?: ChildPolicy;
2786 /**
2787 * The default IAM role to use when a workflow execution invokes a AWS Lambda function.
2788 */
2789 defaultLambdaRole?: Arn;
2790 }
2791 export interface WorkflowTypeDetail {
2792 /**
2793 * 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.
2794 */
2795 typeInfo: WorkflowTypeInfo;
2796 /**
2797 * Configuration settings of the workflow type registered through RegisterWorkflowType
2798 */
2799 configuration: WorkflowTypeConfiguration;
2800 }
2801 export interface WorkflowTypeFilter {
2802 /**
2803 * Required. Name of the workflow type.
2804 */
2805 name: Name;
2806 /**
2807 * Version of the workflow type.
2808 */
2809 version?: VersionOptional;
2810 }
2811 export interface WorkflowTypeInfo {
2812 /**
2813 * The workflow type this information is about.
2814 */
2815 workflowType: WorkflowType;
2816 /**
2817 * The current status of the workflow type.
2818 */
2819 status: RegistrationStatus;
2820 /**
2821 * The description of the type registered through RegisterWorkflowType.
2822 */
2823 description?: Description;
2824 /**
2825 * The date when this type was registered.
2826 */
2827 creationDate: Timestamp;
2828 /**
2829 * If the type is in deprecated state, then it is set to the date when the type was deprecated.
2830 */
2831 deprecationDate?: Timestamp;
2832 }
2833 export type WorkflowTypeInfoList = WorkflowTypeInfo[];
2834 export interface WorkflowTypeInfos {
2835 /**
2836 * The list of workflow type information.
2837 */
2838 typeInfos: WorkflowTypeInfoList;
2839 /**
2840 * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
2841 */
2842 nextPageToken?: PageToken;
2843 }
2844 /**
2845 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2846 */
2847 export type apiVersion = "2012-01-25"|"latest"|string;
2848 export interface ClientApiVersions {
2849 /**
2850 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2851 */
2852 apiVersion?: apiVersion;
2853 }
2854 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2855 }
2856 export = SWF;