UNPKG

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