@aws-sdk/client-swf 3.379.1 → 3.385.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.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +593 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -6,6 +6,7 @@ import { SWFServiceException as __BaseException } from "./SWFServiceException";
6
6
  */
7
7
  export interface ActivityType {
8
8
  /**
9
+ * @public
9
10
  * <p>The name of this activity.</p>
10
11
  * <note>
11
12
  * <p>The combination of activity type name and version must be unique within a domain.</p>
@@ -13,6 +14,7 @@ export interface ActivityType {
13
14
  */
14
15
  name: string | undefined;
15
16
  /**
17
+ * @public
16
18
  * <p>The version of this activity.</p>
17
19
  * <note>
18
20
  * <p>The combination of activity type name and version must be unique with in a domain.</p>
@@ -26,10 +28,12 @@ export interface ActivityType {
26
28
  */
27
29
  export interface WorkflowExecution {
28
30
  /**
31
+ * @public
29
32
  * <p>The user defined identifier associated with the workflow execution.</p>
30
33
  */
31
34
  workflowId: string | undefined;
32
35
  /**
36
+ * @public
33
37
  * <p>A system-generated unique identifier for the workflow execution.</p>
34
38
  */
35
39
  runId: string | undefined;
@@ -40,26 +44,32 @@ export interface WorkflowExecution {
40
44
  */
41
45
  export interface ActivityTask {
42
46
  /**
47
+ * @public
43
48
  * <p>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.</p>
44
49
  */
45
50
  taskToken: string | undefined;
46
51
  /**
52
+ * @public
47
53
  * <p>The unique ID of the task.</p>
48
54
  */
49
55
  activityId: string | undefined;
50
56
  /**
57
+ * @public
51
58
  * <p>The ID of the <code>ActivityTaskStarted</code> event recorded in the history.</p>
52
59
  */
53
60
  startedEventId: number | undefined;
54
61
  /**
62
+ * @public
55
63
  * <p>The workflow execution that started this activity task.</p>
56
64
  */
57
65
  workflowExecution: WorkflowExecution | undefined;
58
66
  /**
67
+ * @public
59
68
  * <p>The type of this activity task.</p>
60
69
  */
61
70
  activityType: ActivityType | undefined;
62
71
  /**
72
+ * @public
63
73
  * <p>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.</p>
64
74
  */
65
75
  input?: string;
@@ -70,20 +80,24 @@ export interface ActivityTask {
70
80
  */
71
81
  export interface ActivityTaskCanceledEventAttributes {
72
82
  /**
83
+ * @public
73
84
  * <p>Details of the cancellation.</p>
74
85
  */
75
86
  details?: string;
76
87
  /**
88
+ * @public
77
89
  * <p>The ID of the <code>ActivityTaskScheduled</code> 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.</p>
78
90
  */
79
91
  scheduledEventId: number | undefined;
80
92
  /**
93
+ * @public
81
94
  * <p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This
82
95
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
83
96
  * event.</p>
84
97
  */
85
98
  startedEventId: number | undefined;
86
99
  /**
100
+ * @public
87
101
  * <p>If set, contains the ID of the last <code>ActivityTaskCancelRequested</code> 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.</p>
88
102
  */
89
103
  latestCancelRequestedEventId?: number;
@@ -94,11 +108,13 @@ export interface ActivityTaskCanceledEventAttributes {
94
108
  */
95
109
  export interface ActivityTaskCancelRequestedEventAttributes {
96
110
  /**
111
+ * @public
97
112
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
98
113
  * <code>RequestCancelActivityTask</code> 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.</p>
99
114
  */
100
115
  decisionTaskCompletedEventId: number | undefined;
101
116
  /**
117
+ * @public
102
118
  * <p>The unique ID of the task.</p>
103
119
  */
104
120
  activityId: string | undefined;
@@ -109,14 +125,17 @@ export interface ActivityTaskCancelRequestedEventAttributes {
109
125
  */
110
126
  export interface ActivityTaskCompletedEventAttributes {
111
127
  /**
128
+ * @public
112
129
  * <p>The results of the activity task.</p>
113
130
  */
114
131
  result?: string;
115
132
  /**
133
+ * @public
116
134
  * <p>The ID of the <code>ActivityTaskScheduled</code> 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.</p>
117
135
  */
118
136
  scheduledEventId: number | undefined;
119
137
  /**
138
+ * @public
120
139
  * <p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This
121
140
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
122
141
  * event.</p>
@@ -129,18 +148,22 @@ export interface ActivityTaskCompletedEventAttributes {
129
148
  */
130
149
  export interface ActivityTaskFailedEventAttributes {
131
150
  /**
151
+ * @public
132
152
  * <p>The reason provided for the failure.</p>
133
153
  */
134
154
  reason?: string;
135
155
  /**
156
+ * @public
136
157
  * <p>The details of the failure.</p>
137
158
  */
138
159
  details?: string;
139
160
  /**
161
+ * @public
140
162
  * <p>The ID of the <code>ActivityTaskScheduled</code> 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.</p>
141
163
  */
142
164
  scheduledEventId: number | undefined;
143
165
  /**
166
+ * @public
144
167
  * <p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This
145
168
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
146
169
  * event.</p>
@@ -153,6 +176,7 @@ export interface ActivityTaskFailedEventAttributes {
153
176
  */
154
177
  export interface TaskList {
155
178
  /**
179
+ * @public
156
180
  * <p>The name of the task list.</p>
157
181
  */
158
182
  name: string | undefined;
@@ -163,38 +187,47 @@ export interface TaskList {
163
187
  */
164
188
  export interface ActivityTaskScheduledEventAttributes {
165
189
  /**
190
+ * @public
166
191
  * <p>The type of the activity task.</p>
167
192
  */
168
193
  activityType: ActivityType | undefined;
169
194
  /**
195
+ * @public
170
196
  * <p>The unique ID of the activity task.</p>
171
197
  */
172
198
  activityId: string | undefined;
173
199
  /**
200
+ * @public
174
201
  * <p>The input provided to the activity task.</p>
175
202
  */
176
203
  input?: string;
177
204
  /**
205
+ * @public
178
206
  * <p>Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.</p>
179
207
  */
180
208
  control?: string;
181
209
  /**
210
+ * @public
182
211
  * <p>The maximum amount of time the activity task can wait to be assigned to a worker.</p>
183
212
  */
184
213
  scheduleToStartTimeout?: string;
185
214
  /**
215
+ * @public
186
216
  * <p>The maximum amount of time for this activity task.</p>
187
217
  */
188
218
  scheduleToCloseTimeout?: string;
189
219
  /**
220
+ * @public
190
221
  * <p>The maximum amount of time a worker may take to process the activity task.</p>
191
222
  */
192
223
  startToCloseTimeout?: string;
193
224
  /**
225
+ * @public
194
226
  * <p>The task list in which the activity task has been scheduled.</p>
195
227
  */
196
228
  taskList: TaskList | undefined;
197
229
  /**
230
+ * @public
198
231
  * <p>
199
232
  * The priority to assign to the scheduled activity task. If set, this overrides any default
200
233
  * priority value that was assigned when the activity type was registered.</p>
@@ -204,10 +237,12 @@ export interface ActivityTaskScheduledEventAttributes {
204
237
  */
205
238
  taskPriority?: string;
206
239
  /**
240
+ * @public
207
241
  * <p>The ID of the <code>DecisionTaskCompleted</code> 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.</p>
208
242
  */
209
243
  decisionTaskCompletedEventId: number | undefined;
210
244
  /**
245
+ * @public
211
246
  * <p>The maximum time before which the worker processing this task must report progress by calling
212
247
  * <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out. If
213
248
  * the worker subsequently attempts to record a heartbeat or return a result, it is ignored.</p>
@@ -220,10 +255,12 @@ export interface ActivityTaskScheduledEventAttributes {
220
255
  */
221
256
  export interface ActivityTaskStartedEventAttributes {
222
257
  /**
258
+ * @public
223
259
  * <p>Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.</p>
224
260
  */
225
261
  identity?: string;
226
262
  /**
263
+ * @public
227
264
  * <p>The ID of the <code>ActivityTaskScheduled</code> 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.</p>
228
265
  */
229
266
  scheduledEventId: number | undefined;
@@ -234,6 +271,7 @@ export interface ActivityTaskStartedEventAttributes {
234
271
  */
235
272
  export interface ActivityTaskStatus {
236
273
  /**
274
+ * @public
237
275
  * <p>Set to <code>true</code> if cancellation of the task is requested.</p>
238
276
  */
239
277
  cancelRequested: boolean | undefined;
@@ -258,20 +296,24 @@ export type ActivityTaskTimeoutType = (typeof ActivityTaskTimeoutType)[keyof typ
258
296
  */
259
297
  export interface ActivityTaskTimedOutEventAttributes {
260
298
  /**
299
+ * @public
261
300
  * <p>The type of the timeout that caused this event.</p>
262
301
  */
263
302
  timeoutType: ActivityTaskTimeoutType | string | undefined;
264
303
  /**
304
+ * @public
265
305
  * <p>The ID of the <code>ActivityTaskScheduled</code> 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.</p>
266
306
  */
267
307
  scheduledEventId: number | undefined;
268
308
  /**
309
+ * @public
269
310
  * <p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This
270
311
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
271
312
  * event.</p>
272
313
  */
273
314
  startedEventId: number | undefined;
274
315
  /**
316
+ * @public
275
317
  * <p>Contains the content of the <code>details</code> parameter for the last call made by the activity to
276
318
  * <code>RecordActivityTaskHeartbeat</code>.</p>
277
319
  */
@@ -283,6 +325,7 @@ export interface ActivityTaskTimedOutEventAttributes {
283
325
  */
284
326
  export interface ActivityTypeConfiguration {
285
327
  /**
328
+ * @public
286
329
  * <p>
287
330
  * The default maximum duration for tasks of an activity type specified when registering the activity
288
331
  * type. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code>
@@ -291,6 +334,7 @@ export interface ActivityTypeConfiguration {
291
334
  */
292
335
  defaultTaskStartToCloseTimeout?: string;
293
336
  /**
337
+ * @public
294
338
  * <p>
295
339
  * The default maximum time, in seconds, before which a worker processing a task must report
296
340
  * progress by calling <a>RecordActivityTaskHeartbeat</a>.</p>
@@ -304,6 +348,7 @@ export interface ActivityTypeConfiguration {
304
348
  */
305
349
  defaultTaskHeartbeatTimeout?: string;
306
350
  /**
351
+ * @public
307
352
  * <p>
308
353
  * The default task list specified for this activity type at registration. This default is used if
309
354
  * a task list isn't provided when a task is scheduled through the <code>ScheduleActivityTask</code>
@@ -313,6 +358,7 @@ export interface ActivityTypeConfiguration {
313
358
  */
314
359
  defaultTaskList?: TaskList;
315
360
  /**
361
+ * @public
316
362
  * <p>
317
363
  * The default task priority for tasks of this activity type, specified at registration. If not
318
364
  * set, then <code>0</code> is used as the default priority. This default can be overridden when scheduling an activity
@@ -323,6 +369,7 @@ export interface ActivityTypeConfiguration {
323
369
  */
324
370
  defaultTaskPriority?: string;
325
371
  /**
372
+ * @public
326
373
  * <p>
327
374
  * The default maximum duration, specified when registering the activity type, that a task of an
328
375
  * activity type can wait before being assigned to a worker. You can override this default when scheduling a task
@@ -332,6 +379,7 @@ export interface ActivityTypeConfiguration {
332
379
  */
333
380
  defaultTaskScheduleToStartTimeout?: string;
334
381
  /**
382
+ * @public
335
383
  * <p>
336
384
  * The default maximum duration, specified when registering the activity type, for tasks of this activity
337
385
  * type. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code>
@@ -358,22 +406,27 @@ export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof Regist
358
406
  */
359
407
  export interface ActivityTypeInfo {
360
408
  /**
409
+ * @public
361
410
  * <p>The <a>ActivityType</a> type structure representing the activity type.</p>
362
411
  */
363
412
  activityType: ActivityType | undefined;
364
413
  /**
414
+ * @public
365
415
  * <p>The current status of the activity type.</p>
366
416
  */
367
417
  status: RegistrationStatus | string | undefined;
368
418
  /**
419
+ * @public
369
420
  * <p>The description of the activity type provided in <a>RegisterActivityType</a>.</p>
370
421
  */
371
422
  description?: string;
372
423
  /**
424
+ * @public
373
425
  * <p>The date and time this activity type was created through <a>RegisterActivityType</a>.</p>
374
426
  */
375
427
  creationDate: Date | undefined;
376
428
  /**
429
+ * @public
377
430
  * <p>If DEPRECATED, the date and time <a>DeprecateActivityType</a> was called.</p>
378
431
  */
379
432
  deprecationDate?: Date;
@@ -384,6 +437,7 @@ export interface ActivityTypeInfo {
384
437
  */
385
438
  export interface ActivityTypeDetail {
386
439
  /**
440
+ * @public
387
441
  * <p>General information about the activity type.</p>
388
442
  * <p>The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.</p>
389
443
  * <ul>
@@ -404,6 +458,7 @@ export interface ActivityTypeDetail {
404
458
  */
405
459
  typeInfo: ActivityTypeInfo | undefined;
406
460
  /**
461
+ * @public
407
462
  * <p>The configuration settings registered with the activity type.</p>
408
463
  */
409
464
  configuration: ActivityTypeConfiguration | undefined;
@@ -414,10 +469,12 @@ export interface ActivityTypeDetail {
414
469
  */
415
470
  export interface ActivityTypeInfos {
416
471
  /**
472
+ * @public
417
473
  * <p>List of activity type information.</p>
418
474
  */
419
475
  typeInfos: ActivityTypeInfo[] | undefined;
420
476
  /**
477
+ * @public
421
478
  * <p>If a <code>NextPageToken</code> was returned by a previous call, there are more
422
479
  * results available. To retrieve the next page of results, make the call again using the returned token in
423
480
  * <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
@@ -451,6 +508,7 @@ export interface ActivityTypeInfos {
451
508
  */
452
509
  export interface CancelTimerDecisionAttributes {
453
510
  /**
511
+ * @public
454
512
  * <p>
455
513
  * The unique ID of the timer to cancel.</p>
456
514
  */
@@ -474,10 +532,12 @@ export type CancelTimerFailedCause = (typeof CancelTimerFailedCause)[keyof typeo
474
532
  */
475
533
  export interface CancelTimerFailedEventAttributes {
476
534
  /**
535
+ * @public
477
536
  * <p>The timerId provided in the <code>CancelTimer</code> decision that failed.</p>
478
537
  */
479
538
  timerId: string | undefined;
480
539
  /**
540
+ * @public
481
541
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
482
542
  * <note>
483
543
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -487,6 +547,7 @@ export interface CancelTimerFailedEventAttributes {
487
547
  */
488
548
  cause: CancelTimerFailedCause | string | undefined;
489
549
  /**
550
+ * @public
490
551
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>CancelTimer</code> 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.</p>
491
552
  */
492
553
  decisionTaskCompletedEventId: number | undefined;
@@ -517,6 +578,7 @@ export interface CancelTimerFailedEventAttributes {
517
578
  */
518
579
  export interface CancelWorkflowExecutionDecisionAttributes {
519
580
  /**
581
+ * @public
520
582
  * <p>
521
583
  * Details of the cancellation.</p>
522
584
  */
@@ -540,6 +602,7 @@ export type CancelWorkflowExecutionFailedCause = (typeof CancelWorkflowExecution
540
602
  */
541
603
  export interface CancelWorkflowExecutionFailedEventAttributes {
542
604
  /**
605
+ * @public
543
606
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
544
607
  * <note>
545
608
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -549,6 +612,7 @@ export interface CancelWorkflowExecutionFailedEventAttributes {
549
612
  */
550
613
  cause: CancelWorkflowExecutionFailedCause | string | undefined;
551
614
  /**
615
+ * @public
552
616
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>CancelWorkflowExecution</code> 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.</p>
553
617
  */
554
618
  decisionTaskCompletedEventId: number | undefined;
@@ -572,6 +636,7 @@ export type ChildPolicy = (typeof ChildPolicy)[keyof typeof ChildPolicy];
572
636
  */
573
637
  export interface WorkflowType {
574
638
  /**
639
+ * @public
575
640
  * <p>
576
641
  * The name of the workflow type.</p>
577
642
  * <note>
@@ -580,6 +645,7 @@ export interface WorkflowType {
580
645
  */
581
646
  name: string | undefined;
582
647
  /**
648
+ * @public
583
649
  * <p>
584
650
  * The version of the workflow type.</p>
585
651
  * <note>
@@ -594,18 +660,22 @@ export interface WorkflowType {
594
660
  */
595
661
  export interface ChildWorkflowExecutionCanceledEventAttributes {
596
662
  /**
663
+ * @public
597
664
  * <p>The child workflow execution that was canceled.</p>
598
665
  */
599
666
  workflowExecution: WorkflowExecution | undefined;
600
667
  /**
668
+ * @public
601
669
  * <p>The type of the child workflow execution.</p>
602
670
  */
603
671
  workflowType: WorkflowType | undefined;
604
672
  /**
673
+ * @public
605
674
  * <p>Details of the cancellation (if provided).</p>
606
675
  */
607
676
  details?: string;
608
677
  /**
678
+ * @public
609
679
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the
610
680
  * <code>StartChildWorkflowExecution</code>
611
681
  * <a>Decision</a> to start this child workflow execution.
@@ -614,6 +684,7 @@ export interface ChildWorkflowExecutionCanceledEventAttributes {
614
684
  */
615
685
  initiatedEventId: number | undefined;
616
686
  /**
687
+ * @public
617
688
  * <p>The ID of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was
618
689
  * started. This information can be useful for diagnosing problems by tracing back the chain of
619
690
  * events leading up to this event.</p>
@@ -626,23 +697,28 @@ export interface ChildWorkflowExecutionCanceledEventAttributes {
626
697
  */
627
698
  export interface ChildWorkflowExecutionCompletedEventAttributes {
628
699
  /**
700
+ * @public
629
701
  * <p>The child workflow execution that was completed.</p>
630
702
  */
631
703
  workflowExecution: WorkflowExecution | undefined;
632
704
  /**
705
+ * @public
633
706
  * <p>The type of the child workflow execution.</p>
634
707
  */
635
708
  workflowType: WorkflowType | undefined;
636
709
  /**
710
+ * @public
637
711
  * <p>The result of the child workflow execution.</p>
638
712
  */
639
713
  result?: string;
640
714
  /**
715
+ * @public
641
716
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the <code>StartChildWorkflowExecution</code>
642
717
  * <a>Decision</a> 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.</p>
643
718
  */
644
719
  initiatedEventId: number | undefined;
645
720
  /**
721
+ * @public
646
722
  * <p>The ID of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was
647
723
  * started. This information can be useful for diagnosing problems by tracing back the chain of
648
724
  * events leading up to this event.</p>
@@ -655,22 +731,27 @@ export interface ChildWorkflowExecutionCompletedEventAttributes {
655
731
  */
656
732
  export interface ChildWorkflowExecutionFailedEventAttributes {
657
733
  /**
734
+ * @public
658
735
  * <p>The child workflow execution that failed.</p>
659
736
  */
660
737
  workflowExecution: WorkflowExecution | undefined;
661
738
  /**
739
+ * @public
662
740
  * <p>The type of the child workflow execution.</p>
663
741
  */
664
742
  workflowType: WorkflowType | undefined;
665
743
  /**
744
+ * @public
666
745
  * <p>The reason for the failure (if provided).</p>
667
746
  */
668
747
  reason?: string;
669
748
  /**
749
+ * @public
670
750
  * <p>The details of the failure (if provided).</p>
671
751
  */
672
752
  details?: string;
673
753
  /**
754
+ * @public
674
755
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the
675
756
  * <code>StartChildWorkflowExecution</code>
676
757
  * <a>Decision</a> to start this child workflow execution.
@@ -679,6 +760,7 @@ export interface ChildWorkflowExecutionFailedEventAttributes {
679
760
  */
680
761
  initiatedEventId: number | undefined;
681
762
  /**
763
+ * @public
682
764
  * <p>The ID of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was
683
765
  * started. This information can be useful for diagnosing problems by tracing back the chain of
684
766
  * events leading up to this event.</p>
@@ -691,14 +773,17 @@ export interface ChildWorkflowExecutionFailedEventAttributes {
691
773
  */
692
774
  export interface ChildWorkflowExecutionStartedEventAttributes {
693
775
  /**
776
+ * @public
694
777
  * <p>The child workflow execution that was started.</p>
695
778
  */
696
779
  workflowExecution: WorkflowExecution | undefined;
697
780
  /**
781
+ * @public
698
782
  * <p>The type of the child workflow execution.</p>
699
783
  */
700
784
  workflowType: WorkflowType | undefined;
701
785
  /**
786
+ * @public
702
787
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the
703
788
  * <code>StartChildWorkflowExecution</code>
704
789
  * <a>Decision</a> to start this child workflow execution.
@@ -713,14 +798,17 @@ export interface ChildWorkflowExecutionStartedEventAttributes {
713
798
  */
714
799
  export interface ChildWorkflowExecutionTerminatedEventAttributes {
715
800
  /**
801
+ * @public
716
802
  * <p>The child workflow execution that was terminated.</p>
717
803
  */
718
804
  workflowExecution: WorkflowExecution | undefined;
719
805
  /**
806
+ * @public
720
807
  * <p>The type of the child workflow execution.</p>
721
808
  */
722
809
  workflowType: WorkflowType | undefined;
723
810
  /**
811
+ * @public
724
812
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the
725
813
  * <code>StartChildWorkflowExecution</code>
726
814
  * <a>Decision</a> to start this child workflow execution.
@@ -729,6 +817,7 @@ export interface ChildWorkflowExecutionTerminatedEventAttributes {
729
817
  */
730
818
  initiatedEventId: number | undefined;
731
819
  /**
820
+ * @public
732
821
  * <p>The ID of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was
733
822
  * started. This information can be useful for diagnosing problems by tracing back the chain of
734
823
  * events leading up to this event.</p>
@@ -752,18 +841,22 @@ export type WorkflowExecutionTimeoutType = (typeof WorkflowExecutionTimeoutType)
752
841
  */
753
842
  export interface ChildWorkflowExecutionTimedOutEventAttributes {
754
843
  /**
844
+ * @public
755
845
  * <p>The child workflow execution that timed out.</p>
756
846
  */
757
847
  workflowExecution: WorkflowExecution | undefined;
758
848
  /**
849
+ * @public
759
850
  * <p>The type of the child workflow execution.</p>
760
851
  */
761
852
  workflowType: WorkflowType | undefined;
762
853
  /**
854
+ * @public
763
855
  * <p>The type of the timeout that caused the child workflow execution to time out.</p>
764
856
  */
765
857
  timeoutType: WorkflowExecutionTimeoutType | string | undefined;
766
858
  /**
859
+ * @public
767
860
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the
768
861
  * <code>StartChildWorkflowExecution</code>
769
862
  * <a>Decision</a> to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of
@@ -771,6 +864,7 @@ export interface ChildWorkflowExecutionTimedOutEventAttributes {
771
864
  */
772
865
  initiatedEventId: number | undefined;
773
866
  /**
867
+ * @public
774
868
  * <p>The ID of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was
775
869
  * started. This information can be useful for diagnosing problems by tracing back the chain of
776
870
  * events leading up to this event.</p>
@@ -799,6 +893,7 @@ export type CloseStatus = (typeof CloseStatus)[keyof typeof CloseStatus];
799
893
  */
800
894
  export interface CloseStatusFilter {
801
895
  /**
896
+ * @public
802
897
  * <p>
803
898
  * The close status that must match the close status of an execution for it to meet the criteria of
804
899
  * this filter.</p>
@@ -831,6 +926,7 @@ export interface CloseStatusFilter {
831
926
  */
832
927
  export interface CompleteWorkflowExecutionDecisionAttributes {
833
928
  /**
929
+ * @public
834
930
  * <p>The result of the workflow execution. The form of the result is implementation defined.</p>
835
931
  */
836
932
  result?: string;
@@ -853,6 +949,7 @@ export type CompleteWorkflowExecutionFailedCause = (typeof CompleteWorkflowExecu
853
949
  */
854
950
  export interface CompleteWorkflowExecutionFailedEventAttributes {
855
951
  /**
952
+ * @public
856
953
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
857
954
  * <note>
858
955
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -862,6 +959,7 @@ export interface CompleteWorkflowExecutionFailedEventAttributes {
862
959
  */
863
960
  cause: CompleteWorkflowExecutionFailedCause | string | undefined;
864
961
  /**
962
+ * @public
865
963
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
866
964
  * <code>CompleteWorkflowExecution</code> decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of
867
965
  * events leading up to this event.</p>
@@ -909,10 +1007,12 @@ export interface CompleteWorkflowExecutionFailedEventAttributes {
909
1007
  */
910
1008
  export interface ContinueAsNewWorkflowExecutionDecisionAttributes {
911
1009
  /**
1010
+ * @public
912
1011
  * <p>The input provided to the new workflow execution.</p>
913
1012
  */
914
1013
  input?: string;
915
1014
  /**
1015
+ * @public
916
1016
  * <p>If set, specifies the total duration for this workflow execution. This overrides the
917
1017
  * <code>defaultExecutionStartToCloseTimeout</code> specified when registering the workflow type.</p>
918
1018
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
@@ -922,11 +1022,13 @@ export interface ContinueAsNewWorkflowExecutionDecisionAttributes {
922
1022
  */
923
1023
  executionStartToCloseTimeout?: string;
924
1024
  /**
1025
+ * @public
925
1026
  * <p>The task list to use for the decisions of the new (continued) workflow
926
1027
  * execution.</p>
927
1028
  */
928
1029
  taskList?: TaskList;
929
1030
  /**
1031
+ * @public
930
1032
  * <p>
931
1033
  * The task priority that, if set, specifies the priority for the decision tasks for this workflow
932
1034
  * execution. This overrides the defaultTaskPriority specified when registering the workflow type.
@@ -936,6 +1038,7 @@ export interface ContinueAsNewWorkflowExecutionDecisionAttributes {
936
1038
  */
937
1039
  taskPriority?: string;
938
1040
  /**
1041
+ * @public
939
1042
  * <p>Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the
940
1043
  * <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using
941
1044
  * <a>RegisterWorkflowType</a>.</p>
@@ -946,6 +1049,7 @@ export interface ContinueAsNewWorkflowExecutionDecisionAttributes {
946
1049
  */
947
1050
  taskStartToCloseTimeout?: string;
948
1051
  /**
1052
+ * @public
949
1053
  * <p>If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated
950
1054
  * by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout. This policy
951
1055
  * overrides the default child policy specified when registering the workflow type using
@@ -973,16 +1077,19 @@ export interface ContinueAsNewWorkflowExecutionDecisionAttributes {
973
1077
  */
974
1078
  childPolicy?: ChildPolicy | string;
975
1079
  /**
1080
+ * @public
976
1081
  * <p>The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can
977
1082
  * list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a> or
978
1083
  * <a>ListClosedWorkflowExecutions</a> and specifying a <a>TagFilter</a>.</p>
979
1084
  */
980
1085
  tagList?: string[];
981
1086
  /**
1087
+ * @public
982
1088
  * <p>The version of the workflow to start.</p>
983
1089
  */
984
1090
  workflowTypeVersion?: string;
985
1091
  /**
1092
+ * @public
986
1093
  * <p>The IAM role to attach to the new (continued) execution.</p>
987
1094
  */
988
1095
  lambdaRole?: string;
@@ -1012,6 +1119,7 @@ export type ContinueAsNewWorkflowExecutionFailedCause = (typeof ContinueAsNewWor
1012
1119
  */
1013
1120
  export interface ContinueAsNewWorkflowExecutionFailedEventAttributes {
1014
1121
  /**
1122
+ * @public
1015
1123
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
1016
1124
  * <note>
1017
1125
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -1021,6 +1129,7 @@ export interface ContinueAsNewWorkflowExecutionFailedEventAttributes {
1021
1129
  */
1022
1130
  cause: ContinueAsNewWorkflowExecutionFailedCause | string | undefined;
1023
1131
  /**
1132
+ * @public
1024
1133
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
1025
1134
  * <code>ContinueAsNewWorkflowExecution</code> decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of
1026
1135
  * events leading up to this event.</p>
@@ -1036,10 +1145,12 @@ export interface ContinueAsNewWorkflowExecutionFailedEventAttributes {
1036
1145
  */
1037
1146
  export interface ExecutionTimeFilter {
1038
1147
  /**
1148
+ * @public
1039
1149
  * <p>Specifies the oldest start or close date and time to return.</p>
1040
1150
  */
1041
1151
  oldestDate: Date | undefined;
1042
1152
  /**
1153
+ * @public
1043
1154
  * <p>Specifies the latest start or close date and time to return.</p>
1044
1155
  */
1045
1156
  latestDate?: Date;
@@ -1050,6 +1161,7 @@ export interface ExecutionTimeFilter {
1050
1161
  */
1051
1162
  export interface WorkflowExecutionFilter {
1052
1163
  /**
1164
+ * @public
1053
1165
  * <p>The workflowId to pass of match the criteria of this filter.</p>
1054
1166
  */
1055
1167
  workflowId: string | undefined;
@@ -1060,6 +1172,7 @@ export interface WorkflowExecutionFilter {
1060
1172
  */
1061
1173
  export interface TagFilter {
1062
1174
  /**
1175
+ * @public
1063
1176
  * <p>
1064
1177
  * Specifies the tag that must be associated with the execution for it to meet the filter
1065
1178
  * criteria.</p>
@@ -1073,11 +1186,13 @@ export interface TagFilter {
1073
1186
  */
1074
1187
  export interface WorkflowTypeFilter {
1075
1188
  /**
1189
+ * @public
1076
1190
  * <p>
1077
1191
  * Name of the workflow type.</p>
1078
1192
  */
1079
1193
  name: string | undefined;
1080
1194
  /**
1195
+ * @public
1081
1196
  * <p>Version of the workflow type.</p>
1082
1197
  */
1083
1198
  version?: string;
@@ -1087,10 +1202,12 @@ export interface WorkflowTypeFilter {
1087
1202
  */
1088
1203
  export interface CountClosedWorkflowExecutionsInput {
1089
1204
  /**
1205
+ * @public
1090
1206
  * <p>The name of the domain containing the workflow executions to count.</p>
1091
1207
  */
1092
1208
  domain: string | undefined;
1093
1209
  /**
1210
+ * @public
1094
1211
  * <p>If specified, only workflow executions that meet the start time criteria of the filter
1095
1212
  * are counted.</p>
1096
1213
  * <note>
@@ -1101,6 +1218,7 @@ export interface CountClosedWorkflowExecutionsInput {
1101
1218
  */
1102
1219
  startTimeFilter?: ExecutionTimeFilter;
1103
1220
  /**
1221
+ * @public
1104
1222
  * <p>If specified, only workflow executions that meet the close time criteria of the filter
1105
1223
  * are counted.</p>
1106
1224
  * <note>
@@ -1111,6 +1229,7 @@ export interface CountClosedWorkflowExecutionsInput {
1111
1229
  */
1112
1230
  closeTimeFilter?: ExecutionTimeFilter;
1113
1231
  /**
1232
+ * @public
1114
1233
  * <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the
1115
1234
  * filter are counted.</p>
1116
1235
  * <note>
@@ -1122,6 +1241,7 @@ export interface CountClosedWorkflowExecutionsInput {
1122
1241
  */
1123
1242
  executionFilter?: WorkflowExecutionFilter;
1124
1243
  /**
1244
+ * @public
1125
1245
  * <p>If specified, indicates the type of the workflow executions to be counted.</p>
1126
1246
  * <note>
1127
1247
  * <p>
@@ -1132,6 +1252,7 @@ export interface CountClosedWorkflowExecutionsInput {
1132
1252
  */
1133
1253
  typeFilter?: WorkflowTypeFilter;
1134
1254
  /**
1255
+ * @public
1135
1256
  * <p>If specified, only executions that have a tag that matches the filter are
1136
1257
  * counted.</p>
1137
1258
  * <note>
@@ -1143,6 +1264,7 @@ export interface CountClosedWorkflowExecutionsInput {
1143
1264
  */
1144
1265
  tagFilter?: TagFilter;
1145
1266
  /**
1267
+ * @public
1146
1268
  * <p>If specified, only workflow executions that match this close status are counted. This
1147
1269
  * filter has an affect only if <code>executionStatus</code> is specified as
1148
1270
  * <code>CLOSED</code>.</p>
@@ -1187,10 +1309,12 @@ export declare class UnknownResourceFault extends __BaseException {
1187
1309
  */
1188
1310
  export interface WorkflowExecutionCount {
1189
1311
  /**
1312
+ * @public
1190
1313
  * <p>The number of workflow executions.</p>
1191
1314
  */
1192
1315
  count: number | undefined;
1193
1316
  /**
1317
+ * @public
1194
1318
  * <p>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.</p>
1195
1319
  */
1196
1320
  truncated?: boolean;
@@ -1200,15 +1324,18 @@ export interface WorkflowExecutionCount {
1200
1324
  */
1201
1325
  export interface CountOpenWorkflowExecutionsInput {
1202
1326
  /**
1327
+ * @public
1203
1328
  * <p>The name of the domain containing the workflow executions to count.</p>
1204
1329
  */
1205
1330
  domain: string | undefined;
1206
1331
  /**
1332
+ * @public
1207
1333
  * <p>Specifies the start time criteria that workflow executions must meet in order to be
1208
1334
  * counted.</p>
1209
1335
  */
1210
1336
  startTimeFilter: ExecutionTimeFilter | undefined;
1211
1337
  /**
1338
+ * @public
1212
1339
  * <p>Specifies the type of the workflow executions to be counted.</p>
1213
1340
  * <note>
1214
1341
  * <p>
@@ -1218,6 +1345,7 @@ export interface CountOpenWorkflowExecutionsInput {
1218
1345
  */
1219
1346
  typeFilter?: WorkflowTypeFilter;
1220
1347
  /**
1348
+ * @public
1221
1349
  * <p>If specified, only executions that have a tag that matches the filter are
1222
1350
  * counted.</p>
1223
1351
  * <note>
@@ -1228,6 +1356,7 @@ export interface CountOpenWorkflowExecutionsInput {
1228
1356
  */
1229
1357
  tagFilter?: TagFilter;
1230
1358
  /**
1359
+ * @public
1231
1360
  * <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the
1232
1361
  * filter are counted.</p>
1233
1362
  * <note>
@@ -1243,10 +1372,12 @@ export interface CountOpenWorkflowExecutionsInput {
1243
1372
  */
1244
1373
  export interface CountPendingActivityTasksInput {
1245
1374
  /**
1375
+ * @public
1246
1376
  * <p>The name of the domain that contains the task list.</p>
1247
1377
  */
1248
1378
  domain: string | undefined;
1249
1379
  /**
1380
+ * @public
1250
1381
  * <p>The name of the task list.</p>
1251
1382
  */
1252
1383
  taskList: TaskList | undefined;
@@ -1257,10 +1388,12 @@ export interface CountPendingActivityTasksInput {
1257
1388
  */
1258
1389
  export interface PendingTaskCount {
1259
1390
  /**
1391
+ * @public
1260
1392
  * <p>The number of tasks in the task list.</p>
1261
1393
  */
1262
1394
  count: number | undefined;
1263
1395
  /**
1396
+ * @public
1264
1397
  * <p>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.</p>
1265
1398
  */
1266
1399
  truncated?: boolean;
@@ -1270,10 +1403,12 @@ export interface PendingTaskCount {
1270
1403
  */
1271
1404
  export interface CountPendingDecisionTasksInput {
1272
1405
  /**
1406
+ * @public
1273
1407
  * <p>The name of the domain that contains the task list.</p>
1274
1408
  */
1275
1409
  domain: string | undefined;
1276
1410
  /**
1411
+ * @public
1277
1412
  * <p>The name of the task list.</p>
1278
1413
  */
1279
1414
  taskList: TaskList | undefined;
@@ -1328,10 +1463,12 @@ export type DecisionType = (typeof DecisionType)[keyof typeof DecisionType];
1328
1463
  */
1329
1464
  export interface FailWorkflowExecutionDecisionAttributes {
1330
1465
  /**
1466
+ * @public
1331
1467
  * <p>A descriptive reason for the failure that may help in diagnostics.</p>
1332
1468
  */
1333
1469
  reason?: string;
1334
1470
  /**
1471
+ * @public
1335
1472
  * <p>
1336
1473
  * Details of the failure.</p>
1337
1474
  */
@@ -1363,11 +1500,13 @@ export interface FailWorkflowExecutionDecisionAttributes {
1363
1500
  */
1364
1501
  export interface RecordMarkerDecisionAttributes {
1365
1502
  /**
1503
+ * @public
1366
1504
  * <p>
1367
1505
  * The name of the marker.</p>
1368
1506
  */
1369
1507
  markerName: string | undefined;
1370
1508
  /**
1509
+ * @public
1371
1510
  * <p>
1372
1511
  * The details of the marker.</p>
1373
1512
  */
@@ -1400,6 +1539,7 @@ export interface RecordMarkerDecisionAttributes {
1400
1539
  */
1401
1540
  export interface RequestCancelActivityTaskDecisionAttributes {
1402
1541
  /**
1542
+ * @public
1403
1543
  * <p>The <code>activityId</code> of the activity task to be canceled.</p>
1404
1544
  */
1405
1545
  activityId: string | undefined;
@@ -1430,15 +1570,18 @@ export interface RequestCancelActivityTaskDecisionAttributes {
1430
1570
  */
1431
1571
  export interface RequestCancelExternalWorkflowExecutionDecisionAttributes {
1432
1572
  /**
1573
+ * @public
1433
1574
  * <p>
1434
1575
  * The <code>workflowId</code> of the external workflow execution to cancel.</p>
1435
1576
  */
1436
1577
  workflowId: string | undefined;
1437
1578
  /**
1579
+ * @public
1438
1580
  * <p>The <code>runId</code> of the external workflow execution to cancel.</p>
1439
1581
  */
1440
1582
  runId?: string;
1441
1583
  /**
1584
+ * @public
1442
1585
  * <p>The data attached to the event that can be used by the decider in subsequent workflow tasks.</p>
1443
1586
  */
1444
1587
  control?: string;
@@ -1485,11 +1628,13 @@ export interface RequestCancelExternalWorkflowExecutionDecisionAttributes {
1485
1628
  */
1486
1629
  export interface ScheduleActivityTaskDecisionAttributes {
1487
1630
  /**
1631
+ * @public
1488
1632
  * <p>
1489
1633
  * The type of the activity task to schedule.</p>
1490
1634
  */
1491
1635
  activityType: ActivityType | undefined;
1492
1636
  /**
1637
+ * @public
1493
1638
  * <p>
1494
1639
  * The <code>activityId</code> of the activity task.</p>
1495
1640
  * <p>The specified string must not contain a
@@ -1499,14 +1644,17 @@ export interface ScheduleActivityTaskDecisionAttributes {
1499
1644
  */
1500
1645
  activityId: string | undefined;
1501
1646
  /**
1647
+ * @public
1502
1648
  * <p>Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.</p>
1503
1649
  */
1504
1650
  control?: string;
1505
1651
  /**
1652
+ * @public
1506
1653
  * <p>The input provided to the activity task.</p>
1507
1654
  */
1508
1655
  input?: string;
1509
1656
  /**
1657
+ * @public
1510
1658
  * <p>The maximum duration for this activity task.</p>
1511
1659
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
1512
1660
  * <note>
@@ -1515,6 +1663,7 @@ export interface ScheduleActivityTaskDecisionAttributes {
1515
1663
  */
1516
1664
  scheduleToCloseTimeout?: string;
1517
1665
  /**
1666
+ * @public
1518
1667
  * <p>If set, specifies the name of the task list in which to schedule the activity task. If not specified, the
1519
1668
  * <code>defaultTaskList</code> registered with the activity type is used.</p>
1520
1669
  * <note>
@@ -1527,6 +1676,7 @@ export interface ScheduleActivityTaskDecisionAttributes {
1527
1676
  */
1528
1677
  taskList?: TaskList;
1529
1678
  /**
1679
+ * @public
1530
1680
  * <p>
1531
1681
  * If set, specifies the priority with which the activity task is to be assigned to a worker. This
1532
1682
  * overrides the defaultTaskPriority specified when registering the activity type using <a>RegisterActivityType</a>.
@@ -1536,6 +1686,7 @@ export interface ScheduleActivityTaskDecisionAttributes {
1536
1686
  */
1537
1687
  taskPriority?: string;
1538
1688
  /**
1689
+ * @public
1539
1690
  * <p>
1540
1691
  * If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
1541
1692
  * This overrides the default schedule-to-start timeout specified when registering the activity type using
@@ -1547,6 +1698,7 @@ export interface ScheduleActivityTaskDecisionAttributes {
1547
1698
  */
1548
1699
  scheduleToStartTimeout?: string;
1549
1700
  /**
1701
+ * @public
1550
1702
  * <p>If set, specifies the maximum duration a worker may take to process this activity task. This overrides the
1551
1703
  * default start-to-close timeout specified when registering the activity type using <a>RegisterActivityType</a>.</p>
1552
1704
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
@@ -1556,6 +1708,7 @@ export interface ScheduleActivityTaskDecisionAttributes {
1556
1708
  */
1557
1709
  startToCloseTimeout?: string;
1558
1710
  /**
1711
+ * @public
1559
1712
  * <p>If set, specifies the maximum time before which a worker processing a task of this type must report progress by
1560
1713
  * calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed
1561
1714
  * out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This
@@ -1572,23 +1725,28 @@ export interface ScheduleActivityTaskDecisionAttributes {
1572
1725
  */
1573
1726
  export interface ScheduleLambdaFunctionDecisionAttributes {
1574
1727
  /**
1728
+ * @public
1575
1729
  * <p>A string that identifies the Lambda function execution in the event history.</p>
1576
1730
  */
1577
1731
  id: string | undefined;
1578
1732
  /**
1733
+ * @public
1579
1734
  * <p>The name, or ARN, of the Lambda function to schedule.</p>
1580
1735
  */
1581
1736
  name: string | undefined;
1582
1737
  /**
1738
+ * @public
1583
1739
  * <p>The data attached to the event that the decider can use in subsequent workflow tasks.
1584
1740
  * This data isn't sent to the Lambda task.</p>
1585
1741
  */
1586
1742
  control?: string;
1587
1743
  /**
1744
+ * @public
1588
1745
  * <p>The optional input data to be supplied to the Lambda function.</p>
1589
1746
  */
1590
1747
  input?: string;
1591
1748
  /**
1749
+ * @public
1592
1750
  * <p>The timeout value, in seconds, after which the Lambda function is considered to be
1593
1751
  * failed once it has started. This can be any integer from 1-900 (1s-15m).</p>
1594
1752
  * <p>If no value is supplied, then a default value of 900s is assumed.</p>
@@ -1621,27 +1779,32 @@ export interface ScheduleLambdaFunctionDecisionAttributes {
1621
1779
  */
1622
1780
  export interface SignalExternalWorkflowExecutionDecisionAttributes {
1623
1781
  /**
1782
+ * @public
1624
1783
  * <p>
1625
1784
  * The <code>workflowId</code> of the workflow execution to be signaled.</p>
1626
1785
  */
1627
1786
  workflowId: string | undefined;
1628
1787
  /**
1788
+ * @public
1629
1789
  * <p>The <code>runId</code> of the workflow execution to be signaled.</p>
1630
1790
  */
1631
1791
  runId?: string;
1632
1792
  /**
1793
+ * @public
1633
1794
  * <p>
1634
1795
  * The name of the signal.The target workflow execution uses the signal name and input to
1635
1796
  * process the signal.</p>
1636
1797
  */
1637
1798
  signalName: string | undefined;
1638
1799
  /**
1800
+ * @public
1639
1801
  * <p>
1640
1802
  * The input data to be provided with the signal. The target workflow execution uses the signal
1641
1803
  * name and input data to process the signal.</p>
1642
1804
  */
1643
1805
  input?: string;
1644
1806
  /**
1807
+ * @public
1645
1808
  * <p>The data attached to the event that can be used by the decider in subsequent decision tasks.</p>
1646
1809
  */
1647
1810
  control?: string;
@@ -1692,11 +1855,13 @@ export interface SignalExternalWorkflowExecutionDecisionAttributes {
1692
1855
  */
1693
1856
  export interface StartChildWorkflowExecutionDecisionAttributes {
1694
1857
  /**
1858
+ * @public
1695
1859
  * <p>
1696
1860
  * The type of the workflow execution to be started.</p>
1697
1861
  */
1698
1862
  workflowType: WorkflowType | undefined;
1699
1863
  /**
1864
+ * @public
1700
1865
  * <p>
1701
1866
  * The <code>workflowId</code> of the workflow execution.</p>
1702
1867
  * <p>The specified string must not contain a
@@ -1706,14 +1871,17 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1706
1871
  */
1707
1872
  workflowId: string | undefined;
1708
1873
  /**
1874
+ * @public
1709
1875
  * <p>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.</p>
1710
1876
  */
1711
1877
  control?: string;
1712
1878
  /**
1879
+ * @public
1713
1880
  * <p>The input to be provided to the workflow execution.</p>
1714
1881
  */
1715
1882
  input?: string;
1716
1883
  /**
1884
+ * @public
1717
1885
  * <p>The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.</p>
1718
1886
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
1719
1887
  * <note>
@@ -1722,6 +1890,7 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1722
1890
  */
1723
1891
  executionStartToCloseTimeout?: string;
1724
1892
  /**
1893
+ * @public
1725
1894
  * <p>The name of the task list to be used for decision tasks of the child workflow execution.</p>
1726
1895
  * <note>
1727
1896
  * <p>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.</p>
@@ -1733,6 +1902,7 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1733
1902
  */
1734
1903
  taskList?: TaskList;
1735
1904
  /**
1905
+ * @public
1736
1906
  * <p>
1737
1907
  * A task priority that, if set, specifies the priority for a decision task of this workflow
1738
1908
  * execution. This overrides the defaultTaskPriority specified when registering the workflow type.
@@ -1742,6 +1912,7 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1742
1912
  */
1743
1913
  taskPriority?: string;
1744
1914
  /**
1915
+ * @public
1745
1916
  * <p>Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the
1746
1917
  * <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using
1747
1918
  * <a>RegisterWorkflowType</a>.</p>
@@ -1752,6 +1923,7 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1752
1923
  */
1753
1924
  taskStartToCloseTimeout?: string;
1754
1925
  /**
1926
+ * @public
1755
1927
  * <p>
1756
1928
  * If set, specifies the policy to use for the child workflow executions if the workflow execution
1757
1929
  * being started is terminated by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an
@@ -1780,12 +1952,14 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1780
1952
  */
1781
1953
  childPolicy?: ChildPolicy | string;
1782
1954
  /**
1955
+ * @public
1783
1956
  * <p>The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can
1784
1957
  * list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a> or
1785
1958
  * <a>ListClosedWorkflowExecutions</a> and specifying a <a>TagFilter</a>.</p>
1786
1959
  */
1787
1960
  tagList?: string[];
1788
1961
  /**
1962
+ * @public
1789
1963
  * <p>The IAM role attached to the child workflow execution.</p>
1790
1964
  */
1791
1965
  lambdaRole?: string;
@@ -1816,6 +1990,7 @@ export interface StartChildWorkflowExecutionDecisionAttributes {
1816
1990
  */
1817
1991
  export interface StartTimerDecisionAttributes {
1818
1992
  /**
1993
+ * @public
1819
1994
  * <p>
1820
1995
  * The unique ID of the timer.</p>
1821
1996
  * <p>The specified string must not contain a
@@ -1825,10 +2000,12 @@ export interface StartTimerDecisionAttributes {
1825
2000
  */
1826
2001
  timerId: string | undefined;
1827
2002
  /**
2003
+ * @public
1828
2004
  * <p>The data attached to the event that can be used by the decider in subsequent workflow tasks.</p>
1829
2005
  */
1830
2006
  control?: string;
1831
2007
  /**
2008
+ * @public
1832
2009
  * <p>
1833
2010
  * The duration to wait before firing the timer.</p>
1834
2011
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>.</p>
@@ -2109,59 +2286,73 @@ export interface StartTimerDecisionAttributes {
2109
2286
  */
2110
2287
  export interface Decision {
2111
2288
  /**
2289
+ * @public
2112
2290
  * <p>Specifies the type of the decision.</p>
2113
2291
  */
2114
2292
  decisionType: DecisionType | string | undefined;
2115
2293
  /**
2294
+ * @public
2116
2295
  * <p>Provides the details of the <code>ScheduleActivityTask</code> decision. It isn't set for other decision types.</p>
2117
2296
  */
2118
2297
  scheduleActivityTaskDecisionAttributes?: ScheduleActivityTaskDecisionAttributes;
2119
2298
  /**
2299
+ * @public
2120
2300
  * <p>Provides the details of the <code>RequestCancelActivityTask</code> decision. It isn't set for other decision types.</p>
2121
2301
  */
2122
2302
  requestCancelActivityTaskDecisionAttributes?: RequestCancelActivityTaskDecisionAttributes;
2123
2303
  /**
2304
+ * @public
2124
2305
  * <p>Provides the details of the <code>CompleteWorkflowExecution</code> decision. It isn't set for other decision types.</p>
2125
2306
  */
2126
2307
  completeWorkflowExecutionDecisionAttributes?: CompleteWorkflowExecutionDecisionAttributes;
2127
2308
  /**
2309
+ * @public
2128
2310
  * <p>Provides the details of the <code>FailWorkflowExecution</code> decision. It isn't set for other decision types.</p>
2129
2311
  */
2130
2312
  failWorkflowExecutionDecisionAttributes?: FailWorkflowExecutionDecisionAttributes;
2131
2313
  /**
2314
+ * @public
2132
2315
  * <p>Provides the details of the <code>CancelWorkflowExecution</code> decision. It isn't set for other decision types.</p>
2133
2316
  */
2134
2317
  cancelWorkflowExecutionDecisionAttributes?: CancelWorkflowExecutionDecisionAttributes;
2135
2318
  /**
2319
+ * @public
2136
2320
  * <p>Provides the details of the <code>ContinueAsNewWorkflowExecution</code> decision. It isn't set for other decision types.</p>
2137
2321
  */
2138
2322
  continueAsNewWorkflowExecutionDecisionAttributes?: ContinueAsNewWorkflowExecutionDecisionAttributes;
2139
2323
  /**
2324
+ * @public
2140
2325
  * <p>Provides the details of the <code>RecordMarker</code> decision. It isn't set for other decision types.</p>
2141
2326
  */
2142
2327
  recordMarkerDecisionAttributes?: RecordMarkerDecisionAttributes;
2143
2328
  /**
2329
+ * @public
2144
2330
  * <p>Provides the details of the <code>StartTimer</code> decision. It isn't set for other decision types.</p>
2145
2331
  */
2146
2332
  startTimerDecisionAttributes?: StartTimerDecisionAttributes;
2147
2333
  /**
2334
+ * @public
2148
2335
  * <p>Provides the details of the <code>CancelTimer</code> decision. It isn't set for other decision types.</p>
2149
2336
  */
2150
2337
  cancelTimerDecisionAttributes?: CancelTimerDecisionAttributes;
2151
2338
  /**
2339
+ * @public
2152
2340
  * <p>Provides the details of the <code>SignalExternalWorkflowExecution</code> decision. It isn't set for other decision types.</p>
2153
2341
  */
2154
2342
  signalExternalWorkflowExecutionDecisionAttributes?: SignalExternalWorkflowExecutionDecisionAttributes;
2155
2343
  /**
2344
+ * @public
2156
2345
  * <p>Provides the details of the <code>RequestCancelExternalWorkflowExecution</code> decision.
2157
2346
  * It isn't set for other decision types.</p>
2158
2347
  */
2159
2348
  requestCancelExternalWorkflowExecutionDecisionAttributes?: RequestCancelExternalWorkflowExecutionDecisionAttributes;
2160
2349
  /**
2350
+ * @public
2161
2351
  * <p>Provides the details of the <code>StartChildWorkflowExecution</code> decision. It isn't set for other decision types.</p>
2162
2352
  */
2163
2353
  startChildWorkflowExecutionDecisionAttributes?: StartChildWorkflowExecutionDecisionAttributes;
2164
2354
  /**
2355
+ * @public
2165
2356
  * <p>Provides the details of the <code>ScheduleLambdaFunction</code> decision. It isn't set
2166
2357
  * for other decision types.</p>
2167
2358
  */
@@ -2173,16 +2364,19 @@ export interface Decision {
2173
2364
  */
2174
2365
  export interface DecisionTaskCompletedEventAttributes {
2175
2366
  /**
2367
+ * @public
2176
2368
  * <p>User defined context for the workflow execution.</p>
2177
2369
  */
2178
2370
  executionContext?: string;
2179
2371
  /**
2372
+ * @public
2180
2373
  * <p>The ID of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was scheduled.
2181
2374
  * This information can be useful for diagnosing problems by tracing back the chain of
2182
2375
  * events leading up to this event.</p>
2183
2376
  */
2184
2377
  scheduledEventId: number | undefined;
2185
2378
  /**
2379
+ * @public
2186
2380
  * <p>The ID of the <code>DecisionTaskStarted</code> event recorded when this decision task was started.
2187
2381
  * This information can be useful for diagnosing problems by tracing back the chain of
2188
2382
  * events leading up to this event.</p>
@@ -2195,10 +2389,12 @@ export interface DecisionTaskCompletedEventAttributes {
2195
2389
  */
2196
2390
  export interface DecisionTaskScheduledEventAttributes {
2197
2391
  /**
2392
+ * @public
2198
2393
  * <p>The name of the task list in which the decision task was scheduled.</p>
2199
2394
  */
2200
2395
  taskList: TaskList | undefined;
2201
2396
  /**
2397
+ * @public
2202
2398
  * <p>
2203
2399
  * A task priority that, if set, specifies the priority for this decision task.
2204
2400
  * Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code>
@@ -2207,6 +2403,7 @@ export interface DecisionTaskScheduledEventAttributes {
2207
2403
  */
2208
2404
  taskPriority?: string;
2209
2405
  /**
2406
+ * @public
2210
2407
  * <p>The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.</p>
2211
2408
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
2212
2409
  */
@@ -2218,10 +2415,12 @@ export interface DecisionTaskScheduledEventAttributes {
2218
2415
  */
2219
2416
  export interface DecisionTaskStartedEventAttributes {
2220
2417
  /**
2418
+ * @public
2221
2419
  * <p>Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.</p>
2222
2420
  */
2223
2421
  identity?: string;
2224
2422
  /**
2423
+ * @public
2225
2424
  * <p>The ID of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was scheduled.
2226
2425
  * This information can be useful for diagnosing problems by tracing back the chain of
2227
2426
  * events leading up to this event.</p>
@@ -2245,16 +2444,19 @@ export type DecisionTaskTimeoutType = (typeof DecisionTaskTimeoutType)[keyof typ
2245
2444
  */
2246
2445
  export interface DecisionTaskTimedOutEventAttributes {
2247
2446
  /**
2447
+ * @public
2248
2448
  * <p>The type of timeout that expired before the decision task could be completed.</p>
2249
2449
  */
2250
2450
  timeoutType: DecisionTaskTimeoutType | string | undefined;
2251
2451
  /**
2452
+ * @public
2252
2453
  * <p>The ID of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was scheduled.
2253
2454
  * This information can be useful for diagnosing problems by tracing back the chain of
2254
2455
  * events leading up to this event.</p>
2255
2456
  */
2256
2457
  scheduledEventId: number | undefined;
2257
2458
  /**
2459
+ * @public
2258
2460
  * <p>The ID of the <code>DecisionTaskStarted</code> event recorded when this decision task was started. This
2259
2461
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
2260
2462
  * event.</p>
@@ -2331,10 +2533,12 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
2331
2533
  */
2332
2534
  export interface ExternalWorkflowExecutionCancelRequestedEventAttributes {
2333
2535
  /**
2536
+ * @public
2334
2537
  * <p>The external workflow execution to which the cancellation request was delivered.</p>
2335
2538
  */
2336
2539
  workflowExecution: WorkflowExecution | undefined;
2337
2540
  /**
2541
+ * @public
2338
2542
  * <p>The ID of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the
2339
2543
  * <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution. This
2340
2544
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
@@ -2348,10 +2552,12 @@ export interface ExternalWorkflowExecutionCancelRequestedEventAttributes {
2348
2552
  */
2349
2553
  export interface ExternalWorkflowExecutionSignaledEventAttributes {
2350
2554
  /**
2555
+ * @public
2351
2556
  * <p>The external workflow execution that the signal was delivered to.</p>
2352
2557
  */
2353
2558
  workflowExecution: WorkflowExecution | undefined;
2354
2559
  /**
2560
+ * @public
2355
2561
  * <p>The ID of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the
2356
2562
  * <code>SignalExternalWorkflowExecution</code> decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of
2357
2563
  * events leading up to this event.</p>
@@ -2376,6 +2582,7 @@ export type FailWorkflowExecutionFailedCause = (typeof FailWorkflowExecutionFail
2376
2582
  */
2377
2583
  export interface FailWorkflowExecutionFailedEventAttributes {
2378
2584
  /**
2585
+ * @public
2379
2586
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2380
2587
  * <note>
2381
2588
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -2385,6 +2592,7 @@ export interface FailWorkflowExecutionFailedEventAttributes {
2385
2592
  */
2386
2593
  cause: FailWorkflowExecutionFailedCause | string | undefined;
2387
2594
  /**
2595
+ * @public
2388
2596
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2389
2597
  * <code>FailWorkflowExecution</code> decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of
2390
2598
  * events leading up to this event.</p>
@@ -2398,16 +2606,19 @@ export interface FailWorkflowExecutionFailedEventAttributes {
2398
2606
  */
2399
2607
  export interface LambdaFunctionCompletedEventAttributes {
2400
2608
  /**
2609
+ * @public
2401
2610
  * <p>The ID of the <code>LambdaFunctionScheduled</code> event that was recorded when this
2402
2611
  * Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2403
2612
  */
2404
2613
  scheduledEventId: number | undefined;
2405
2614
  /**
2615
+ * @public
2406
2616
  * <p>The ID of the <code>LambdaFunctionStarted</code> event recorded when this activity task
2407
2617
  * started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2408
2618
  */
2409
2619
  startedEventId: number | undefined;
2410
2620
  /**
2621
+ * @public
2411
2622
  * <p>The results of the Lambda task.</p>
2412
2623
  */
2413
2624
  result?: string;
@@ -2419,20 +2630,24 @@ export interface LambdaFunctionCompletedEventAttributes {
2419
2630
  */
2420
2631
  export interface LambdaFunctionFailedEventAttributes {
2421
2632
  /**
2633
+ * @public
2422
2634
  * <p>The ID of the <code>LambdaFunctionScheduled</code> event that was recorded when this
2423
2635
  * activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2424
2636
  */
2425
2637
  scheduledEventId: number | undefined;
2426
2638
  /**
2639
+ * @public
2427
2640
  * <p>The ID of the <code>LambdaFunctionStarted</code> event recorded when this activity task
2428
2641
  * started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2429
2642
  */
2430
2643
  startedEventId: number | undefined;
2431
2644
  /**
2645
+ * @public
2432
2646
  * <p>The reason provided for the failure.</p>
2433
2647
  */
2434
2648
  reason?: string;
2435
2649
  /**
2650
+ * @public
2436
2651
  * <p>The details of the failure.</p>
2437
2652
  */
2438
2653
  details?: string;
@@ -2444,27 +2659,33 @@ export interface LambdaFunctionFailedEventAttributes {
2444
2659
  */
2445
2660
  export interface LambdaFunctionScheduledEventAttributes {
2446
2661
  /**
2662
+ * @public
2447
2663
  * <p>The unique ID of the Lambda task.</p>
2448
2664
  */
2449
2665
  id: string | undefined;
2450
2666
  /**
2667
+ * @public
2451
2668
  * <p>The name of the Lambda function.</p>
2452
2669
  */
2453
2670
  name: string | undefined;
2454
2671
  /**
2672
+ * @public
2455
2673
  * <p>Data attached to the event that the decider can use in subsequent workflow tasks. This
2456
2674
  * data isn't sent to the Lambda task.</p>
2457
2675
  */
2458
2676
  control?: string;
2459
2677
  /**
2678
+ * @public
2460
2679
  * <p>The input provided to the Lambda task.</p>
2461
2680
  */
2462
2681
  input?: string;
2463
2682
  /**
2683
+ * @public
2464
2684
  * <p>The maximum amount of time a worker can take to process the Lambda task.</p>
2465
2685
  */
2466
2686
  startToCloseTimeout?: string;
2467
2687
  /**
2688
+ * @public
2468
2689
  * <p>The ID of the <code>LambdaFunctionCompleted</code> event corresponding to the decision
2469
2690
  * 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.</p>
2470
2691
  */
@@ -2477,6 +2698,7 @@ export interface LambdaFunctionScheduledEventAttributes {
2477
2698
  */
2478
2699
  export interface LambdaFunctionStartedEventAttributes {
2479
2700
  /**
2701
+ * @public
2480
2702
  * <p>The ID of the <code>LambdaFunctionScheduled</code> event that was recorded when this
2481
2703
  * activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2482
2704
  */
@@ -2499,16 +2721,19 @@ export type LambdaFunctionTimeoutType = (typeof LambdaFunctionTimeoutType)[keyof
2499
2721
  */
2500
2722
  export interface LambdaFunctionTimedOutEventAttributes {
2501
2723
  /**
2724
+ * @public
2502
2725
  * <p>The ID of the <code>LambdaFunctionScheduled</code> event that was recorded when this
2503
2726
  * activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2504
2727
  */
2505
2728
  scheduledEventId: number | undefined;
2506
2729
  /**
2730
+ * @public
2507
2731
  * <p>The ID of the <code>ActivityTaskStarted</code> event that was recorded when this
2508
2732
  * activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2509
2733
  */
2510
2734
  startedEventId: number | undefined;
2511
2735
  /**
2736
+ * @public
2512
2737
  * <p>The type of the timeout that caused this event.</p>
2513
2738
  */
2514
2739
  timeoutType?: LambdaFunctionTimeoutType | string;
@@ -2519,14 +2744,17 @@ export interface LambdaFunctionTimedOutEventAttributes {
2519
2744
  */
2520
2745
  export interface MarkerRecordedEventAttributes {
2521
2746
  /**
2747
+ * @public
2522
2748
  * <p>The name of the marker.</p>
2523
2749
  */
2524
2750
  markerName: string | undefined;
2525
2751
  /**
2752
+ * @public
2526
2753
  * <p>The details of the marker.</p>
2527
2754
  */
2528
2755
  details?: string;
2529
2756
  /**
2757
+ * @public
2530
2758
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2531
2759
  * <code>RecordMarker</code> decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of
2532
2760
  * events leading up to this event.</p>
@@ -2550,10 +2778,12 @@ export type RecordMarkerFailedCause = (typeof RecordMarkerFailedCause)[keyof typ
2550
2778
  */
2551
2779
  export interface RecordMarkerFailedEventAttributes {
2552
2780
  /**
2781
+ * @public
2553
2782
  * <p>The marker's name.</p>
2554
2783
  */
2555
2784
  markerName: string | undefined;
2556
2785
  /**
2786
+ * @public
2557
2787
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2558
2788
  * <note>
2559
2789
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -2563,6 +2793,7 @@ export interface RecordMarkerFailedEventAttributes {
2563
2793
  */
2564
2794
  cause: RecordMarkerFailedCause | string | undefined;
2565
2795
  /**
2796
+ * @public
2566
2797
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2567
2798
  * <code>RecordMarkerFailed</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of
2568
2799
  * events leading up to this event.</p>
@@ -2587,10 +2818,12 @@ export type RequestCancelActivityTaskFailedCause = (typeof RequestCancelActivity
2587
2818
  */
2588
2819
  export interface RequestCancelActivityTaskFailedEventAttributes {
2589
2820
  /**
2821
+ * @public
2590
2822
  * <p>The activityId provided in the <code>RequestCancelActivityTask</code> decision that failed.</p>
2591
2823
  */
2592
2824
  activityId: string | undefined;
2593
2825
  /**
2826
+ * @public
2594
2827
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2595
2828
  * <note>
2596
2829
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -2600,6 +2833,7 @@ export interface RequestCancelActivityTaskFailedEventAttributes {
2600
2833
  */
2601
2834
  cause: RequestCancelActivityTaskFailedCause | string | undefined;
2602
2835
  /**
2836
+ * @public
2603
2837
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2604
2838
  * <code>RequestCancelActivityTask</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of
2605
2839
  * events leading up to this event.</p>
@@ -2625,14 +2859,17 @@ export type RequestCancelExternalWorkflowExecutionFailedCause = (typeof RequestC
2625
2859
  */
2626
2860
  export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes {
2627
2861
  /**
2862
+ * @public
2628
2863
  * <p>The <code>workflowId</code> of the external workflow to which the cancel request was to be delivered.</p>
2629
2864
  */
2630
2865
  workflowId: string | undefined;
2631
2866
  /**
2867
+ * @public
2632
2868
  * <p>The <code>runId</code> of the external workflow execution.</p>
2633
2869
  */
2634
2870
  runId?: string;
2635
2871
  /**
2872
+ * @public
2636
2873
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2637
2874
  * <note>
2638
2875
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -2642,6 +2879,7 @@ export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes {
2642
2879
  */
2643
2880
  cause: RequestCancelExternalWorkflowExecutionFailedCause | string | undefined;
2644
2881
  /**
2882
+ * @public
2645
2883
  * <p>The ID of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the
2646
2884
  * <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution. This
2647
2885
  * information can be useful for diagnosing problems by tracing back the chain of events leading up to this
@@ -2649,12 +2887,14 @@ export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes {
2649
2887
  */
2650
2888
  initiatedEventId: number | undefined;
2651
2889
  /**
2890
+ * @public
2652
2891
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2653
2892
  * <code>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of
2654
2893
  * events leading up to this event.</p>
2655
2894
  */
2656
2895
  decisionTaskCompletedEventId: number | undefined;
2657
2896
  /**
2897
+ * @public
2658
2898
  * <p>The data attached to the event that the decider can use in subsequent workflow tasks.
2659
2899
  * This data isn't sent to the workflow execution.</p>
2660
2900
  */
@@ -2666,14 +2906,17 @@ export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes {
2666
2906
  */
2667
2907
  export interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributes {
2668
2908
  /**
2909
+ * @public
2669
2910
  * <p>The <code>workflowId</code> of the external workflow execution to be canceled.</p>
2670
2911
  */
2671
2912
  workflowId: string | undefined;
2672
2913
  /**
2914
+ * @public
2673
2915
  * <p>The <code>runId</code> of the external workflow execution to be canceled.</p>
2674
2916
  */
2675
2917
  runId?: string;
2676
2918
  /**
2919
+ * @public
2677
2920
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2678
2921
  * <code>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request.
2679
2922
  * This information can be useful for diagnosing problems by tracing back the chain of
@@ -2681,6 +2924,7 @@ export interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
2681
2924
  */
2682
2925
  decisionTaskCompletedEventId: number | undefined;
2683
2926
  /**
2927
+ * @public
2684
2928
  * <p>Data attached to the event that can be used by the decider in subsequent workflow tasks.</p>
2685
2929
  */
2686
2930
  control?: string;
@@ -2712,14 +2956,17 @@ export type ScheduleActivityTaskFailedCause = (typeof ScheduleActivityTaskFailed
2712
2956
  */
2713
2957
  export interface ScheduleActivityTaskFailedEventAttributes {
2714
2958
  /**
2959
+ * @public
2715
2960
  * <p>The activity type provided in the <code>ScheduleActivityTask</code> decision that failed.</p>
2716
2961
  */
2717
2962
  activityType: ActivityType | undefined;
2718
2963
  /**
2964
+ * @public
2719
2965
  * <p>The activityId provided in the <code>ScheduleActivityTask</code> decision that failed.</p>
2720
2966
  */
2721
2967
  activityId: string | undefined;
2722
2968
  /**
2969
+ * @public
2723
2970
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2724
2971
  * <note>
2725
2972
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -2729,6 +2976,7 @@ export interface ScheduleActivityTaskFailedEventAttributes {
2729
2976
  */
2730
2977
  cause: ScheduleActivityTaskFailedCause | string | undefined;
2731
2978
  /**
2979
+ * @public
2732
2980
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision that resulted in the
2733
2981
  * scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of
2734
2982
  * events leading up to this event.</p>
@@ -2756,15 +3004,18 @@ export type ScheduleLambdaFunctionFailedCause = (typeof ScheduleLambdaFunctionFa
2756
3004
  */
2757
3005
  export interface ScheduleLambdaFunctionFailedEventAttributes {
2758
3006
  /**
3007
+ * @public
2759
3008
  * <p>The ID provided in the <code>ScheduleLambdaFunction</code> decision that failed.
2760
3009
  * </p>
2761
3010
  */
2762
3011
  id: string | undefined;
2763
3012
  /**
3013
+ * @public
2764
3014
  * <p>The name of the Lambda function.</p>
2765
3015
  */
2766
3016
  name: string | undefined;
2767
3017
  /**
3018
+ * @public
2768
3019
  * <p>The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
2769
3020
  * <note>
2770
3021
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision
@@ -2776,6 +3027,7 @@ export interface ScheduleLambdaFunctionFailedEventAttributes {
2776
3027
  */
2777
3028
  cause: ScheduleLambdaFunctionFailedCause | string | undefined;
2778
3029
  /**
3030
+ * @public
2779
3031
  * <p>The ID of the <code>LambdaFunctionCompleted</code> event corresponding to the decision
2780
3032
  * 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.</p>
2781
3033
  */
@@ -2800,14 +3052,17 @@ export type SignalExternalWorkflowExecutionFailedCause = (typeof SignalExternalW
2800
3052
  */
2801
3053
  export interface SignalExternalWorkflowExecutionFailedEventAttributes {
2802
3054
  /**
3055
+ * @public
2803
3056
  * <p>The <code>workflowId</code> of the external workflow execution that the signal was being delivered to.</p>
2804
3057
  */
2805
3058
  workflowId: string | undefined;
2806
3059
  /**
3060
+ * @public
2807
3061
  * <p>The <code>runId</code> of the external workflow execution that the signal was being delivered to.</p>
2808
3062
  */
2809
3063
  runId?: string;
2810
3064
  /**
3065
+ * @public
2811
3066
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2812
3067
  * <note>
2813
3068
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -2817,18 +3072,21 @@ export interface SignalExternalWorkflowExecutionFailedEventAttributes {
2817
3072
  */
2818
3073
  cause: SignalExternalWorkflowExecutionFailedCause | string | undefined;
2819
3074
  /**
3075
+ * @public
2820
3076
  * <p>The ID of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the
2821
3077
  * <code>SignalExternalWorkflowExecution</code> decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of
2822
3078
  * events leading up to this event.</p>
2823
3079
  */
2824
3080
  initiatedEventId: number | undefined;
2825
3081
  /**
3082
+ * @public
2826
3083
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2827
3084
  * <code>SignalExternalWorkflowExecution</code> decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of
2828
3085
  * events leading up to this event.</p>
2829
3086
  */
2830
3087
  decisionTaskCompletedEventId: number | undefined;
2831
3088
  /**
3089
+ * @public
2832
3090
  * <p>The data attached to the event that the decider can use in subsequent workflow tasks.
2833
3091
  * This data isn't sent to the workflow execution.</p>
2834
3092
  */
@@ -2840,28 +3098,34 @@ export interface SignalExternalWorkflowExecutionFailedEventAttributes {
2840
3098
  */
2841
3099
  export interface SignalExternalWorkflowExecutionInitiatedEventAttributes {
2842
3100
  /**
3101
+ * @public
2843
3102
  * <p>The <code>workflowId</code> of the external workflow execution.</p>
2844
3103
  */
2845
3104
  workflowId: string | undefined;
2846
3105
  /**
3106
+ * @public
2847
3107
  * <p>The <code>runId</code> of the external workflow execution to send the signal to.</p>
2848
3108
  */
2849
3109
  runId?: string;
2850
3110
  /**
3111
+ * @public
2851
3112
  * <p>The name of the signal.</p>
2852
3113
  */
2853
3114
  signalName: string | undefined;
2854
3115
  /**
3116
+ * @public
2855
3117
  * <p>The input provided to the signal.</p>
2856
3118
  */
2857
3119
  input?: string;
2858
3120
  /**
3121
+ * @public
2859
3122
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2860
3123
  * <code>SignalExternalWorkflowExecution</code> decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of
2861
3124
  * events leading up to this event.</p>
2862
3125
  */
2863
3126
  decisionTaskCompletedEventId: number | undefined;
2864
3127
  /**
3128
+ * @public
2865
3129
  * <p>Data attached to the event that can be used by the decider in subsequent decision tasks.</p>
2866
3130
  */
2867
3131
  control?: string;
@@ -2893,11 +3157,13 @@ export type StartChildWorkflowExecutionFailedCause = (typeof StartChildWorkflowE
2893
3157
  */
2894
3158
  export interface StartChildWorkflowExecutionFailedEventAttributes {
2895
3159
  /**
3160
+ * @public
2896
3161
  * <p>The workflow type provided in the <code>StartChildWorkflowExecution</code>
2897
3162
  * <a>Decision</a> that failed.</p>
2898
3163
  */
2899
3164
  workflowType: WorkflowType | undefined;
2900
3165
  /**
3166
+ * @public
2901
3167
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
2902
3168
  * <note>
2903
3169
  * <p>When <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision fails because it lacks sufficient permissions.
@@ -2907,10 +3173,12 @@ export interface StartChildWorkflowExecutionFailedEventAttributes {
2907
3173
  */
2908
3174
  cause: StartChildWorkflowExecutionFailedCause | string | undefined;
2909
3175
  /**
3176
+ * @public
2910
3177
  * <p>The <code>workflowId</code> of the child workflow execution.</p>
2911
3178
  */
2912
3179
  workflowId: string | undefined;
2913
3180
  /**
3181
+ * @public
2914
3182
  * <p>When the <code>cause</code> is <code>WORKFLOW_ALREADY_RUNNING</code>, <code>initiatedEventId</code> is the ID of the <code>StartChildWorkflowExecutionInitiated</code>
2915
3183
  * event that corresponds to the <code>StartChildWorkflowExecution</code>
2916
3184
  * <a>Decision</a> to start the workflow execution. You can use this information to diagnose
@@ -2920,11 +3188,13 @@ export interface StartChildWorkflowExecutionFailedEventAttributes {
2920
3188
  */
2921
3189
  initiatedEventId: number | undefined;
2922
3190
  /**
3191
+ * @public
2923
3192
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>StartChildWorkflowExecution</code>
2924
3193
  * <a>Decision</a> to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.</p>
2925
3194
  */
2926
3195
  decisionTaskCompletedEventId: number | undefined;
2927
3196
  /**
3197
+ * @public
2928
3198
  * <p>The data attached to the event that the decider can use in subsequent workflow tasks.
2929
3199
  * This data isn't sent to the child workflow execution.</p>
2930
3200
  */
@@ -2936,31 +3206,38 @@ export interface StartChildWorkflowExecutionFailedEventAttributes {
2936
3206
  */
2937
3207
  export interface StartChildWorkflowExecutionInitiatedEventAttributes {
2938
3208
  /**
3209
+ * @public
2939
3210
  * <p>The <code>workflowId</code> of the child workflow execution.</p>
2940
3211
  */
2941
3212
  workflowId: string | undefined;
2942
3213
  /**
3214
+ * @public
2943
3215
  * <p>The type of the child workflow execution.</p>
2944
3216
  */
2945
3217
  workflowType: WorkflowType | undefined;
2946
3218
  /**
3219
+ * @public
2947
3220
  * <p>Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.</p>
2948
3221
  */
2949
3222
  control?: string;
2950
3223
  /**
3224
+ * @public
2951
3225
  * <p>The inputs provided to the child workflow execution.</p>
2952
3226
  */
2953
3227
  input?: string;
2954
3228
  /**
3229
+ * @public
2955
3230
  * <p>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.</p>
2956
3231
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
2957
3232
  */
2958
3233
  executionStartToCloseTimeout?: string;
2959
3234
  /**
3235
+ * @public
2960
3236
  * <p>The name of the task list used for the decision tasks of the child workflow execution.</p>
2961
3237
  */
2962
3238
  taskList: TaskList | undefined;
2963
3239
  /**
3240
+ * @public
2964
3241
  * <p>
2965
3242
  * The priority assigned for the decision tasks for this workflow execution.
2966
3243
  * Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code>
@@ -2969,6 +3246,7 @@ export interface StartChildWorkflowExecutionInitiatedEventAttributes {
2969
3246
  */
2970
3247
  taskPriority?: string;
2971
3248
  /**
3249
+ * @public
2972
3250
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
2973
3251
  * <code>StartChildWorkflowExecution</code>
2974
3252
  * <a>Decision</a> to request this child workflow execution. This
@@ -2976,6 +3254,7 @@ export interface StartChildWorkflowExecutionInitiatedEventAttributes {
2976
3254
  */
2977
3255
  decisionTaskCompletedEventId: number | undefined;
2978
3256
  /**
3257
+ * @public
2979
3258
  * <p>The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the
2980
3259
  * <a>TerminateWorkflowExecution</a> action or due to an expired timeout.</p>
2981
3260
  * <p>The supported child policies are:</p>
@@ -2998,15 +3277,18 @@ export interface StartChildWorkflowExecutionInitiatedEventAttributes {
2998
3277
  */
2999
3278
  childPolicy: ChildPolicy | string | undefined;
3000
3279
  /**
3280
+ * @public
3001
3281
  * <p>The maximum duration allowed for the decision tasks for this workflow execution.</p>
3002
3282
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
3003
3283
  */
3004
3284
  taskStartToCloseTimeout?: string;
3005
3285
  /**
3286
+ * @public
3006
3287
  * <p>The list of tags to associated with the child workflow execution.</p>
3007
3288
  */
3008
3289
  tagList?: string[];
3009
3290
  /**
3291
+ * @public
3010
3292
  * <p>The IAM role to attach to the child workflow execution.</p>
3011
3293
  */
3012
3294
  lambdaRole?: string;
@@ -3029,11 +3311,13 @@ export type StartLambdaFunctionFailedCause = (typeof StartLambdaFunctionFailedCa
3029
3311
  */
3030
3312
  export interface StartLambdaFunctionFailedEventAttributes {
3031
3313
  /**
3314
+ * @public
3032
3315
  * <p>The ID of the <code>ActivityTaskScheduled</code> event that was recorded when this
3033
3316
  * activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
3034
3317
  */
3035
3318
  scheduledEventId?: number;
3036
3319
  /**
3320
+ * @public
3037
3321
  * <p>The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.</p>
3038
3322
  * <note>
3039
3323
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision
@@ -3044,6 +3328,7 @@ export interface StartLambdaFunctionFailedEventAttributes {
3044
3328
  */
3045
3329
  cause?: StartLambdaFunctionFailedCause | string;
3046
3330
  /**
3331
+ * @public
3047
3332
  * <p>A description that can help diagnose the cause of the fault.</p>
3048
3333
  */
3049
3334
  message?: string;
@@ -3068,10 +3353,12 @@ export type StartTimerFailedCause = (typeof StartTimerFailedCause)[keyof typeof
3068
3353
  */
3069
3354
  export interface StartTimerFailedEventAttributes {
3070
3355
  /**
3356
+ * @public
3071
3357
  * <p>The timerId provided in the <code>StartTimer</code> decision that failed.</p>
3072
3358
  */
3073
3359
  timerId: string | undefined;
3074
3360
  /**
3361
+ * @public
3075
3362
  * <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>
3076
3363
  * <note>
3077
3364
  * <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed
@@ -3081,6 +3368,7 @@ export interface StartTimerFailedEventAttributes {
3081
3368
  */
3082
3369
  cause: StartTimerFailedCause | string | undefined;
3083
3370
  /**
3371
+ * @public
3084
3372
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3085
3373
  * <code>StartTimer</code> decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of
3086
3374
  * events leading up to this event.</p>
@@ -3095,16 +3383,19 @@ export interface StartTimerFailedEventAttributes {
3095
3383
  */
3096
3384
  export interface TimerCanceledEventAttributes {
3097
3385
  /**
3386
+ * @public
3098
3387
  * <p>The unique ID of the timer that was canceled.</p>
3099
3388
  */
3100
3389
  timerId: string | undefined;
3101
3390
  /**
3391
+ * @public
3102
3392
  * <p>The ID of the <code>TimerStarted</code> event that was recorded when this timer was started.
3103
3393
  * This information can be useful for diagnosing problems by tracing back the chain of
3104
3394
  * events leading up to this event.</p>
3105
3395
  */
3106
3396
  startedEventId: number | undefined;
3107
3397
  /**
3398
+ * @public
3108
3399
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3109
3400
  * <code>CancelTimer</code> decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of
3110
3401
  * events leading up to this event.</p>
@@ -3117,10 +3408,12 @@ export interface TimerCanceledEventAttributes {
3117
3408
  */
3118
3409
  export interface TimerFiredEventAttributes {
3119
3410
  /**
3411
+ * @public
3120
3412
  * <p>The unique ID of the timer that fired.</p>
3121
3413
  */
3122
3414
  timerId: string | undefined;
3123
3415
  /**
3416
+ * @public
3124
3417
  * <p>The ID of the <code>TimerStarted</code> event that was recorded when this timer was started.
3125
3418
  * This information can be useful for diagnosing problems by tracing back the chain of
3126
3419
  * events leading up to this event.</p>
@@ -3133,19 +3426,23 @@ export interface TimerFiredEventAttributes {
3133
3426
  */
3134
3427
  export interface TimerStartedEventAttributes {
3135
3428
  /**
3429
+ * @public
3136
3430
  * <p>The unique ID of the timer that was started.</p>
3137
3431
  */
3138
3432
  timerId: string | undefined;
3139
3433
  /**
3434
+ * @public
3140
3435
  * <p>Data attached to the event that can be used by the decider in subsequent workflow tasks.</p>
3141
3436
  */
3142
3437
  control?: string;
3143
3438
  /**
3439
+ * @public
3144
3440
  * <p>The duration of time after which the timer fires.</p>
3145
3441
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>.</p>
3146
3442
  */
3147
3443
  startToFireTimeout: string | undefined;
3148
3444
  /**
3445
+ * @public
3149
3446
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3150
3447
  * <code>StartTimer</code> decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of
3151
3448
  * events leading up to this event.</p>
@@ -3158,10 +3455,12 @@ export interface TimerStartedEventAttributes {
3158
3455
  */
3159
3456
  export interface WorkflowExecutionCanceledEventAttributes {
3160
3457
  /**
3458
+ * @public
3161
3459
  * <p>The details of the cancellation.</p>
3162
3460
  */
3163
3461
  details?: string;
3164
3462
  /**
3463
+ * @public
3165
3464
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3166
3465
  * <code>CancelWorkflowExecution</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of
3167
3466
  * events leading up to this event.</p>
@@ -3185,10 +3484,12 @@ export type WorkflowExecutionCancelRequestedCause = (typeof WorkflowExecutionCan
3185
3484
  */
3186
3485
  export interface WorkflowExecutionCancelRequestedEventAttributes {
3187
3486
  /**
3487
+ * @public
3188
3488
  * <p>The external workflow execution for which the cancellation was requested.</p>
3189
3489
  */
3190
3490
  externalWorkflowExecution?: WorkflowExecution;
3191
3491
  /**
3492
+ * @public
3192
3493
  * <p>The ID of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the
3193
3494
  * <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this workflow execution.The source event
3194
3495
  * 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
@@ -3196,6 +3497,7 @@ export interface WorkflowExecutionCancelRequestedEventAttributes {
3196
3497
  */
3197
3498
  externalInitiatedEventId?: number;
3198
3499
  /**
3500
+ * @public
3199
3501
  * <p>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.</p>
3200
3502
  */
3201
3503
  cause?: WorkflowExecutionCancelRequestedCause | string;
@@ -3206,10 +3508,12 @@ export interface WorkflowExecutionCancelRequestedEventAttributes {
3206
3508
  */
3207
3509
  export interface WorkflowExecutionCompletedEventAttributes {
3208
3510
  /**
3511
+ * @public
3209
3512
  * <p>The result produced by the workflow execution upon successful completion.</p>
3210
3513
  */
3211
3514
  result?: string;
3212
3515
  /**
3516
+ * @public
3213
3517
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3214
3518
  * <code>CompleteWorkflowExecution</code> decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of
3215
3519
  * events leading up to this event.</p>
@@ -3222,40 +3526,48 @@ export interface WorkflowExecutionCompletedEventAttributes {
3222
3526
  */
3223
3527
  export interface WorkflowExecutionContinuedAsNewEventAttributes {
3224
3528
  /**
3529
+ * @public
3225
3530
  * <p>The input provided to the new workflow execution.</p>
3226
3531
  */
3227
3532
  input?: string;
3228
3533
  /**
3534
+ * @public
3229
3535
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3230
3536
  * <code>ContinueAsNewWorkflowExecution</code> decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of
3231
3537
  * events leading up to this event.</p>
3232
3538
  */
3233
3539
  decisionTaskCompletedEventId: number | undefined;
3234
3540
  /**
3541
+ * @public
3235
3542
  * <p>The <code>runId</code> of the new workflow execution.</p>
3236
3543
  */
3237
3544
  newExecutionRunId: string | undefined;
3238
3545
  /**
3546
+ * @public
3239
3547
  * <p>The total duration allowed for the new workflow execution.</p>
3240
3548
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
3241
3549
  */
3242
3550
  executionStartToCloseTimeout?: string;
3243
3551
  /**
3552
+ * @public
3244
3553
  * <p>The task list to use for the decisions of the new (continued) workflow
3245
3554
  * execution.</p>
3246
3555
  */
3247
3556
  taskList: TaskList | undefined;
3248
3557
  /**
3558
+ * @public
3249
3559
  * <p>The priority of the task to use for the decisions of the new (continued) workflow
3250
3560
  * execution.</p>
3251
3561
  */
3252
3562
  taskPriority?: string;
3253
3563
  /**
3564
+ * @public
3254
3565
  * <p>The maximum duration of decision tasks for the new workflow execution.</p>
3255
3566
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
3256
3567
  */
3257
3568
  taskStartToCloseTimeout?: string;
3258
3569
  /**
3570
+ * @public
3259
3571
  * <p>The policy to use for the child workflow executions of the new execution if it is terminated by calling the
3260
3572
  * <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p>
3261
3573
  * <p>The supported child policies are:</p>
@@ -3278,14 +3590,17 @@ export interface WorkflowExecutionContinuedAsNewEventAttributes {
3278
3590
  */
3279
3591
  childPolicy: ChildPolicy | string | undefined;
3280
3592
  /**
3593
+ * @public
3281
3594
  * <p>The list of tags associated with the new workflow execution.</p>
3282
3595
  */
3283
3596
  tagList?: string[];
3284
3597
  /**
3598
+ * @public
3285
3599
  * <p>The workflow type of this execution.</p>
3286
3600
  */
3287
3601
  workflowType: WorkflowType | undefined;
3288
3602
  /**
3603
+ * @public
3289
3604
  * <p>The IAM role to attach to the new (continued) workflow execution.</p>
3290
3605
  */
3291
3606
  lambdaRole?: string;
@@ -3296,14 +3611,17 @@ export interface WorkflowExecutionContinuedAsNewEventAttributes {
3296
3611
  */
3297
3612
  export interface WorkflowExecutionFailedEventAttributes {
3298
3613
  /**
3614
+ * @public
3299
3615
  * <p>The descriptive reason provided for the failure.</p>
3300
3616
  */
3301
3617
  reason?: string;
3302
3618
  /**
3619
+ * @public
3303
3620
  * <p>The details of the failure.</p>
3304
3621
  */
3305
3622
  details?: string;
3306
3623
  /**
3624
+ * @public
3307
3625
  * <p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the
3308
3626
  * <code>FailWorkflowExecution</code> decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of
3309
3627
  * events leading up to this event.</p>
@@ -3316,18 +3634,22 @@ export interface WorkflowExecutionFailedEventAttributes {
3316
3634
  */
3317
3635
  export interface WorkflowExecutionSignaledEventAttributes {
3318
3636
  /**
3637
+ * @public
3319
3638
  * <p>The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.</p>
3320
3639
  */
3321
3640
  signalName: string | undefined;
3322
3641
  /**
3642
+ * @public
3323
3643
  * <p>The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.</p>
3324
3644
  */
3325
3645
  input?: string;
3326
3646
  /**
3647
+ * @public
3327
3648
  * <p>The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.</p>
3328
3649
  */
3329
3650
  externalWorkflowExecution?: WorkflowExecution;
3330
3651
  /**
3652
+ * @public
3331
3653
  * <p>The ID of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the
3332
3654
  * <code>SignalExternalWorkflow</code> decision to signal this workflow execution.The source event with this ID can
3333
3655
  * be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of
@@ -3342,20 +3664,24 @@ export interface WorkflowExecutionSignaledEventAttributes {
3342
3664
  */
3343
3665
  export interface WorkflowExecutionStartedEventAttributes {
3344
3666
  /**
3667
+ * @public
3345
3668
  * <p>The input provided to the workflow execution.</p>
3346
3669
  */
3347
3670
  input?: string;
3348
3671
  /**
3672
+ * @public
3349
3673
  * <p>The maximum duration for this workflow execution.</p>
3350
3674
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
3351
3675
  */
3352
3676
  executionStartToCloseTimeout?: string;
3353
3677
  /**
3678
+ * @public
3354
3679
  * <p>The maximum duration of decision tasks for this workflow type.</p>
3355
3680
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
3356
3681
  */
3357
3682
  taskStartToCloseTimeout?: string;
3358
3683
  /**
3684
+ * @public
3359
3685
  * <p>The policy to use for the child workflow executions if this workflow execution is terminated, by calling the
3360
3686
  * <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p>
3361
3687
  * <p>The supported child policies are:</p>
@@ -3378,32 +3704,39 @@ export interface WorkflowExecutionStartedEventAttributes {
3378
3704
  */
3379
3705
  childPolicy: ChildPolicy | string | undefined;
3380
3706
  /**
3707
+ * @public
3381
3708
  * <p>The name of the task list for scheduling the decision tasks for this workflow execution.</p>
3382
3709
  */
3383
3710
  taskList: TaskList | undefined;
3384
3711
  /**
3712
+ * @public
3385
3713
  * <p>The priority of the decision tasks in the workflow execution.</p>
3386
3714
  */
3387
3715
  taskPriority?: string;
3388
3716
  /**
3717
+ * @public
3389
3718
  * <p>The workflow type of this execution.</p>
3390
3719
  */
3391
3720
  workflowType: WorkflowType | undefined;
3392
3721
  /**
3722
+ * @public
3393
3723
  * <p>The list of tags associated with this workflow execution. An execution can have up to 5 tags.</p>
3394
3724
  */
3395
3725
  tagList?: string[];
3396
3726
  /**
3727
+ * @public
3397
3728
  * <p>If this workflow execution was started due to a <code>ContinueAsNewWorkflowExecution</code> decision, then it
3398
3729
  * contains the <code>runId</code> of the previous workflow execution that was closed and continued as this
3399
3730
  * execution.</p>
3400
3731
  */
3401
3732
  continuedExecutionRunId?: string;
3402
3733
  /**
3734
+ * @public
3403
3735
  * <p>The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.</p>
3404
3736
  */
3405
3737
  parentWorkflowExecution?: WorkflowExecution;
3406
3738
  /**
3739
+ * @public
3407
3740
  * <p>The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the
3408
3741
  * <code>StartChildWorkflowExecution</code>
3409
3742
  * <a>Decision</a> to start this workflow execution. The source event with
@@ -3412,6 +3745,7 @@ export interface WorkflowExecutionStartedEventAttributes {
3412
3745
  */
3413
3746
  parentInitiatedEventId?: number;
3414
3747
  /**
3748
+ * @public
3415
3749
  * <p>The IAM role attached to the workflow execution.</p>
3416
3750
  */
3417
3751
  lambdaRole?: string;
@@ -3435,14 +3769,17 @@ export type WorkflowExecutionTerminatedCause = (typeof WorkflowExecutionTerminat
3435
3769
  */
3436
3770
  export interface WorkflowExecutionTerminatedEventAttributes {
3437
3771
  /**
3772
+ * @public
3438
3773
  * <p>The reason provided for the termination.</p>
3439
3774
  */
3440
3775
  reason?: string;
3441
3776
  /**
3777
+ * @public
3442
3778
  * <p>The details provided for the termination.</p>
3443
3779
  */
3444
3780
  details?: string;
3445
3781
  /**
3782
+ * @public
3446
3783
  * <p>The policy used for the child workflow executions of this workflow execution.</p>
3447
3784
  * <p>The supported child policies are:</p>
3448
3785
  * <ul>
@@ -3464,6 +3801,7 @@ export interface WorkflowExecutionTerminatedEventAttributes {
3464
3801
  */
3465
3802
  childPolicy: ChildPolicy | string | undefined;
3466
3803
  /**
3804
+ * @public
3467
3805
  * <p>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.</p>
3468
3806
  */
3469
3807
  cause?: WorkflowExecutionTerminatedCause | string;
@@ -3474,10 +3812,12 @@ export interface WorkflowExecutionTerminatedEventAttributes {
3474
3812
  */
3475
3813
  export interface WorkflowExecutionTimedOutEventAttributes {
3476
3814
  /**
3815
+ * @public
3477
3816
  * <p>The type of timeout that caused this event.</p>
3478
3817
  */
3479
3818
  timeoutType: WorkflowExecutionTimeoutType | string | undefined;
3480
3819
  /**
3820
+ * @public
3481
3821
  * <p>The policy used for the child workflow executions of this workflow execution.</p>
3482
3822
  * <p>The supported child policies are:</p>
3483
3823
  * <ul>
@@ -3722,283 +4062,340 @@ export interface WorkflowExecutionTimedOutEventAttributes {
3722
4062
  */
3723
4063
  export interface HistoryEvent {
3724
4064
  /**
4065
+ * @public
3725
4066
  * <p>The date and time when the event occurred.</p>
3726
4067
  */
3727
4068
  eventTimestamp: Date | undefined;
3728
4069
  /**
4070
+ * @public
3729
4071
  * <p>The type of the history event.</p>
3730
4072
  */
3731
4073
  eventType: EventType | string | undefined;
3732
4074
  /**
4075
+ * @public
3733
4076
  * <p>The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.</p>
3734
4077
  */
3735
4078
  eventId: number | undefined;
3736
4079
  /**
4080
+ * @public
3737
4081
  * <p>If the event is of type <code>WorkflowExecutionStarted</code> then this member is set and provides detailed
3738
4082
  * information about the event. It isn't set for other event types.</p>
3739
4083
  */
3740
4084
  workflowExecutionStartedEventAttributes?: WorkflowExecutionStartedEventAttributes;
3741
4085
  /**
4086
+ * @public
3742
4087
  * <p>If the event is of type <code>WorkflowExecutionCompleted</code> then this member is set and provides detailed
3743
4088
  * information about the event. It isn't set for other event types.</p>
3744
4089
  */
3745
4090
  workflowExecutionCompletedEventAttributes?: WorkflowExecutionCompletedEventAttributes;
3746
4091
  /**
4092
+ * @public
3747
4093
  * <p>If the event is of type <code>CompleteWorkflowExecutionFailed</code> then this member is set and provides
3748
4094
  * detailed information about the event. It isn't set for other event types.</p>
3749
4095
  */
3750
4096
  completeWorkflowExecutionFailedEventAttributes?: CompleteWorkflowExecutionFailedEventAttributes;
3751
4097
  /**
4098
+ * @public
3752
4099
  * <p>If the event is of type <code>WorkflowExecutionFailed</code> then this member is set and provides detailed
3753
4100
  * information about the event. It isn't set for other event types.</p>
3754
4101
  */
3755
4102
  workflowExecutionFailedEventAttributes?: WorkflowExecutionFailedEventAttributes;
3756
4103
  /**
4104
+ * @public
3757
4105
  * <p>If the event is of type <code>FailWorkflowExecutionFailed</code> then this member is set and provides detailed
3758
4106
  * information about the event. It isn't set for other event types.</p>
3759
4107
  */
3760
4108
  failWorkflowExecutionFailedEventAttributes?: FailWorkflowExecutionFailedEventAttributes;
3761
4109
  /**
4110
+ * @public
3762
4111
  * <p>If the event is of type <code>WorkflowExecutionTimedOut</code> then this member is set and provides detailed
3763
4112
  * information about the event. It isn't set for other event types.</p>
3764
4113
  */
3765
4114
  workflowExecutionTimedOutEventAttributes?: WorkflowExecutionTimedOutEventAttributes;
3766
4115
  /**
4116
+ * @public
3767
4117
  * <p>If the event is of type <code>WorkflowExecutionCanceled</code> then this member is set and provides detailed
3768
4118
  * information about the event. It isn't set for other event types.</p>
3769
4119
  */
3770
4120
  workflowExecutionCanceledEventAttributes?: WorkflowExecutionCanceledEventAttributes;
3771
4121
  /**
4122
+ * @public
3772
4123
  * <p>If the event is of type <code>CancelWorkflowExecutionFailed</code> then this member is set and provides detailed
3773
4124
  * information about the event. It isn't set for other event types.</p>
3774
4125
  */
3775
4126
  cancelWorkflowExecutionFailedEventAttributes?: CancelWorkflowExecutionFailedEventAttributes;
3776
4127
  /**
4128
+ * @public
3777
4129
  * <p>If the event is of type <code>WorkflowExecutionContinuedAsNew</code> then this member is set and provides
3778
4130
  * detailed information about the event. It isn't set for other event types.</p>
3779
4131
  */
3780
4132
  workflowExecutionContinuedAsNewEventAttributes?: WorkflowExecutionContinuedAsNewEventAttributes;
3781
4133
  /**
4134
+ * @public
3782
4135
  * <p>If the event is of type <code>ContinueAsNewWorkflowExecutionFailed</code> then this member is set and provides
3783
4136
  * detailed information about the event. It isn't set for other event types.</p>
3784
4137
  */
3785
4138
  continueAsNewWorkflowExecutionFailedEventAttributes?: ContinueAsNewWorkflowExecutionFailedEventAttributes;
3786
4139
  /**
4140
+ * @public
3787
4141
  * <p>If the event is of type <code>WorkflowExecutionTerminated</code> then this member is set and provides detailed
3788
4142
  * information about the event. It isn't set for other event types.</p>
3789
4143
  */
3790
4144
  workflowExecutionTerminatedEventAttributes?: WorkflowExecutionTerminatedEventAttributes;
3791
4145
  /**
4146
+ * @public
3792
4147
  * <p>If the event is of type <code>WorkflowExecutionCancelRequested</code> then this member is set and provides
3793
4148
  * detailed information about the event. It isn't set for other event types.</p>
3794
4149
  */
3795
4150
  workflowExecutionCancelRequestedEventAttributes?: WorkflowExecutionCancelRequestedEventAttributes;
3796
4151
  /**
4152
+ * @public
3797
4153
  * <p>If the event is of type <code>DecisionTaskScheduled</code> then this member is set and provides detailed
3798
4154
  * information about the event. It isn't set for other event types.</p>
3799
4155
  */
3800
4156
  decisionTaskScheduledEventAttributes?: DecisionTaskScheduledEventAttributes;
3801
4157
  /**
4158
+ * @public
3802
4159
  * <p>If the event is of type <code>DecisionTaskStarted</code> then this member is set and provides detailed
3803
4160
  * information about the event. It isn't set for other event types.</p>
3804
4161
  */
3805
4162
  decisionTaskStartedEventAttributes?: DecisionTaskStartedEventAttributes;
3806
4163
  /**
4164
+ * @public
3807
4165
  * <p>If the event is of type <code>DecisionTaskCompleted</code> then this member is set and provides detailed
3808
4166
  * information about the event. It isn't set for other event types.</p>
3809
4167
  */
3810
4168
  decisionTaskCompletedEventAttributes?: DecisionTaskCompletedEventAttributes;
3811
4169
  /**
4170
+ * @public
3812
4171
  * <p>If the event is of type <code>DecisionTaskTimedOut</code> then this member is set and provides detailed
3813
4172
  * information about the event. It isn't set for other event types.</p>
3814
4173
  */
3815
4174
  decisionTaskTimedOutEventAttributes?: DecisionTaskTimedOutEventAttributes;
3816
4175
  /**
4176
+ * @public
3817
4177
  * <p>If the event is of type <code>ActivityTaskScheduled</code> then this member is set and provides detailed
3818
4178
  * information about the event. It isn't set for other event types.</p>
3819
4179
  */
3820
4180
  activityTaskScheduledEventAttributes?: ActivityTaskScheduledEventAttributes;
3821
4181
  /**
4182
+ * @public
3822
4183
  * <p>If the event is of type <code>ActivityTaskStarted</code> then this member is set and provides detailed
3823
4184
  * information about the event. It isn't set for other event types.</p>
3824
4185
  */
3825
4186
  activityTaskStartedEventAttributes?: ActivityTaskStartedEventAttributes;
3826
4187
  /**
4188
+ * @public
3827
4189
  * <p>If the event is of type <code>ActivityTaskCompleted</code> then this member is set and provides detailed
3828
4190
  * information about the event. It isn't set for other event types.</p>
3829
4191
  */
3830
4192
  activityTaskCompletedEventAttributes?: ActivityTaskCompletedEventAttributes;
3831
4193
  /**
4194
+ * @public
3832
4195
  * <p>If the event is of type <code>ActivityTaskFailed</code> then this member is set and provides detailed
3833
4196
  * information about the event. It isn't set for other event types.</p>
3834
4197
  */
3835
4198
  activityTaskFailedEventAttributes?: ActivityTaskFailedEventAttributes;
3836
4199
  /**
4200
+ * @public
3837
4201
  * <p>If the event is of type <code>ActivityTaskTimedOut</code> then this member is set and provides detailed
3838
4202
  * information about the event. It isn't set for other event types.</p>
3839
4203
  */
3840
4204
  activityTaskTimedOutEventAttributes?: ActivityTaskTimedOutEventAttributes;
3841
4205
  /**
4206
+ * @public
3842
4207
  * <p>If the event is of type <code>ActivityTaskCanceled</code> then this member is set and provides detailed
3843
4208
  * information about the event. It isn't set for other event types.</p>
3844
4209
  */
3845
4210
  activityTaskCanceledEventAttributes?: ActivityTaskCanceledEventAttributes;
3846
4211
  /**
4212
+ * @public
3847
4213
  * <p>If the event is of type <code>ActivityTaskcancelRequested</code> then this member is set and provides detailed
3848
4214
  * information about the event. It isn't set for other event types.</p>
3849
4215
  */
3850
4216
  activityTaskCancelRequestedEventAttributes?: ActivityTaskCancelRequestedEventAttributes;
3851
4217
  /**
4218
+ * @public
3852
4219
  * <p>If the event is of type <code>WorkflowExecutionSignaled</code> then this member is set and provides detailed
3853
4220
  * information about the event. It isn't set for other event types.</p>
3854
4221
  */
3855
4222
  workflowExecutionSignaledEventAttributes?: WorkflowExecutionSignaledEventAttributes;
3856
4223
  /**
4224
+ * @public
3857
4225
  * <p>If the event is of type <code>MarkerRecorded</code> then this member is set and provides detailed information
3858
4226
  * about the event. It isn't set for other event types.</p>
3859
4227
  */
3860
4228
  markerRecordedEventAttributes?: MarkerRecordedEventAttributes;
3861
4229
  /**
4230
+ * @public
3862
4231
  * <p>If the event is of type <code>DecisionTaskFailed</code> then this member is set and provides detailed
3863
4232
  * information about the event. It isn't set for other event types.</p>
3864
4233
  */
3865
4234
  recordMarkerFailedEventAttributes?: RecordMarkerFailedEventAttributes;
3866
4235
  /**
4236
+ * @public
3867
4237
  * <p>If the event is of type <code>TimerStarted</code> then this member is set and provides detailed information
3868
4238
  * about the event. It isn't set for other event types.</p>
3869
4239
  */
3870
4240
  timerStartedEventAttributes?: TimerStartedEventAttributes;
3871
4241
  /**
4242
+ * @public
3872
4243
  * <p>If the event is of type <code>TimerFired</code> then this member is set and provides detailed information about
3873
4244
  * the event. It isn't set for other event types.</p>
3874
4245
  */
3875
4246
  timerFiredEventAttributes?: TimerFiredEventAttributes;
3876
4247
  /**
4248
+ * @public
3877
4249
  * <p>If the event is of type <code>TimerCanceled</code> then this member is set and provides detailed information
3878
4250
  * about the event. It isn't set for other event types.</p>
3879
4251
  */
3880
4252
  timerCanceledEventAttributes?: TimerCanceledEventAttributes;
3881
4253
  /**
4254
+ * @public
3882
4255
  * <p>If the event is of type <code>StartChildWorkflowExecutionInitiated</code> then this member is set and provides
3883
4256
  * detailed information about the event. It isn't set for other event types.</p>
3884
4257
  */
3885
4258
  startChildWorkflowExecutionInitiatedEventAttributes?: StartChildWorkflowExecutionInitiatedEventAttributes;
3886
4259
  /**
4260
+ * @public
3887
4261
  * <p>If the event is of type <code>ChildWorkflowExecutionStarted</code> then this member is set and provides detailed
3888
4262
  * information about the event. It isn't set for other event types.</p>
3889
4263
  */
3890
4264
  childWorkflowExecutionStartedEventAttributes?: ChildWorkflowExecutionStartedEventAttributes;
3891
4265
  /**
4266
+ * @public
3892
4267
  * <p>If the event is of type <code>ChildWorkflowExecutionCompleted</code> then this member is set and provides
3893
4268
  * detailed information about the event. It isn't set for other event types.</p>
3894
4269
  */
3895
4270
  childWorkflowExecutionCompletedEventAttributes?: ChildWorkflowExecutionCompletedEventAttributes;
3896
4271
  /**
4272
+ * @public
3897
4273
  * <p>If the event is of type <code>ChildWorkflowExecutionFailed</code> then this member is set and provides detailed
3898
4274
  * information about the event. It isn't set for other event types.</p>
3899
4275
  */
3900
4276
  childWorkflowExecutionFailedEventAttributes?: ChildWorkflowExecutionFailedEventAttributes;
3901
4277
  /**
4278
+ * @public
3902
4279
  * <p>If the event is of type <code>ChildWorkflowExecutionTimedOut</code> then this member is set and provides
3903
4280
  * detailed information about the event. It isn't set for other event types.</p>
3904
4281
  */
3905
4282
  childWorkflowExecutionTimedOutEventAttributes?: ChildWorkflowExecutionTimedOutEventAttributes;
3906
4283
  /**
4284
+ * @public
3907
4285
  * <p>If the event is of type <code>ChildWorkflowExecutionCanceled</code> then this member is set and provides
3908
4286
  * detailed information about the event. It isn't set for other event types.</p>
3909
4287
  */
3910
4288
  childWorkflowExecutionCanceledEventAttributes?: ChildWorkflowExecutionCanceledEventAttributes;
3911
4289
  /**
4290
+ * @public
3912
4291
  * <p>If the event is of type <code>ChildWorkflowExecutionTerminated</code> then this member is set and provides
3913
4292
  * detailed information about the event. It isn't set for other event types.</p>
3914
4293
  */
3915
4294
  childWorkflowExecutionTerminatedEventAttributes?: ChildWorkflowExecutionTerminatedEventAttributes;
3916
4295
  /**
4296
+ * @public
3917
4297
  * <p>If the event is of type <code>SignalExternalWorkflowExecutionInitiated</code> then this member is set and
3918
4298
  * provides detailed information about the event. It isn't set for other event types.</p>
3919
4299
  */
3920
4300
  signalExternalWorkflowExecutionInitiatedEventAttributes?: SignalExternalWorkflowExecutionInitiatedEventAttributes;
3921
4301
  /**
4302
+ * @public
3922
4303
  * <p>If the event is of type <code>ExternalWorkflowExecutionSignaled</code> then this member is set and provides
3923
4304
  * detailed information about the event. It isn't set for other event types.</p>
3924
4305
  */
3925
4306
  externalWorkflowExecutionSignaledEventAttributes?: ExternalWorkflowExecutionSignaledEventAttributes;
3926
4307
  /**
4308
+ * @public
3927
4309
  * <p>If the event is of type <code>SignalExternalWorkflowExecutionFailed</code> then this member is set and provides
3928
4310
  * detailed information about the event. It isn't set for other event types.</p>
3929
4311
  */
3930
4312
  signalExternalWorkflowExecutionFailedEventAttributes?: SignalExternalWorkflowExecutionFailedEventAttributes;
3931
4313
  /**
4314
+ * @public
3932
4315
  * <p>If the event is of type <code>ExternalWorkflowExecutionCancelRequested</code> then this member is set and
3933
4316
  * provides detailed information about the event. It isn't set for other event types. </p>
3934
4317
  */
3935
4318
  externalWorkflowExecutionCancelRequestedEventAttributes?: ExternalWorkflowExecutionCancelRequestedEventAttributes;
3936
4319
  /**
4320
+ * @public
3937
4321
  * <p>If the event is of type <code>RequestCancelExternalWorkflowExecutionInitiated</code> then this member is set and
3938
4322
  * provides detailed information about the event. It isn't set for other event types.</p>
3939
4323
  */
3940
4324
  requestCancelExternalWorkflowExecutionInitiatedEventAttributes?: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes;
3941
4325
  /**
4326
+ * @public
3942
4327
  * <p>If the event is of type <code>RequestCancelExternalWorkflowExecutionFailed</code> then this member is set and
3943
4328
  * provides detailed information about the event. It isn't set for other event types.</p>
3944
4329
  */
3945
4330
  requestCancelExternalWorkflowExecutionFailedEventAttributes?: RequestCancelExternalWorkflowExecutionFailedEventAttributes;
3946
4331
  /**
4332
+ * @public
3947
4333
  * <p>If the event is of type <code>ScheduleActivityTaskFailed</code> then this member is set and provides detailed
3948
4334
  * information about the event. It isn't set for other event types.</p>
3949
4335
  */
3950
4336
  scheduleActivityTaskFailedEventAttributes?: ScheduleActivityTaskFailedEventAttributes;
3951
4337
  /**
4338
+ * @public
3952
4339
  * <p>If the event is of type <code>RequestCancelActivityTaskFailed</code> then this member is set and provides
3953
4340
  * detailed information about the event. It isn't set for other event types.</p>
3954
4341
  */
3955
4342
  requestCancelActivityTaskFailedEventAttributes?: RequestCancelActivityTaskFailedEventAttributes;
3956
4343
  /**
4344
+ * @public
3957
4345
  * <p>If the event is of type <code>StartTimerFailed</code> then this member is set and provides detailed information
3958
4346
  * about the event. It isn't set for other event types.</p>
3959
4347
  */
3960
4348
  startTimerFailedEventAttributes?: StartTimerFailedEventAttributes;
3961
4349
  /**
4350
+ * @public
3962
4351
  * <p>If the event is of type <code>CancelTimerFailed</code> then this member is set and provides detailed information
3963
4352
  * about the event. It isn't set for other event types.</p>
3964
4353
  */
3965
4354
  cancelTimerFailedEventAttributes?: CancelTimerFailedEventAttributes;
3966
4355
  /**
4356
+ * @public
3967
4357
  * <p>If the event is of type <code>StartChildWorkflowExecutionFailed</code> then this member is set and provides
3968
4358
  * detailed information about the event. It isn't set for other event types.</p>
3969
4359
  */
3970
4360
  startChildWorkflowExecutionFailedEventAttributes?: StartChildWorkflowExecutionFailedEventAttributes;
3971
4361
  /**
4362
+ * @public
3972
4363
  * <p>Provides the details of the <code>LambdaFunctionScheduled</code> event. It isn't set
3973
4364
  * for other event types.</p>
3974
4365
  */
3975
4366
  lambdaFunctionScheduledEventAttributes?: LambdaFunctionScheduledEventAttributes;
3976
4367
  /**
4368
+ * @public
3977
4369
  * <p>Provides the details of the <code>LambdaFunctionStarted</code> event. It isn't set for
3978
4370
  * other event types.</p>
3979
4371
  */
3980
4372
  lambdaFunctionStartedEventAttributes?: LambdaFunctionStartedEventAttributes;
3981
4373
  /**
4374
+ * @public
3982
4375
  * <p>Provides the details of the <code>LambdaFunctionCompleted</code> event. It isn't set
3983
4376
  * for other event types.</p>
3984
4377
  */
3985
4378
  lambdaFunctionCompletedEventAttributes?: LambdaFunctionCompletedEventAttributes;
3986
4379
  /**
4380
+ * @public
3987
4381
  * <p>Provides the details of the <code>LambdaFunctionFailed</code> event. It isn't set for
3988
4382
  * other event types.</p>
3989
4383
  */
3990
4384
  lambdaFunctionFailedEventAttributes?: LambdaFunctionFailedEventAttributes;
3991
4385
  /**
4386
+ * @public
3992
4387
  * <p>Provides the details of the <code>LambdaFunctionTimedOut</code> event. It isn't set for
3993
4388
  * other event types.</p>
3994
4389
  */
3995
4390
  lambdaFunctionTimedOutEventAttributes?: LambdaFunctionTimedOutEventAttributes;
3996
4391
  /**
4392
+ * @public
3997
4393
  * <p>Provides the details of the <code>ScheduleLambdaFunctionFailed</code> event. It isn't
3998
4394
  * set for other event types.</p>
3999
4395
  */
4000
4396
  scheduleLambdaFunctionFailedEventAttributes?: ScheduleLambdaFunctionFailedEventAttributes;
4001
4397
  /**
4398
+ * @public
4002
4399
  * <p>Provides the details of the <code>StartLambdaFunctionFailed</code> event. It isn't set
4003
4400
  * for other event types.</p>
4004
4401
  */
@@ -4010,26 +4407,32 @@ export interface HistoryEvent {
4010
4407
  */
4011
4408
  export interface DecisionTask {
4012
4409
  /**
4410
+ * @public
4013
4411
  * <p>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.</p>
4014
4412
  */
4015
4413
  taskToken: string | undefined;
4016
4414
  /**
4415
+ * @public
4017
4416
  * <p>The ID of the <code>DecisionTaskStarted</code> event recorded in the history.</p>
4018
4417
  */
4019
4418
  startedEventId: number | undefined;
4020
4419
  /**
4420
+ * @public
4021
4421
  * <p>The workflow execution for which this decision task was created.</p>
4022
4422
  */
4023
4423
  workflowExecution: WorkflowExecution | undefined;
4024
4424
  /**
4425
+ * @public
4025
4426
  * <p>The type of the workflow execution for which this decision task was created.</p>
4026
4427
  */
4027
4428
  workflowType: WorkflowType | undefined;
4028
4429
  /**
4430
+ * @public
4029
4431
  * <p>A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.</p>
4030
4432
  */
4031
4433
  events: HistoryEvent[] | undefined;
4032
4434
  /**
4435
+ * @public
4033
4436
  * <p>If a <code>NextPageToken</code> was returned by a previous call, there are more
4034
4437
  * results available. To retrieve the next page of results, make the call again using the returned token in
4035
4438
  * <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
@@ -4037,6 +4440,7 @@ export interface DecisionTask {
4037
4440
  */
4038
4441
  nextPageToken?: string;
4039
4442
  /**
4443
+ * @public
4040
4444
  * <p>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.</p>
4041
4445
  */
4042
4446
  previousStartedEventId?: number;
@@ -4068,10 +4472,12 @@ export declare class DefaultUndefinedFault extends __BaseException {
4068
4472
  */
4069
4473
  export interface DeprecateActivityTypeInput {
4070
4474
  /**
4475
+ * @public
4071
4476
  * <p>The name of the domain in which the activity type is registered.</p>
4072
4477
  */
4073
4478
  domain: string | undefined;
4074
4479
  /**
4480
+ * @public
4075
4481
  * <p>The activity type to deprecate.</p>
4076
4482
  */
4077
4483
  activityType: ActivityType | undefined;
@@ -4093,6 +4499,7 @@ export declare class TypeDeprecatedFault extends __BaseException {
4093
4499
  */
4094
4500
  export interface DeprecateDomainInput {
4095
4501
  /**
4502
+ * @public
4096
4503
  * <p>The name of the domain to deprecate.</p>
4097
4504
  */
4098
4505
  name: string | undefined;
@@ -4114,10 +4521,12 @@ export declare class DomainDeprecatedFault extends __BaseException {
4114
4521
  */
4115
4522
  export interface DeprecateWorkflowTypeInput {
4116
4523
  /**
4524
+ * @public
4117
4525
  * <p>The name of the domain in which the workflow type is registered.</p>
4118
4526
  */
4119
4527
  domain: string | undefined;
4120
4528
  /**
4529
+ * @public
4121
4530
  * <p>The workflow type to deprecate.</p>
4122
4531
  */
4123
4532
  workflowType: WorkflowType | undefined;
@@ -4127,10 +4536,12 @@ export interface DeprecateWorkflowTypeInput {
4127
4536
  */
4128
4537
  export interface DescribeActivityTypeInput {
4129
4538
  /**
4539
+ * @public
4130
4540
  * <p>The name of the domain in which the activity type is registered.</p>
4131
4541
  */
4132
4542
  domain: string | undefined;
4133
4543
  /**
4544
+ * @public
4134
4545
  * <p>The activity type to get information about. Activity types are identified by the
4135
4546
  * <code>name</code> and <code>version</code> that were supplied when the activity was
4136
4547
  * registered.</p>
@@ -4142,6 +4553,7 @@ export interface DescribeActivityTypeInput {
4142
4553
  */
4143
4554
  export interface DescribeDomainInput {
4144
4555
  /**
4556
+ * @public
4145
4557
  * <p>The name of the domain to describe.</p>
4146
4558
  */
4147
4559
  name: string | undefined;
@@ -4152,6 +4564,7 @@ export interface DescribeDomainInput {
4152
4564
  */
4153
4565
  export interface DomainConfiguration {
4154
4566
  /**
4567
+ * @public
4155
4568
  * <p>The retention period for workflow executions in this domain.</p>
4156
4569
  */
4157
4570
  workflowExecutionRetentionPeriodInDays: string | undefined;
@@ -4162,10 +4575,12 @@ export interface DomainConfiguration {
4162
4575
  */
4163
4576
  export interface DomainInfo {
4164
4577
  /**
4578
+ * @public
4165
4579
  * <p>The name of the domain. This name is unique within the account.</p>
4166
4580
  */
4167
4581
  name: string | undefined;
4168
4582
  /**
4583
+ * @public
4169
4584
  * <p>The status of the domain:</p>
4170
4585
  * <ul>
4171
4586
  * <li>
@@ -4184,10 +4599,12 @@ export interface DomainInfo {
4184
4599
  */
4185
4600
  status: RegistrationStatus | string | undefined;
4186
4601
  /**
4602
+ * @public
4187
4603
  * <p>The description of the domain provided through <a>RegisterDomain</a>.</p>
4188
4604
  */
4189
4605
  description?: string;
4190
4606
  /**
4607
+ * @public
4191
4608
  * <p>The ARN of the domain.</p>
4192
4609
  */
4193
4610
  arn?: string;
@@ -4198,11 +4615,13 @@ export interface DomainInfo {
4198
4615
  */
4199
4616
  export interface DomainDetail {
4200
4617
  /**
4618
+ * @public
4201
4619
  * <p>The basic information about a domain, such as its name, status, and
4202
4620
  * description.</p>
4203
4621
  */
4204
4622
  domainInfo: DomainInfo | undefined;
4205
4623
  /**
4624
+ * @public
4206
4625
  * <p>The domain configuration. Currently, this includes only the domain's retention
4207
4626
  * period.</p>
4208
4627
  */
@@ -4213,10 +4632,12 @@ export interface DomainDetail {
4213
4632
  */
4214
4633
  export interface DescribeWorkflowExecutionInput {
4215
4634
  /**
4635
+ * @public
4216
4636
  * <p>The name of the domain containing the workflow execution.</p>
4217
4637
  */
4218
4638
  domain: string | undefined;
4219
4639
  /**
4640
+ * @public
4220
4641
  * <p>The workflow execution to describe.</p>
4221
4642
  */
4222
4643
  execution: WorkflowExecution | undefined;
@@ -4227,26 +4648,31 @@ export interface DescribeWorkflowExecutionInput {
4227
4648
  */
4228
4649
  export interface WorkflowExecutionConfiguration {
4229
4650
  /**
4651
+ * @public
4230
4652
  * <p>The maximum duration allowed for decision tasks for this workflow execution.</p>
4231
4653
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
4232
4654
  */
4233
4655
  taskStartToCloseTimeout: string | undefined;
4234
4656
  /**
4657
+ * @public
4235
4658
  * <p>The total duration for this workflow execution.</p>
4236
4659
  * <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
4237
4660
  */
4238
4661
  executionStartToCloseTimeout: string | undefined;
4239
4662
  /**
4663
+ * @public
4240
4664
  * <p>The task list used for the decision tasks generated for this workflow execution.</p>
4241
4665
  */
4242
4666
  taskList: TaskList | undefined;
4243
4667
  /**
4668
+ * @public
4244
4669
  * <p>The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code>
4245
4670
  * (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p>
4246
4671
  * <p>For more information about setting task priority, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>
4247
4672
  */
4248
4673
  taskPriority?: string;
4249
4674
  /**
4675
+ * @public
4250
4676
  * <p>The policy to use for the child workflow executions if this workflow execution is terminated, by calling the
4251
4677
  * <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p>
4252
4678
  * <p>The supported child policies are:</p>
@@ -4269,6 +4695,7 @@ export interface WorkflowExecutionConfiguration {
4269
4695
  */
4270
4696
  childPolicy: ChildPolicy | string | undefined;
4271
4697
  /**
4698
+ * @public
4272
4699
  * <p>The IAM role attached to the child workflow execution.</p>
4273
4700
  */
4274
4701
  lambdaRole?: string;
@@ -4291,26 +4718,32 @@ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionSta
4291
4718
  */
4292
4719
  export interface WorkflowExecutionInfo {
4293
4720
  /**
4721
+ * @public
4294
4722
  * <p>The workflow execution this information is about.</p>
4295
4723
  */
4296
4724
  execution: WorkflowExecution | undefined;
4297
4725
  /**
4726
+ * @public
4298
4727
  * <p>The type of the workflow execution.</p>
4299
4728
  */
4300
4729
  workflowType: WorkflowType | undefined;
4301
4730
  /**
4731
+ * @public
4302
4732
  * <p>The time when the execution was started.</p>
4303
4733
  */
4304
4734
  startTimestamp: Date | undefined;
4305
4735
  /**
4736
+ * @public
4306
4737
  * <p>The time when the workflow execution was closed. Set only if the execution status is CLOSED.</p>
4307
4738
  */
4308
4739
  closeTimestamp?: Date;
4309
4740
  /**
4741
+ * @public
4310
4742
  * <p>The current status of the execution.</p>
4311
4743
  */
4312
4744
  executionStatus: ExecutionStatus | string | undefined;
4313
4745
  /**
4746
+ * @public
4314
4747
  * <p>If the execution status is closed then this specifies how the execution was closed:</p>
4315
4748
  * <ul>
4316
4749
  * <li>
@@ -4344,14 +4777,17 @@ export interface WorkflowExecutionInfo {
4344
4777
  */
4345
4778
  closeStatus?: CloseStatus | string;
4346
4779
  /**
4780
+ * @public
4347
4781
  * <p>If this workflow execution is a child of another execution then contains the workflow execution that started this execution.</p>
4348
4782
  */
4349
4783
  parent?: WorkflowExecution;
4350
4784
  /**
4785
+ * @public
4351
4786
  * <p>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.</p>
4352
4787
  */
4353
4788
  tagList?: string[];
4354
4789
  /**
4790
+ * @public
4355
4791
  * <p>Set to true if a cancellation is requested for this workflow execution.</p>
4356
4792
  */
4357
4793
  cancelRequested?: boolean;
@@ -4362,22 +4798,27 @@ export interface WorkflowExecutionInfo {
4362
4798
  */
4363
4799
  export interface WorkflowExecutionOpenCounts {
4364
4800
  /**
4801
+ * @public
4365
4802
  * <p>The count of activity tasks whose status is <code>OPEN</code>.</p>
4366
4803
  */
4367
4804
  openActivityTasks: number | undefined;
4368
4805
  /**
4806
+ * @public
4369
4807
  * <p>The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.</p>
4370
4808
  */
4371
4809
  openDecisionTasks: number | undefined;
4372
4810
  /**
4811
+ * @public
4373
4812
  * <p>The count of timers started by this workflow execution that have not fired yet.</p>
4374
4813
  */
4375
4814
  openTimers: number | undefined;
4376
4815
  /**
4816
+ * @public
4377
4817
  * <p>The count of child workflow executions whose status is <code>OPEN</code>.</p>
4378
4818
  */
4379
4819
  openChildWorkflowExecutions: number | undefined;
4380
4820
  /**
4821
+ * @public
4381
4822
  * <p>The count of Lambda tasks whose status is <code>OPEN</code>.</p>
4382
4823
  */
4383
4824
  openLambdaFunctions?: number;
@@ -4388,22 +4829,27 @@ export interface WorkflowExecutionOpenCounts {
4388
4829
  */
4389
4830
  export interface WorkflowExecutionDetail {
4390
4831
  /**
4832
+ * @public
4391
4833
  * <p>Information about the workflow execution.</p>
4392
4834
  */
4393
4835
  executionInfo: WorkflowExecutionInfo | undefined;
4394
4836
  /**
4837
+ * @public
4395
4838
  * <p>The configuration settings for this workflow execution including timeout values, tasklist etc.</p>
4396
4839
  */
4397
4840
  executionConfiguration: WorkflowExecutionConfiguration | undefined;
4398
4841
  /**
4842
+ * @public
4399
4843
  * <p>The number of tasks for this workflow execution. This includes open and closed tasks of all types.</p>
4400
4844
  */
4401
4845
  openCounts: WorkflowExecutionOpenCounts | undefined;
4402
4846
  /**
4847
+ * @public
4403
4848
  * <p>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.</p>
4404
4849
  */
4405
4850
  latestActivityTaskTimestamp?: Date;
4406
4851
  /**
4852
+ * @public
4407
4853
  * <p>The latest executionContext provided by the decider for this workflow execution. A decider can provide an
4408
4854
  * executionContext (a free-form string) when closing a decision task using <a>RespondDecisionTaskCompleted</a>.</p>
4409
4855
  */
@@ -4414,10 +4860,12 @@ export interface WorkflowExecutionDetail {
4414
4860
  */
4415
4861
  export interface DescribeWorkflowTypeInput {
4416
4862
  /**
4863
+ * @public
4417
4864
  * <p>The name of the domain in which this workflow type is registered.</p>
4418
4865
  */
4419
4866
  domain: string | undefined;
4420
4867
  /**
4868
+ * @public
4421
4869
  * <p>The workflow type to describe.</p>
4422
4870
  */
4423
4871
  workflowType: WorkflowType | undefined;
@@ -4428,6 +4876,7 @@ export interface DescribeWorkflowTypeInput {
4428
4876
  */
4429
4877
  export interface WorkflowTypeConfiguration {
4430
4878
  /**
4879
+ * @public
4431
4880
  * <p>
4432
4881
  * The default maximum duration, specified when registering the workflow type, that a decision task
4433
4882
  * for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close
@@ -4439,6 +4888,7 @@ export interface WorkflowTypeConfiguration {
4439
4888
  */
4440
4889
  defaultTaskStartToCloseTimeout?: string;
4441
4890
  /**
4891
+ * @public
4442
4892
  * <p>
4443
4893
  * The default maximum duration, specified when registering the workflow type, for executions of
4444
4894
  * this workflow type. This default can be overridden when starting a workflow execution using the
@@ -4448,6 +4898,7 @@ export interface WorkflowTypeConfiguration {
4448
4898
  */
4449
4899
  defaultExecutionStartToCloseTimeout?: string;
4450
4900
  /**
4901
+ * @public
4451
4902
  * <p>
4452
4903
  * The default task list, specified when registering the workflow type, for decisions tasks
4453
4904
  * scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution
@@ -4456,6 +4907,7 @@ export interface WorkflowTypeConfiguration {
4456
4907
  */
4457
4908
  defaultTaskList?: TaskList;
4458
4909
  /**
4910
+ * @public
4459
4911
  * <p>
4460
4912
  * The default task priority, specified when registering the workflow type, for all decision tasks
4461
4913
  * of this workflow type. This default can be overridden when starting a workflow execution using the
@@ -4466,6 +4918,7 @@ export interface WorkflowTypeConfiguration {
4466
4918
  */
4467
4919
  defaultTaskPriority?: string;
4468
4920
  /**
4921
+ * @public
4469
4922
  * <p>
4470
4923
  * The default policy to use for the child workflow executions when a workflow execution of this
4471
4924
  * type is terminated, by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired
@@ -4492,6 +4945,7 @@ export interface WorkflowTypeConfiguration {
4492
4945
  */
4493
4946
  defaultChildPolicy?: ChildPolicy | string;
4494
4947
  /**
4948
+ * @public
4495
4949
  * <p>The default IAM role attached to this workflow type.</p>
4496
4950
  * <note>
4497
4951
  * <p>Executions of this workflow type need IAM roles to invoke Lambda functions. If you
@@ -4508,22 +4962,27 @@ export interface WorkflowTypeConfiguration {
4508
4962
  */
4509
4963
  export interface WorkflowTypeInfo {
4510
4964
  /**
4965
+ * @public
4511
4966
  * <p>The workflow type this information is about.</p>
4512
4967
  */
4513
4968
  workflowType: WorkflowType | undefined;
4514
4969
  /**
4970
+ * @public
4515
4971
  * <p>The current status of the workflow type.</p>
4516
4972
  */
4517
4973
  status: RegistrationStatus | string | undefined;
4518
4974
  /**
4975
+ * @public
4519
4976
  * <p>The description of the type registered through <a>RegisterWorkflowType</a>.</p>
4520
4977
  */
4521
4978
  description?: string;
4522
4979
  /**
4980
+ * @public
4523
4981
  * <p>The date when this type was registered.</p>
4524
4982
  */
4525
4983
  creationDate: Date | undefined;
4526
4984
  /**
4985
+ * @public
4527
4986
  * <p>If the type is in deprecated state, then it is set to the date when the type was deprecated.</p>
4528
4987
  */
4529
4988
  deprecationDate?: Date;
@@ -4534,6 +4993,7 @@ export interface WorkflowTypeInfo {
4534
4993
  */
4535
4994
  export interface WorkflowTypeDetail {
4536
4995
  /**
4996
+ * @public
4537
4997
  * <p>General information about the workflow type.</p>
4538
4998
  * <p>The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.</p>
4539
4999
  * <ul>
@@ -4550,6 +5010,7 @@ export interface WorkflowTypeDetail {
4550
5010
  */
4551
5011
  typeInfo: WorkflowTypeInfo | undefined;
4552
5012
  /**
5013
+ * @public
4553
5014
  * <p>Configuration settings of the workflow type registered through <a>RegisterWorkflowType</a>
4554
5015
  * </p>
4555
5016
  */
@@ -4573,10 +5034,12 @@ export declare class DomainAlreadyExistsFault extends __BaseException {
4573
5034
  */
4574
5035
  export interface DomainInfos {
4575
5036
  /**
5037
+ * @public
4576
5038
  * <p>A list of DomainInfo structures.</p>
4577
5039
  */
4578
5040
  domainInfos: DomainInfo[] | undefined;
4579
5041
  /**
5042
+ * @public
4580
5043
  * <p>If a <code>NextPageToken</code> was returned by a previous call, there are more
4581
5044
  * results available. To retrieve the next page of results, make the call again using the returned token in
4582
5045
  * <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
@@ -4589,14 +5052,17 @@ export interface DomainInfos {
4589
5052
  */
4590
5053
  export interface GetWorkflowExecutionHistoryInput {
4591
5054
  /**
5055
+ * @public
4592
5056
  * <p>The name of the domain containing the workflow execution.</p>
4593
5057
  */
4594
5058
  domain: string | undefined;
4595
5059
  /**
5060
+ * @public
4596
5061
  * <p>Specifies the workflow execution for which to return the history.</p>
4597
5062
  */
4598
5063
  execution: WorkflowExecution | undefined;
4599
5064
  /**
5065
+ * @public
4600
5066
  * <p>If <code>NextPageToken</code> is returned there are more results
4601
5067
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
4602
5068
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -4607,11 +5073,13 @@ export interface GetWorkflowExecutionHistoryInput {
4607
5073
  */
4608
5074
  nextPageToken?: string;
4609
5075
  /**
5076
+ * @public
4610
5077
  * <p>The maximum number of results that are returned per call.
4611
5078
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
4612
5079
  */
4613
5080
  maximumPageSize?: number;
4614
5081
  /**
5082
+ * @public
4615
5083
  * <p>When set to <code>true</code>, returns the events in reverse order. By default the
4616
5084
  * results are returned in ascending order of the <code>eventTimeStamp</code> of the
4617
5085
  * events.</p>
@@ -4624,10 +5092,12 @@ export interface GetWorkflowExecutionHistoryInput {
4624
5092
  */
4625
5093
  export interface History {
4626
5094
  /**
5095
+ * @public
4627
5096
  * <p>The list of history events.</p>
4628
5097
  */
4629
5098
  events: HistoryEvent[] | undefined;
4630
5099
  /**
5100
+ * @public
4631
5101
  * <p>If a <code>NextPageToken</code> was returned by a previous call, there are more
4632
5102
  * results available. To retrieve the next page of results, make the call again using the returned token in
4633
5103
  * <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
@@ -4652,18 +5122,22 @@ export declare class LimitExceededFault extends __BaseException {
4652
5122
  */
4653
5123
  export interface ListActivityTypesInput {
4654
5124
  /**
5125
+ * @public
4655
5126
  * <p>The name of the domain in which the activity types have been registered.</p>
4656
5127
  */
4657
5128
  domain: string | undefined;
4658
5129
  /**
5130
+ * @public
4659
5131
  * <p>If specified, only lists the activity types that have this name.</p>
4660
5132
  */
4661
5133
  name?: string;
4662
5134
  /**
5135
+ * @public
4663
5136
  * <p>Specifies the registration status of the activity types to list.</p>
4664
5137
  */
4665
5138
  registrationStatus: RegistrationStatus | string | undefined;
4666
5139
  /**
5140
+ * @public
4667
5141
  * <p>If <code>NextPageToken</code> is returned there are more results
4668
5142
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
4669
5143
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -4674,11 +5148,13 @@ export interface ListActivityTypesInput {
4674
5148
  */
4675
5149
  nextPageToken?: string;
4676
5150
  /**
5151
+ * @public
4677
5152
  * <p>The maximum number of results that are returned per call.
4678
5153
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
4679
5154
  */
4680
5155
  maximumPageSize?: number;
4681
5156
  /**
5157
+ * @public
4682
5158
  * <p>When set to <code>true</code>, returns the results in reverse order. By default, the
4683
5159
  * results are returned in ascending alphabetical order by <code>name</code> of the activity
4684
5160
  * types.</p>
@@ -4690,10 +5166,12 @@ export interface ListActivityTypesInput {
4690
5166
  */
4691
5167
  export interface ListClosedWorkflowExecutionsInput {
4692
5168
  /**
5169
+ * @public
4693
5170
  * <p>The name of the domain that contains the workflow executions to list.</p>
4694
5171
  */
4695
5172
  domain: string | undefined;
4696
5173
  /**
5174
+ * @public
4697
5175
  * <p>If specified, the workflow executions are included in the returned results based on
4698
5176
  * whether their start times are within the range specified by this filter. Also, if this
4699
5177
  * parameter is specified, the returned results are ordered by their start times.</p>
@@ -4705,6 +5183,7 @@ export interface ListClosedWorkflowExecutionsInput {
4705
5183
  */
4706
5184
  startTimeFilter?: ExecutionTimeFilter;
4707
5185
  /**
5186
+ * @public
4708
5187
  * <p>If specified, the workflow executions are included in the returned results based on
4709
5188
  * whether their close times are within the range specified by this filter. Also, if this
4710
5189
  * parameter is specified, the returned results are ordered by their close times.</p>
@@ -4716,6 +5195,7 @@ export interface ListClosedWorkflowExecutionsInput {
4716
5195
  */
4717
5196
  closeTimeFilter?: ExecutionTimeFilter;
4718
5197
  /**
5198
+ * @public
4719
5199
  * <p>If specified, only workflow executions matching the workflow ID specified in the filter
4720
5200
  * are returned.</p>
4721
5201
  * <note>
@@ -4727,6 +5207,7 @@ export interface ListClosedWorkflowExecutionsInput {
4727
5207
  */
4728
5208
  executionFilter?: WorkflowExecutionFilter;
4729
5209
  /**
5210
+ * @public
4730
5211
  * <p>If specified, only workflow executions that match this <i>close
4731
5212
  * status</i> are listed. For example, if TERMINATED is specified, then only TERMINATED
4732
5213
  * workflow executions are listed.</p>
@@ -4739,6 +5220,7 @@ export interface ListClosedWorkflowExecutionsInput {
4739
5220
  */
4740
5221
  closeStatusFilter?: CloseStatusFilter;
4741
5222
  /**
5223
+ * @public
4742
5224
  * <p>If specified, only executions of the type specified in the filter are
4743
5225
  * returned.</p>
4744
5226
  * <note>
@@ -4750,6 +5232,7 @@ export interface ListClosedWorkflowExecutionsInput {
4750
5232
  */
4751
5233
  typeFilter?: WorkflowTypeFilter;
4752
5234
  /**
5235
+ * @public
4753
5236
  * <p>If specified, only executions that have the matching tag are listed.</p>
4754
5237
  * <note>
4755
5238
  * <p>
@@ -4760,6 +5243,7 @@ export interface ListClosedWorkflowExecutionsInput {
4760
5243
  */
4761
5244
  tagFilter?: TagFilter;
4762
5245
  /**
5246
+ * @public
4763
5247
  * <p>If <code>NextPageToken</code> is returned there are more results
4764
5248
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
4765
5249
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -4770,11 +5254,13 @@ export interface ListClosedWorkflowExecutionsInput {
4770
5254
  */
4771
5255
  nextPageToken?: string;
4772
5256
  /**
5257
+ * @public
4773
5258
  * <p>The maximum number of results that are returned per call.
4774
5259
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
4775
5260
  */
4776
5261
  maximumPageSize?: number;
4777
5262
  /**
5263
+ * @public
4778
5264
  * <p>When set to <code>true</code>, returns the results in reverse order. By default the
4779
5265
  * results are returned in descending order of the start or the close time of the
4780
5266
  * executions.</p>
@@ -4787,10 +5273,12 @@ export interface ListClosedWorkflowExecutionsInput {
4787
5273
  */
4788
5274
  export interface WorkflowExecutionInfos {
4789
5275
  /**
5276
+ * @public
4790
5277
  * <p>The list of workflow information structures.</p>
4791
5278
  */
4792
5279
  executionInfos: WorkflowExecutionInfo[] | undefined;
4793
5280
  /**
5281
+ * @public
4794
5282
  * <p>If a <code>NextPageToken</code> was returned by a previous call, there are more
4795
5283
  * results available. To retrieve the next page of results, make the call again using the returned token in
4796
5284
  * <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
@@ -4803,6 +5291,7 @@ export interface WorkflowExecutionInfos {
4803
5291
  */
4804
5292
  export interface ListDomainsInput {
4805
5293
  /**
5294
+ * @public
4806
5295
  * <p>If <code>NextPageToken</code> is returned there are more results
4807
5296
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
4808
5297
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -4813,15 +5302,18 @@ export interface ListDomainsInput {
4813
5302
  */
4814
5303
  nextPageToken?: string;
4815
5304
  /**
5305
+ * @public
4816
5306
  * <p>Specifies the registration status of the domains to list.</p>
4817
5307
  */
4818
5308
  registrationStatus: RegistrationStatus | string | undefined;
4819
5309
  /**
5310
+ * @public
4820
5311
  * <p>The maximum number of results that are returned per call.
4821
5312
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
4822
5313
  */
4823
5314
  maximumPageSize?: number;
4824
5315
  /**
5316
+ * @public
4825
5317
  * <p>When set to <code>true</code>, returns the results in reverse order. By default, the
4826
5318
  * results are returned in ascending alphabetical order by <code>name</code> of the
4827
5319
  * domains.</p>
@@ -4833,15 +5325,18 @@ export interface ListDomainsInput {
4833
5325
  */
4834
5326
  export interface ListOpenWorkflowExecutionsInput {
4835
5327
  /**
5328
+ * @public
4836
5329
  * <p>The name of the domain that contains the workflow executions to list.</p>
4837
5330
  */
4838
5331
  domain: string | undefined;
4839
5332
  /**
5333
+ * @public
4840
5334
  * <p>Workflow executions are included in the returned results based on whether their start
4841
5335
  * times are within the range specified by this filter.</p>
4842
5336
  */
4843
5337
  startTimeFilter: ExecutionTimeFilter | undefined;
4844
5338
  /**
5339
+ * @public
4845
5340
  * <p>If specified, only executions of the type specified in the filter are
4846
5341
  * returned.</p>
4847
5342
  * <note>
@@ -4852,6 +5347,7 @@ export interface ListOpenWorkflowExecutionsInput {
4852
5347
  */
4853
5348
  typeFilter?: WorkflowTypeFilter;
4854
5349
  /**
5350
+ * @public
4855
5351
  * <p>If specified, only executions that have the matching tag are listed.</p>
4856
5352
  * <note>
4857
5353
  * <p>
@@ -4861,6 +5357,7 @@ export interface ListOpenWorkflowExecutionsInput {
4861
5357
  */
4862
5358
  tagFilter?: TagFilter;
4863
5359
  /**
5360
+ * @public
4864
5361
  * <p>If <code>NextPageToken</code> is returned there are more results
4865
5362
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
4866
5363
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -4871,16 +5368,19 @@ export interface ListOpenWorkflowExecutionsInput {
4871
5368
  */
4872
5369
  nextPageToken?: string;
4873
5370
  /**
5371
+ * @public
4874
5372
  * <p>The maximum number of results that are returned per call.
4875
5373
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
4876
5374
  */
4877
5375
  maximumPageSize?: number;
4878
5376
  /**
5377
+ * @public
4879
5378
  * <p>When set to <code>true</code>, returns the results in reverse order. By default the
4880
5379
  * results are returned in descending order of the start time of the executions.</p>
4881
5380
  */
4882
5381
  reverseOrder?: boolean;
4883
5382
  /**
5383
+ * @public
4884
5384
  * <p>If specified, only workflow executions matching the workflow ID specified in the filter
4885
5385
  * are returned.</p>
4886
5386
  * <note>
@@ -4896,6 +5396,7 @@ export interface ListOpenWorkflowExecutionsInput {
4896
5396
  */
4897
5397
  export interface ListTagsForResourceInput {
4898
5398
  /**
5399
+ * @public
4899
5400
  * <p>The Amazon Resource Name (ARN) for the Amazon SWF domain.</p>
4900
5401
  */
4901
5402
  resourceArn: string | undefined;
@@ -4908,10 +5409,12 @@ export interface ListTagsForResourceInput {
4908
5409
  */
4909
5410
  export interface ResourceTag {
4910
5411
  /**
5412
+ * @public
4911
5413
  * <p>The key of a tag.</p>
4912
5414
  */
4913
5415
  key: string | undefined;
4914
5416
  /**
5417
+ * @public
4915
5418
  * <p>The value of a tag.</p>
4916
5419
  */
4917
5420
  value?: string;
@@ -4921,6 +5424,7 @@ export interface ResourceTag {
4921
5424
  */
4922
5425
  export interface ListTagsForResourceOutput {
4923
5426
  /**
5427
+ * @public
4924
5428
  * <p>An array of tags associated with the domain.</p>
4925
5429
  */
4926
5430
  tags?: ResourceTag[];
@@ -4930,18 +5434,22 @@ export interface ListTagsForResourceOutput {
4930
5434
  */
4931
5435
  export interface ListWorkflowTypesInput {
4932
5436
  /**
5437
+ * @public
4933
5438
  * <p>The name of the domain in which the workflow types have been registered.</p>
4934
5439
  */
4935
5440
  domain: string | undefined;
4936
5441
  /**
5442
+ * @public
4937
5443
  * <p>If specified, lists the workflow type with this name.</p>
4938
5444
  */
4939
5445
  name?: string;
4940
5446
  /**
5447
+ * @public
4941
5448
  * <p>Specifies the registration status of the workflow types to list.</p>
4942
5449
  */
4943
5450
  registrationStatus: RegistrationStatus | string | undefined;
4944
5451
  /**
5452
+ * @public
4945
5453
  * <p>If <code>NextPageToken</code> is returned there are more results
4946
5454
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
4947
5455
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -4952,11 +5460,13 @@ export interface ListWorkflowTypesInput {
4952
5460
  */
4953
5461
  nextPageToken?: string;
4954
5462
  /**
5463
+ * @public
4955
5464
  * <p>The maximum number of results that are returned per call.
4956
5465
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
4957
5466
  */
4958
5467
  maximumPageSize?: number;
4959
5468
  /**
5469
+ * @public
4960
5470
  * <p>When set to <code>true</code>, returns the results in reverse order. By default the
4961
5471
  * results are returned in ascending alphabetical order of the <code>name</code> of the workflow
4962
5472
  * types.</p>
@@ -4969,10 +5479,12 @@ export interface ListWorkflowTypesInput {
4969
5479
  */
4970
5480
  export interface WorkflowTypeInfos {
4971
5481
  /**
5482
+ * @public
4972
5483
  * <p>The list of workflow type information.</p>
4973
5484
  */
4974
5485
  typeInfos: WorkflowTypeInfo[] | undefined;
4975
5486
  /**
5487
+ * @public
4976
5488
  * <p>If a <code>NextPageToken</code> was returned by a previous call, there are more
4977
5489
  * results available. To retrieve the next page of results, make the call again using the returned token in
4978
5490
  * <code>nextPageToken</code>. Keep all other arguments unchanged.</p>
@@ -4985,10 +5497,12 @@ export interface WorkflowTypeInfos {
4985
5497
  */
4986
5498
  export interface PollForActivityTaskInput {
4987
5499
  /**
5500
+ * @public
4988
5501
  * <p>The name of the domain that contains the task lists being polled.</p>
4989
5502
  */
4990
5503
  domain: string | undefined;
4991
5504
  /**
5505
+ * @public
4992
5506
  * <p>Specifies the task list to poll for activity tasks.</p>
4993
5507
  * <p>The specified string must not start or end with whitespace. It must not contain a
4994
5508
  * <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any
@@ -4997,6 +5511,7 @@ export interface PollForActivityTaskInput {
4997
5511
  */
4998
5512
  taskList: TaskList | undefined;
4999
5513
  /**
5514
+ * @public
5000
5515
  * <p>Identity of the worker making the request, recorded in the
5001
5516
  * <code>ActivityTaskStarted</code> event in the workflow history. This enables diagnostic
5002
5517
  * tracing when problems arise. The form of this identity is user defined.</p>
@@ -5008,10 +5523,12 @@ export interface PollForActivityTaskInput {
5008
5523
  */
5009
5524
  export interface PollForDecisionTaskInput {
5010
5525
  /**
5526
+ * @public
5011
5527
  * <p>The name of the domain containing the task lists to poll.</p>
5012
5528
  */
5013
5529
  domain: string | undefined;
5014
5530
  /**
5531
+ * @public
5015
5532
  * <p>Specifies the task list to poll for decision tasks.</p>
5016
5533
  * <p>The specified string must not contain a
5017
5534
  * <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any
@@ -5020,12 +5537,14 @@ export interface PollForDecisionTaskInput {
5020
5537
  */
5021
5538
  taskList: TaskList | undefined;
5022
5539
  /**
5540
+ * @public
5023
5541
  * <p>Identity of the decider making the request, which is recorded in the
5024
5542
  * DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when
5025
5543
  * problems arise. The form of this identity is user defined.</p>
5026
5544
  */
5027
5545
  identity?: string;
5028
5546
  /**
5547
+ * @public
5029
5548
  * <p>If <code>NextPageToken</code> is returned there are more results
5030
5549
  * available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using
5031
5550
  * the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
@@ -5041,6 +5560,7 @@ export interface PollForDecisionTaskInput {
5041
5560
  */
5042
5561
  nextPageToken?: string;
5043
5562
  /**
5563
+ * @public
5044
5564
  * <p>The maximum number of results that are returned per call.
5045
5565
  * Use <code>nextPageToken</code> to obtain further pages of results. </p>
5046
5566
  * <p>This
@@ -5049,12 +5569,14 @@ export interface PollForDecisionTaskInput {
5049
5569
  */
5050
5570
  maximumPageSize?: number;
5051
5571
  /**
5572
+ * @public
5052
5573
  * <p>When set to <code>true</code>, returns the events in reverse order. By default the
5053
5574
  * results are returned in ascending order of the <code>eventTimestamp</code> of the
5054
5575
  * events.</p>
5055
5576
  */
5056
5577
  reverseOrder?: boolean;
5057
5578
  /**
5579
+ * @public
5058
5580
  * <p>When set to <code>true</code>, returns the events with <code>eventTimestamp</code> greater than or equal to <code>eventTimestamp</code> of the most recent <code>DecisionTaskStarted</code> event. By default, this parameter is set to <code>false</code>.</p>
5059
5581
  */
5060
5582
  startAtPreviousStartedEvent?: boolean;
@@ -5064,6 +5586,7 @@ export interface PollForDecisionTaskInput {
5064
5586
  */
5065
5587
  export interface RecordActivityTaskHeartbeatInput {
5066
5588
  /**
5589
+ * @public
5067
5590
  * <p>The <code>taskToken</code> of the <a>ActivityTask</a>.</p>
5068
5591
  * <important>
5069
5592
  * <p>
@@ -5074,6 +5597,7 @@ export interface RecordActivityTaskHeartbeatInput {
5074
5597
  */
5075
5598
  taskToken: string | undefined;
5076
5599
  /**
5600
+ * @public
5077
5601
  * <p>If specified, contains details about the progress of the task.</p>
5078
5602
  */
5079
5603
  details?: string;
@@ -5083,10 +5607,12 @@ export interface RecordActivityTaskHeartbeatInput {
5083
5607
  */
5084
5608
  export interface RegisterActivityTypeInput {
5085
5609
  /**
5610
+ * @public
5086
5611
  * <p>The name of the domain in which this activity is to be registered.</p>
5087
5612
  */
5088
5613
  domain: string | undefined;
5089
5614
  /**
5615
+ * @public
5090
5616
  * <p>The name of the activity type within the domain.</p>
5091
5617
  * <p>The specified string must not contain a
5092
5618
  * <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any
@@ -5095,6 +5621,7 @@ export interface RegisterActivityTypeInput {
5095
5621
  */
5096
5622
  name: string | undefined;
5097
5623
  /**
5624
+ * @public
5098
5625
  * <p>The version of the activity type.</p>
5099
5626
  * <note>
5100
5627
  * <p>The activity type consists of the name and version, the combination of which must be
@@ -5107,10 +5634,12 @@ export interface RegisterActivityTypeInput {
5107
5634
  */
5108
5635
  version: string | undefined;
5109
5636
  /**
5637
+ * @public
5110
5638
  * <p>A textual description of the activity type.</p>
5111
5639
  */
5112
5640
  description?: string;
5113
5641
  /**
5642
+ * @public
5114
5643
  * <p>If set, specifies the default maximum duration that a worker can take to process tasks
5115
5644
  * of this activity type. This default can be overridden when scheduling an activity task using
5116
5645
  * the <code>ScheduleActivityTask</code>
@@ -5120,6 +5649,7 @@ export interface RegisterActivityTypeInput {
5120
5649
  */
5121
5650
  defaultTaskStartToCloseTimeout?: string;
5122
5651
  /**
5652
+ * @public
5123
5653
  * <p>If set, specifies the default maximum time before which a worker processing a task of
5124
5654
  * this type must report progress by calling <a>RecordActivityTaskHeartbeat</a>. If
5125
5655
  * the timeout is exceeded, the activity task is automatically timed out. This default can be
@@ -5133,6 +5663,7 @@ export interface RegisterActivityTypeInput {
5133
5663
  */
5134
5664
  defaultTaskHeartbeatTimeout?: string;
5135
5665
  /**
5666
+ * @public
5136
5667
  * <p>If set, specifies the default task list to use for scheduling tasks of this activity
5137
5668
  * type. This default task list is used if a task list isn't provided when a task is scheduled
5138
5669
  * through the <code>ScheduleActivityTask</code>
@@ -5140,6 +5671,7 @@ export interface RegisterActivityTypeInput {
5140
5671
  */
5141
5672
  defaultTaskList?: TaskList;
5142
5673
  /**
5674
+ * @public
5143
5675
  * <p>The default task priority to assign to the activity type. If not assigned, then
5144
5676
  * <code>0</code> is used. Valid values are integers that range from Java's
5145
5677
  * <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647).
@@ -5150,6 +5682,7 @@ export interface RegisterActivityTypeInput {
5150
5682
  */
5151
5683
  defaultTaskPriority?: string;
5152
5684
  /**
5685
+ * @public
5153
5686
  * <p>If set, specifies the default maximum duration that a task of this activity type can
5154
5687
  * wait before being assigned to a worker. This default can be overridden when scheduling an
5155
5688
  * activity task using the <code>ScheduleActivityTask</code>
@@ -5159,6 +5692,7 @@ export interface RegisterActivityTypeInput {
5159
5692
  */
5160
5693
  defaultTaskScheduleToStartTimeout?: string;
5161
5694
  /**
5695
+ * @public
5162
5696
  * <p>If set, specifies the default maximum duration for a task of this activity type. This
5163
5697
  * default can be overridden when scheduling an activity task using the
5164
5698
  * <code>ScheduleActivityTask</code>
@@ -5185,6 +5719,7 @@ export declare class TypeAlreadyExistsFault extends __BaseException {
5185
5719
  */
5186
5720
  export interface RegisterDomainInput {
5187
5721
  /**
5722
+ * @public
5188
5723
  * <p>Name of the domain to register. The name must be unique in the region that the domain
5189
5724
  * is registered in.</p>
5190
5725
  * <p>The specified string must not start or end with whitespace. It must not contain a
@@ -5194,10 +5729,12 @@ export interface RegisterDomainInput {
5194
5729
  */
5195
5730
  name: string | undefined;
5196
5731
  /**
5732
+ * @public
5197
5733
  * <p>A text description of the domain.</p>
5198
5734
  */
5199
5735
  description?: string;
5200
5736
  /**
5737
+ * @public
5201
5738
  * <p>The duration (in days) that records and histories of workflow executions on the domain
5202
5739
  * should be kept by the service. After the retention period, the workflow execution isn't
5203
5740
  * available in the results of visibility calls.</p>
@@ -5210,6 +5747,7 @@ export interface RegisterDomainInput {
5210
5747
  */
5211
5748
  workflowExecutionRetentionPeriodInDays: string | undefined;
5212
5749
  /**
5750
+ * @public
5213
5751
  * <p>Tags to be added when registering a domain.</p>
5214
5752
  * <p>Tags may only contain unicode letters, digits, whitespace, or these symbols: <code>_ . : / = + - @</code>.</p>
5215
5753
  */
@@ -5232,10 +5770,12 @@ export declare class TooManyTagsFault extends __BaseException {
5232
5770
  */
5233
5771
  export interface RegisterWorkflowTypeInput {
5234
5772
  /**
5773
+ * @public
5235
5774
  * <p>The name of the domain in which to register the workflow type.</p>
5236
5775
  */
5237
5776
  domain: string | undefined;
5238
5777
  /**
5778
+ * @public
5239
5779
  * <p>The name of the workflow type.</p>
5240
5780
  * <p>The specified string must not contain a
5241
5781
  * <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any
@@ -5244,6 +5784,7 @@ export interface RegisterWorkflowTypeInput {
5244
5784
  */
5245
5785
  name: string | undefined;
5246
5786
  /**
5787
+ * @public
5247
5788
  * <p>The version of the workflow type.</p>
5248
5789
  * <note>
5249
5790
  * <p>The workflow type consists of the name and version, the combination of which must be
@@ -5257,10 +5798,12 @@ export interface RegisterWorkflowTypeInput {
5257
5798
  */
5258
5799
  version: string | undefined;
5259
5800
  /**
5801
+ * @public
5260
5802
  * <p>Textual description of the workflow type.</p>
5261
5803
  */
5262
5804
  description?: string;
5263
5805
  /**
5806
+ * @public
5264
5807
  * <p>If set, specifies the default maximum duration of decision tasks for this workflow
5265
5808
  * type. This default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or the <code>StartChildWorkflowExecution</code>
5266
5809
  * <a>Decision</a>.</p>
@@ -5269,6 +5812,7 @@ export interface RegisterWorkflowTypeInput {
5269
5812
  */
5270
5813
  defaultTaskStartToCloseTimeout?: string;
5271
5814
  /**
5815
+ * @public
5272
5816
  * <p>If set, specifies the default maximum duration for executions of this workflow type.
5273
5817
  * You can override this default when starting an execution through the <a>StartWorkflowExecution</a> Action or <code>StartChildWorkflowExecution</code>
5274
5818
  * <a>Decision</a>.</p>
@@ -5280,6 +5824,7 @@ export interface RegisterWorkflowTypeInput {
5280
5824
  */
5281
5825
  defaultExecutionStartToCloseTimeout?: string;
5282
5826
  /**
5827
+ * @public
5283
5828
  * <p>If set, specifies the default task list to use for scheduling decision tasks for
5284
5829
  * executions of this workflow type. This default is used only if a task list isn't provided when
5285
5830
  * starting the execution through the <a>StartWorkflowExecution</a> Action or
@@ -5288,6 +5833,7 @@ export interface RegisterWorkflowTypeInput {
5288
5833
  */
5289
5834
  defaultTaskList?: TaskList;
5290
5835
  /**
5836
+ * @public
5291
5837
  * <p>The default task priority to assign to the workflow type. If not assigned, then
5292
5838
  * <code>0</code> is used. Valid values are integers that range from Java's
5293
5839
  * <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647).
@@ -5297,6 +5843,7 @@ export interface RegisterWorkflowTypeInput {
5297
5843
  */
5298
5844
  defaultTaskPriority?: string;
5299
5845
  /**
5846
+ * @public
5300
5847
  * <p>If set, specifies the default policy to use for the child workflow executions when a
5301
5848
  * workflow execution of this type is terminated, by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout. This
5302
5849
  * default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or the <code>StartChildWorkflowExecution</code>
@@ -5323,6 +5870,7 @@ export interface RegisterWorkflowTypeInput {
5323
5870
  */
5324
5871
  defaultChildPolicy?: ChildPolicy | string;
5325
5872
  /**
5873
+ * @public
5326
5874
  * <p>The default IAM role attached to this workflow type.</p>
5327
5875
  * <note>
5328
5876
  * <p>Executions of this workflow type need IAM roles to invoke Lambda functions. If you
@@ -5338,14 +5886,17 @@ export interface RegisterWorkflowTypeInput {
5338
5886
  */
5339
5887
  export interface RequestCancelWorkflowExecutionInput {
5340
5888
  /**
5889
+ * @public
5341
5890
  * <p>The name of the domain containing the workflow execution to cancel.</p>
5342
5891
  */
5343
5892
  domain: string | undefined;
5344
5893
  /**
5894
+ * @public
5345
5895
  * <p>The workflowId of the workflow execution to cancel.</p>
5346
5896
  */
5347
5897
  workflowId: string | undefined;
5348
5898
  /**
5899
+ * @public
5349
5900
  * <p>The runId of the workflow execution to cancel.</p>
5350
5901
  */
5351
5902
  runId?: string;
@@ -5355,6 +5906,7 @@ export interface RequestCancelWorkflowExecutionInput {
5355
5906
  */
5356
5907
  export interface RespondActivityTaskCanceledInput {
5357
5908
  /**
5909
+ * @public
5358
5910
  * <p>The <code>taskToken</code> of the <a>ActivityTask</a>.</p>
5359
5911
  * <important>
5360
5912
  * <p>
@@ -5365,6 +5917,7 @@ export interface RespondActivityTaskCanceledInput {
5365
5917
  */
5366
5918
  taskToken: string | undefined;
5367
5919
  /**
5920
+ * @public
5368
5921
  * <p> Information about the cancellation.</p>
5369
5922
  */
5370
5923
  details?: string;
@@ -5374,6 +5927,7 @@ export interface RespondActivityTaskCanceledInput {
5374
5927
  */
5375
5928
  export interface RespondActivityTaskCompletedInput {
5376
5929
  /**
5930
+ * @public
5377
5931
  * <p>The <code>taskToken</code> of the <a>ActivityTask</a>.</p>
5378
5932
  * <important>
5379
5933
  * <p>
@@ -5384,6 +5938,7 @@ export interface RespondActivityTaskCompletedInput {
5384
5938
  */
5385
5939
  taskToken: string | undefined;
5386
5940
  /**
5941
+ * @public
5387
5942
  * <p>The result of the activity task. It is a free form string that is implementation
5388
5943
  * specific.</p>
5389
5944
  */
@@ -5394,6 +5949,7 @@ export interface RespondActivityTaskCompletedInput {
5394
5949
  */
5395
5950
  export interface RespondActivityTaskFailedInput {
5396
5951
  /**
5952
+ * @public
5397
5953
  * <p>The <code>taskToken</code> of the <a>ActivityTask</a>.</p>
5398
5954
  * <important>
5399
5955
  * <p>
@@ -5404,10 +5960,12 @@ export interface RespondActivityTaskFailedInput {
5404
5960
  */
5405
5961
  taskToken: string | undefined;
5406
5962
  /**
5963
+ * @public
5407
5964
  * <p>Description of the error that may assist in diagnostics.</p>
5408
5965
  */
5409
5966
  reason?: string;
5410
5967
  /**
5968
+ * @public
5411
5969
  * <p> Detailed information about the failure.</p>
5412
5970
  */
5413
5971
  details?: string;
@@ -5418,6 +5976,7 @@ export interface RespondActivityTaskFailedInput {
5418
5976
  */
5419
5977
  export interface RespondDecisionTaskCompletedInput {
5420
5978
  /**
5979
+ * @public
5421
5980
  * <p>The <code>taskToken</code> from the <a>DecisionTask</a>.</p>
5422
5981
  * <important>
5423
5982
  * <p>
@@ -5428,12 +5987,14 @@ export interface RespondDecisionTaskCompletedInput {
5428
5987
  */
5429
5988
  taskToken: string | undefined;
5430
5989
  /**
5990
+ * @public
5431
5991
  * <p>The list of decisions (possibly empty) made by the decider while processing this
5432
5992
  * decision task. See the docs for the <a>Decision</a> structure for
5433
5993
  * details.</p>
5434
5994
  */
5435
5995
  decisions?: Decision[];
5436
5996
  /**
5997
+ * @public
5437
5998
  * <p>User defined context to add to workflow execution.</p>
5438
5999
  */
5439
6000
  executionContext?: string;
@@ -5444,6 +6005,7 @@ export interface RespondDecisionTaskCompletedInput {
5444
6005
  */
5445
6006
  export interface Run {
5446
6007
  /**
6008
+ * @public
5447
6009
  * <p>The <code>runId</code> of a workflow execution. This ID is generated by the service and
5448
6010
  * can be used to uniquely identify the workflow execution within a domain.</p>
5449
6011
  */
@@ -5454,22 +6016,27 @@ export interface Run {
5454
6016
  */
5455
6017
  export interface SignalWorkflowExecutionInput {
5456
6018
  /**
6019
+ * @public
5457
6020
  * <p>The name of the domain containing the workflow execution to signal.</p>
5458
6021
  */
5459
6022
  domain: string | undefined;
5460
6023
  /**
6024
+ * @public
5461
6025
  * <p>The workflowId of the workflow execution to signal.</p>
5462
6026
  */
5463
6027
  workflowId: string | undefined;
5464
6028
  /**
6029
+ * @public
5465
6030
  * <p>The runId of the workflow execution to signal.</p>
5466
6031
  */
5467
6032
  runId?: string;
5468
6033
  /**
6034
+ * @public
5469
6035
  * <p>The name of the signal. This name must be meaningful to the target workflow.</p>
5470
6036
  */
5471
6037
  signalName: string | undefined;
5472
6038
  /**
6039
+ * @public
5473
6040
  * <p>Data to attach to the <code>WorkflowExecutionSignaled</code> event in the target
5474
6041
  * workflow execution's history.</p>
5475
6042
  */
@@ -5480,6 +6047,7 @@ export interface SignalWorkflowExecutionInput {
5480
6047
  */
5481
6048
  export interface StartWorkflowExecutionInput {
5482
6049
  /**
6050
+ * @public
5483
6051
  * <p>The name of the domain in which the workflow execution is created.</p>
5484
6052
  * <p>The specified string must not contain a
5485
6053
  * <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any
@@ -5488,6 +6056,7 @@ export interface StartWorkflowExecutionInput {
5488
6056
  */
5489
6057
  domain: string | undefined;
5490
6058
  /**
6059
+ * @public
5491
6060
  * <p>The user defined identifier associated with the workflow execution. You can use this to
5492
6061
  * associate a custom identifier with the workflow execution. You may specify the same identifier
5493
6062
  * if a workflow execution is logically a <i>restart</i> of a previous execution.
@@ -5500,10 +6069,12 @@ export interface StartWorkflowExecutionInput {
5500
6069
  */
5501
6070
  workflowId: string | undefined;
5502
6071
  /**
6072
+ * @public
5503
6073
  * <p>The type of the workflow to start.</p>
5504
6074
  */
5505
6075
  workflowType: WorkflowType | undefined;
5506
6076
  /**
6077
+ * @public
5507
6078
  * <p>The task list to use for the decision tasks generated for this workflow execution. This
5508
6079
  * overrides the <code>defaultTaskList</code> specified when registering the workflow
5509
6080
  * type.</p>
@@ -5519,6 +6090,7 @@ export interface StartWorkflowExecutionInput {
5519
6090
  */
5520
6091
  taskList?: TaskList;
5521
6092
  /**
6093
+ * @public
5522
6094
  * <p>The task priority to use for this workflow execution. This overrides any default
5523
6095
  * priority that was assigned when the workflow type was registered. If not set, then the default
5524
6096
  * task priority for the workflow type is used. Valid values are integers that range from Java's
@@ -5529,12 +6101,14 @@ export interface StartWorkflowExecutionInput {
5529
6101
  */
5530
6102
  taskPriority?: string;
5531
6103
  /**
6104
+ * @public
5532
6105
  * <p>The input for the workflow execution. This is a free form string which should be
5533
6106
  * meaningful to the workflow you are starting. This <code>input</code> is made available to the
5534
6107
  * new workflow execution in the <code>WorkflowExecutionStarted</code> history event.</p>
5535
6108
  */
5536
6109
  input?: string;
5537
6110
  /**
6111
+ * @public
5538
6112
  * <p>The total duration for this workflow execution. This overrides the
5539
6113
  * defaultExecutionStartToCloseTimeout specified when registering the workflow type.</p>
5540
6114
  * <p>The duration is specified in seconds; an integer greater than or equal to
@@ -5550,12 +6124,14 @@ export interface StartWorkflowExecutionInput {
5550
6124
  */
5551
6125
  executionStartToCloseTimeout?: string;
5552
6126
  /**
6127
+ * @public
5553
6128
  * <p>The list of tags to associate with the workflow execution. You can specify a maximum of
5554
6129
  * 5 tags. You can list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a> or <a>ListClosedWorkflowExecutions</a> and
5555
6130
  * specifying a <a>TagFilter</a>.</p>
5556
6131
  */
5557
6132
  tagList?: string[];
5558
6133
  /**
6134
+ * @public
5559
6135
  * <p>Specifies the maximum duration of decision tasks for this workflow execution. This
5560
6136
  * parameter overrides the <code>defaultTaskStartToCloseTimout</code> specified when registering
5561
6137
  * the workflow type using <a>RegisterWorkflowType</a>.</p>
@@ -5570,6 +6146,7 @@ export interface StartWorkflowExecutionInput {
5570
6146
  */
5571
6147
  taskStartToCloseTimeout?: string;
5572
6148
  /**
6149
+ * @public
5573
6150
  * <p>If set, specifies the policy to use for the child workflow executions of this workflow
5574
6151
  * execution if it is terminated, by calling the <a>TerminateWorkflowExecution</a>
5575
6152
  * action explicitly or due to an expired timeout. This policy overrides the default child policy
@@ -5601,6 +6178,7 @@ export interface StartWorkflowExecutionInput {
5601
6178
  */
5602
6179
  childPolicy?: ChildPolicy | string;
5603
6180
  /**
6181
+ * @public
5604
6182
  * <p>The IAM role to attach to this workflow execution.</p>
5605
6183
  * <note>
5606
6184
  * <p>Executions of this workflow type need IAM roles to invoke Lambda functions. If you
@@ -5629,10 +6207,12 @@ export declare class WorkflowExecutionAlreadyStartedFault extends __BaseExceptio
5629
6207
  */
5630
6208
  export interface TagResourceInput {
5631
6209
  /**
6210
+ * @public
5632
6211
  * <p>The Amazon Resource Name (ARN) for the Amazon SWF domain.</p>
5633
6212
  */
5634
6213
  resourceArn: string | undefined;
5635
6214
  /**
6215
+ * @public
5636
6216
  * <p>The list of tags to add to a domain. </p>
5637
6217
  * <p>Tags may only contain unicode letters, digits, whitespace, or these symbols: <code>_ . : / = + - @</code>.</p>
5638
6218
  */
@@ -5643,26 +6223,32 @@ export interface TagResourceInput {
5643
6223
  */
5644
6224
  export interface TerminateWorkflowExecutionInput {
5645
6225
  /**
6226
+ * @public
5646
6227
  * <p>The domain of the workflow execution to terminate.</p>
5647
6228
  */
5648
6229
  domain: string | undefined;
5649
6230
  /**
6231
+ * @public
5650
6232
  * <p>The workflowId of the workflow execution to terminate.</p>
5651
6233
  */
5652
6234
  workflowId: string | undefined;
5653
6235
  /**
6236
+ * @public
5654
6237
  * <p>The runId of the workflow execution to terminate.</p>
5655
6238
  */
5656
6239
  runId?: string;
5657
6240
  /**
6241
+ * @public
5658
6242
  * <p> A descriptive reason for terminating the workflow execution.</p>
5659
6243
  */
5660
6244
  reason?: string;
5661
6245
  /**
6246
+ * @public
5662
6247
  * <p> Details for terminating the workflow execution.</p>
5663
6248
  */
5664
6249
  details?: string;
5665
6250
  /**
6251
+ * @public
5666
6252
  * <p>If set, specifies the policy to use for the child workflow executions of the workflow
5667
6253
  * execution being terminated. This policy overrides the child policy specified for the workflow
5668
6254
  * execution at registration time or when starting the execution.</p>
@@ -5698,10 +6284,12 @@ export interface TerminateWorkflowExecutionInput {
5698
6284
  */
5699
6285
  export interface UndeprecateActivityTypeInput {
5700
6286
  /**
6287
+ * @public
5701
6288
  * <p>The name of the domain of the deprecated activity type.</p>
5702
6289
  */
5703
6290
  domain: string | undefined;
5704
6291
  /**
6292
+ * @public
5705
6293
  * <p>The activity type to undeprecate.</p>
5706
6294
  */
5707
6295
  activityType: ActivityType | undefined;
@@ -5711,6 +6299,7 @@ export interface UndeprecateActivityTypeInput {
5711
6299
  */
5712
6300
  export interface UndeprecateDomainInput {
5713
6301
  /**
6302
+ * @public
5714
6303
  * <p>The name of the domain of the deprecated workflow type.</p>
5715
6304
  */
5716
6305
  name: string | undefined;
@@ -5720,10 +6309,12 @@ export interface UndeprecateDomainInput {
5720
6309
  */
5721
6310
  export interface UndeprecateWorkflowTypeInput {
5722
6311
  /**
6312
+ * @public
5723
6313
  * <p>The name of the domain of the deprecated workflow type.</p>
5724
6314
  */
5725
6315
  domain: string | undefined;
5726
6316
  /**
6317
+ * @public
5727
6318
  * <p>The name of the domain of the deprecated workflow type.</p>
5728
6319
  */
5729
6320
  workflowType: WorkflowType | undefined;
@@ -5733,10 +6324,12 @@ export interface UndeprecateWorkflowTypeInput {
5733
6324
  */
5734
6325
  export interface UntagResourceInput {
5735
6326
  /**
6327
+ * @public
5736
6328
  * <p>The Amazon Resource Name (ARN) for the Amazon SWF domain.</p>
5737
6329
  */
5738
6330
  resourceArn: string | undefined;
5739
6331
  /**
6332
+ * @public
5740
6333
  * <p>The list of tags to remove from the Amazon SWF domain.</p>
5741
6334
  */
5742
6335
  tagKeys: string[] | undefined;