@aws-sdk/client-swf 3.315.0 → 3.316.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,1551 +37,248 @@ import { UndeprecateDomainCommandInput, UndeprecateDomainCommandOutput } from ".
37
37
  import { UndeprecateWorkflowTypeCommandInput, UndeprecateWorkflowTypeCommandOutput } from "./commands/UndeprecateWorkflowTypeCommand";
38
38
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
39
39
  import { SWFClient } from "./SWFClient";
40
- /**
41
- * @public
42
- * <fullname>Amazon Simple Workflow Service</fullname>
43
- *
44
- * <p>The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to
45
- * coordinate work across distributed components. In Amazon SWF, a <i>task</i>
46
- * represents a logical unit of work that is performed by a component of your workflow.
47
- * Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and
48
- * concurrency in accordance with the logical flow of the application.</p>
49
- *
50
- * <p>Amazon SWF gives you full control over implementing tasks and coordinating them without
51
- * worrying about underlying complexities such as tracking their progress and maintaining their
52
- * state.</p>
53
- *
54
- * <p>This documentation serves as reference only. For a broader overview of the Amazon SWF
55
- * programming model, see the <i>
56
- * <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/">Amazon SWF Developer Guide</a>
57
- * </i>.</p>
58
- */
59
- export declare class SWF extends SWFClient {
40
+ export interface SWF {
60
41
  /**
61
- * @public
62
- * <p>Returns the number of closed workflow executions within the given domain that meet the
63
- * specified filtering criteria.</p>
64
- * <note>
65
- * <p>This operation is eventually consistent. The results are best effort and may not
66
- * exactly reflect recent updates and changes.</p>
67
- * </note>
68
- * <p>
69
- * <b>Access Control</b>
70
- * </p>
71
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
72
- * follows:</p>
73
- * <ul>
74
- * <li>
75
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
76
- * only specified domains.</p>
77
- * </li>
78
- * <li>
79
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
80
- * action.</p>
81
- * </li>
82
- * <li>
83
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
84
- * the appropriate keys.</p>
85
- * <ul>
86
- * <li>
87
- * <p>
88
- * <code>tagFilter.tag</code>: String constraint. The key is
89
- * <code>swf:tagFilter.tag</code>.</p>
90
- * </li>
91
- * <li>
92
- * <p>
93
- * <code>typeFilter.name</code>: String constraint. The key is
94
- * <code>swf:typeFilter.name</code>.</p>
95
- * </li>
96
- * <li>
97
- * <p>
98
- * <code>typeFilter.version</code>: String constraint. The key is
99
- * <code>swf:typeFilter.version</code>.</p>
100
- * </li>
101
- * </ul>
102
- * </li>
103
- * </ul>
104
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
105
- * parameter values fall outside the specified constraints, the action fails. The associated
106
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
107
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
108
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
42
+ * @see {@link CountClosedWorkflowExecutionsCommand}
109
43
  */
110
44
  countClosedWorkflowExecutions(args: CountClosedWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<CountClosedWorkflowExecutionsCommandOutput>;
111
45
  countClosedWorkflowExecutions(args: CountClosedWorkflowExecutionsCommandInput, cb: (err: any, data?: CountClosedWorkflowExecutionsCommandOutput) => void): void;
112
46
  countClosedWorkflowExecutions(args: CountClosedWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountClosedWorkflowExecutionsCommandOutput) => void): void;
113
47
  /**
114
- * @public
115
- * <p>Returns the number of open workflow executions within the given domain that meet the
116
- * specified filtering criteria.</p>
117
- * <note>
118
- * <p>This operation is eventually consistent. The results are best effort and may not
119
- * exactly reflect recent updates and changes.</p>
120
- * </note>
121
- * <p>
122
- * <b>Access Control</b>
123
- * </p>
124
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
125
- * follows:</p>
126
- * <ul>
127
- * <li>
128
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
129
- * only specified domains.</p>
130
- * </li>
131
- * <li>
132
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
133
- * action.</p>
134
- * </li>
135
- * <li>
136
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
137
- * the appropriate keys.</p>
138
- * <ul>
139
- * <li>
140
- * <p>
141
- * <code>tagFilter.tag</code>: String constraint. The key is
142
- * <code>swf:tagFilter.tag</code>.</p>
143
- * </li>
144
- * <li>
145
- * <p>
146
- * <code>typeFilter.name</code>: String constraint. The key is
147
- * <code>swf:typeFilter.name</code>.</p>
148
- * </li>
149
- * <li>
150
- * <p>
151
- * <code>typeFilter.version</code>: String constraint. The key is
152
- * <code>swf:typeFilter.version</code>.</p>
153
- * </li>
154
- * </ul>
155
- * </li>
156
- * </ul>
157
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
158
- * parameter values fall outside the specified constraints, the action fails. The associated
159
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
160
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
161
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
48
+ * @see {@link CountOpenWorkflowExecutionsCommand}
162
49
  */
163
50
  countOpenWorkflowExecutions(args: CountOpenWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<CountOpenWorkflowExecutionsCommandOutput>;
164
51
  countOpenWorkflowExecutions(args: CountOpenWorkflowExecutionsCommandInput, cb: (err: any, data?: CountOpenWorkflowExecutionsCommandOutput) => void): void;
165
52
  countOpenWorkflowExecutions(args: CountOpenWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountOpenWorkflowExecutionsCommandOutput) => void): void;
166
53
  /**
167
- * @public
168
- * <p>Returns the estimated number of activity tasks in the specified task list. The count
169
- * returned is an approximation and isn't guaranteed to be exact. If you specify a task list that
170
- * no activity task was ever scheduled in then <code>0</code> is returned.</p>
171
- * <p>
172
- * <b>Access Control</b>
173
- * </p>
174
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
175
- * follows:</p>
176
- * <ul>
177
- * <li>
178
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
179
- * only specified domains.</p>
180
- * </li>
181
- * <li>
182
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
183
- * action.</p>
184
- * </li>
185
- * <li>
186
- * <p>Constrain the <code>taskList.name</code> parameter by using a
187
- * <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the
188
- * action to access only certain task lists.</p>
189
- * </li>
190
- * </ul>
191
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
192
- * parameter values fall outside the specified constraints, the action fails. The associated
193
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
194
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
195
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
54
+ * @see {@link CountPendingActivityTasksCommand}
196
55
  */
197
56
  countPendingActivityTasks(args: CountPendingActivityTasksCommandInput, options?: __HttpHandlerOptions): Promise<CountPendingActivityTasksCommandOutput>;
198
57
  countPendingActivityTasks(args: CountPendingActivityTasksCommandInput, cb: (err: any, data?: CountPendingActivityTasksCommandOutput) => void): void;
199
58
  countPendingActivityTasks(args: CountPendingActivityTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountPendingActivityTasksCommandOutput) => void): void;
200
59
  /**
201
- * @public
202
- * <p>Returns the estimated number of decision tasks in the specified task list. The count
203
- * returned is an approximation and isn't guaranteed to be exact. If you specify a task list that
204
- * no decision task was ever scheduled in then <code>0</code> is returned.</p>
205
- * <p>
206
- * <b>Access Control</b>
207
- * </p>
208
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
209
- * follows:</p>
210
- * <ul>
211
- * <li>
212
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
213
- * only specified domains.</p>
214
- * </li>
215
- * <li>
216
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
217
- * action.</p>
218
- * </li>
219
- * <li>
220
- * <p>Constrain the <code>taskList.name</code> parameter by using a
221
- * <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the
222
- * action to access only certain task lists.</p>
223
- * </li>
224
- * </ul>
225
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
226
- * parameter values fall outside the specified constraints, the action fails. The associated
227
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
228
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
229
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
60
+ * @see {@link CountPendingDecisionTasksCommand}
230
61
  */
231
62
  countPendingDecisionTasks(args: CountPendingDecisionTasksCommandInput, options?: __HttpHandlerOptions): Promise<CountPendingDecisionTasksCommandOutput>;
232
63
  countPendingDecisionTasks(args: CountPendingDecisionTasksCommandInput, cb: (err: any, data?: CountPendingDecisionTasksCommandOutput) => void): void;
233
64
  countPendingDecisionTasks(args: CountPendingDecisionTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountPendingDecisionTasksCommandOutput) => void): void;
234
65
  /**
235
- * @public
236
- * <p>Deprecates the specified <i>activity type</i>. After an activity type has
237
- * been deprecated, you cannot create new tasks of that activity type. Tasks of this type that
238
- * were scheduled before the type was deprecated continue to run.</p>
239
- * <note>
240
- * <p>This operation is eventually consistent. The results are best effort and may not
241
- * exactly reflect recent updates and changes.</p>
242
- * </note>
243
- * <p>
244
- * <b>Access Control</b>
245
- * </p>
246
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
247
- * follows:</p>
248
- * <ul>
249
- * <li>
250
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
251
- * only specified domains.</p>
252
- * </li>
253
- * <li>
254
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
255
- * action.</p>
256
- * </li>
257
- * <li>
258
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
259
- * the appropriate keys.</p>
260
- * <ul>
261
- * <li>
262
- * <p>
263
- * <code>activityType.name</code>: String constraint. The key is
264
- * <code>swf:activityType.name</code>.</p>
265
- * </li>
266
- * <li>
267
- * <p>
268
- * <code>activityType.version</code>: String constraint. The key is
269
- * <code>swf:activityType.version</code>.</p>
270
- * </li>
271
- * </ul>
272
- * </li>
273
- * </ul>
274
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
275
- * parameter values fall outside the specified constraints, the action fails. The associated
276
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
277
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
278
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
66
+ * @see {@link DeprecateActivityTypeCommand}
279
67
  */
280
68
  deprecateActivityType(args: DeprecateActivityTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeprecateActivityTypeCommandOutput>;
281
69
  deprecateActivityType(args: DeprecateActivityTypeCommandInput, cb: (err: any, data?: DeprecateActivityTypeCommandOutput) => void): void;
282
70
  deprecateActivityType(args: DeprecateActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateActivityTypeCommandOutput) => void): void;
283
71
  /**
284
- * @public
285
- * <p>Deprecates the specified domain. After a domain has been deprecated it cannot be used
286
- * to create new workflow executions or register new types. However, you can still use visibility
287
- * actions on this domain. Deprecating a domain also deprecates all activity and workflow types
288
- * registered in the domain. Executions that were started before the domain was deprecated
289
- * continues to run.</p>
290
- * <note>
291
- * <p>This operation is eventually consistent. The results are best effort and may not
292
- * exactly reflect recent updates and changes.</p>
293
- * </note>
294
- * <p>
295
- * <b>Access Control</b>
296
- * </p>
297
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
298
- * follows:</p>
299
- * <ul>
300
- * <li>
301
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
302
- * only specified domains.</p>
303
- * </li>
304
- * <li>
305
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
306
- * action.</p>
307
- * </li>
308
- * <li>
309
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
310
- * </li>
311
- * </ul>
312
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
313
- * parameter values fall outside the specified constraints, the action fails. The associated
314
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
315
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
316
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
72
+ * @see {@link DeprecateDomainCommand}
317
73
  */
318
74
  deprecateDomain(args: DeprecateDomainCommandInput, options?: __HttpHandlerOptions): Promise<DeprecateDomainCommandOutput>;
319
75
  deprecateDomain(args: DeprecateDomainCommandInput, cb: (err: any, data?: DeprecateDomainCommandOutput) => void): void;
320
76
  deprecateDomain(args: DeprecateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateDomainCommandOutput) => void): void;
321
77
  /**
322
- * @public
323
- * <p>Deprecates the specified <i>workflow type</i>. After a workflow type has
324
- * been deprecated, you cannot create new executions of that type. Executions that were started
325
- * before the type was deprecated continues to run. A deprecated workflow type may still be used
326
- * when calling visibility actions.</p>
327
- * <note>
328
- * <p>This operation is eventually consistent. The results are best effort and may not
329
- * exactly reflect recent updates and changes.</p>
330
- * </note>
331
- * <p>
332
- * <b>Access Control</b>
333
- * </p>
334
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
335
- * follows:</p>
336
- * <ul>
337
- * <li>
338
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
339
- * only specified domains.</p>
340
- * </li>
341
- * <li>
342
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
343
- * action.</p>
344
- * </li>
345
- * <li>
346
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
347
- * the appropriate keys.</p>
348
- * <ul>
349
- * <li>
350
- * <p>
351
- * <code>workflowType.name</code>: String constraint. The key is
352
- * <code>swf:workflowType.name</code>.</p>
353
- * </li>
354
- * <li>
355
- * <p>
356
- * <code>workflowType.version</code>: String constraint. The key is
357
- * <code>swf:workflowType.version</code>.</p>
358
- * </li>
359
- * </ul>
360
- * </li>
361
- * </ul>
362
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
363
- * parameter values fall outside the specified constraints, the action fails. The associated
364
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
365
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
366
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
78
+ * @see {@link DeprecateWorkflowTypeCommand}
367
79
  */
368
80
  deprecateWorkflowType(args: DeprecateWorkflowTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeprecateWorkflowTypeCommandOutput>;
369
81
  deprecateWorkflowType(args: DeprecateWorkflowTypeCommandInput, cb: (err: any, data?: DeprecateWorkflowTypeCommandOutput) => void): void;
370
82
  deprecateWorkflowType(args: DeprecateWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateWorkflowTypeCommandOutput) => void): void;
371
83
  /**
372
- * @public
373
- * <p>Returns information about the specified activity type. This includes configuration
374
- * settings provided when the type was registered and other general information about the
375
- * type.</p>
376
- * <p>
377
- * <b>Access Control</b>
378
- * </p>
379
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
380
- * follows:</p>
381
- * <ul>
382
- * <li>
383
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
384
- * only specified domains.</p>
385
- * </li>
386
- * <li>
387
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
388
- * action.</p>
389
- * </li>
390
- * <li>
391
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
392
- * the appropriate keys.</p>
393
- * <ul>
394
- * <li>
395
- * <p>
396
- * <code>activityType.name</code>: String constraint. The key is
397
- * <code>swf:activityType.name</code>.</p>
398
- * </li>
399
- * <li>
400
- * <p>
401
- * <code>activityType.version</code>: String constraint. The key is
402
- * <code>swf:activityType.version</code>.</p>
403
- * </li>
404
- * </ul>
405
- * </li>
406
- * </ul>
407
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
408
- * parameter values fall outside the specified constraints, the action fails. The associated
409
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
410
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
411
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
84
+ * @see {@link DescribeActivityTypeCommand}
412
85
  */
413
86
  describeActivityType(args: DescribeActivityTypeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeActivityTypeCommandOutput>;
414
87
  describeActivityType(args: DescribeActivityTypeCommandInput, cb: (err: any, data?: DescribeActivityTypeCommandOutput) => void): void;
415
88
  describeActivityType(args: DescribeActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivityTypeCommandOutput) => void): void;
416
89
  /**
417
- * @public
418
- * <p>Returns information about the specified domain, including description and
419
- * status.</p>
420
- * <p>
421
- * <b>Access Control</b>
422
- * </p>
423
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
424
- * follows:</p>
425
- * <ul>
426
- * <li>
427
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
428
- * only specified domains.</p>
429
- * </li>
430
- * <li>
431
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
432
- * action.</p>
433
- * </li>
434
- * <li>
435
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
436
- * </li>
437
- * </ul>
438
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
439
- * parameter values fall outside the specified constraints, the action fails. The associated
440
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
441
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
442
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
90
+ * @see {@link DescribeDomainCommand}
443
91
  */
444
92
  describeDomain(args: DescribeDomainCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDomainCommandOutput>;
445
93
  describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void;
446
94
  describeDomain(args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void;
447
95
  /**
448
- * @public
449
- * <p>Returns information about the specified workflow execution including its type and some
450
- * statistics.</p>
451
- * <note>
452
- * <p>This operation is eventually consistent. The results are best effort and may not
453
- * exactly reflect recent updates and changes.</p>
454
- * </note>
455
- * <p>
456
- * <b>Access Control</b>
457
- * </p>
458
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
459
- * follows:</p>
460
- * <ul>
461
- * <li>
462
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
463
- * only specified domains.</p>
464
- * </li>
465
- * <li>
466
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
467
- * action.</p>
468
- * </li>
469
- * <li>
470
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
471
- * </li>
472
- * </ul>
473
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
474
- * parameter values fall outside the specified constraints, the action fails. The associated
475
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
476
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
477
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
96
+ * @see {@link DescribeWorkflowExecutionCommand}
478
97
  */
479
98
  describeWorkflowExecution(args: DescribeWorkflowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkflowExecutionCommandOutput>;
480
99
  describeWorkflowExecution(args: DescribeWorkflowExecutionCommandInput, cb: (err: any, data?: DescribeWorkflowExecutionCommandOutput) => void): void;
481
100
  describeWorkflowExecution(args: DescribeWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkflowExecutionCommandOutput) => void): void;
482
101
  /**
483
- * @public
484
- * <p>Returns information about the specified <i>workflow type</i>. This
485
- * includes configuration settings specified when the type was registered and other information
486
- * such as creation date, current status, etc.</p>
487
- * <p>
488
- * <b>Access Control</b>
489
- * </p>
490
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
491
- * follows:</p>
492
- * <ul>
493
- * <li>
494
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
495
- * only specified domains.</p>
496
- * </li>
497
- * <li>
498
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
499
- * action.</p>
500
- * </li>
501
- * <li>
502
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
503
- * the appropriate keys.</p>
504
- * <ul>
505
- * <li>
506
- * <p>
507
- * <code>workflowType.name</code>: String constraint. The key is
508
- * <code>swf:workflowType.name</code>.</p>
509
- * </li>
510
- * <li>
511
- * <p>
512
- * <code>workflowType.version</code>: String constraint. The key is
513
- * <code>swf:workflowType.version</code>.</p>
514
- * </li>
515
- * </ul>
516
- * </li>
517
- * </ul>
518
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
519
- * parameter values fall outside the specified constraints, the action fails. The associated
520
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
521
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
522
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
102
+ * @see {@link DescribeWorkflowTypeCommand}
523
103
  */
524
104
  describeWorkflowType(args: DescribeWorkflowTypeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkflowTypeCommandOutput>;
525
105
  describeWorkflowType(args: DescribeWorkflowTypeCommandInput, cb: (err: any, data?: DescribeWorkflowTypeCommandOutput) => void): void;
526
106
  describeWorkflowType(args: DescribeWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkflowTypeCommandOutput) => void): void;
527
107
  /**
528
- * @public
529
- * <p>Returns the history of the specified workflow execution. The results may be split into
530
- * multiple pages. To retrieve subsequent pages, make the call again using the
531
- * <code>nextPageToken</code> returned by the initial call.</p>
532
- * <note>
533
- * <p>This operation is eventually consistent. The results are best effort and may not
534
- * exactly reflect recent updates and changes.</p>
535
- * </note>
536
- * <p>
537
- * <b>Access Control</b>
538
- * </p>
539
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
540
- * follows:</p>
541
- * <ul>
542
- * <li>
543
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
544
- * only specified domains.</p>
545
- * </li>
546
- * <li>
547
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
548
- * action.</p>
549
- * </li>
550
- * <li>
551
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
552
- * </li>
553
- * </ul>
554
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
555
- * parameter values fall outside the specified constraints, the action fails. The associated
556
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
557
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
558
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
108
+ * @see {@link GetWorkflowExecutionHistoryCommand}
559
109
  */
560
110
  getWorkflowExecutionHistory(args: GetWorkflowExecutionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkflowExecutionHistoryCommandOutput>;
561
111
  getWorkflowExecutionHistory(args: GetWorkflowExecutionHistoryCommandInput, cb: (err: any, data?: GetWorkflowExecutionHistoryCommandOutput) => void): void;
562
112
  getWorkflowExecutionHistory(args: GetWorkflowExecutionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowExecutionHistoryCommandOutput) => void): void;
563
113
  /**
564
- * @public
565
- * <p>Returns information about all activities registered in the specified domain that match
566
- * the specified name and registration status. The result includes information like creation
567
- * date, current status of the activity, etc. The results may be split into multiple pages. To
568
- * retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned
569
- * by the initial call.</p>
570
- * <p>
571
- * <b>Access Control</b>
572
- * </p>
573
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
574
- * follows:</p>
575
- * <ul>
576
- * <li>
577
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
578
- * only specified domains.</p>
579
- * </li>
580
- * <li>
581
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
582
- * action.</p>
583
- * </li>
584
- * <li>
585
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
586
- * </li>
587
- * </ul>
588
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
589
- * parameter values fall outside the specified constraints, the action fails. The associated
590
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
591
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
592
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
114
+ * @see {@link ListActivityTypesCommand}
593
115
  */
594
116
  listActivityTypes(args: ListActivityTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListActivityTypesCommandOutput>;
595
117
  listActivityTypes(args: ListActivityTypesCommandInput, cb: (err: any, data?: ListActivityTypesCommandOutput) => void): void;
596
118
  listActivityTypes(args: ListActivityTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivityTypesCommandOutput) => void): void;
597
119
  /**
598
- * @public
599
- * <p>Returns a list of closed workflow executions in the specified domain that meet the
600
- * filtering criteria. The results may be split into multiple pages. To retrieve subsequent
601
- * pages, make the call again using the nextPageToken returned by the initial call.</p>
602
- * <note>
603
- * <p>This operation is eventually consistent. The results are best effort and may not
604
- * exactly reflect recent updates and changes.</p>
605
- * </note>
606
- * <p>
607
- * <b>Access Control</b>
608
- * </p>
609
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
610
- * follows:</p>
611
- * <ul>
612
- * <li>
613
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
614
- * only specified domains.</p>
615
- * </li>
616
- * <li>
617
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
618
- * action.</p>
619
- * </li>
620
- * <li>
621
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
622
- * the appropriate keys.</p>
623
- * <ul>
624
- * <li>
625
- * <p>
626
- * <code>tagFilter.tag</code>: String constraint. The key is
627
- * <code>swf:tagFilter.tag</code>.</p>
628
- * </li>
629
- * <li>
630
- * <p>
631
- * <code>typeFilter.name</code>: String constraint. The key is
632
- * <code>swf:typeFilter.name</code>.</p>
633
- * </li>
634
- * <li>
635
- * <p>
636
- * <code>typeFilter.version</code>: String constraint. The key is
637
- * <code>swf:typeFilter.version</code>.</p>
638
- * </li>
639
- * </ul>
640
- * </li>
641
- * </ul>
642
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
643
- * parameter values fall outside the specified constraints, the action fails. The associated
644
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
645
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
646
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
120
+ * @see {@link ListClosedWorkflowExecutionsCommand}
647
121
  */
648
122
  listClosedWorkflowExecutions(args: ListClosedWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListClosedWorkflowExecutionsCommandOutput>;
649
123
  listClosedWorkflowExecutions(args: ListClosedWorkflowExecutionsCommandInput, cb: (err: any, data?: ListClosedWorkflowExecutionsCommandOutput) => void): void;
650
124
  listClosedWorkflowExecutions(args: ListClosedWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClosedWorkflowExecutionsCommandOutput) => void): void;
651
125
  /**
652
- * @public
653
- * <p>Returns the list of domains registered in the account. The results may be split into
654
- * multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken
655
- * returned by the initial call.</p>
656
- * <note>
657
- * <p>This operation is eventually consistent. The results are best effort and may not
658
- * exactly reflect recent updates and changes.</p>
659
- * </note>
660
- * <p>
661
- * <b>Access Control</b>
662
- * </p>
663
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
664
- * follows:</p>
665
- * <ul>
666
- * <li>
667
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
668
- * only specified domains. The element must be set to
669
- * <code>arn:aws:swf::AccountID:domain/*</code>, where <i>AccountID</i> is
670
- * the account ID, with no dashes.</p>
671
- * </li>
672
- * <li>
673
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
674
- * action.</p>
675
- * </li>
676
- * <li>
677
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
678
- * </li>
679
- * </ul>
680
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
681
- * parameter values fall outside the specified constraints, the action fails. The associated
682
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
683
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
684
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
126
+ * @see {@link ListDomainsCommand}
685
127
  */
686
128
  listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
687
129
  listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
688
130
  listDomains(args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
689
131
  /**
690
- * @public
691
- * <p>Returns a list of open workflow executions in the specified domain that meet the
692
- * filtering criteria. The results may be split into multiple pages. To retrieve subsequent
693
- * pages, make the call again using the nextPageToken returned by the initial call.</p>
694
- * <note>
695
- * <p>This operation is eventually consistent. The results are best effort and may not
696
- * exactly reflect recent updates and changes.</p>
697
- * </note>
698
- * <p>
699
- * <b>Access Control</b>
700
- * </p>
701
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
702
- * follows:</p>
703
- * <ul>
704
- * <li>
705
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
706
- * only specified domains.</p>
707
- * </li>
708
- * <li>
709
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
710
- * action.</p>
711
- * </li>
712
- * <li>
713
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
714
- * the appropriate keys.</p>
715
- * <ul>
716
- * <li>
717
- * <p>
718
- * <code>tagFilter.tag</code>: String constraint. The key is
719
- * <code>swf:tagFilter.tag</code>.</p>
720
- * </li>
721
- * <li>
722
- * <p>
723
- * <code>typeFilter.name</code>: String constraint. The key is
724
- * <code>swf:typeFilter.name</code>.</p>
725
- * </li>
726
- * <li>
727
- * <p>
728
- * <code>typeFilter.version</code>: String constraint. The key is
729
- * <code>swf:typeFilter.version</code>.</p>
730
- * </li>
731
- * </ul>
732
- * </li>
733
- * </ul>
734
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
735
- * parameter values fall outside the specified constraints, the action fails. The associated
736
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
737
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
738
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
132
+ * @see {@link ListOpenWorkflowExecutionsCommand}
739
133
  */
740
134
  listOpenWorkflowExecutions(args: ListOpenWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListOpenWorkflowExecutionsCommandOutput>;
741
135
  listOpenWorkflowExecutions(args: ListOpenWorkflowExecutionsCommandInput, cb: (err: any, data?: ListOpenWorkflowExecutionsCommandOutput) => void): void;
742
136
  listOpenWorkflowExecutions(args: ListOpenWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpenWorkflowExecutionsCommandOutput) => void): void;
743
137
  /**
744
- * @public
745
- * <p>List tags for a given domain.</p>
138
+ * @see {@link ListTagsForResourceCommand}
746
139
  */
747
140
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
748
141
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
749
142
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
750
143
  /**
751
- * @public
752
- * <p>Returns information about workflow types in the specified domain. The results may be
753
- * split into multiple pages that can be retrieved by making the call repeatedly.</p>
754
- * <p>
755
- * <b>Access Control</b>
756
- * </p>
757
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
758
- * follows:</p>
759
- * <ul>
760
- * <li>
761
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
762
- * only specified domains.</p>
763
- * </li>
764
- * <li>
765
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
766
- * action.</p>
767
- * </li>
768
- * <li>
769
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
770
- * </li>
771
- * </ul>
772
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
773
- * parameter values fall outside the specified constraints, the action fails. The associated
774
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
775
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
776
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
144
+ * @see {@link ListWorkflowTypesCommand}
777
145
  */
778
146
  listWorkflowTypes(args: ListWorkflowTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkflowTypesCommandOutput>;
779
147
  listWorkflowTypes(args: ListWorkflowTypesCommandInput, cb: (err: any, data?: ListWorkflowTypesCommandOutput) => void): void;
780
148
  listWorkflowTypes(args: ListWorkflowTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowTypesCommandOutput) => void): void;
781
149
  /**
782
- * @public
783
- * <p>Used by workers to get an <a>ActivityTask</a> from the specified activity
784
- * <code>taskList</code>. This initiates a long poll, where the service holds the HTTP
785
- * connection open and responds as soon as a task becomes available. The maximum time the service
786
- * holds on to the request before responding is 60 seconds. If no task is available within 60
787
- * seconds, the poll returns an empty result. An empty result, in this context, means that an
788
- * ActivityTask is returned, but that the value of taskToken is an empty string. If a task is
789
- * returned, the worker should use its type to identify and process it correctly.</p>
790
- * <important>
791
- * <p>Workers should set their client side socket timeout to at least 70 seconds (10
792
- * seconds higher than the maximum time service may hold the poll request).</p>
793
- * </important>
794
- * <p>
795
- * <b>Access Control</b>
796
- * </p>
797
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
798
- * follows:</p>
799
- * <ul>
800
- * <li>
801
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
802
- * only specified domains.</p>
803
- * </li>
804
- * <li>
805
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
806
- * action.</p>
807
- * </li>
808
- * <li>
809
- * <p>Constrain the <code>taskList.name</code> parameter by using a
810
- * <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the
811
- * action to access only certain task lists.</p>
812
- * </li>
813
- * </ul>
814
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
815
- * parameter values fall outside the specified constraints, the action fails. The associated
816
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
817
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
818
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
150
+ * @see {@link PollForActivityTaskCommand}
819
151
  */
820
152
  pollForActivityTask(args: PollForActivityTaskCommandInput, options?: __HttpHandlerOptions): Promise<PollForActivityTaskCommandOutput>;
821
153
  pollForActivityTask(args: PollForActivityTaskCommandInput, cb: (err: any, data?: PollForActivityTaskCommandOutput) => void): void;
822
154
  pollForActivityTask(args: PollForActivityTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForActivityTaskCommandOutput) => void): void;
823
155
  /**
824
- * @public
825
- * <p>Used by deciders to get a <a>DecisionTask</a> from the specified decision
826
- * <code>taskList</code>. A decision task may be returned for any open workflow execution that
827
- * is using the specified task list. The task includes a paginated view of the history of the
828
- * workflow execution. The decider should use the workflow type and the history to determine how
829
- * to properly handle the task.</p>
830
- * <p>This action initiates a long poll, where the service holds the HTTP connection open and
831
- * responds as soon a task becomes available. If no decision task is available in the specified
832
- * task list before the timeout of 60 seconds expires, an empty result is returned. An empty
833
- * result, in this context, means that a DecisionTask is returned, but that the value of
834
- * taskToken is an empty string.</p>
835
- * <important>
836
- * <p>Deciders should set their client side socket timeout to at least 70 seconds (10
837
- * seconds higher than the timeout).</p>
838
- * </important>
839
- * <important>
840
- * <p>Because the number of workflow history events for a single workflow execution might
841
- * be very large, the result returned might be split up across a number of pages. To retrieve
842
- * subsequent pages, make additional calls to <code>PollForDecisionTask</code> using the
843
- * <code>nextPageToken</code> returned by the initial call. Note that you do
844
- * <i>not</i> call <code>GetWorkflowExecutionHistory</code> with this
845
- * <code>nextPageToken</code>. Instead, call <code>PollForDecisionTask</code>
846
- * again.</p>
847
- * </important>
848
- * <p>
849
- * <b>Access Control</b>
850
- * </p>
851
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
852
- * follows:</p>
853
- * <ul>
854
- * <li>
855
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
856
- * only specified domains.</p>
857
- * </li>
858
- * <li>
859
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
860
- * action.</p>
861
- * </li>
862
- * <li>
863
- * <p>Constrain the <code>taskList.name</code> parameter by using a
864
- * <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the
865
- * action to access only certain task lists.</p>
866
- * </li>
867
- * </ul>
868
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
869
- * parameter values fall outside the specified constraints, the action fails. The associated
870
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
871
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
872
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
156
+ * @see {@link PollForDecisionTaskCommand}
873
157
  */
874
158
  pollForDecisionTask(args: PollForDecisionTaskCommandInput, options?: __HttpHandlerOptions): Promise<PollForDecisionTaskCommandOutput>;
875
159
  pollForDecisionTask(args: PollForDecisionTaskCommandInput, cb: (err: any, data?: PollForDecisionTaskCommandOutput) => void): void;
876
160
  pollForDecisionTask(args: PollForDecisionTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForDecisionTaskCommandOutput) => void): void;
877
161
  /**
878
- * @public
879
- * <p>Used by activity workers to report to the service that the <a>ActivityTask</a> represented by the specified <code>taskToken</code> is still making progress. The worker
880
- * can also specify details of the progress, for example percent complete, using the
881
- * <code>details</code> parameter. This action can also be used by the worker as a mechanism to
882
- * check if cancellation is being requested for the activity task. If a cancellation is being
883
- * attempted for the specified task, then the boolean <code>cancelRequested</code> flag returned
884
- * by the service is set to <code>true</code>.</p>
885
- * <p>This action resets the <code>taskHeartbeatTimeout</code> clock. The
886
- * <code>taskHeartbeatTimeout</code> is specified in <a>RegisterActivityType</a>.</p>
887
- * <p>This action doesn't in itself create an event in the workflow execution history.
888
- * However, if the task times out, the workflow execution history contains a
889
- * <code>ActivityTaskTimedOut</code> event that contains the information from the last
890
- * heartbeat generated by the activity worker.</p>
891
- * <note>
892
- * <p>The <code>taskStartToCloseTimeout</code> of an activity type is the maximum duration
893
- * of an activity task, regardless of the number of <a>RecordActivityTaskHeartbeat</a> requests received. The <code>taskStartToCloseTimeout</code> is also specified in <a>RegisterActivityType</a>.</p>
894
- * </note>
895
- * <note>
896
- * <p>This operation is only useful for long-lived activities to report liveliness of the
897
- * task and to determine if a cancellation is being attempted.</p>
898
- * </note>
899
- * <important>
900
- * <p>If the <code>cancelRequested</code> flag returns <code>true</code>, a cancellation is
901
- * being attempted. If the worker can cancel the activity, it should respond with <a>RespondActivityTaskCanceled</a>. Otherwise, it should ignore the cancellation
902
- * request.</p>
903
- * </important>
904
- * <p>
905
- * <b>Access Control</b>
906
- * </p>
907
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
908
- * follows:</p>
909
- * <ul>
910
- * <li>
911
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
912
- * only specified domains.</p>
913
- * </li>
914
- * <li>
915
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
916
- * action.</p>
917
- * </li>
918
- * <li>
919
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
920
- * </li>
921
- * </ul>
922
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
923
- * parameter values fall outside the specified constraints, the action fails. The associated
924
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
925
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
926
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
162
+ * @see {@link RecordActivityTaskHeartbeatCommand}
927
163
  */
928
164
  recordActivityTaskHeartbeat(args: RecordActivityTaskHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise<RecordActivityTaskHeartbeatCommandOutput>;
929
165
  recordActivityTaskHeartbeat(args: RecordActivityTaskHeartbeatCommandInput, cb: (err: any, data?: RecordActivityTaskHeartbeatCommandOutput) => void): void;
930
166
  recordActivityTaskHeartbeat(args: RecordActivityTaskHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecordActivityTaskHeartbeatCommandOutput) => void): void;
931
167
  /**
932
- * @public
933
- * <p>Registers a new <i>activity type</i> along with its configuration
934
- * settings in the specified domain.</p>
935
- * <important>
936
- * <p>A <code>TypeAlreadyExists</code> fault is returned if the type already exists in the
937
- * domain. You cannot change any configuration settings of the type after its registration, and
938
- * it must be registered as a new version.</p>
939
- * </important>
940
- * <p>
941
- * <b>Access Control</b>
942
- * </p>
943
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
944
- * follows:</p>
945
- * <ul>
946
- * <li>
947
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
948
- * only specified domains.</p>
949
- * </li>
950
- * <li>
951
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
952
- * action.</p>
953
- * </li>
954
- * <li>
955
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
956
- * the appropriate keys.</p>
957
- * <ul>
958
- * <li>
959
- * <p>
960
- * <code>defaultTaskList.name</code>: String constraint. The key is
961
- * <code>swf:defaultTaskList.name</code>.</p>
962
- * </li>
963
- * <li>
964
- * <p>
965
- * <code>name</code>: String constraint. The key is <code>swf:name</code>.</p>
966
- * </li>
967
- * <li>
968
- * <p>
969
- * <code>version</code>: String constraint. The key is
970
- * <code>swf:version</code>.</p>
971
- * </li>
972
- * </ul>
973
- * </li>
974
- * </ul>
975
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
976
- * parameter values fall outside the specified constraints, the action fails. The associated
977
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
978
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
979
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
168
+ * @see {@link RegisterActivityTypeCommand}
980
169
  */
981
170
  registerActivityType(args: RegisterActivityTypeCommandInput, options?: __HttpHandlerOptions): Promise<RegisterActivityTypeCommandOutput>;
982
171
  registerActivityType(args: RegisterActivityTypeCommandInput, cb: (err: any, data?: RegisterActivityTypeCommandOutput) => void): void;
983
172
  registerActivityType(args: RegisterActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterActivityTypeCommandOutput) => void): void;
984
173
  /**
985
- * @public
986
- * <p>Registers a new domain.</p>
987
- * <p>
988
- * <b>Access Control</b>
989
- * </p>
990
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
991
- * follows:</p>
992
- * <ul>
993
- * <li>
994
- * <p>You cannot use an IAM policy to control domain access for this action. The name of
995
- * the domain being registered is available as the resource of this action.</p>
996
- * </li>
997
- * <li>
998
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
999
- * action.</p>
1000
- * </li>
1001
- * <li>
1002
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1003
- * </li>
1004
- * </ul>
1005
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1006
- * parameter values fall outside the specified constraints, the action fails. The associated
1007
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1008
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1009
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
174
+ * @see {@link RegisterDomainCommand}
1010
175
  */
1011
176
  registerDomain(args: RegisterDomainCommandInput, options?: __HttpHandlerOptions): Promise<RegisterDomainCommandOutput>;
1012
177
  registerDomain(args: RegisterDomainCommandInput, cb: (err: any, data?: RegisterDomainCommandOutput) => void): void;
1013
178
  registerDomain(args: RegisterDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDomainCommandOutput) => void): void;
1014
179
  /**
1015
- * @public
1016
- * <p>Registers a new <i>workflow type</i> and its configuration settings in
1017
- * the specified domain.</p>
1018
- * <p>The retention period for the workflow history is set by the <a>RegisterDomain</a> action.</p>
1019
- * <important>
1020
- * <p>If the type already exists, then a <code>TypeAlreadyExists</code> fault is returned.
1021
- * You cannot change the configuration settings of a workflow type once it is registered and it
1022
- * must be registered as a new version.</p>
1023
- * </important>
1024
- * <p>
1025
- * <b>Access Control</b>
1026
- * </p>
1027
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1028
- * follows:</p>
1029
- * <ul>
1030
- * <li>
1031
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1032
- * only specified domains.</p>
1033
- * </li>
1034
- * <li>
1035
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1036
- * action.</p>
1037
- * </li>
1038
- * <li>
1039
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
1040
- * the appropriate keys.</p>
1041
- * <ul>
1042
- * <li>
1043
- * <p>
1044
- * <code>defaultTaskList.name</code>: String constraint. The key is
1045
- * <code>swf:defaultTaskList.name</code>.</p>
1046
- * </li>
1047
- * <li>
1048
- * <p>
1049
- * <code>name</code>: String constraint. The key is <code>swf:name</code>.</p>
1050
- * </li>
1051
- * <li>
1052
- * <p>
1053
- * <code>version</code>: String constraint. The key is
1054
- * <code>swf:version</code>.</p>
1055
- * </li>
1056
- * </ul>
1057
- * </li>
1058
- * </ul>
1059
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1060
- * parameter values fall outside the specified constraints, the action fails. The associated
1061
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1062
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1063
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
180
+ * @see {@link RegisterWorkflowTypeCommand}
1064
181
  */
1065
182
  registerWorkflowType(args: RegisterWorkflowTypeCommandInput, options?: __HttpHandlerOptions): Promise<RegisterWorkflowTypeCommandOutput>;
1066
183
  registerWorkflowType(args: RegisterWorkflowTypeCommandInput, cb: (err: any, data?: RegisterWorkflowTypeCommandOutput) => void): void;
1067
184
  registerWorkflowType(args: RegisterWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterWorkflowTypeCommandOutput) => void): void;
1068
185
  /**
1069
- * @public
1070
- * <p>Records a <code>WorkflowExecutionCancelRequested</code> event in the currently running
1071
- * workflow execution identified by the given domain, workflowId, and runId. This logically
1072
- * requests the cancellation of the workflow execution as a whole. It is up to the decider to
1073
- * take appropriate actions when it receives an execution history with this event.</p>
1074
- *
1075
- * <note>
1076
- * <p>If the runId isn't specified, the <code>WorkflowExecutionCancelRequested</code> event
1077
- * is recorded in the history of the current open workflow execution with the specified
1078
- * workflowId in the domain.</p>
1079
- * </note>
1080
- *
1081
- * <note>
1082
- * <p>Because this action allows the workflow to properly clean up and gracefully close, it
1083
- * should be used instead of <a>TerminateWorkflowExecution</a> when
1084
- * possible.</p>
1085
- * </note>
1086
- * <p>
1087
- * <b>Access Control</b>
1088
- * </p>
1089
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1090
- * follows:</p>
1091
- * <ul>
1092
- * <li>
1093
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1094
- * only specified domains.</p>
1095
- * </li>
1096
- * <li>
1097
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1098
- * action.</p>
1099
- * </li>
1100
- * <li>
1101
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1102
- * </li>
1103
- * </ul>
1104
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1105
- * parameter values fall outside the specified constraints, the action fails. The associated
1106
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1107
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1108
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
186
+ * @see {@link RequestCancelWorkflowExecutionCommand}
1109
187
  */
1110
188
  requestCancelWorkflowExecution(args: RequestCancelWorkflowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<RequestCancelWorkflowExecutionCommandOutput>;
1111
189
  requestCancelWorkflowExecution(args: RequestCancelWorkflowExecutionCommandInput, cb: (err: any, data?: RequestCancelWorkflowExecutionCommandOutput) => void): void;
1112
190
  requestCancelWorkflowExecution(args: RequestCancelWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestCancelWorkflowExecutionCommandOutput) => void): void;
1113
191
  /**
1114
- * @public
1115
- * <p>Used by workers to tell the service that the <a>ActivityTask</a> identified
1116
- * by the <code>taskToken</code> was successfully canceled. Additional <code>details</code> can
1117
- * be provided using the <code>details</code> argument.</p>
1118
- *
1119
- * <p>These <code>details</code> (if provided) appear in the
1120
- * <code>ActivityTaskCanceled</code> event added to the workflow history.</p>
1121
- *
1122
- * <important>
1123
- * <p>Only use this operation if the <code>canceled</code> flag of a <a>RecordActivityTaskHeartbeat</a> request returns <code>true</code> and if the
1124
- * activity can be safely undone or abandoned.</p>
1125
- * </important>
1126
- *
1127
- * <p>A task is considered open from the time that it is scheduled until it is closed.
1128
- * Therefore a task is reported as open while a worker is processing it. A task is closed after
1129
- * it has been specified in a call to <a>RespondActivityTaskCompleted</a>,
1130
- * RespondActivityTaskCanceled, <a>RespondActivityTaskFailed</a>, or the task has
1131
- * <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed
1132
- * out</a>.</p>
1133
- *
1134
- * <p>
1135
- * <b>Access Control</b>
1136
- * </p>
1137
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1138
- * follows:</p>
1139
- * <ul>
1140
- * <li>
1141
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1142
- * only specified domains.</p>
1143
- * </li>
1144
- * <li>
1145
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1146
- * action.</p>
1147
- * </li>
1148
- * <li>
1149
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1150
- * </li>
1151
- * </ul>
1152
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1153
- * parameter values fall outside the specified constraints, the action fails. The associated
1154
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1155
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1156
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
192
+ * @see {@link RespondActivityTaskCanceledCommand}
1157
193
  */
1158
194
  respondActivityTaskCanceled(args: RespondActivityTaskCanceledCommandInput, options?: __HttpHandlerOptions): Promise<RespondActivityTaskCanceledCommandOutput>;
1159
195
  respondActivityTaskCanceled(args: RespondActivityTaskCanceledCommandInput, cb: (err: any, data?: RespondActivityTaskCanceledCommandOutput) => void): void;
1160
196
  respondActivityTaskCanceled(args: RespondActivityTaskCanceledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondActivityTaskCanceledCommandOutput) => void): void;
1161
197
  /**
1162
- * @public
1163
- * <p>Used by workers to tell the service that the <a>ActivityTask</a> identified
1164
- * by the <code>taskToken</code> completed successfully with a <code>result</code> (if provided).
1165
- * The <code>result</code> appears in the <code>ActivityTaskCompleted</code> event in the
1166
- * workflow history.</p>
1167
- *
1168
- * <important>
1169
- * <p>If the requested task doesn't complete successfully, use <a>RespondActivityTaskFailed</a> instead. If the worker finds that the task is
1170
- * canceled through the <code>canceled</code> flag returned by <a>RecordActivityTaskHeartbeat</a>, it should cancel the task, clean up and then call
1171
- * <a>RespondActivityTaskCanceled</a>.</p>
1172
- * </important>
1173
- *
1174
- * <p>A task is considered open from the time that it is scheduled until it is closed.
1175
- * Therefore a task is reported as open while a worker is processing it. A task is closed after
1176
- * it has been specified in a call to RespondActivityTaskCompleted, <a>RespondActivityTaskCanceled</a>, <a>RespondActivityTaskFailed</a>, or the
1177
- * task has <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed
1178
- * out</a>.</p>
1179
- *
1180
- * <p>
1181
- * <b>Access Control</b>
1182
- * </p>
1183
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1184
- * follows:</p>
1185
- * <ul>
1186
- * <li>
1187
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1188
- * only specified domains.</p>
1189
- * </li>
1190
- * <li>
1191
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1192
- * action.</p>
1193
- * </li>
1194
- * <li>
1195
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1196
- * </li>
1197
- * </ul>
1198
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1199
- * parameter values fall outside the specified constraints, the action fails. The associated
1200
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1201
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1202
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
198
+ * @see {@link RespondActivityTaskCompletedCommand}
1203
199
  */
1204
200
  respondActivityTaskCompleted(args: RespondActivityTaskCompletedCommandInput, options?: __HttpHandlerOptions): Promise<RespondActivityTaskCompletedCommandOutput>;
1205
201
  respondActivityTaskCompleted(args: RespondActivityTaskCompletedCommandInput, cb: (err: any, data?: RespondActivityTaskCompletedCommandOutput) => void): void;
1206
202
  respondActivityTaskCompleted(args: RespondActivityTaskCompletedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondActivityTaskCompletedCommandOutput) => void): void;
1207
203
  /**
1208
- * @public
1209
- * <p>Used by workers to tell the service that the <a>ActivityTask</a> identified
1210
- * by the <code>taskToken</code> has failed with <code>reason</code> (if specified). The
1211
- * <code>reason</code> and <code>details</code> appear in the <code>ActivityTaskFailed</code>
1212
- * event added to the workflow history.</p>
1213
- *
1214
- * <p>A task is considered open from the time that it is scheduled until it is closed.
1215
- * Therefore a task is reported as open while a worker is processing it. A task is closed after
1216
- * it has been specified in a call to <a>RespondActivityTaskCompleted</a>, <a>RespondActivityTaskCanceled</a>, RespondActivityTaskFailed, or the task has <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed
1217
- * out</a>.</p>
1218
- *
1219
- * <p>
1220
- * <b>Access Control</b>
1221
- * </p>
1222
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1223
- * follows:</p>
1224
- * <ul>
1225
- * <li>
1226
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1227
- * only specified domains.</p>
1228
- * </li>
1229
- * <li>
1230
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1231
- * action.</p>
1232
- * </li>
1233
- * <li>
1234
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1235
- * </li>
1236
- * </ul>
1237
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1238
- * parameter values fall outside the specified constraints, the action fails. The associated
1239
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1240
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1241
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
204
+ * @see {@link RespondActivityTaskFailedCommand}
1242
205
  */
1243
206
  respondActivityTaskFailed(args: RespondActivityTaskFailedCommandInput, options?: __HttpHandlerOptions): Promise<RespondActivityTaskFailedCommandOutput>;
1244
207
  respondActivityTaskFailed(args: RespondActivityTaskFailedCommandInput, cb: (err: any, data?: RespondActivityTaskFailedCommandOutput) => void): void;
1245
208
  respondActivityTaskFailed(args: RespondActivityTaskFailedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondActivityTaskFailedCommandOutput) => void): void;
1246
209
  /**
1247
- * @public
1248
- * <p>Used by deciders to tell the service that the <a>DecisionTask</a> identified
1249
- * by the <code>taskToken</code> has successfully completed. The <code>decisions</code> argument
1250
- * specifies the list of decisions made while processing the task.</p>
1251
- *
1252
- * <p>A <code>DecisionTaskCompleted</code> event is added to the workflow history. The
1253
- * <code>executionContext</code> specified is attached to the event in the workflow execution
1254
- * history.</p>
1255
- *
1256
- * <p>
1257
- * <b>Access Control</b>
1258
- * </p>
1259
- *
1260
- * <p>If an IAM policy grants permission to use <code>RespondDecisionTaskCompleted</code>, it
1261
- * can express permissions for the list of decisions in the <code>decisions</code> parameter.
1262
- * Each of the decisions has one or more parameters, much like a regular API call. To allow for
1263
- * policies to be as readable as possible, you can express permissions on decisions as if they
1264
- * were actual API calls, including applying conditions to some parameters. For more information,
1265
- * see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using
1266
- * IAM to Manage Access to Amazon SWF Workflows</a> in the
1267
- * <i>Amazon SWF Developer Guide</i>.</p>
210
+ * @see {@link RespondDecisionTaskCompletedCommand}
1268
211
  */
1269
212
  respondDecisionTaskCompleted(args: RespondDecisionTaskCompletedCommandInput, options?: __HttpHandlerOptions): Promise<RespondDecisionTaskCompletedCommandOutput>;
1270
213
  respondDecisionTaskCompleted(args: RespondDecisionTaskCompletedCommandInput, cb: (err: any, data?: RespondDecisionTaskCompletedCommandOutput) => void): void;
1271
214
  respondDecisionTaskCompleted(args: RespondDecisionTaskCompletedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondDecisionTaskCompletedCommandOutput) => void): void;
1272
215
  /**
1273
- * @public
1274
- * <p>Records a <code>WorkflowExecutionSignaled</code> event in the workflow execution
1275
- * history and creates a decision task for the workflow execution identified by the given domain,
1276
- * workflowId and runId. The event is recorded with the specified user defined signalName and
1277
- * input (if provided).</p>
1278
- *
1279
- * <note>
1280
- * <p>If a runId isn't specified, then the <code>WorkflowExecutionSignaled</code> event is
1281
- * recorded in the history of the current open workflow with the matching workflowId in the
1282
- * domain.</p>
1283
- * </note>
1284
- *
1285
- * <note>
1286
- * <p>If the specified workflow execution isn't open, this method fails with
1287
- * <code>UnknownResource</code>.</p>
1288
- * </note>
1289
- *
1290
- * <p>
1291
- * <b>Access Control</b>
1292
- * </p>
1293
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1294
- * follows:</p>
1295
- * <ul>
1296
- * <li>
1297
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1298
- * only specified domains.</p>
1299
- * </li>
1300
- * <li>
1301
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1302
- * action.</p>
1303
- * </li>
1304
- * <li>
1305
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1306
- * </li>
1307
- * </ul>
1308
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1309
- * parameter values fall outside the specified constraints, the action fails. The associated
1310
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1311
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1312
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
216
+ * @see {@link SignalWorkflowExecutionCommand}
1313
217
  */
1314
218
  signalWorkflowExecution(args: SignalWorkflowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<SignalWorkflowExecutionCommandOutput>;
1315
219
  signalWorkflowExecution(args: SignalWorkflowExecutionCommandInput, cb: (err: any, data?: SignalWorkflowExecutionCommandOutput) => void): void;
1316
220
  signalWorkflowExecution(args: SignalWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignalWorkflowExecutionCommandOutput) => void): void;
1317
221
  /**
1318
- * @public
1319
- * <p>Starts an execution of the workflow type in the specified domain using the provided
1320
- * <code>workflowId</code> and input data.</p>
1321
- *
1322
- * <p>This action returns the newly started workflow execution.</p>
1323
- *
1324
- * <p>
1325
- * <b>Access Control</b>
1326
- * </p>
1327
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1328
- * follows:</p>
1329
- * <ul>
1330
- * <li>
1331
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1332
- * only specified domains.</p>
1333
- * </li>
1334
- * <li>
1335
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1336
- * action.</p>
1337
- * </li>
1338
- * <li>
1339
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
1340
- * the appropriate keys.</p>
1341
- * <ul>
1342
- * <li>
1343
- * <p>
1344
- * <code>tagList.member.0</code>: The key is <code>swf:tagList.member.0</code>.</p>
1345
- * </li>
1346
- * <li>
1347
- * <p>
1348
- * <code>tagList.member.1</code>: The key is <code>swf:tagList.member.1</code>.</p>
1349
- * </li>
1350
- * <li>
1351
- * <p>
1352
- * <code>tagList.member.2</code>: The key is <code>swf:tagList.member.2</code>.</p>
1353
- * </li>
1354
- * <li>
1355
- * <p>
1356
- * <code>tagList.member.3</code>: The key is <code>swf:tagList.member.3</code>.</p>
1357
- * </li>
1358
- * <li>
1359
- * <p>
1360
- * <code>tagList.member.4</code>: The key is <code>swf:tagList.member.4</code>.</p>
1361
- * </li>
1362
- * <li>
1363
- * <p>
1364
- * <code>taskList</code>: String constraint. The key is
1365
- * <code>swf:taskList.name</code>.</p>
1366
- * </li>
1367
- * <li>
1368
- * <p>
1369
- * <code>workflowType.name</code>: String constraint. The key is
1370
- * <code>swf:workflowType.name</code>.</p>
1371
- * </li>
1372
- * <li>
1373
- * <p>
1374
- * <code>workflowType.version</code>: String constraint. The key is
1375
- * <code>swf:workflowType.version</code>.</p>
1376
- * </li>
1377
- * </ul>
1378
- * </li>
1379
- * </ul>
1380
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1381
- * parameter values fall outside the specified constraints, the action fails. The associated
1382
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1383
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1384
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
222
+ * @see {@link StartWorkflowExecutionCommand}
1385
223
  */
1386
224
  startWorkflowExecution(args: StartWorkflowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartWorkflowExecutionCommandOutput>;
1387
225
  startWorkflowExecution(args: StartWorkflowExecutionCommandInput, cb: (err: any, data?: StartWorkflowExecutionCommandOutput) => void): void;
1388
226
  startWorkflowExecution(args: StartWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWorkflowExecutionCommandOutput) => void): void;
1389
227
  /**
1390
- * @public
1391
- * <p>Add a tag to a Amazon SWF domain.</p>
1392
- * <note>
1393
- * <p>Amazon SWF supports a maximum of 50 tags per resource.</p>
1394
- * </note>
228
+ * @see {@link TagResourceCommand}
1395
229
  */
1396
230
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
1397
231
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
1398
232
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
1399
233
  /**
1400
- * @public
1401
- * <p>Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the
1402
- * workflow execution identified by the given domain, runId, and workflowId. The child policy,
1403
- * registered with the workflow type or specified when starting this execution, is applied to any
1404
- * open child workflow executions of this workflow execution.</p>
1405
- *
1406
- * <important>
1407
- * <p>If the identified workflow execution was in progress, it is terminated
1408
- * immediately.</p>
1409
- * </important>
1410
- *
1411
- * <note>
1412
- * <p>If a runId isn't specified, then the <code>WorkflowExecutionTerminated</code> event
1413
- * is recorded in the history of the current open workflow with the matching workflowId in the
1414
- * domain.</p>
1415
- * </note>
1416
- *
1417
- * <note>
1418
- * <p>You should consider using <a>RequestCancelWorkflowExecution</a> action
1419
- * instead because it allows the workflow to gracefully close while <a>TerminateWorkflowExecution</a> doesn't.</p>
1420
- * </note>
1421
- *
1422
- * <p>
1423
- * <b>Access Control</b>
1424
- * </p>
1425
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1426
- * follows:</p>
1427
- * <ul>
1428
- * <li>
1429
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1430
- * only specified domains.</p>
1431
- * </li>
1432
- * <li>
1433
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1434
- * action.</p>
1435
- * </li>
1436
- * <li>
1437
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1438
- * </li>
1439
- * </ul>
1440
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1441
- * parameter values fall outside the specified constraints, the action fails. The associated
1442
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1443
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1444
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
234
+ * @see {@link TerminateWorkflowExecutionCommand}
1445
235
  */
1446
236
  terminateWorkflowExecution(args: TerminateWorkflowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<TerminateWorkflowExecutionCommandOutput>;
1447
237
  terminateWorkflowExecution(args: TerminateWorkflowExecutionCommandInput, cb: (err: any, data?: TerminateWorkflowExecutionCommandOutput) => void): void;
1448
238
  terminateWorkflowExecution(args: TerminateWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateWorkflowExecutionCommandOutput) => void): void;
1449
239
  /**
1450
- * @public
1451
- * <p>Undeprecates a previously deprecated <i>activity type</i>. After an activity type has
1452
- * been undeprecated, you can create new tasks of that activity type.</p>
1453
- * <note>
1454
- * <p>This operation is eventually consistent. The results are best effort and may not
1455
- * exactly reflect recent updates and changes.</p>
1456
- * </note>
1457
- * <p>
1458
- * <b>Access Control</b>
1459
- * </p>
1460
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1461
- * follows:</p>
1462
- * <ul>
1463
- * <li>
1464
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1465
- * only specified domains.</p>
1466
- * </li>
1467
- * <li>
1468
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1469
- * action.</p>
1470
- * </li>
1471
- * <li>
1472
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
1473
- * the appropriate keys.</p>
1474
- * <ul>
1475
- * <li>
1476
- * <p>
1477
- * <code>activityType.name</code>: String constraint. The key is
1478
- * <code>swf:activityType.name</code>.</p>
1479
- * </li>
1480
- * <li>
1481
- * <p>
1482
- * <code>activityType.version</code>: String constraint. The key is
1483
- * <code>swf:activityType.version</code>.</p>
1484
- * </li>
1485
- * </ul>
1486
- * </li>
1487
- * </ul>
1488
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1489
- * parameter values fall outside the specified constraints, the action fails. The associated
1490
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1491
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1492
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
240
+ * @see {@link UndeprecateActivityTypeCommand}
1493
241
  */
1494
242
  undeprecateActivityType(args: UndeprecateActivityTypeCommandInput, options?: __HttpHandlerOptions): Promise<UndeprecateActivityTypeCommandOutput>;
1495
243
  undeprecateActivityType(args: UndeprecateActivityTypeCommandInput, cb: (err: any, data?: UndeprecateActivityTypeCommandOutput) => void): void;
1496
244
  undeprecateActivityType(args: UndeprecateActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeprecateActivityTypeCommandOutput) => void): void;
1497
245
  /**
1498
- * @public
1499
- * <p>Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used
1500
- * to create new workflow executions or register new types.</p>
1501
- * <note>
1502
- * <p>This operation is eventually consistent. The results are best effort and may not
1503
- * exactly reflect recent updates and changes.</p>
1504
- * </note>
1505
- * <p>
1506
- * <b>Access Control</b>
1507
- * </p>
1508
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1509
- * follows:</p>
1510
- * <ul>
1511
- * <li>
1512
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1513
- * only specified domains.</p>
1514
- * </li>
1515
- * <li>
1516
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1517
- * action.</p>
1518
- * </li>
1519
- * <li>
1520
- * <p>You cannot use an IAM policy to constrain this action's parameters.</p>
1521
- * </li>
1522
- * </ul>
1523
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1524
- * parameter values fall outside the specified constraints, the action fails. The associated
1525
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1526
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1527
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
246
+ * @see {@link UndeprecateDomainCommand}
1528
247
  */
1529
248
  undeprecateDomain(args: UndeprecateDomainCommandInput, options?: __HttpHandlerOptions): Promise<UndeprecateDomainCommandOutput>;
1530
249
  undeprecateDomain(args: UndeprecateDomainCommandInput, cb: (err: any, data?: UndeprecateDomainCommandOutput) => void): void;
1531
250
  undeprecateDomain(args: UndeprecateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeprecateDomainCommandOutput) => void): void;
1532
251
  /**
1533
- * @public
1534
- * <p>Undeprecates a previously deprecated <i>workflow type</i>. After a workflow type has
1535
- * been undeprecated, you can create new executions of that type. </p>
1536
- * <note>
1537
- * <p>This operation is eventually consistent. The results are best effort and may not
1538
- * exactly reflect recent updates and changes.</p>
1539
- * </note>
1540
- * <p>
1541
- * <b>Access Control</b>
1542
- * </p>
1543
- * <p>You can use IAM policies to control this action's access to Amazon SWF resources as
1544
- * follows:</p>
1545
- * <ul>
1546
- * <li>
1547
- * <p>Use a <code>Resource</code> element with the domain name to limit the action to
1548
- * only specified domains.</p>
1549
- * </li>
1550
- * <li>
1551
- * <p>Use an <code>Action</code> element to allow or deny permission to call this
1552
- * action.</p>
1553
- * </li>
1554
- * <li>
1555
- * <p>Constrain the following parameters by using a <code>Condition</code> element with
1556
- * the appropriate keys.</p>
1557
- * <ul>
1558
- * <li>
1559
- * <p>
1560
- * <code>workflowType.name</code>: String constraint. The key is
1561
- * <code>swf:workflowType.name</code>.</p>
1562
- * </li>
1563
- * <li>
1564
- * <p>
1565
- * <code>workflowType.version</code>: String constraint. The key is
1566
- * <code>swf:workflowType.version</code>.</p>
1567
- * </li>
1568
- * </ul>
1569
- * </li>
1570
- * </ul>
1571
- * <p>If the caller doesn't have sufficient permissions to invoke the action, or the
1572
- * parameter values fall outside the specified constraints, the action fails. The associated
1573
- * event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
1574
- * For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
1575
- * Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
252
+ * @see {@link UndeprecateWorkflowTypeCommand}
1576
253
  */
1577
254
  undeprecateWorkflowType(args: UndeprecateWorkflowTypeCommandInput, options?: __HttpHandlerOptions): Promise<UndeprecateWorkflowTypeCommandOutput>;
1578
255
  undeprecateWorkflowType(args: UndeprecateWorkflowTypeCommandInput, cb: (err: any, data?: UndeprecateWorkflowTypeCommandOutput) => void): void;
1579
256
  undeprecateWorkflowType(args: UndeprecateWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeprecateWorkflowTypeCommandOutput) => void): void;
1580
257
  /**
1581
- * @public
1582
- * <p>Remove a tag from a Amazon SWF domain.</p>
258
+ * @see {@link UntagResourceCommand}
1583
259
  */
1584
260
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
1585
261
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
1586
262
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
1587
263
  }
264
+ /**
265
+ * @public
266
+ * <fullname>Amazon Simple Workflow Service</fullname>
267
+ *
268
+ * <p>The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to
269
+ * coordinate work across distributed components. In Amazon SWF, a <i>task</i>
270
+ * represents a logical unit of work that is performed by a component of your workflow.
271
+ * Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and
272
+ * concurrency in accordance with the logical flow of the application.</p>
273
+ *
274
+ * <p>Amazon SWF gives you full control over implementing tasks and coordinating them without
275
+ * worrying about underlying complexities such as tracking their progress and maintaining their
276
+ * state.</p>
277
+ *
278
+ * <p>This documentation serves as reference only. For a broader overview of the Amazon SWF
279
+ * programming model, see the <i>
280
+ * <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/">Amazon SWF Developer Guide</a>
281
+ * </i>.</p>
282
+ */
283
+ export declare class SWF extends SWFClient implements SWF {
284
+ }