stepfunctions.d.ts
62.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class StepFunctions extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: StepFunctions.Types.ClientConfiguration)
config: Config & StepFunctions.Types.ClientConfiguration;
/**
* Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
*/
createActivity(params: StepFunctions.Types.CreateActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>;
/**
* Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
*/
createActivity(callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>;
/**
* Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
*/
createStateMachine(params: StepFunctions.Types.CreateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>;
/**
* Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
*/
createStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>;
/**
* Deletes an activity.
*/
deleteActivity(params: StepFunctions.Types.DeleteActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>;
/**
* Deletes an activity.
*/
deleteActivity(callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>;
/**
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted.
*/
deleteStateMachine(params: StepFunctions.Types.DeleteStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>;
/**
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted.
*/
deleteStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>;
/**
* Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeActivity(params: StepFunctions.Types.DescribeActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>;
/**
* Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeActivity(callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>;
/**
* Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeExecution(params: StepFunctions.Types.DescribeExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>;
/**
* Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>;
/**
* Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeStateMachine(params: StepFunctions.Types.DescribeStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>;
/**
* Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>;
/**
* Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeStateMachineForExecution(params: StepFunctions.Types.DescribeStateMachineForExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>;
/**
* Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
describeStateMachineForExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>;
/**
* Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
*/
getActivityTask(params: StepFunctions.Types.GetActivityTaskInput, callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request<StepFunctions.Types.GetActivityTaskOutput, AWSError>;
/**
* Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
*/
getActivityTask(callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request<StepFunctions.Types.GetActivityTaskOutput, AWSError>;
/**
* Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
getExecutionHistory(params: StepFunctions.Types.GetExecutionHistoryInput, callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request<StepFunctions.Types.GetExecutionHistoryOutput, AWSError>;
/**
* Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
getExecutionHistory(callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request<StepFunctions.Types.GetExecutionHistoryOutput, AWSError>;
/**
* Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
listActivities(params: StepFunctions.Types.ListActivitiesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>;
/**
* Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
listActivities(callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>;
/**
* Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
listExecutions(params: StepFunctions.Types.ListExecutionsInput, callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>;
/**
* Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
listExecutions(callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>;
/**
* Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
listStateMachines(params: StepFunctions.Types.ListStateMachinesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request<StepFunctions.Types.ListStateMachinesOutput, AWSError>;
/**
* Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
*/
listStateMachines(callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request<StepFunctions.Types.ListStateMachinesOutput, AWSError>;
/**
* List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
listTagsForResource(params: StepFunctions.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>;
/**
* List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
listTagsForResource(callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>;
/**
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
*/
sendTaskFailure(params: StepFunctions.Types.SendTaskFailureInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request<StepFunctions.Types.SendTaskFailureOutput, AWSError>;
/**
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
*/
sendTaskFailure(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request<StepFunctions.Types.SendTaskFailureOutput, AWSError>;
/**
* Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
*/
sendTaskHeartbeat(params: StepFunctions.Types.SendTaskHeartbeatInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request<StepFunctions.Types.SendTaskHeartbeatOutput, AWSError>;
/**
* Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
*/
sendTaskHeartbeat(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request<StepFunctions.Types.SendTaskHeartbeatOutput, AWSError>;
/**
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
*/
sendTaskSuccess(params: StepFunctions.Types.SendTaskSuccessInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>;
/**
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
*/
sendTaskSuccess(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>;
/**
* Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
*/
startExecution(params: StepFunctions.Types.StartExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>;
/**
* Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
*/
startExecution(callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>;
/**
* Stops an execution.
*/
stopExecution(params: StepFunctions.Types.StopExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request<StepFunctions.Types.StopExecutionOutput, AWSError>;
/**
* Stops an execution.
*/
stopExecution(callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request<StepFunctions.Types.StopExecutionOutput, AWSError>;
/**
* Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
tagResource(params: StepFunctions.Types.TagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request<StepFunctions.Types.TagResourceOutput, AWSError>;
/**
* Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
tagResource(callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request<StepFunctions.Types.TagResourceOutput, AWSError>;
/**
* Remove a tag from a Step Functions resource
*/
untagResource(params: StepFunctions.Types.UntagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request<StepFunctions.Types.UntagResourceOutput, AWSError>;
/**
* Remove a tag from a Step Functions resource
*/
untagResource(callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request<StepFunctions.Types.UntagResourceOutput, AWSError>;
/**
* Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
*/
updateStateMachine(params: StepFunctions.Types.UpdateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>;
/**
* Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
*/
updateStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>;
}
declare namespace StepFunctions {
export interface ActivityFailedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export type ActivityList = ActivityListItem[];
export interface ActivityListItem {
/**
* The Amazon Resource Name (ARN) that identifies the activity.
*/
activityArn: Arn;
/**
* The name of the activity. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The date the activity is created.
*/
creationDate: Timestamp;
}
export interface ActivityScheduleFailedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface ActivityScheduledEventDetails {
/**
* The Amazon Resource Name (ARN) of the scheduled activity.
*/
resource: Arn;
/**
* The JSON data input to the activity task.
*/
input?: SensitiveData;
/**
* The maximum allowed duration of the activity task.
*/
timeoutInSeconds?: TimeoutInSeconds;
/**
* The maximum allowed duration between two heartbeats for the activity task.
*/
heartbeatInSeconds?: TimeoutInSeconds;
}
export interface ActivityStartedEventDetails {
/**
* The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
*/
workerName?: Identity;
}
export interface ActivitySucceededEventDetails {
/**
* The JSON data output by the activity task.
*/
output?: SensitiveData;
}
export interface ActivityTimedOutEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the timeout.
*/
cause?: SensitiveCause;
}
export type Arn = string;
export interface CloudWatchLogsLogGroup {
/**
* The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
*/
logGroupArn?: Arn;
}
export type ConnectorParameters = string;
export interface CreateActivityInput {
/**
* The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The list of tags to add to a resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
tags?: TagList;
}
export interface CreateActivityOutput {
/**
* The Amazon Resource Name (ARN) that identifies the created activity.
*/
activityArn: Arn;
/**
* The date the activity is created.
*/
creationDate: Timestamp;
}
export interface CreateStateMachineInput {
/**
* The name of the state machine. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The Amazon States Language definition of the state machine. See Amazon States Language.
*/
definition: Definition;
/**
* The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
*/
roleArn: Arn;
/**
* Determines whether a Standard or Express state machine is created. If not set, Standard is created.
*/
type?: StateMachineType;
/**
* Defines what execution history events are logged and where they are logged.
*/
loggingConfiguration?: LoggingConfiguration;
/**
* Tags to be added when creating a state machine. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
tags?: TagList;
}
export interface CreateStateMachineOutput {
/**
* The Amazon Resource Name (ARN) that identifies the created state machine.
*/
stateMachineArn: Arn;
/**
* The date the state machine is created.
*/
creationDate: Timestamp;
}
export type Definition = string;
export interface DeleteActivityInput {
/**
* The Amazon Resource Name (ARN) of the activity to delete.
*/
activityArn: Arn;
}
export interface DeleteActivityOutput {
}
export interface DeleteStateMachineInput {
/**
* The Amazon Resource Name (ARN) of the state machine to delete.
*/
stateMachineArn: Arn;
}
export interface DeleteStateMachineOutput {
}
export interface DescribeActivityInput {
/**
* The Amazon Resource Name (ARN) of the activity to describe.
*/
activityArn: Arn;
}
export interface DescribeActivityOutput {
/**
* The Amazon Resource Name (ARN) that identifies the activity.
*/
activityArn: Arn;
/**
* The name of the activity. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The date the activity is created.
*/
creationDate: Timestamp;
}
export interface DescribeExecutionInput {
/**
* The Amazon Resource Name (ARN) of the execution to describe.
*/
executionArn: Arn;
}
export interface DescribeExecutionOutput {
/**
* The Amazon Resource Name (ARN) that identifies the execution.
*/
executionArn: Arn;
/**
* The Amazon Resource Name (ARN) of the executed stated machine.
*/
stateMachineArn: Arn;
/**
* The name of the execution. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name?: Name;
/**
* The current status of the execution.
*/
status: ExecutionStatus;
/**
* The date the execution is started.
*/
startDate: Timestamp;
/**
* If the execution has already ended, the date the execution stopped.
*/
stopDate?: Timestamp;
/**
* The string that contains the JSON input data of the execution.
*/
input: SensitiveData;
/**
* The JSON output data of the execution. This field is set only if the execution succeeds. If the execution fails, this field is null.
*/
output?: SensitiveData;
}
export interface DescribeStateMachineForExecutionInput {
/**
* The Amazon Resource Name (ARN) of the execution you want state machine information for.
*/
executionArn: Arn;
}
export interface DescribeStateMachineForExecutionOutput {
/**
* The Amazon Resource Name (ARN) of the state machine associated with the execution.
*/
stateMachineArn: Arn;
/**
* The name of the state machine associated with the execution.
*/
name: Name;
/**
* The Amazon States Language definition of the state machine. See Amazon States Language.
*/
definition: Definition;
/**
* The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
*/
roleArn: Arn;
/**
* The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
*/
updateDate: Timestamp;
}
export interface DescribeStateMachineInput {
/**
* The Amazon Resource Name (ARN) of the state machine to describe.
*/
stateMachineArn: Arn;
}
export interface DescribeStateMachineOutput {
/**
* The Amazon Resource Name (ARN) that identifies the state machine.
*/
stateMachineArn: Arn;
/**
* The name of the state machine. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The current status of the state machine.
*/
status?: StateMachineStatus;
/**
* The Amazon States Language definition of the state machine. See Amazon States Language.
*/
definition: Definition;
/**
* The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)
*/
roleArn: Arn;
/**
*
*/
type: StateMachineType;
/**
* The date the state machine is created.
*/
creationDate: Timestamp;
/**
*
*/
loggingConfiguration?: LoggingConfiguration;
}
export type EventId = number;
export interface ExecutionAbortedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface ExecutionFailedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export type ExecutionList = ExecutionListItem[];
export interface ExecutionListItem {
/**
* The Amazon Resource Name (ARN) that identifies the execution.
*/
executionArn: Arn;
/**
* The Amazon Resource Name (ARN) of the executed state machine.
*/
stateMachineArn: Arn;
/**
* The name of the execution. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The current status of the execution.
*/
status: ExecutionStatus;
/**
* The date the execution started.
*/
startDate: Timestamp;
/**
* If the execution already ended, the date the execution stopped.
*/
stopDate?: Timestamp;
}
export interface ExecutionStartedEventDetails {
/**
* The JSON data input to the execution.
*/
input?: SensitiveData;
/**
* The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
*/
roleArn?: Arn;
}
export type ExecutionStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"ABORTED"|string;
export interface ExecutionSucceededEventDetails {
/**
* The JSON data output by the execution.
*/
output?: SensitiveData;
}
export interface ExecutionTimedOutEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the timeout.
*/
cause?: SensitiveCause;
}
export interface GetActivityTaskInput {
/**
* The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
*/
activityArn: Arn;
/**
* You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
*/
workerName?: Name;
}
export interface GetActivityTaskOutput {
/**
* A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
*/
taskToken?: TaskToken;
/**
* The string that contains the JSON input data for the task.
*/
input?: SensitiveDataJobInput;
}
export interface GetExecutionHistoryInput {
/**
* The Amazon Resource Name (ARN) of the execution.
*/
executionArn: Arn;
/**
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*/
maxResults?: PageSize;
/**
* Lists events in descending order of their timeStamp.
*/
reverseOrder?: ReverseOrder;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: PageToken;
}
export interface GetExecutionHistoryOutput {
/**
* The list of events that occurred in the execution.
*/
events: HistoryEventList;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: PageToken;
}
export interface HistoryEvent {
/**
* The date and time the event occurred.
*/
timestamp: Timestamp;
/**
* The type of the event.
*/
type: HistoryEventType;
/**
* The id of the event. Events are numbered sequentially, starting at one.
*/
id: EventId;
/**
* The id of the previous event.
*/
previousEventId?: EventId;
activityFailedEventDetails?: ActivityFailedEventDetails;
/**
* Contains details about an activity schedule event that failed during an execution.
*/
activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails;
activityScheduledEventDetails?: ActivityScheduledEventDetails;
activityStartedEventDetails?: ActivityStartedEventDetails;
activitySucceededEventDetails?: ActivitySucceededEventDetails;
activityTimedOutEventDetails?: ActivityTimedOutEventDetails;
/**
* Contains details about the failure of a task.
*/
taskFailedEventDetails?: TaskFailedEventDetails;
/**
* Contains details about a task that was scheduled.
*/
taskScheduledEventDetails?: TaskScheduledEventDetails;
/**
* Contains details about a task that failed to start.
*/
taskStartFailedEventDetails?: TaskStartFailedEventDetails;
/**
* Contains details about a task that was started.
*/
taskStartedEventDetails?: TaskStartedEventDetails;
/**
* Contains details about a task that where the submit failed.
*/
taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails;
/**
* Contains details about a submitted task.
*/
taskSubmittedEventDetails?: TaskSubmittedEventDetails;
/**
* Contains details about a task that succeeded.
*/
taskSucceededEventDetails?: TaskSucceededEventDetails;
/**
* Contains details about a task that timed out.
*/
taskTimedOutEventDetails?: TaskTimedOutEventDetails;
executionFailedEventDetails?: ExecutionFailedEventDetails;
executionStartedEventDetails?: ExecutionStartedEventDetails;
executionSucceededEventDetails?: ExecutionSucceededEventDetails;
executionAbortedEventDetails?: ExecutionAbortedEventDetails;
executionTimedOutEventDetails?: ExecutionTimedOutEventDetails;
/**
* Contains details about Map state that was started.
*/
mapStateStartedEventDetails?: MapStateStartedEventDetails;
/**
* Contains details about an iteration of a Map state that was started.
*/
mapIterationStartedEventDetails?: MapIterationEventDetails;
/**
* Contains details about an iteration of a Map state that succeeded.
*/
mapIterationSucceededEventDetails?: MapIterationEventDetails;
/**
* Contains details about an iteration of a Map state that failed.
*/
mapIterationFailedEventDetails?: MapIterationEventDetails;
/**
* Contains details about an iteration of a Map state that was aborted.
*/
mapIterationAbortedEventDetails?: MapIterationEventDetails;
lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails;
lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails;
lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails;
/**
* Contains details about a lambda function that failed to start during an execution.
*/
lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails;
/**
* Contains details about a lambda function that terminated successfully during an execution.
*/
lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails;
lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails;
stateEnteredEventDetails?: StateEnteredEventDetails;
stateExitedEventDetails?: StateExitedEventDetails;
}
export type HistoryEventList = HistoryEvent[];
export type HistoryEventType = "ActivityFailed"|"ActivityScheduled"|"ActivityScheduleFailed"|"ActivityStarted"|"ActivitySucceeded"|"ActivityTimedOut"|"ChoiceStateEntered"|"ChoiceStateExited"|"ExecutionAborted"|"ExecutionFailed"|"ExecutionStarted"|"ExecutionSucceeded"|"ExecutionTimedOut"|"FailStateEntered"|"LambdaFunctionFailed"|"LambdaFunctionScheduled"|"LambdaFunctionScheduleFailed"|"LambdaFunctionStarted"|"LambdaFunctionStartFailed"|"LambdaFunctionSucceeded"|"LambdaFunctionTimedOut"|"MapIterationAborted"|"MapIterationFailed"|"MapIterationStarted"|"MapIterationSucceeded"|"MapStateAborted"|"MapStateEntered"|"MapStateExited"|"MapStateFailed"|"MapStateStarted"|"MapStateSucceeded"|"ParallelStateAborted"|"ParallelStateEntered"|"ParallelStateExited"|"ParallelStateFailed"|"ParallelStateStarted"|"ParallelStateSucceeded"|"PassStateEntered"|"PassStateExited"|"SucceedStateEntered"|"SucceedStateExited"|"TaskFailed"|"TaskScheduled"|"TaskStarted"|"TaskStartFailed"|"TaskStateAborted"|"TaskStateEntered"|"TaskStateExited"|"TaskSubmitFailed"|"TaskSubmitted"|"TaskSucceeded"|"TaskTimedOut"|"WaitStateAborted"|"WaitStateEntered"|"WaitStateExited"|string;
export type Identity = string;
export type IncludeExecutionData = boolean;
export interface LambdaFunctionFailedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface LambdaFunctionScheduleFailedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface LambdaFunctionScheduledEventDetails {
/**
* The Amazon Resource Name (ARN) of the scheduled lambda function.
*/
resource: Arn;
/**
* The JSON data input to the lambda function.
*/
input?: SensitiveData;
/**
* The maximum allowed duration of the lambda function.
*/
timeoutInSeconds?: TimeoutInSeconds;
}
export interface LambdaFunctionStartFailedEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface LambdaFunctionSucceededEventDetails {
/**
* The JSON data output by the lambda function.
*/
output?: SensitiveData;
}
export interface LambdaFunctionTimedOutEventDetails {
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the timeout.
*/
cause?: SensitiveCause;
}
export interface ListActivitiesInput {
/**
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*/
maxResults?: PageSize;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: PageToken;
}
export interface ListActivitiesOutput {
/**
* The list of activities.
*/
activities: ActivityList;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: PageToken;
}
export interface ListExecutionsInput {
/**
* The Amazon Resource Name (ARN) of the state machine whose executions is listed.
*/
stateMachineArn: Arn;
/**
* If specified, only list the executions whose current execution status matches the given filter.
*/
statusFilter?: ExecutionStatus;
/**
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*/
maxResults?: PageSize;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: ListExecutionsPageToken;
}
export interface ListExecutionsOutput {
/**
* The list of matching executions.
*/
executions: ExecutionList;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: ListExecutionsPageToken;
}
export type ListExecutionsPageToken = string;
export interface ListStateMachinesInput {
/**
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*/
maxResults?: PageSize;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: PageToken;
}
export interface ListStateMachinesOutput {
stateMachines: StateMachineList;
/**
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
nextToken?: PageToken;
}
export interface ListTagsForResourceInput {
/**
* The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
*/
resourceArn: Arn;
}
export interface ListTagsForResourceOutput {
/**
* An array of tags associated with the resource.
*/
tags?: TagList;
}
export interface LogDestination {
/**
* An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
*/
cloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
}
export type LogDestinationList = LogDestination[];
export type LogLevel = "ALL"|"ERROR"|"FATAL"|"OFF"|string;
export interface LoggingConfiguration {
/**
* Defines which category of execution history events are logged.
*/
level?: LogLevel;
/**
* Determines whether execution history data is included in your log. When set to FALSE, data is excluded.
*/
includeExecutionData?: IncludeExecutionData;
/**
* An object that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.
*/
destinations?: LogDestinationList;
}
export interface MapIterationEventDetails {
/**
* The name of the iteration’s parent Map state.
*/
name?: Name;
/**
* The index of the array belonging to the Map state iteration.
*/
index?: UnsignedInteger;
}
export interface MapStateStartedEventDetails {
/**
* The size of the array for Map state iterations.
*/
length?: UnsignedInteger;
}
export type Name = string;
export type PageSize = number;
export type PageToken = string;
export type ReverseOrder = boolean;
export interface SendTaskFailureInput {
/**
* The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
*/
taskToken: TaskToken;
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface SendTaskFailureOutput {
}
export interface SendTaskHeartbeatInput {
/**
* The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
*/
taskToken: TaskToken;
}
export interface SendTaskHeartbeatOutput {
}
export interface SendTaskSuccessInput {
/**
* The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
*/
taskToken: TaskToken;
/**
* The JSON output of the task.
*/
output: SensitiveData;
}
export interface SendTaskSuccessOutput {
}
export type SensitiveCause = string;
export type SensitiveData = string;
export type SensitiveDataJobInput = string;
export type SensitiveError = string;
export interface StartExecutionInput {
/**
* The Amazon Resource Name (ARN) of the state machine to execute.
*/
stateMachineArn: Arn;
/**
* The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name?: Name;
/**
* The string that contains the JSON input data for the execution, for example: "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"
*/
input?: SensitiveData;
}
export interface StartExecutionOutput {
/**
* The Amazon Resource Name (ARN) that identifies the execution.
*/
executionArn: Arn;
/**
* The date the execution is started.
*/
startDate: Timestamp;
}
export interface StateEnteredEventDetails {
/**
* The name of the state.
*/
name: Name;
/**
* The string that contains the JSON input data for the state.
*/
input?: SensitiveData;
}
export interface StateExitedEventDetails {
/**
* The name of the state. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
* The JSON output data of the state.
*/
output?: SensitiveData;
}
export type StateMachineList = StateMachineListItem[];
export interface StateMachineListItem {
/**
* The Amazon Resource Name (ARN) that identifies the state machine.
*/
stateMachineArn: Arn;
/**
* The name of the state machine. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F)
*/
name: Name;
/**
*
*/
type: StateMachineType;
/**
* The date the state machine is created.
*/
creationDate: Timestamp;
}
export type StateMachineStatus = "ACTIVE"|"DELETING"|string;
export type StateMachineType = "STANDARD"|"EXPRESS"|string;
export interface StopExecutionInput {
/**
* The Amazon Resource Name (ARN) of the execution to stop.
*/
executionArn: Arn;
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface StopExecutionOutput {
/**
* The date the execution is stopped.
*/
stopDate: Timestamp;
}
export interface Tag {
/**
* The key of a tag.
*/
key?: TagKey;
/**
* The value of a tag.
*/
value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceInput {
/**
* The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
*/
resourceArn: Arn;
/**
* The list of tags to add to a resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*/
tags: TagList;
}
export interface TagResourceOutput {
}
export type TagValue = string;
export interface TaskFailedEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface TaskScheduledEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The region of the scheduled task
*/
region: Name;
/**
* The JSON data passed to the resource referenced in a task state.
*/
parameters: ConnectorParameters;
/**
* The maximum allowed duration of the task.
*/
timeoutInSeconds?: TimeoutInSeconds;
}
export interface TaskStartFailedEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface TaskStartedEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
}
export interface TaskSubmitFailedEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export interface TaskSubmittedEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The response from a resource when a task has started.
*/
output?: SensitiveData;
}
export interface TaskSucceededEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task.
*/
output?: SensitiveData;
}
export interface TaskTimedOutEventDetails {
/**
* The action of the resource called by a task state.
*/
resourceType: Name;
/**
* The service name of the resource in a task state.
*/
resource: Name;
/**
* The error code of the failure.
*/
error?: SensitiveError;
/**
* A more detailed explanation of the cause of the failure.
*/
cause?: SensitiveCause;
}
export type TaskToken = string;
export type TimeoutInSeconds = number;
export type Timestamp = Date;
export type UnsignedInteger = number;
export interface UntagResourceInput {
/**
* The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
*/
resourceArn: Arn;
/**
* The list of tags to remove from the resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceOutput {
}
export interface UpdateStateMachineInput {
/**
* The Amazon Resource Name (ARN) of the state machine.
*/
stateMachineArn: Arn;
/**
* The Amazon States Language definition of the state machine. See Amazon States Language.
*/
definition?: Definition;
/**
* The Amazon Resource Name (ARN) of the IAM role of the state machine.
*/
roleArn?: Arn;
/**
*
*/
loggingConfiguration?: LoggingConfiguration;
}
export interface UpdateStateMachineOutput {
/**
* The date and time the state machine was updated.
*/
updateDate: Timestamp;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-11-23"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the StepFunctions client.
*/
export import Types = StepFunctions;
}
export = StepFunctions;