UNPKG

245 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 continue to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 continue to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 continues to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 continues to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 continues to run. A deprecated workflow type may still be used when calling visibility actions. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 continues to run. A deprecated workflow type may still be used when calling visibility actions. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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, etc. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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, etc. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request). Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request). Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true. This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType. This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true. This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType. This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 provided using the details argument. These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history. Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 provided using the details argument. These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history. Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 in the Amazon SWF Developer Guide.
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 in the Amazon SWF Developer Guide.
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 isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution isn't open, this method fails with UnknownResource. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution isn't open, this method fails with UnknownResource. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
260 */
261 terminateWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
262}
263declare namespace SWF {
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.
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.
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.
336 */
337 reason?: FailureReason;
338 /**
339 * The details of the failure.
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 * Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't 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 * The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
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 is 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 * The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
445 */
446 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
447 /**
448 * The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat. You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
449 */
450 defaultTaskHeartbeatTimeout?: DurationInSecondsOptional;
451 /**
452 * The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.
453 */
454 defaultTaskList?: TaskList;
455 /**
456 * The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
457 */
458 defaultTaskPriority?: TaskPriority;
459 /**
460 * The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
461 */
462 defaultTaskScheduleToStartTimeout?: DurationInSecondsOptional;
463 /**
464 * The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
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 * 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 in the Amazon SWF Developer Guide.
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 * 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 in the Amazon SWF Developer Guide.
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.
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 * 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 in the Amazon SWF Developer Guide.
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. You can use NONE to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
708 */
709 executionStartToCloseTimeout?: DurationInSecondsOptional;
710 /**
711 * The task list to use for the decisions of the new (continued) workflow execution.
712 */
713 taskList?: TaskList;
714 /**
715 * The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
716 */
717 taskPriority?: TaskPriority;
718 /**
719 * Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
720 */
721 taskStartToCloseTimeout?: DurationInSecondsOptional;
722 /**
723 * If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
724 */
725 childPolicy?: ChildPolicy;
726 /**
727 * 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.
728 */
729 tagList?: TagList;
730 /**
731 * The version of the workflow to start.
732 */
733 workflowTypeVersion?: Version;
734 /**
735 * The IAM role to attach to the new (continued) execution.
736 */
737 lambdaRole?: Arn;
738 }
739 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;
740 export interface ContinueAsNewWorkflowExecutionFailedEventAttributes {
741 /**
742 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
743 */
744 cause: ContinueAsNewWorkflowExecutionFailedCause;
745 /**
746 * 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.
747 */
748 decisionTaskCompletedEventId: EventId;
749 }
750 export type Count = number;
751 export interface CountClosedWorkflowExecutionsInput {
752 /**
753 * The name of the domain containing the workflow executions to count.
754 */
755 domain: DomainName;
756 /**
757 * 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.
758 */
759 startTimeFilter?: ExecutionTimeFilter;
760 /**
761 * 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.
762 */
763 closeTimeFilter?: ExecutionTimeFilter;
764 /**
765 * 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.
766 */
767 executionFilter?: WorkflowExecutionFilter;
768 /**
769 * 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.
770 */
771 typeFilter?: WorkflowTypeFilter;
772 /**
773 * 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.
774 */
775 tagFilter?: TagFilter;
776 /**
777 * 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.
778 */
779 closeStatusFilter?: CloseStatusFilter;
780 }
781 export interface CountOpenWorkflowExecutionsInput {
782 /**
783 * The name of the domain containing the workflow executions to count.
784 */
785 domain: DomainName;
786 /**
787 * Specifies the start time criteria that workflow executions must meet in order to be counted.
788 */
789 startTimeFilter: ExecutionTimeFilter;
790 /**
791 * 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.
792 */
793 typeFilter?: WorkflowTypeFilter;
794 /**
795 * 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.
796 */
797 tagFilter?: TagFilter;
798 /**
799 * 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.
800 */
801 executionFilter?: WorkflowExecutionFilter;
802 }
803 export interface CountPendingActivityTasksInput {
804 /**
805 * The name of the domain that contains the task list.
806 */
807 domain: DomainName;
808 /**
809 * The name of the task list.
810 */
811 taskList: TaskList;
812 }
813 export interface CountPendingDecisionTasksInput {
814 /**
815 * The name of the domain that contains the task list.
816 */
817 domain: DomainName;
818 /**
819 * The name of the task list.
820 */
821 taskList: TaskList;
822 }
823 export type Data = string;
824 export interface Decision {
825 /**
826 * Specifies the type of the decision.
827 */
828 decisionType: DecisionType;
829 /**
830 * Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.
831 */
832 scheduleActivityTaskDecisionAttributes?: ScheduleActivityTaskDecisionAttributes;
833 /**
834 * Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.
835 */
836 requestCancelActivityTaskDecisionAttributes?: RequestCancelActivityTaskDecisionAttributes;
837 /**
838 * Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.
839 */
840 completeWorkflowExecutionDecisionAttributes?: CompleteWorkflowExecutionDecisionAttributes;
841 /**
842 * Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.
843 */
844 failWorkflowExecutionDecisionAttributes?: FailWorkflowExecutionDecisionAttributes;
845 /**
846 * Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.
847 */
848 cancelWorkflowExecutionDecisionAttributes?: CancelWorkflowExecutionDecisionAttributes;
849 /**
850 * Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.
851 */
852 continueAsNewWorkflowExecutionDecisionAttributes?: ContinueAsNewWorkflowExecutionDecisionAttributes;
853 /**
854 * Provides the details of the RecordMarker decision. It isn't set for other decision types.
855 */
856 recordMarkerDecisionAttributes?: RecordMarkerDecisionAttributes;
857 /**
858 * Provides the details of the StartTimer decision. It isn't set for other decision types.
859 */
860 startTimerDecisionAttributes?: StartTimerDecisionAttributes;
861 /**
862 * Provides the details of the CancelTimer decision. It isn't set for other decision types.
863 */
864 cancelTimerDecisionAttributes?: CancelTimerDecisionAttributes;
865 /**
866 * Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.
867 */
868 signalExternalWorkflowExecutionDecisionAttributes?: SignalExternalWorkflowExecutionDecisionAttributes;
869 /**
870 * Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.
871 */
872 requestCancelExternalWorkflowExecutionDecisionAttributes?: RequestCancelExternalWorkflowExecutionDecisionAttributes;
873 /**
874 * Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.
875 */
876 startChildWorkflowExecutionDecisionAttributes?: StartChildWorkflowExecutionDecisionAttributes;
877 /**
878 * Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.
879 */
880 scheduleLambdaFunctionDecisionAttributes?: ScheduleLambdaFunctionDecisionAttributes;
881 }
882 export type DecisionList = Decision[];
883 export interface DecisionTask {
884 /**
885 * 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.
886 */
887 taskToken: TaskToken;
888 /**
889 * The ID of the DecisionTaskStarted event recorded in the history.
890 */
891 startedEventId: EventId;
892 /**
893 * The workflow execution for which this decision task was created.
894 */
895 workflowExecution: WorkflowExecution;
896 /**
897 * The type of the workflow execution for which this decision task was created.
898 */
899 workflowType: WorkflowType;
900 /**
901 * A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
902 */
903 events: HistoryEventList;
904 /**
905 * 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.
906 */
907 nextPageToken?: PageToken;
908 /**
909 * 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.
910 */
911 previousStartedEventId?: EventId;
912 }
913 export interface DecisionTaskCompletedEventAttributes {
914 /**
915 * User defined context for the workflow execution.
916 */
917 executionContext?: Data;
918 /**
919 * 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.
920 */
921 scheduledEventId: EventId;
922 /**
923 * 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.
924 */
925 startedEventId: EventId;
926 }
927 export interface DecisionTaskScheduledEventAttributes {
928 /**
929 * The name of the task list in which the decision task was scheduled.
930 */
931 taskList: TaskList;
932 /**
933 * A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
934 */
935 taskPriority?: TaskPriority;
936 /**
937 * The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
938 */
939 startToCloseTimeout?: DurationInSecondsOptional;
940 }
941 export interface DecisionTaskStartedEventAttributes {
942 /**
943 * Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
944 */
945 identity?: Identity;
946 /**
947 * 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.
948 */
949 scheduledEventId: EventId;
950 }
951 export interface DecisionTaskTimedOutEventAttributes {
952 /**
953 * The type of timeout that expired before the decision task could be completed.
954 */
955 timeoutType: DecisionTaskTimeoutType;
956 /**
957 * 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.
958 */
959 scheduledEventId: EventId;
960 /**
961 * 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.
962 */
963 startedEventId: EventId;
964 }
965 export type DecisionTaskTimeoutType = "START_TO_CLOSE"|string;
966 export type DecisionType = "ScheduleActivityTask"|"RequestCancelActivityTask"|"CompleteWorkflowExecution"|"FailWorkflowExecution"|"CancelWorkflowExecution"|"ContinueAsNewWorkflowExecution"|"RecordMarker"|"StartTimer"|"CancelTimer"|"SignalExternalWorkflowExecution"|"RequestCancelExternalWorkflowExecution"|"StartChildWorkflowExecution"|"ScheduleLambdaFunction"|string;
967 export interface DeprecateActivityTypeInput {
968 /**
969 * The name of the domain in which the activity type is registered.
970 */
971 domain: DomainName;
972 /**
973 * The activity type to deprecate.
974 */
975 activityType: ActivityType;
976 }
977 export interface DeprecateDomainInput {
978 /**
979 * The name of the domain to deprecate.
980 */
981 name: DomainName;
982 }
983 export interface DeprecateWorkflowTypeInput {
984 /**
985 * The name of the domain in which the workflow type is registered.
986 */
987 domain: DomainName;
988 /**
989 * The workflow type to deprecate.
990 */
991 workflowType: WorkflowType;
992 }
993 export interface DescribeActivityTypeInput {
994 /**
995 * The name of the domain in which the activity type is registered.
996 */
997 domain: DomainName;
998 /**
999 * The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.
1000 */
1001 activityType: ActivityType;
1002 }
1003 export interface DescribeDomainInput {
1004 /**
1005 * The name of the domain to describe.
1006 */
1007 name: DomainName;
1008 }
1009 export interface DescribeWorkflowExecutionInput {
1010 /**
1011 * The name of the domain containing the workflow execution.
1012 */
1013 domain: DomainName;
1014 /**
1015 * The workflow execution to describe.
1016 */
1017 execution: WorkflowExecution;
1018 }
1019 export interface DescribeWorkflowTypeInput {
1020 /**
1021 * The name of the domain in which this workflow type is registered.
1022 */
1023 domain: DomainName;
1024 /**
1025 * The workflow type to describe.
1026 */
1027 workflowType: WorkflowType;
1028 }
1029 export type Description = string;
1030 export interface DomainConfiguration {
1031 /**
1032 * The retention period for workflow executions in this domain.
1033 */
1034 workflowExecutionRetentionPeriodInDays: DurationInDays;
1035 }
1036 export interface DomainDetail {
1037 /**
1038 * The basic information about a domain, such as its name, status, and description.
1039 */
1040 domainInfo: DomainInfo;
1041 /**
1042 * The domain configuration. Currently, this includes only the domain's retention period.
1043 */
1044 configuration: DomainConfiguration;
1045 }
1046 export interface DomainInfo {
1047 /**
1048 * The name of the domain. This name is unique within the account.
1049 */
1050 name: DomainName;
1051 /**
1052 * 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.
1053 */
1054 status: RegistrationStatus;
1055 /**
1056 * The description of the domain provided through RegisterDomain.
1057 */
1058 description?: Description;
1059 }
1060 export type DomainInfoList = DomainInfo[];
1061 export interface DomainInfos {
1062 /**
1063 * A list of DomainInfo structures.
1064 */
1065 domainInfos: DomainInfoList;
1066 /**
1067 * 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.
1068 */
1069 nextPageToken?: PageToken;
1070 }
1071 export type DomainName = string;
1072 export type DurationInDays = string;
1073 export type DurationInSeconds = string;
1074 export type DurationInSecondsOptional = string;
1075 export type EventId = number;
1076 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;
1077 export type ExecutionStatus = "OPEN"|"CLOSED"|string;
1078 export interface ExecutionTimeFilter {
1079 /**
1080 * Specifies the oldest start or close date and time to return.
1081 */
1082 oldestDate: Timestamp;
1083 /**
1084 * Specifies the latest start or close date and time to return.
1085 */
1086 latestDate?: Timestamp;
1087 }
1088 export interface ExternalWorkflowExecutionCancelRequestedEventAttributes {
1089 /**
1090 * The external workflow execution to which the cancellation request was delivered.
1091 */
1092 workflowExecution: WorkflowExecution;
1093 /**
1094 * 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.
1095 */
1096 initiatedEventId: EventId;
1097 }
1098 export interface ExternalWorkflowExecutionSignaledEventAttributes {
1099 /**
1100 * The external workflow execution that the signal was delivered to.
1101 */
1102 workflowExecution: WorkflowExecution;
1103 /**
1104 * 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.
1105 */
1106 initiatedEventId: EventId;
1107 }
1108 export interface FailWorkflowExecutionDecisionAttributes {
1109 /**
1110 * A descriptive reason for the failure that may help in diagnostics.
1111 */
1112 reason?: FailureReason;
1113 /**
1114 * Details of the failure.
1115 */
1116 details?: Data;
1117 }
1118 export type FailWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string;
1119 export interface FailWorkflowExecutionFailedEventAttributes {
1120 /**
1121 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
1122 */
1123 cause: FailWorkflowExecutionFailedCause;
1124 /**
1125 * 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.
1126 */
1127 decisionTaskCompletedEventId: EventId;
1128 }
1129 export type FailureReason = string;
1130 export type FunctionId = string;
1131 export type FunctionInput = string;
1132 export type FunctionName = string;
1133 export interface GetWorkflowExecutionHistoryInput {
1134 /**
1135 * The name of the domain containing the workflow execution.
1136 */
1137 domain: DomainName;
1138 /**
1139 * Specifies the workflow execution for which to return the history.
1140 */
1141 execution: WorkflowExecution;
1142 /**
1143 * 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.
1144 */
1145 nextPageToken?: PageToken;
1146 /**
1147 * The maximum number of results that are 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.
1148 */
1149 maximumPageSize?: PageSize;
1150 /**
1151 * 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.
1152 */
1153 reverseOrder?: ReverseOrder;
1154 }
1155 export interface History {
1156 /**
1157 * The list of history events.
1158 */
1159 events: HistoryEventList;
1160 /**
1161 * 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.
1162 */
1163 nextPageToken?: PageToken;
1164 }
1165 export interface HistoryEvent {
1166 /**
1167 * The date and time when the event occurred.
1168 */
1169 eventTimestamp: Timestamp;
1170 /**
1171 * The type of the history event.
1172 */
1173 eventType: EventType;
1174 /**
1175 * The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.
1176 */
1177 eventId: EventId;
1178 /**
1179 * If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
1180 */
1181 workflowExecutionStartedEventAttributes?: WorkflowExecutionStartedEventAttributes;
1182 /**
1183 * If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
1184 */
1185 workflowExecutionCompletedEventAttributes?: WorkflowExecutionCompletedEventAttributes;
1186 /**
1187 * If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1188 */
1189 completeWorkflowExecutionFailedEventAttributes?: CompleteWorkflowExecutionFailedEventAttributes;
1190 /**
1191 * If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1192 */
1193 workflowExecutionFailedEventAttributes?: WorkflowExecutionFailedEventAttributes;
1194 /**
1195 * If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1196 */
1197 failWorkflowExecutionFailedEventAttributes?: FailWorkflowExecutionFailedEventAttributes;
1198 /**
1199 * If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
1200 */
1201 workflowExecutionTimedOutEventAttributes?: WorkflowExecutionTimedOutEventAttributes;
1202 /**
1203 * If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
1204 */
1205 workflowExecutionCanceledEventAttributes?: WorkflowExecutionCanceledEventAttributes;
1206 /**
1207 * If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1208 */
1209 cancelWorkflowExecutionFailedEventAttributes?: CancelWorkflowExecutionFailedEventAttributes;
1210 /**
1211 * If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.
1212 */
1213 workflowExecutionContinuedAsNewEventAttributes?: WorkflowExecutionContinuedAsNewEventAttributes;
1214 /**
1215 * If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1216 */
1217 continueAsNewWorkflowExecutionFailedEventAttributes?: ContinueAsNewWorkflowExecutionFailedEventAttributes;
1218 /**
1219 * If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.
1220 */
1221 workflowExecutionTerminatedEventAttributes?: WorkflowExecutionTerminatedEventAttributes;
1222 /**
1223 * If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
1224 */
1225 workflowExecutionCancelRequestedEventAttributes?: WorkflowExecutionCancelRequestedEventAttributes;
1226 /**
1227 * If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.
1228 */
1229 decisionTaskScheduledEventAttributes?: DecisionTaskScheduledEventAttributes;
1230 /**
1231 * If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
1232 */
1233 decisionTaskStartedEventAttributes?: DecisionTaskStartedEventAttributes;
1234 /**
1235 * If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
1236 */
1237 decisionTaskCompletedEventAttributes?: DecisionTaskCompletedEventAttributes;
1238 /**
1239 * If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
1240 */
1241 decisionTaskTimedOutEventAttributes?: DecisionTaskTimedOutEventAttributes;
1242 /**
1243 * If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.
1244 */
1245 activityTaskScheduledEventAttributes?: ActivityTaskScheduledEventAttributes;
1246 /**
1247 * If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
1248 */
1249 activityTaskStartedEventAttributes?: ActivityTaskStartedEventAttributes;
1250 /**
1251 * If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
1252 */
1253 activityTaskCompletedEventAttributes?: ActivityTaskCompletedEventAttributes;
1254 /**
1255 * If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1256 */
1257 activityTaskFailedEventAttributes?: ActivityTaskFailedEventAttributes;
1258 /**
1259 * If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
1260 */
1261 activityTaskTimedOutEventAttributes?: ActivityTaskTimedOutEventAttributes;
1262 /**
1263 * If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
1264 */
1265 activityTaskCanceledEventAttributes?: ActivityTaskCanceledEventAttributes;
1266 /**
1267 * If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
1268 */
1269 activityTaskCancelRequestedEventAttributes?: ActivityTaskCancelRequestedEventAttributes;
1270 /**
1271 * If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.
1272 */
1273 workflowExecutionSignaledEventAttributes?: WorkflowExecutionSignaledEventAttributes;
1274 /**
1275 * If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.
1276 */
1277 markerRecordedEventAttributes?: MarkerRecordedEventAttributes;
1278 /**
1279 * If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1280 */
1281 recordMarkerFailedEventAttributes?: RecordMarkerFailedEventAttributes;
1282 /**
1283 * If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
1284 */
1285 timerStartedEventAttributes?: TimerStartedEventAttributes;
1286 /**
1287 * If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.
1288 */
1289 timerFiredEventAttributes?: TimerFiredEventAttributes;
1290 /**
1291 * If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
1292 */
1293 timerCanceledEventAttributes?: TimerCanceledEventAttributes;
1294 /**
1295 * If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
1296 */
1297 startChildWorkflowExecutionInitiatedEventAttributes?: StartChildWorkflowExecutionInitiatedEventAttributes;
1298 /**
1299 * If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
1300 */
1301 childWorkflowExecutionStartedEventAttributes?: ChildWorkflowExecutionStartedEventAttributes;
1302 /**
1303 * If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
1304 */
1305 childWorkflowExecutionCompletedEventAttributes?: ChildWorkflowExecutionCompletedEventAttributes;
1306 /**
1307 * If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1308 */
1309 childWorkflowExecutionFailedEventAttributes?: ChildWorkflowExecutionFailedEventAttributes;
1310 /**
1311 * If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
1312 */
1313 childWorkflowExecutionTimedOutEventAttributes?: ChildWorkflowExecutionTimedOutEventAttributes;
1314 /**
1315 * If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
1316 */
1317 childWorkflowExecutionCanceledEventAttributes?: ChildWorkflowExecutionCanceledEventAttributes;
1318 /**
1319 * If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.
1320 */
1321 childWorkflowExecutionTerminatedEventAttributes?: ChildWorkflowExecutionTerminatedEventAttributes;
1322 /**
1323 * If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
1324 */
1325 signalExternalWorkflowExecutionInitiatedEventAttributes?: SignalExternalWorkflowExecutionInitiatedEventAttributes;
1326 /**
1327 * If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.
1328 */
1329 externalWorkflowExecutionSignaledEventAttributes?: ExternalWorkflowExecutionSignaledEventAttributes;
1330 /**
1331 * If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1332 */
1333 signalExternalWorkflowExecutionFailedEventAttributes?: SignalExternalWorkflowExecutionFailedEventAttributes;
1334 /**
1335 * If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
1336 */
1337 externalWorkflowExecutionCancelRequestedEventAttributes?: ExternalWorkflowExecutionCancelRequestedEventAttributes;
1338 /**
1339 * If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
1340 */
1341 requestCancelExternalWorkflowExecutionInitiatedEventAttributes?: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes;
1342 /**
1343 * If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1344 */
1345 requestCancelExternalWorkflowExecutionFailedEventAttributes?: RequestCancelExternalWorkflowExecutionFailedEventAttributes;
1346 /**
1347 * If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1348 */
1349 scheduleActivityTaskFailedEventAttributes?: ScheduleActivityTaskFailedEventAttributes;
1350 /**
1351 * If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1352 */
1353 requestCancelActivityTaskFailedEventAttributes?: RequestCancelActivityTaskFailedEventAttributes;
1354 /**
1355 * If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1356 */
1357 startTimerFailedEventAttributes?: StartTimerFailedEventAttributes;
1358 /**
1359 * If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1360 */
1361 cancelTimerFailedEventAttributes?: CancelTimerFailedEventAttributes;
1362 /**
1363 * If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
1364 */
1365 startChildWorkflowExecutionFailedEventAttributes?: StartChildWorkflowExecutionFailedEventAttributes;
1366 /**
1367 * Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.
1368 */
1369 lambdaFunctionScheduledEventAttributes?: LambdaFunctionScheduledEventAttributes;
1370 /**
1371 * Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.
1372 */
1373 lambdaFunctionStartedEventAttributes?: LambdaFunctionStartedEventAttributes;
1374 /**
1375 * Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.
1376 */
1377 lambdaFunctionCompletedEventAttributes?: LambdaFunctionCompletedEventAttributes;
1378 /**
1379 * Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.
1380 */
1381 lambdaFunctionFailedEventAttributes?: LambdaFunctionFailedEventAttributes;
1382 /**
1383 * Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.
1384 */
1385 lambdaFunctionTimedOutEventAttributes?: LambdaFunctionTimedOutEventAttributes;
1386 /**
1387 * Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.
1388 */
1389 scheduleLambdaFunctionFailedEventAttributes?: ScheduleLambdaFunctionFailedEventAttributes;
1390 /**
1391 * Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.
1392 */
1393 startLambdaFunctionFailedEventAttributes?: StartLambdaFunctionFailedEventAttributes;
1394 }
1395 export type HistoryEventList = HistoryEvent[];
1396 export type Identity = string;
1397 export interface LambdaFunctionCompletedEventAttributes {
1398 /**
1399 * The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1400 */
1401 scheduledEventId: EventId;
1402 /**
1403 * The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1404 */
1405 startedEventId: EventId;
1406 /**
1407 * The results of the Lambda task.
1408 */
1409 result?: Data;
1410 }
1411 export interface LambdaFunctionFailedEventAttributes {
1412 /**
1413 * The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1414 */
1415 scheduledEventId: EventId;
1416 /**
1417 * The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1418 */
1419 startedEventId: EventId;
1420 /**
1421 * The reason provided for the failure.
1422 */
1423 reason?: FailureReason;
1424 /**
1425 * The details of the failure.
1426 */
1427 details?: Data;
1428 }
1429 export interface LambdaFunctionScheduledEventAttributes {
1430 /**
1431 * The unique ID of the Lambda task.
1432 */
1433 id: FunctionId;
1434 /**
1435 * The name of the Lambda function.
1436 */
1437 name: FunctionName;
1438 /**
1439 * Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
1440 */
1441 control?: Data;
1442 /**
1443 * The input provided to the Lambda task.
1444 */
1445 input?: FunctionInput;
1446 /**
1447 * The maximum amount of time a worker can take to process the Lambda task.
1448 */
1449 startToCloseTimeout?: DurationInSecondsOptional;
1450 /**
1451 * The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1452 */
1453 decisionTaskCompletedEventId: EventId;
1454 }
1455 export interface LambdaFunctionStartedEventAttributes {
1456 /**
1457 * The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1458 */
1459 scheduledEventId: EventId;
1460 }
1461 export interface LambdaFunctionTimedOutEventAttributes {
1462 /**
1463 * The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1464 */
1465 scheduledEventId: EventId;
1466 /**
1467 * The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
1468 */
1469 startedEventId: EventId;
1470 /**
1471 * The type of the timeout that caused this event.
1472 */
1473 timeoutType?: LambdaFunctionTimeoutType;
1474 }
1475 export type LambdaFunctionTimeoutType = "START_TO_CLOSE"|string;
1476 export type LimitedData = string;
1477 export interface ListActivityTypesInput {
1478 /**
1479 * The name of the domain in which the activity types have been registered.
1480 */
1481 domain: DomainName;
1482 /**
1483 * If specified, only lists the activity types that have this name.
1484 */
1485 name?: Name;
1486 /**
1487 * Specifies the registration status of the activity types to list.
1488 */
1489 registrationStatus: RegistrationStatus;
1490 /**
1491 * 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.
1492 */
1493 nextPageToken?: PageToken;
1494 /**
1495 * The maximum number of results that are 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.
1496 */
1497 maximumPageSize?: PageSize;
1498 /**
1499 * 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.
1500 */
1501 reverseOrder?: ReverseOrder;
1502 }
1503 export interface ListClosedWorkflowExecutionsInput {
1504 /**
1505 * The name of the domain that contains the workflow executions to list.
1506 */
1507 domain: DomainName;
1508 /**
1509 * 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.
1510 */
1511 startTimeFilter?: ExecutionTimeFilter;
1512 /**
1513 * 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.
1514 */
1515 closeTimeFilter?: ExecutionTimeFilter;
1516 /**
1517 * 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.
1518 */
1519 executionFilter?: WorkflowExecutionFilter;
1520 /**
1521 * 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.
1522 */
1523 closeStatusFilter?: CloseStatusFilter;
1524 /**
1525 * 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.
1526 */
1527 typeFilter?: WorkflowTypeFilter;
1528 /**
1529 * 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.
1530 */
1531 tagFilter?: TagFilter;
1532 /**
1533 * 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.
1534 */
1535 nextPageToken?: PageToken;
1536 /**
1537 * The maximum number of results that are 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.
1538 */
1539 maximumPageSize?: PageSize;
1540 /**
1541 * 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.
1542 */
1543 reverseOrder?: ReverseOrder;
1544 }
1545 export interface ListDomainsInput {
1546 /**
1547 * 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.
1548 */
1549 nextPageToken?: PageToken;
1550 /**
1551 * Specifies the registration status of the domains to list.
1552 */
1553 registrationStatus: RegistrationStatus;
1554 /**
1555 * The maximum number of results that are 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.
1556 */
1557 maximumPageSize?: PageSize;
1558 /**
1559 * 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.
1560 */
1561 reverseOrder?: ReverseOrder;
1562 }
1563 export interface ListOpenWorkflowExecutionsInput {
1564 /**
1565 * The name of the domain that contains the workflow executions to list.
1566 */
1567 domain: DomainName;
1568 /**
1569 * Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
1570 */
1571 startTimeFilter: ExecutionTimeFilter;
1572 /**
1573 * 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.
1574 */
1575 typeFilter?: WorkflowTypeFilter;
1576 /**
1577 * 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.
1578 */
1579 tagFilter?: TagFilter;
1580 /**
1581 * 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.
1582 */
1583 nextPageToken?: PageToken;
1584 /**
1585 * The maximum number of results that are 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.
1586 */
1587 maximumPageSize?: PageSize;
1588 /**
1589 * 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.
1590 */
1591 reverseOrder?: ReverseOrder;
1592 /**
1593 * 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.
1594 */
1595 executionFilter?: WorkflowExecutionFilter;
1596 }
1597 export interface ListWorkflowTypesInput {
1598 /**
1599 * The name of the domain in which the workflow types have been registered.
1600 */
1601 domain: DomainName;
1602 /**
1603 * If specified, lists the workflow type with this name.
1604 */
1605 name?: Name;
1606 /**
1607 * Specifies the registration status of the workflow types to list.
1608 */
1609 registrationStatus: RegistrationStatus;
1610 /**
1611 * 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.
1612 */
1613 nextPageToken?: PageToken;
1614 /**
1615 * The maximum number of results that are 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.
1616 */
1617 maximumPageSize?: PageSize;
1618 /**
1619 * 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.
1620 */
1621 reverseOrder?: ReverseOrder;
1622 }
1623 export type MarkerName = string;
1624 export interface MarkerRecordedEventAttributes {
1625 /**
1626 * The name of the marker.
1627 */
1628 markerName: MarkerName;
1629 /**
1630 * The details of the marker.
1631 */
1632 details?: Data;
1633 /**
1634 * 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.
1635 */
1636 decisionTaskCompletedEventId: EventId;
1637 }
1638 export type Name = string;
1639 export type OpenDecisionTasksCount = number;
1640 export type PageSize = number;
1641 export type PageToken = string;
1642 export interface PendingTaskCount {
1643 /**
1644 * The number of tasks in the task list.
1645 */
1646 count: Count;
1647 /**
1648 * 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.
1649 */
1650 truncated?: Truncated;
1651 }
1652 export interface PollForActivityTaskInput {
1653 /**
1654 * The name of the domain that contains the task lists being polled.
1655 */
1656 domain: DomainName;
1657 /**
1658 * Specifies the task list to poll for activity tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
1659 */
1660 taskList: TaskList;
1661 /**
1662 * 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.
1663 */
1664 identity?: Identity;
1665 }
1666 export interface PollForDecisionTaskInput {
1667 /**
1668 * The name of the domain containing the task lists to poll.
1669 */
1670 domain: DomainName;
1671 /**
1672 * Specifies the task list to poll for decision tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
1673 */
1674 taskList: TaskList;
1675 /**
1676 * 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.
1677 */
1678 identity?: Identity;
1679 /**
1680 * 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 doesn't return a new decision task.
1681 */
1682 nextPageToken?: PageToken;
1683 /**
1684 * The maximum number of results that are 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.
1685 */
1686 maximumPageSize?: PageSize;
1687 /**
1688 * 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.
1689 */
1690 reverseOrder?: ReverseOrder;
1691 }
1692 export interface RecordActivityTaskHeartbeatInput {
1693 /**
1694 * 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.
1695 */
1696 taskToken: TaskToken;
1697 /**
1698 * If specified, contains details about the progress of the task.
1699 */
1700 details?: LimitedData;
1701 }
1702 export interface RecordMarkerDecisionAttributes {
1703 /**
1704 * The name of the marker.
1705 */
1706 markerName: MarkerName;
1707 /**
1708 * The details of the marker.
1709 */
1710 details?: Data;
1711 }
1712 export type RecordMarkerFailedCause = "OPERATION_NOT_PERMITTED"|string;
1713 export interface RecordMarkerFailedEventAttributes {
1714 /**
1715 * The marker's name.
1716 */
1717 markerName: MarkerName;
1718 /**
1719 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
1720 */
1721 cause: RecordMarkerFailedCause;
1722 /**
1723 * 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.
1724 */
1725 decisionTaskCompletedEventId: EventId;
1726 }
1727 export interface RegisterActivityTypeInput {
1728 /**
1729 * The name of the domain in which this activity is to be registered.
1730 */
1731 domain: DomainName;
1732 /**
1733 * The name of the activity type within the domain. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
1734 */
1735 name: Name;
1736 /**
1737 * 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 arn.
1738 */
1739 version: Version;
1740 /**
1741 * A textual description of the activity type.
1742 */
1743 description?: Description;
1744 /**
1745 * If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
1746 */
1747 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
1748 /**
1749 * If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
1750 */
1751 defaultTaskHeartbeatTimeout?: DurationInSecondsOptional;
1752 /**
1753 * If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.
1754 */
1755 defaultTaskList?: TaskList;
1756 /**
1757 * The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..
1758 */
1759 defaultTaskPriority?: TaskPriority;
1760 /**
1761 * If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
1762 */
1763 defaultTaskScheduleToStartTimeout?: DurationInSecondsOptional;
1764 /**
1765 * If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
1766 */
1767 defaultTaskScheduleToCloseTimeout?: DurationInSecondsOptional;
1768 }
1769 export interface RegisterDomainInput {
1770 /**
1771 * 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 arn.
1772 */
1773 name: DomainName;
1774 /**
1775 * A text description of the domain.
1776 */
1777 description?: Description;
1778 /**
1779 * The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls. If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted. The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
1780 */
1781 workflowExecutionRetentionPeriodInDays: DurationInDays;
1782 }
1783 export interface RegisterWorkflowTypeInput {
1784 /**
1785 * The name of the domain in which to register the workflow type.
1786 */
1787 domain: DomainName;
1788 /**
1789 * The name of the workflow type. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
1790 */
1791 name: Name;
1792 /**
1793 * 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 arn.
1794 */
1795 version: Version;
1796 /**
1797 * Textual description of the workflow type.
1798 */
1799 description?: Description;
1800 /**
1801 * If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
1802 */
1803 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
1804 /**
1805 * If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision. The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.
1806 */
1807 defaultExecutionStartToCloseTimeout?: DurationInSecondsOptional;
1808 /**
1809 * If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
1810 */
1811 defaultTaskList?: TaskList;
1812 /**
1813 * The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
1814 */
1815 defaultTaskPriority?: TaskPriority;
1816 /**
1817 * If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
1818 */
1819 defaultChildPolicy?: ChildPolicy;
1820 /**
1821 * The default IAM role attached to this workflow type. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
1822 */
1823 defaultLambdaRole?: Arn;
1824 }
1825 export type RegistrationStatus = "REGISTERED"|"DEPRECATED"|string;
1826 export interface RequestCancelActivityTaskDecisionAttributes {
1827 /**
1828 * The activityId of the activity task to be canceled.
1829 */
1830 activityId: ActivityId;
1831 }
1832 export type RequestCancelActivityTaskFailedCause = "ACTIVITY_ID_UNKNOWN"|"OPERATION_NOT_PERMITTED"|string;
1833 export interface RequestCancelActivityTaskFailedEventAttributes {
1834 /**
1835 * The activityId provided in the RequestCancelActivityTask decision that failed.
1836 */
1837 activityId: ActivityId;
1838 /**
1839 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
1840 */
1841 cause: RequestCancelActivityTaskFailedCause;
1842 /**
1843 * 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.
1844 */
1845 decisionTaskCompletedEventId: EventId;
1846 }
1847 export interface RequestCancelExternalWorkflowExecutionDecisionAttributes {
1848 /**
1849 * The workflowId of the external workflow execution to cancel.
1850 */
1851 workflowId: WorkflowId;
1852 /**
1853 * The runId of the external workflow execution to cancel.
1854 */
1855 runId?: WorkflowRunIdOptional;
1856 /**
1857 * The data attached to the event that can be used by the decider in subsequent workflow tasks.
1858 */
1859 control?: Data;
1860 }
1861 export type RequestCancelExternalWorkflowExecutionFailedCause = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"|"REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
1862 export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes {
1863 /**
1864 * The workflowId of the external workflow to which the cancel request was to be delivered.
1865 */
1866 workflowId: WorkflowId;
1867 /**
1868 * The runId of the external workflow execution.
1869 */
1870 runId?: WorkflowRunIdOptional;
1871 /**
1872 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
1873 */
1874 cause: RequestCancelExternalWorkflowExecutionFailedCause;
1875 /**
1876 * 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.
1877 */
1878 initiatedEventId: EventId;
1879 /**
1880 * 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.
1881 */
1882 decisionTaskCompletedEventId: EventId;
1883 /**
1884 * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
1885 */
1886 control?: Data;
1887 }
1888 export interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributes {
1889 /**
1890 * The workflowId of the external workflow execution to be canceled.
1891 */
1892 workflowId: WorkflowId;
1893 /**
1894 * The runId of the external workflow execution to be canceled.
1895 */
1896 runId?: WorkflowRunIdOptional;
1897 /**
1898 * 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.
1899 */
1900 decisionTaskCompletedEventId: EventId;
1901 /**
1902 * Data attached to the event that can be used by the decider in subsequent workflow tasks.
1903 */
1904 control?: Data;
1905 }
1906 export interface RequestCancelWorkflowExecutionInput {
1907 /**
1908 * The name of the domain containing the workflow execution to cancel.
1909 */
1910 domain: DomainName;
1911 /**
1912 * The workflowId of the workflow execution to cancel.
1913 */
1914 workflowId: WorkflowId;
1915 /**
1916 * The runId of the workflow execution to cancel.
1917 */
1918 runId?: WorkflowRunIdOptional;
1919 }
1920 export interface RespondActivityTaskCanceledInput {
1921 /**
1922 * 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.
1923 */
1924 taskToken: TaskToken;
1925 /**
1926 * Information about the cancellation.
1927 */
1928 details?: Data;
1929 }
1930 export interface RespondActivityTaskCompletedInput {
1931 /**
1932 * 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.
1933 */
1934 taskToken: TaskToken;
1935 /**
1936 * The result of the activity task. It is a free form string that is implementation specific.
1937 */
1938 result?: Data;
1939 }
1940 export interface RespondActivityTaskFailedInput {
1941 /**
1942 * 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.
1943 */
1944 taskToken: TaskToken;
1945 /**
1946 * Description of the error that may assist in diagnostics.
1947 */
1948 reason?: FailureReason;
1949 /**
1950 * Detailed information about the failure.
1951 */
1952 details?: Data;
1953 }
1954 export interface RespondDecisionTaskCompletedInput {
1955 /**
1956 * 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.
1957 */
1958 taskToken: TaskToken;
1959 /**
1960 * The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.
1961 */
1962 decisions?: DecisionList;
1963 /**
1964 * User defined context to add to workflow execution.
1965 */
1966 executionContext?: Data;
1967 }
1968 export type ReverseOrder = boolean;
1969 export interface Run {
1970 /**
1971 * 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.
1972 */
1973 runId?: WorkflowRunId;
1974 }
1975 export interface ScheduleActivityTaskDecisionAttributes {
1976 /**
1977 * The type of the activity task to schedule.
1978 */
1979 activityType: ActivityType;
1980 /**
1981 * 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 arn.
1982 */
1983 activityId: ActivityId;
1984 /**
1985 * Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
1986 */
1987 control?: Data;
1988 /**
1989 * The input provided to the activity task.
1990 */
1991 input?: Data;
1992 /**
1993 * The maximum duration for this activity task. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
1994 */
1995 scheduleToCloseTimeout?: DurationInSecondsOptional;
1996 /**
1997 * If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used. A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
1998 */
1999 taskList?: TaskList;
2000 /**
2001 * If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
2002 */
2003 taskPriority?: TaskPriority;
2004 /**
2005 * If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
2006 */
2007 scheduleToStartTimeout?: DurationInSecondsOptional;
2008 /**
2009 * If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
2010 */
2011 startToCloseTimeout?: DurationInSecondsOptional;
2012 /**
2013 * If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2014 */
2015 heartbeatTimeout?: DurationInSecondsOptional;
2016 }
2017 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;
2018 export interface ScheduleActivityTaskFailedEventAttributes {
2019 /**
2020 * The activity type provided in the ScheduleActivityTask decision that failed.
2021 */
2022 activityType: ActivityType;
2023 /**
2024 * The activityId provided in the ScheduleActivityTask decision that failed.
2025 */
2026 activityId: ActivityId;
2027 /**
2028 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
2029 */
2030 cause: ScheduleActivityTaskFailedCause;
2031 /**
2032 * 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.
2033 */
2034 decisionTaskCompletedEventId: EventId;
2035 }
2036 export interface ScheduleLambdaFunctionDecisionAttributes {
2037 /**
2038 * A string that identifies the Lambda function execution in the event history.
2039 */
2040 id: FunctionId;
2041 /**
2042 * The name, or ARN, of the Lambda function to schedule.
2043 */
2044 name: FunctionName;
2045 /**
2046 * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
2047 */
2048 control?: Data;
2049 /**
2050 * The optional input data to be supplied to the Lambda function.
2051 */
2052 input?: FunctionInput;
2053 /**
2054 * The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.
2055 */
2056 startToCloseTimeout?: DurationInSecondsOptional;
2057 }
2058 export type ScheduleLambdaFunctionFailedCause = "ID_ALREADY_IN_USE"|"OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED"|"LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED"|"LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"|string;
2059 export interface ScheduleLambdaFunctionFailedEventAttributes {
2060 /**
2061 * The ID provided in the ScheduleLambdaFunction decision that failed.
2062 */
2063 id: FunctionId;
2064 /**
2065 * The name of the Lambda function.
2066 */
2067 name: FunctionName;
2068 /**
2069 * The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
2070 */
2071 cause: ScheduleLambdaFunctionFailedCause;
2072 /**
2073 * The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
2074 */
2075 decisionTaskCompletedEventId: EventId;
2076 }
2077 export interface SignalExternalWorkflowExecutionDecisionAttributes {
2078 /**
2079 * The workflowId of the workflow execution to be signaled.
2080 */
2081 workflowId: WorkflowId;
2082 /**
2083 * The runId of the workflow execution to be signaled.
2084 */
2085 runId?: WorkflowRunIdOptional;
2086 /**
2087 * The name of the signal.The target workflow execution uses the signal name and input to process the signal.
2088 */
2089 signalName: SignalName;
2090 /**
2091 * The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.
2092 */
2093 input?: Data;
2094 /**
2095 * The data attached to the event that can be used by the decider in subsequent decision tasks.
2096 */
2097 control?: Data;
2098 }
2099 export type SignalExternalWorkflowExecutionFailedCause = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"|"SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
2100 export interface SignalExternalWorkflowExecutionFailedEventAttributes {
2101 /**
2102 * The workflowId of the external workflow execution that the signal was being delivered to.
2103 */
2104 workflowId: WorkflowId;
2105 /**
2106 * The runId of the external workflow execution that the signal was being delivered to.
2107 */
2108 runId?: WorkflowRunIdOptional;
2109 /**
2110 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
2111 */
2112 cause: SignalExternalWorkflowExecutionFailedCause;
2113 /**
2114 * 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.
2115 */
2116 initiatedEventId: EventId;
2117 /**
2118 * 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.
2119 */
2120 decisionTaskCompletedEventId: EventId;
2121 /**
2122 * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
2123 */
2124 control?: Data;
2125 }
2126 export interface SignalExternalWorkflowExecutionInitiatedEventAttributes {
2127 /**
2128 * The workflowId of the external workflow execution.
2129 */
2130 workflowId: WorkflowId;
2131 /**
2132 * The runId of the external workflow execution to send the signal to.
2133 */
2134 runId?: WorkflowRunIdOptional;
2135 /**
2136 * The name of the signal.
2137 */
2138 signalName: SignalName;
2139 /**
2140 * The input provided to the signal.
2141 */
2142 input?: Data;
2143 /**
2144 * 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.
2145 */
2146 decisionTaskCompletedEventId: EventId;
2147 /**
2148 * Data attached to the event that can be used by the decider in subsequent decision tasks.
2149 */
2150 control?: Data;
2151 }
2152 export type SignalName = string;
2153 export interface SignalWorkflowExecutionInput {
2154 /**
2155 * The name of the domain containing the workflow execution to signal.
2156 */
2157 domain: DomainName;
2158 /**
2159 * The workflowId of the workflow execution to signal.
2160 */
2161 workflowId: WorkflowId;
2162 /**
2163 * The runId of the workflow execution to signal.
2164 */
2165 runId?: WorkflowRunIdOptional;
2166 /**
2167 * The name of the signal. This name must be meaningful to the target workflow.
2168 */
2169 signalName: SignalName;
2170 /**
2171 * Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
2172 */
2173 input?: Data;
2174 }
2175 export interface StartChildWorkflowExecutionDecisionAttributes {
2176 /**
2177 * The type of the workflow execution to be started.
2178 */
2179 workflowType: WorkflowType;
2180 /**
2181 * 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 arn.
2182 */
2183 workflowId: WorkflowId;
2184 /**
2185 * The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.
2186 */
2187 control?: Data;
2188 /**
2189 * The input to be provided to the workflow execution.
2190 */
2191 input?: Data;
2192 /**
2193 * The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
2194 */
2195 executionStartToCloseTimeout?: DurationInSecondsOptional;
2196 /**
2197 * The name of the task list to be used for decision tasks of the child workflow execution. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
2198 */
2199 taskList?: TaskList;
2200 /**
2201 * A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
2202 */
2203 taskPriority?: TaskPriority;
2204 /**
2205 * Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
2206 */
2207 taskStartToCloseTimeout?: DurationInSecondsOptional;
2208 /**
2209 * If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
2210 */
2211 childPolicy?: ChildPolicy;
2212 /**
2213 * 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.
2214 */
2215 tagList?: TagList;
2216 /**
2217 * The IAM role attached to the child workflow execution.
2218 */
2219 lambdaRole?: Arn;
2220 }
2221 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;
2222 export interface StartChildWorkflowExecutionFailedEventAttributes {
2223 /**
2224 * The workflow type provided in the StartChildWorkflowExecution Decision that failed.
2225 */
2226 workflowType: WorkflowType;
2227 /**
2228 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
2229 */
2230 cause: StartChildWorkflowExecutionFailedCause;
2231 /**
2232 * The workflowId of the child workflow execution.
2233 */
2234 workflowId: WorkflowId;
2235 /**
2236 * When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event. When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
2237 */
2238 initiatedEventId: EventId;
2239 /**
2240 * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.
2241 */
2242 decisionTaskCompletedEventId: EventId;
2243 /**
2244 * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.
2245 */
2246 control?: Data;
2247 }
2248 export interface StartChildWorkflowExecutionInitiatedEventAttributes {
2249 /**
2250 * The workflowId of the child workflow execution.
2251 */
2252 workflowId: WorkflowId;
2253 /**
2254 * The type of the child workflow execution.
2255 */
2256 workflowType: WorkflowType;
2257 /**
2258 * Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.
2259 */
2260 control?: Data;
2261 /**
2262 * The inputs provided to the child workflow execution.
2263 */
2264 input?: Data;
2265 /**
2266 * The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2267 */
2268 executionStartToCloseTimeout?: DurationInSecondsOptional;
2269 /**
2270 * The name of the task list used for the decision tasks of the child workflow execution.
2271 */
2272 taskList: TaskList;
2273 /**
2274 * The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
2275 */
2276 taskPriority?: TaskPriority;
2277 /**
2278 * 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.
2279 */
2280 decisionTaskCompletedEventId: EventId;
2281 /**
2282 * The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2283 */
2284 childPolicy: ChildPolicy;
2285 /**
2286 * The maximum duration allowed for the decision tasks for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2287 */
2288 taskStartToCloseTimeout?: DurationInSecondsOptional;
2289 /**
2290 * The list of tags to associated with the child workflow execution.
2291 */
2292 tagList?: TagList;
2293 /**
2294 * The IAM role to attach to the child workflow execution.
2295 */
2296 lambdaRole?: Arn;
2297 }
2298 export type StartLambdaFunctionFailedCause = "ASSUME_ROLE_FAILED"|string;
2299 export interface StartLambdaFunctionFailedEventAttributes {
2300 /**
2301 * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
2302 */
2303 scheduledEventId?: EventId;
2304 /**
2305 * The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.
2306 */
2307 cause?: StartLambdaFunctionFailedCause;
2308 /**
2309 * A description that can help diagnose the cause of the fault.
2310 */
2311 message?: CauseMessage;
2312 }
2313 export interface StartTimerDecisionAttributes {
2314 /**
2315 * 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 arn.
2316 */
2317 timerId: TimerId;
2318 /**
2319 * The data attached to the event that can be used by the decider in subsequent workflow tasks.
2320 */
2321 control?: Data;
2322 /**
2323 * The duration to wait before firing the timer. The duration is specified in seconds, an integer greater than or equal to 0.
2324 */
2325 startToFireTimeout: DurationInSeconds;
2326 }
2327 export type StartTimerFailedCause = "TIMER_ID_ALREADY_IN_USE"|"OPEN_TIMERS_LIMIT_EXCEEDED"|"TIMER_CREATION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string;
2328 export interface StartTimerFailedEventAttributes {
2329 /**
2330 * The timerId provided in the StartTimer decision that failed.
2331 */
2332 timerId: TimerId;
2333 /**
2334 * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
2335 */
2336 cause: StartTimerFailedCause;
2337 /**
2338 * 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.
2339 */
2340 decisionTaskCompletedEventId: EventId;
2341 }
2342 export interface StartWorkflowExecutionInput {
2343 /**
2344 * The name of the domain in which the workflow execution is created.
2345 */
2346 domain: DomainName;
2347 /**
2348 * The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
2349 */
2350 workflowId: WorkflowId;
2351 /**
2352 * The type of the workflow to start.
2353 */
2354 workflowType: WorkflowType;
2355 /**
2356 * The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.
2357 */
2358 taskList?: TaskList;
2359 /**
2360 * The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
2361 */
2362 taskPriority?: TaskPriority;
2363 /**
2364 * 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.
2365 */
2366 input?: Data;
2367 /**
2368 * The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run. An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
2369 */
2370 executionStartToCloseTimeout?: DurationInSecondsOptional;
2371 /**
2372 * 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.
2373 */
2374 tagList?: TagList;
2375 /**
2376 * Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
2377 */
2378 taskStartToCloseTimeout?: DurationInSecondsOptional;
2379 /**
2380 * If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
2381 */
2382 childPolicy?: ChildPolicy;
2383 /**
2384 * The IAM role to attach to this workflow execution. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
2385 */
2386 lambdaRole?: Arn;
2387 }
2388 export type Tag = string;
2389 export interface TagFilter {
2390 /**
2391 * Specifies the tag that must be associated with the execution for it to meet the filter criteria.
2392 */
2393 tag: Tag;
2394 }
2395 export type TagList = Tag[];
2396 export interface TaskList {
2397 /**
2398 * The name of the task list.
2399 */
2400 name: Name;
2401 }
2402 export type TaskPriority = string;
2403 export type TaskToken = string;
2404 export type TerminateReason = string;
2405 export interface TerminateWorkflowExecutionInput {
2406 /**
2407 * The domain of the workflow execution to terminate.
2408 */
2409 domain: DomainName;
2410 /**
2411 * The workflowId of the workflow execution to terminate.
2412 */
2413 workflowId: WorkflowId;
2414 /**
2415 * The runId of the workflow execution to terminate.
2416 */
2417 runId?: WorkflowRunIdOptional;
2418 /**
2419 * A descriptive reason for terminating the workflow execution.
2420 */
2421 reason?: TerminateReason;
2422 /**
2423 * Details for terminating the workflow execution.
2424 */
2425 details?: Data;
2426 /**
2427 * If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
2428 */
2429 childPolicy?: ChildPolicy;
2430 }
2431 export interface TimerCanceledEventAttributes {
2432 /**
2433 * The unique ID of the timer that was canceled.
2434 */
2435 timerId: TimerId;
2436 /**
2437 * 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.
2438 */
2439 startedEventId: EventId;
2440 /**
2441 * 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.
2442 */
2443 decisionTaskCompletedEventId: EventId;
2444 }
2445 export interface TimerFiredEventAttributes {
2446 /**
2447 * The unique ID of the timer that fired.
2448 */
2449 timerId: TimerId;
2450 /**
2451 * 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.
2452 */
2453 startedEventId: EventId;
2454 }
2455 export type TimerId = string;
2456 export interface TimerStartedEventAttributes {
2457 /**
2458 * The unique ID of the timer that was started.
2459 */
2460 timerId: TimerId;
2461 /**
2462 * Data attached to the event that can be used by the decider in subsequent workflow tasks.
2463 */
2464 control?: Data;
2465 /**
2466 * The duration of time after which the timer fires. The duration is specified in seconds, an integer greater than or equal to 0.
2467 */
2468 startToFireTimeout: DurationInSeconds;
2469 /**
2470 * 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.
2471 */
2472 decisionTaskCompletedEventId: EventId;
2473 }
2474 export type Timestamp = Date;
2475 export type Truncated = boolean;
2476 export type Version = string;
2477 export type VersionOptional = string;
2478 export interface WorkflowExecution {
2479 /**
2480 * The user defined identifier associated with the workflow execution.
2481 */
2482 workflowId: WorkflowId;
2483 /**
2484 * A system-generated unique identifier for the workflow execution.
2485 */
2486 runId: WorkflowRunId;
2487 }
2488 export type WorkflowExecutionCancelRequestedCause = "CHILD_POLICY_APPLIED"|string;
2489 export interface WorkflowExecutionCancelRequestedEventAttributes {
2490 /**
2491 * The external workflow execution for which the cancellation was requested.
2492 */
2493 externalWorkflowExecution?: WorkflowExecution;
2494 /**
2495 * 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.
2496 */
2497 externalInitiatedEventId?: EventId;
2498 /**
2499 * 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.
2500 */
2501 cause?: WorkflowExecutionCancelRequestedCause;
2502 }
2503 export interface WorkflowExecutionCanceledEventAttributes {
2504 /**
2505 * The details of the cancellation.
2506 */
2507 details?: Data;
2508 /**
2509 * 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.
2510 */
2511 decisionTaskCompletedEventId: EventId;
2512 }
2513 export interface WorkflowExecutionCompletedEventAttributes {
2514 /**
2515 * The result produced by the workflow execution upon successful completion.
2516 */
2517 result?: Data;
2518 /**
2519 * 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.
2520 */
2521 decisionTaskCompletedEventId: EventId;
2522 }
2523 export interface WorkflowExecutionConfiguration {
2524 /**
2525 * The maximum duration allowed for decision tasks for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2526 */
2527 taskStartToCloseTimeout: DurationInSeconds;
2528 /**
2529 * The total duration for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2530 */
2531 executionStartToCloseTimeout: DurationInSeconds;
2532 /**
2533 * The task list used for the decision tasks generated for this workflow execution.
2534 */
2535 taskList: TaskList;
2536 /**
2537 * The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
2538 */
2539 taskPriority?: TaskPriority;
2540 /**
2541 * The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2542 */
2543 childPolicy: ChildPolicy;
2544 /**
2545 * The IAM role attached to the child workflow execution.
2546 */
2547 lambdaRole?: Arn;
2548 }
2549 export interface WorkflowExecutionContinuedAsNewEventAttributes {
2550 /**
2551 * The input provided to the new workflow execution.
2552 */
2553 input?: Data;
2554 /**
2555 * 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.
2556 */
2557 decisionTaskCompletedEventId: EventId;
2558 /**
2559 * The runId of the new workflow execution.
2560 */
2561 newExecutionRunId: WorkflowRunId;
2562 /**
2563 * The total duration allowed for the new workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2564 */
2565 executionStartToCloseTimeout?: DurationInSecondsOptional;
2566 /**
2567 * The task list to use for the decisions of the new (continued) workflow execution.
2568 */
2569 taskList: TaskList;
2570 /**
2571 * The priority of the task to use for the decisions of the new (continued) workflow execution.
2572 */
2573 taskPriority?: TaskPriority;
2574 /**
2575 * The maximum duration of decision tasks for the new workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2576 */
2577 taskStartToCloseTimeout?: DurationInSecondsOptional;
2578 /**
2579 * The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2580 */
2581 childPolicy: ChildPolicy;
2582 /**
2583 * The list of tags associated with the new workflow execution.
2584 */
2585 tagList?: TagList;
2586 /**
2587 * The workflow type of this execution.
2588 */
2589 workflowType: WorkflowType;
2590 /**
2591 * The IAM role to attach to the new (continued) workflow execution.
2592 */
2593 lambdaRole?: Arn;
2594 }
2595 export interface WorkflowExecutionCount {
2596 /**
2597 * The number of workflow executions.
2598 */
2599 count: Count;
2600 /**
2601 * 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.
2602 */
2603 truncated?: Truncated;
2604 }
2605 export interface WorkflowExecutionDetail {
2606 /**
2607 * Information about the workflow execution.
2608 */
2609 executionInfo: WorkflowExecutionInfo;
2610 /**
2611 * The configuration settings for this workflow execution including timeout values, tasklist etc.
2612 */
2613 executionConfiguration: WorkflowExecutionConfiguration;
2614 /**
2615 * The number of tasks for this workflow execution. This includes open and closed tasks of all types.
2616 */
2617 openCounts: WorkflowExecutionOpenCounts;
2618 /**
2619 * 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.
2620 */
2621 latestActivityTaskTimestamp?: Timestamp;
2622 /**
2623 * 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.
2624 */
2625 latestExecutionContext?: Data;
2626 }
2627 export interface WorkflowExecutionFailedEventAttributes {
2628 /**
2629 * The descriptive reason provided for the failure.
2630 */
2631 reason?: FailureReason;
2632 /**
2633 * The details of the failure.
2634 */
2635 details?: Data;
2636 /**
2637 * 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.
2638 */
2639 decisionTaskCompletedEventId: EventId;
2640 }
2641 export interface WorkflowExecutionFilter {
2642 /**
2643 * The workflowId to pass of match the criteria of this filter.
2644 */
2645 workflowId: WorkflowId;
2646 }
2647 export interface WorkflowExecutionInfo {
2648 /**
2649 * The workflow execution this information is about.
2650 */
2651 execution: WorkflowExecution;
2652 /**
2653 * The type of the workflow execution.
2654 */
2655 workflowType: WorkflowType;
2656 /**
2657 * The time when the execution was started.
2658 */
2659 startTimestamp: Timestamp;
2660 /**
2661 * The time when the workflow execution was closed. Set only if the execution status is CLOSED.
2662 */
2663 closeTimestamp?: Timestamp;
2664 /**
2665 * The current status of the execution.
2666 */
2667 executionStatus: ExecutionStatus;
2668 /**
2669 * 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.
2670 */
2671 closeStatus?: CloseStatus;
2672 /**
2673 * If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
2674 */
2675 parent?: WorkflowExecution;
2676 /**
2677 * 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.
2678 */
2679 tagList?: TagList;
2680 /**
2681 * Set to true if a cancellation is requested for this workflow execution.
2682 */
2683 cancelRequested?: Canceled;
2684 }
2685 export type WorkflowExecutionInfoList = WorkflowExecutionInfo[];
2686 export interface WorkflowExecutionInfos {
2687 /**
2688 * The list of workflow information structures.
2689 */
2690 executionInfos: WorkflowExecutionInfoList;
2691 /**
2692 * 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.
2693 */
2694 nextPageToken?: PageToken;
2695 }
2696 export interface WorkflowExecutionOpenCounts {
2697 /**
2698 * The count of activity tasks whose status is OPEN.
2699 */
2700 openActivityTasks: Count;
2701 /**
2702 * The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
2703 */
2704 openDecisionTasks: OpenDecisionTasksCount;
2705 /**
2706 * The count of timers started by this workflow execution that have not fired yet.
2707 */
2708 openTimers: Count;
2709 /**
2710 * The count of child workflow executions whose status is OPEN.
2711 */
2712 openChildWorkflowExecutions: Count;
2713 /**
2714 * The count of Lambda tasks whose status is OPEN.
2715 */
2716 openLambdaFunctions?: Count;
2717 }
2718 export interface WorkflowExecutionSignaledEventAttributes {
2719 /**
2720 * The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
2721 */
2722 signalName: SignalName;
2723 /**
2724 * The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.
2725 */
2726 input?: Data;
2727 /**
2728 * The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
2729 */
2730 externalWorkflowExecution?: WorkflowExecution;
2731 /**
2732 * 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.
2733 */
2734 externalInitiatedEventId?: EventId;
2735 }
2736 export interface WorkflowExecutionStartedEventAttributes {
2737 /**
2738 * The input provided to the workflow execution.
2739 */
2740 input?: Data;
2741 /**
2742 * The maximum duration for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2743 */
2744 executionStartToCloseTimeout?: DurationInSecondsOptional;
2745 /**
2746 * The maximum duration of decision tasks for this workflow type. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2747 */
2748 taskStartToCloseTimeout?: DurationInSecondsOptional;
2749 /**
2750 * The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2751 */
2752 childPolicy: ChildPolicy;
2753 /**
2754 * The name of the task list for scheduling the decision tasks for this workflow execution.
2755 */
2756 taskList: TaskList;
2757 /**
2758 * The priority of the decision tasks in the workflow execution.
2759 */
2760 taskPriority?: TaskPriority;
2761 /**
2762 * The workflow type of this execution.
2763 */
2764 workflowType: WorkflowType;
2765 /**
2766 * The list of tags associated with this workflow execution. An execution can have up to 5 tags.
2767 */
2768 tagList?: TagList;
2769 /**
2770 * 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.
2771 */
2772 continuedExecutionRunId?: WorkflowRunIdOptional;
2773 /**
2774 * The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.
2775 */
2776 parentWorkflowExecution?: WorkflowExecution;
2777 /**
2778 * 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.
2779 */
2780 parentInitiatedEventId?: EventId;
2781 /**
2782 * The IAM role attached to the workflow execution.
2783 */
2784 lambdaRole?: Arn;
2785 }
2786 export type WorkflowExecutionTerminatedCause = "CHILD_POLICY_APPLIED"|"EVENT_LIMIT_EXCEEDED"|"OPERATOR_INITIATED"|string;
2787 export interface WorkflowExecutionTerminatedEventAttributes {
2788 /**
2789 * The reason provided for the termination.
2790 */
2791 reason?: TerminateReason;
2792 /**
2793 * The details provided for the termination.
2794 */
2795 details?: Data;
2796 /**
2797 * The policy used for the child workflow executions of this workflow execution. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2798 */
2799 childPolicy: ChildPolicy;
2800 /**
2801 * 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.
2802 */
2803 cause?: WorkflowExecutionTerminatedCause;
2804 }
2805 export interface WorkflowExecutionTimedOutEventAttributes {
2806 /**
2807 * The type of timeout that caused this event.
2808 */
2809 timeoutType: WorkflowExecutionTimeoutType;
2810 /**
2811 * The policy used for the child workflow executions of this workflow execution. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2812 */
2813 childPolicy: ChildPolicy;
2814 }
2815 export type WorkflowExecutionTimeoutType = "START_TO_CLOSE"|string;
2816 export type WorkflowId = string;
2817 export type WorkflowRunId = string;
2818 export type WorkflowRunIdOptional = string;
2819 export interface WorkflowType {
2820 /**
2821 * The name of the workflow type. The combination of workflow type name and version must be unique with in a domain.
2822 */
2823 name: Name;
2824 /**
2825 * The version of the workflow type. The combination of workflow type name and version must be unique with in a domain.
2826 */
2827 version: Version;
2828 }
2829 export interface WorkflowTypeConfiguration {
2830 /**
2831 * The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2832 */
2833 defaultTaskStartToCloseTimeout?: DurationInSecondsOptional;
2834 /**
2835 * The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
2836 */
2837 defaultExecutionStartToCloseTimeout?: DurationInSecondsOptional;
2838 /**
2839 * 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.
2840 */
2841 defaultTaskList?: TaskList;
2842 /**
2843 * The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
2844 */
2845 defaultTaskPriority?: TaskPriority;
2846 /**
2847 * The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run.
2848 */
2849 defaultChildPolicy?: ChildPolicy;
2850 /**
2851 * The default IAM role attached to this workflow type. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
2852 */
2853 defaultLambdaRole?: Arn;
2854 }
2855 export interface WorkflowTypeDetail {
2856 /**
2857 * 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.
2858 */
2859 typeInfo: WorkflowTypeInfo;
2860 /**
2861 * Configuration settings of the workflow type registered through RegisterWorkflowType
2862 */
2863 configuration: WorkflowTypeConfiguration;
2864 }
2865 export interface WorkflowTypeFilter {
2866 /**
2867 * Name of the workflow type.
2868 */
2869 name: Name;
2870 /**
2871 * Version of the workflow type.
2872 */
2873 version?: VersionOptional;
2874 }
2875 export interface WorkflowTypeInfo {
2876 /**
2877 * The workflow type this information is about.
2878 */
2879 workflowType: WorkflowType;
2880 /**
2881 * The current status of the workflow type.
2882 */
2883 status: RegistrationStatus;
2884 /**
2885 * The description of the type registered through RegisterWorkflowType.
2886 */
2887 description?: Description;
2888 /**
2889 * The date when this type was registered.
2890 */
2891 creationDate: Timestamp;
2892 /**
2893 * If the type is in deprecated state, then it is set to the date when the type was deprecated.
2894 */
2895 deprecationDate?: Timestamp;
2896 }
2897 export type WorkflowTypeInfoList = WorkflowTypeInfo[];
2898 export interface WorkflowTypeInfos {
2899 /**
2900 * The list of workflow type information.
2901 */
2902 typeInfos: WorkflowTypeInfoList;
2903 /**
2904 * 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.
2905 */
2906 nextPageToken?: PageToken;
2907 }
2908 /**
2909 * 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.
2910 */
2911 export type apiVersion = "2012-01-25"|"latest"|string;
2912 export interface ClientApiVersions {
2913 /**
2914 * 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.
2915 */
2916 apiVersion?: apiVersion;
2917 }
2918 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2919 /**
2920 * Contains interfaces for use with the SWF client.
2921 */
2922 export import Types = SWF;
2923}
2924export = SWF;