@aws-sdk/client-sfn 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 +374 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -18,10 +18,12 @@ export declare class ActivityDoesNotExist extends __BaseException {
18
18
  */
19
19
  export interface ActivityFailedEventDetails {
20
20
  /**
21
+ * @public
21
22
  * <p>The error code of the failure.</p>
22
23
  */
23
24
  error?: string;
24
25
  /**
26
+ * @public
25
27
  * <p>A more detailed explanation of the cause of the failure.</p>
26
28
  */
27
29
  cause?: string;
@@ -45,10 +47,12 @@ export declare class ActivityLimitExceeded extends __BaseException {
45
47
  */
46
48
  export interface ActivityListItem {
47
49
  /**
50
+ * @public
48
51
  * <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
49
52
  */
50
53
  activityArn: string | undefined;
51
54
  /**
55
+ * @public
52
56
  * <p>The name of the activity.</p>
53
57
  * <p>A name must <i>not</i> contain:</p>
54
58
  * <ul>
@@ -75,6 +79,7 @@ export interface ActivityListItem {
75
79
  */
76
80
  name: string | undefined;
77
81
  /**
82
+ * @public
78
83
  * <p>The date the activity is created.</p>
79
84
  */
80
85
  creationDate: Date | undefined;
@@ -85,6 +90,7 @@ export interface ActivityListItem {
85
90
  */
86
91
  export interface HistoryEventExecutionDataDetails {
87
92
  /**
93
+ * @public
88
94
  * <p>Indicates whether input or output was truncated in the response. Always <code>false</code>
89
95
  * for API calls.</p>
90
96
  */
@@ -96,22 +102,27 @@ export interface HistoryEventExecutionDataDetails {
96
102
  */
97
103
  export interface ActivityScheduledEventDetails {
98
104
  /**
105
+ * @public
99
106
  * <p>The Amazon Resource Name (ARN) of the scheduled activity.</p>
100
107
  */
101
108
  resource: string | undefined;
102
109
  /**
110
+ * @public
103
111
  * <p>The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
104
112
  */
105
113
  input?: string;
106
114
  /**
115
+ * @public
107
116
  * <p>Contains details about the input for an execution history event.</p>
108
117
  */
109
118
  inputDetails?: HistoryEventExecutionDataDetails;
110
119
  /**
120
+ * @public
111
121
  * <p>The maximum allowed duration of the activity task.</p>
112
122
  */
113
123
  timeoutInSeconds?: number;
114
124
  /**
125
+ * @public
115
126
  * <p>The maximum allowed duration between two heartbeats for the activity task.</p>
116
127
  */
117
128
  heartbeatInSeconds?: number;
@@ -123,10 +134,12 @@ export interface ActivityScheduledEventDetails {
123
134
  */
124
135
  export interface ActivityScheduleFailedEventDetails {
125
136
  /**
137
+ * @public
126
138
  * <p>The error code of the failure.</p>
127
139
  */
128
140
  error?: string;
129
141
  /**
142
+ * @public
130
143
  * <p>A more detailed explanation of the cause of the failure.</p>
131
144
  */
132
145
  cause?: string;
@@ -137,6 +150,7 @@ export interface ActivityScheduleFailedEventDetails {
137
150
  */
138
151
  export interface ActivityStartedEventDetails {
139
152
  /**
153
+ * @public
140
154
  * <p>The name of the worker that the task is assigned to. These names are provided by the
141
155
  * workers when calling <a>GetActivityTask</a>.</p>
142
156
  */
@@ -149,10 +163,12 @@ export interface ActivityStartedEventDetails {
149
163
  */
150
164
  export interface ActivitySucceededEventDetails {
151
165
  /**
166
+ * @public
152
167
  * <p>The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
153
168
  */
154
169
  output?: string;
155
170
  /**
171
+ * @public
156
172
  * <p>Contains details about the output of an execution history event.</p>
157
173
  */
158
174
  outputDetails?: HistoryEventExecutionDataDetails;
@@ -163,10 +179,12 @@ export interface ActivitySucceededEventDetails {
163
179
  */
164
180
  export interface ActivityTimedOutEventDetails {
165
181
  /**
182
+ * @public
166
183
  * <p>The error code of the failure.</p>
167
184
  */
168
185
  error?: string;
169
186
  /**
187
+ * @public
170
188
  * <p>A more detailed explanation of the cause of the timeout.</p>
171
189
  */
172
190
  cause?: string;
@@ -196,10 +214,12 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
196
214
  */
197
215
  export interface Tag {
198
216
  /**
217
+ * @public
199
218
  * <p>The key of a tag.</p>
200
219
  */
201
220
  key?: string;
202
221
  /**
222
+ * @public
203
223
  * <p>The value of a tag.</p>
204
224
  */
205
225
  value?: string;
@@ -209,6 +229,7 @@ export interface Tag {
209
229
  */
210
230
  export interface CreateActivityInput {
211
231
  /**
232
+ * @public
212
233
  * <p>The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information,
213
234
  * see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
214
235
  * Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
@@ -237,6 +258,7 @@ export interface CreateActivityInput {
237
258
  */
238
259
  name: string | undefined;
239
260
  /**
261
+ * @public
240
262
  * <p>The list of tags to add to a resource.</p>
241
263
  * <p>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using
242
264
  * Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
@@ -251,10 +273,12 @@ export interface CreateActivityInput {
251
273
  */
252
274
  export interface CreateActivityOutput {
253
275
  /**
276
+ * @public
254
277
  * <p>The Amazon Resource Name (ARN) that identifies the created activity.</p>
255
278
  */
256
279
  activityArn: string | undefined;
257
280
  /**
281
+ * @public
258
282
  * <p>The date the activity is created.</p>
259
283
  */
260
284
  creationDate: Date | undefined;
@@ -304,6 +328,7 @@ export declare class ConflictException extends __BaseException {
304
328
  */
305
329
  export interface CloudWatchLogsLogGroup {
306
330
  /**
331
+ * @public
307
332
  * <p>The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN
308
333
  * must end with <code>:*</code>
309
334
  * </p>
@@ -316,6 +341,7 @@ export interface CloudWatchLogsLogGroup {
316
341
  */
317
342
  export interface LogDestination {
318
343
  /**
344
+ * @public
319
345
  * <p>An object describing a CloudWatch log group. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html">AWS::Logs::LogGroup</a> in the CloudFormation User Guide.</p>
320
346
  */
321
347
  cloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
@@ -341,15 +367,18 @@ export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
341
367
  */
342
368
  export interface LoggingConfiguration {
343
369
  /**
370
+ * @public
344
371
  * <p>Defines which category of execution history events are logged.</p>
345
372
  */
346
373
  level?: LogLevel | string;
347
374
  /**
375
+ * @public
348
376
  * <p>Determines whether execution data is included in your log. When set to <code>false</code>,
349
377
  * data is excluded.</p>
350
378
  */
351
379
  includeExecutionData?: boolean;
352
380
  /**
381
+ * @public
353
382
  * <p>An array of objects that describes where your execution history events will be logged.
354
383
  * Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</p>
355
384
  */
@@ -363,6 +392,7 @@ export interface LoggingConfiguration {
363
392
  */
364
393
  export interface TracingConfiguration {
365
394
  /**
395
+ * @public
366
396
  * <p>When set to <code>true</code>, X-Ray tracing is enabled.</p>
367
397
  */
368
398
  enabled?: boolean;
@@ -384,6 +414,7 @@ export type StateMachineType = (typeof StateMachineType)[keyof typeof StateMachi
384
414
  */
385
415
  export interface CreateStateMachineInput {
386
416
  /**
417
+ * @public
387
418
  * <p>The name of the state machine. </p>
388
419
  * <p>A name must <i>not</i> contain:</p>
389
420
  * <ul>
@@ -410,20 +441,24 @@ export interface CreateStateMachineInput {
410
441
  */
411
442
  name: string | undefined;
412
443
  /**
444
+ * @public
413
445
  * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
414
446
  */
415
447
  definition: string | undefined;
416
448
  /**
449
+ * @public
417
450
  * <p>The Amazon Resource Name (ARN) of the IAM role to use for this state machine.</p>
418
451
  */
419
452
  roleArn: string | undefined;
420
453
  /**
454
+ * @public
421
455
  * <p>Determines whether a Standard or Express state machine is created. The default is
422
456
  * <code>STANDARD</code>. You cannot update the <code>type</code> of a state machine once it
423
457
  * has been created.</p>
424
458
  */
425
459
  type?: StateMachineType | string;
426
460
  /**
461
+ * @public
427
462
  * <p>Defines what execution history events are logged and where they are logged.</p>
428
463
  * <note>
429
464
  * <p>By default, the <code>level</code> is set to <code>OFF</code>. For more information see
@@ -433,6 +468,7 @@ export interface CreateStateMachineInput {
433
468
  */
434
469
  loggingConfiguration?: LoggingConfiguration;
435
470
  /**
471
+ * @public
436
472
  * <p>Tags to be added when creating a state machine.</p>
437
473
  * <p>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using
438
474
  * Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
@@ -442,14 +478,17 @@ export interface CreateStateMachineInput {
442
478
  */
443
479
  tags?: Tag[];
444
480
  /**
481
+ * @public
445
482
  * <p>Selects whether X-Ray tracing is enabled.</p>
446
483
  */
447
484
  tracingConfiguration?: TracingConfiguration;
448
485
  /**
486
+ * @public
449
487
  * <p>Set to <code>true</code> to publish the first version of the state machine during creation. The default is <code>false</code>.</p>
450
488
  */
451
489
  publish?: boolean;
452
490
  /**
491
+ * @public
453
492
  * <p>Sets description about the state machine version. You can only set the description if the <code>publish</code> parameter is set to <code>true</code>. Otherwise, if you set <code>versionDescription</code>, but <code>publish</code> to <code>false</code>, this API action throws <code>ValidationException</code>.</p>
454
493
  */
455
494
  versionDescription?: string;
@@ -459,14 +498,17 @@ export interface CreateStateMachineInput {
459
498
  */
460
499
  export interface CreateStateMachineOutput {
461
500
  /**
501
+ * @public
462
502
  * <p>The Amazon Resource Name (ARN) that identifies the created state machine.</p>
463
503
  */
464
504
  stateMachineArn: string | undefined;
465
505
  /**
506
+ * @public
466
507
  * <p>The date the state machine is created.</p>
467
508
  */
468
509
  creationDate: Date | undefined;
469
510
  /**
511
+ * @public
470
512
  * <p>The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the <code>publish</code> parameter to <code>true</code>, this field returns null value.</p>
471
513
  */
472
514
  stateMachineVersionArn?: string;
@@ -592,6 +634,7 @@ export declare class ValidationException extends __BaseException {
592
634
  readonly name: "ValidationException";
593
635
  readonly $fault: "client";
594
636
  /**
637
+ * @public
595
638
  * <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
596
639
  */
597
640
  reason?: ValidationExceptionReason | string;
@@ -608,11 +651,13 @@ export declare class ValidationException extends __BaseException {
608
651
  */
609
652
  export interface RoutingConfigurationListItem {
610
653
  /**
654
+ * @public
611
655
  * <p>The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.</p>
612
656
  * <p>If you specify the ARN of a second version, it must belong to the same state machine as the first version.</p>
613
657
  */
614
658
  stateMachineVersionArn: string | undefined;
615
659
  /**
660
+ * @public
616
661
  * <p>The percentage of traffic you want to route to the second state machine
617
662
  * version. The sum of the weights in the routing
618
663
  * configuration must be equal to 100.</p>
@@ -624,15 +669,18 @@ export interface RoutingConfigurationListItem {
624
669
  */
625
670
  export interface CreateStateMachineAliasInput {
626
671
  /**
672
+ * @public
627
673
  * <p>A description for the state machine alias.</p>
628
674
  */
629
675
  description?: string;
630
676
  /**
677
+ * @public
631
678
  * <p>The name of the state machine alias.</p>
632
679
  * <p>To avoid conflict with version ARNs, don't use an integer in the name of the alias.</p>
633
680
  */
634
681
  name: string | undefined;
635
682
  /**
683
+ * @public
636
684
  * <p>The routing configuration of a state machine alias. The routing configuration shifts
637
685
  * execution traffic between two state machine versions. <code>routingConfiguration</code>
638
686
  * contains an array of <code>RoutingConfig</code> objects that specify up to two state machine
@@ -646,10 +694,12 @@ export interface CreateStateMachineAliasInput {
646
694
  */
647
695
  export interface CreateStateMachineAliasOutput {
648
696
  /**
697
+ * @public
649
698
  * <p>The Amazon Resource Name (ARN) that identifies the created state machine alias.</p>
650
699
  */
651
700
  stateMachineAliasArn: string | undefined;
652
701
  /**
702
+ * @public
653
703
  * <p>The date the state machine alias was created.</p>
654
704
  */
655
705
  creationDate: Date | undefined;
@@ -685,6 +735,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
685
735
  */
686
736
  export interface DeleteActivityInput {
687
737
  /**
738
+ * @public
688
739
  * <p>The Amazon Resource Name (ARN) of the activity to delete.</p>
689
740
  */
690
741
  activityArn: string | undefined;
@@ -699,6 +750,7 @@ export interface DeleteActivityOutput {
699
750
  */
700
751
  export interface DeleteStateMachineInput {
701
752
  /**
753
+ * @public
702
754
  * <p>The Amazon Resource Name (ARN) of the state machine to delete.</p>
703
755
  */
704
756
  stateMachineArn: string | undefined;
@@ -713,6 +765,7 @@ export interface DeleteStateMachineOutput {
713
765
  */
714
766
  export interface DeleteStateMachineAliasInput {
715
767
  /**
768
+ * @public
716
769
  * <p>The Amazon Resource Name (ARN) of the state machine alias to delete.</p>
717
770
  */
718
771
  stateMachineAliasArn: string | undefined;
@@ -727,6 +780,7 @@ export interface DeleteStateMachineAliasOutput {
727
780
  */
728
781
  export interface DeleteStateMachineVersionInput {
729
782
  /**
783
+ * @public
730
784
  * <p>The Amazon Resource Name (ARN) of the state machine version to delete.</p>
731
785
  */
732
786
  stateMachineVersionArn: string | undefined;
@@ -741,6 +795,7 @@ export interface DeleteStateMachineVersionOutput {
741
795
  */
742
796
  export interface DescribeActivityInput {
743
797
  /**
798
+ * @public
744
799
  * <p>The Amazon Resource Name (ARN) of the activity to describe.</p>
745
800
  */
746
801
  activityArn: string | undefined;
@@ -750,10 +805,12 @@ export interface DescribeActivityInput {
750
805
  */
751
806
  export interface DescribeActivityOutput {
752
807
  /**
808
+ * @public
753
809
  * <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
754
810
  */
755
811
  activityArn: string | undefined;
756
812
  /**
813
+ * @public
757
814
  * <p>The name of the activity.</p>
758
815
  * <p>A name must <i>not</i> contain:</p>
759
816
  * <ul>
@@ -780,6 +837,7 @@ export interface DescribeActivityOutput {
780
837
  */
781
838
  name: string | undefined;
782
839
  /**
840
+ * @public
783
841
  * <p>The date the activity is created.</p>
784
842
  */
785
843
  creationDate: Date | undefined;
@@ -789,6 +847,7 @@ export interface DescribeActivityOutput {
789
847
  */
790
848
  export interface DescribeExecutionInput {
791
849
  /**
850
+ * @public
792
851
  * <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
793
852
  */
794
853
  executionArn: string | undefined;
@@ -799,6 +858,7 @@ export interface DescribeExecutionInput {
799
858
  */
800
859
  export interface CloudWatchEventsExecutionDataDetails {
801
860
  /**
861
+ * @public
802
862
  * <p>Indicates whether input or output was included in the response. Always <code>true</code>
803
863
  * for API calls. </p>
804
864
  */
@@ -824,14 +884,17 @@ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionSta
824
884
  */
825
885
  export interface DescribeExecutionOutput {
826
886
  /**
887
+ * @public
827
888
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
828
889
  */
829
890
  executionArn: string | undefined;
830
891
  /**
892
+ * @public
831
893
  * <p>The Amazon Resource Name (ARN) of the executed stated machine.</p>
832
894
  */
833
895
  stateMachineArn: string | undefined;
834
896
  /**
897
+ * @public
835
898
  * <p>The name of the execution.</p>
836
899
  * <p>A name must <i>not</i> contain:</p>
837
900
  * <ul>
@@ -858,26 +921,32 @@ export interface DescribeExecutionOutput {
858
921
  */
859
922
  name?: string;
860
923
  /**
924
+ * @public
861
925
  * <p>The current status of the execution.</p>
862
926
  */
863
927
  status: ExecutionStatus | string | undefined;
864
928
  /**
929
+ * @public
865
930
  * <p>The date the execution is started.</p>
866
931
  */
867
932
  startDate: Date | undefined;
868
933
  /**
934
+ * @public
869
935
  * <p>If the execution ended, the date the execution stopped.</p>
870
936
  */
871
937
  stopDate?: Date;
872
938
  /**
939
+ * @public
873
940
  * <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
874
941
  */
875
942
  input?: string;
876
943
  /**
944
+ * @public
877
945
  * <p>Provides details about execution input or output.</p>
878
946
  */
879
947
  inputDetails?: CloudWatchEventsExecutionDataDetails;
880
948
  /**
949
+ * @public
881
950
  * <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
882
951
  * <note>
883
952
  * <p>This field is set only if the execution succeeds. If the execution fails, this field is
@@ -886,32 +955,39 @@ export interface DescribeExecutionOutput {
886
955
  */
887
956
  output?: string;
888
957
  /**
958
+ * @public
889
959
  * <p>Provides details about execution input or output.</p>
890
960
  */
891
961
  outputDetails?: CloudWatchEventsExecutionDataDetails;
892
962
  /**
963
+ * @public
893
964
  * <p>The X-Ray trace header that was passed to the execution.</p>
894
965
  */
895
966
  traceHeader?: string;
896
967
  /**
968
+ * @public
897
969
  * <p>The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.</p>
898
970
  */
899
971
  mapRunArn?: string;
900
972
  /**
973
+ * @public
901
974
  * <p>The error string if the state machine execution failed.</p>
902
975
  */
903
976
  error?: string;
904
977
  /**
978
+ * @public
905
979
  * <p>The cause string if the state machine execution failed.</p>
906
980
  */
907
981
  cause?: string;
908
982
  /**
983
+ * @public
909
984
  * <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
910
985
  * <p>If you start an execution from a <code>StartExecution</code> request without specifying a
911
986
  * state machine version or alias ARN, Step Functions returns a null value.</p>
912
987
  */
913
988
  stateMachineVersionArn?: string;
914
989
  /**
990
+ * @public
915
991
  * <p>The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, <code>stateMachineARN:PROD</code>.</p>
916
992
  * <p>If you start an execution from a <code>StartExecution</code> request with a
917
993
  * state machine version ARN, this field will be null.</p>
@@ -935,6 +1011,7 @@ export declare class ExecutionDoesNotExist extends __BaseException {
935
1011
  */
936
1012
  export interface DescribeMapRunInput {
937
1013
  /**
1014
+ * @public
938
1015
  * <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
939
1016
  */
940
1017
  mapRunArn: string | undefined;
@@ -945,34 +1022,42 @@ export interface DescribeMapRunInput {
945
1022
  */
946
1023
  export interface MapRunExecutionCounts {
947
1024
  /**
1025
+ * @public
948
1026
  * <p>The total number of child workflow executions that were started by a Map Run, but haven't started executing yet. </p>
949
1027
  */
950
1028
  pending: number | undefined;
951
1029
  /**
1030
+ * @public
952
1031
  * <p>The total number of child workflow executions that were started by a Map Run and are currently in-progress.</p>
953
1032
  */
954
1033
  running: number | undefined;
955
1034
  /**
1035
+ * @public
956
1036
  * <p>The total number of child workflow executions that were started by a Map Run and have completed successfully.</p>
957
1037
  */
958
1038
  succeeded: number | undefined;
959
1039
  /**
1040
+ * @public
960
1041
  * <p>The total number of child workflow executions that were started by a Map Run, but have failed.</p>
961
1042
  */
962
1043
  failed: number | undefined;
963
1044
  /**
1045
+ * @public
964
1046
  * <p>The total number of child workflow executions that were started by a Map Run and have timed out.</p>
965
1047
  */
966
1048
  timedOut: number | undefined;
967
1049
  /**
1050
+ * @public
968
1051
  * <p>The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed. </p>
969
1052
  */
970
1053
  aborted: number | undefined;
971
1054
  /**
1055
+ * @public
972
1056
  * <p>The total number of child workflow executions that were started by a Map Run.</p>
973
1057
  */
974
1058
  total: number | undefined;
975
1059
  /**
1060
+ * @public
976
1061
  * <p>Returns the count of child workflow executions whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.</p>
977
1062
  */
978
1063
  resultsWritten: number | undefined;
@@ -983,34 +1068,42 @@ export interface MapRunExecutionCounts {
983
1068
  */
984
1069
  export interface MapRunItemCounts {
985
1070
  /**
1071
+ * @public
986
1072
  * <p>The total number of items to process in child workflow executions that haven't started running yet.</p>
987
1073
  */
988
1074
  pending: number | undefined;
989
1075
  /**
1076
+ * @public
990
1077
  * <p>The total number of items being processed in child workflow executions that are currently in-progress.</p>
991
1078
  */
992
1079
  running: number | undefined;
993
1080
  /**
1081
+ * @public
994
1082
  * <p>The total number of items processed in child workflow executions that have completed successfully.</p>
995
1083
  */
996
1084
  succeeded: number | undefined;
997
1085
  /**
1086
+ * @public
998
1087
  * <p>The total number of items processed in child workflow executions that have failed.</p>
999
1088
  */
1000
1089
  failed: number | undefined;
1001
1090
  /**
1091
+ * @public
1002
1092
  * <p>The total number of items processed in child workflow executions that have timed out.</p>
1003
1093
  */
1004
1094
  timedOut: number | undefined;
1005
1095
  /**
1096
+ * @public
1006
1097
  * <p>The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.</p>
1007
1098
  */
1008
1099
  aborted: number | undefined;
1009
1100
  /**
1101
+ * @public
1010
1102
  * <p>The total number of items processed in all the child workflow executions started by a Map Run.</p>
1011
1103
  */
1012
1104
  total: number | undefined;
1013
1105
  /**
1106
+ * @public
1014
1107
  * <p>Returns the count of items whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.</p>
1015
1108
  */
1016
1109
  resultsWritten: number | undefined;
@@ -1034,42 +1127,52 @@ export type MapRunStatus = (typeof MapRunStatus)[keyof typeof MapRunStatus];
1034
1127
  */
1035
1128
  export interface DescribeMapRunOutput {
1036
1129
  /**
1130
+ * @public
1037
1131
  * <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
1038
1132
  */
1039
1133
  mapRunArn: string | undefined;
1040
1134
  /**
1135
+ * @public
1041
1136
  * <p>The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.</p>
1042
1137
  */
1043
1138
  executionArn: string | undefined;
1044
1139
  /**
1140
+ * @public
1045
1141
  * <p>The current status of the Map Run.</p>
1046
1142
  */
1047
1143
  status: MapRunStatus | string | undefined;
1048
1144
  /**
1145
+ * @public
1049
1146
  * <p>The date when the Map Run was started.</p>
1050
1147
  */
1051
1148
  startDate: Date | undefined;
1052
1149
  /**
1150
+ * @public
1053
1151
  * <p>The date when the Map Run was stopped.</p>
1054
1152
  */
1055
1153
  stopDate?: Date;
1056
1154
  /**
1155
+ * @public
1057
1156
  * <p>The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.</p>
1058
1157
  */
1059
1158
  maxConcurrency: number | undefined;
1060
1159
  /**
1160
+ * @public
1061
1161
  * <p>The maximum percentage of failed child workflow executions before the Map Run fails.</p>
1062
1162
  */
1063
1163
  toleratedFailurePercentage: number | undefined;
1064
1164
  /**
1165
+ * @public
1065
1166
  * <p>The maximum number of failed child workflow executions before the Map Run fails.</p>
1066
1167
  */
1067
1168
  toleratedFailureCount: number | undefined;
1068
1169
  /**
1170
+ * @public
1069
1171
  * <p>A JSON object that contains information about the total number of items, and the item count for each processing status, such as <code>pending</code> and <code>failed</code>.</p>
1070
1172
  */
1071
1173
  itemCounts: MapRunItemCounts | undefined;
1072
1174
  /**
1175
+ * @public
1073
1176
  * <p>A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as <code>failed</code> and <code>succeeded</code>.</p>
1074
1177
  */
1075
1178
  executionCounts: MapRunExecutionCounts | undefined;
@@ -1079,6 +1182,7 @@ export interface DescribeMapRunOutput {
1079
1182
  */
1080
1183
  export interface DescribeStateMachineInput {
1081
1184
  /**
1185
+ * @public
1082
1186
  * <p>The Amazon Resource Name (ARN) of the state machine for which you want the information.</p>
1083
1187
  * <p>If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
1084
1188
  */
@@ -1101,11 +1205,13 @@ export type StateMachineStatus = (typeof StateMachineStatus)[keyof typeof StateM
1101
1205
  */
1102
1206
  export interface DescribeStateMachineOutput {
1103
1207
  /**
1208
+ * @public
1104
1209
  * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
1105
1210
  * <p>If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
1106
1211
  */
1107
1212
  stateMachineArn: string | undefined;
1108
1213
  /**
1214
+ * @public
1109
1215
  * <p>The name of the state machine.</p>
1110
1216
  * <p>A name must <i>not</i> contain:</p>
1111
1217
  * <ul>
@@ -1132,42 +1238,51 @@ export interface DescribeStateMachineOutput {
1132
1238
  */
1133
1239
  name: string | undefined;
1134
1240
  /**
1241
+ * @public
1135
1242
  * <p>The current status of the state machine.</p>
1136
1243
  */
1137
1244
  status?: StateMachineStatus | string;
1138
1245
  /**
1246
+ * @public
1139
1247
  * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
1140
1248
  */
1141
1249
  definition: string | undefined;
1142
1250
  /**
1251
+ * @public
1143
1252
  * <p>The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role
1144
1253
  * maintains security by granting Step Functions access to Amazon Web Services resources.)</p>
1145
1254
  */
1146
1255
  roleArn: string | undefined;
1147
1256
  /**
1257
+ * @public
1148
1258
  * <p>The <code>type</code> of the state machine (<code>STANDARD</code> or
1149
1259
  * <code>EXPRESS</code>).</p>
1150
1260
  */
1151
1261
  type: StateMachineType | string | undefined;
1152
1262
  /**
1263
+ * @public
1153
1264
  * <p>The date the state machine is created.</p>
1154
1265
  * <p>For a state machine version, <code>creationDate</code> is the date the version was created.</p>
1155
1266
  */
1156
1267
  creationDate: Date | undefined;
1157
1268
  /**
1269
+ * @public
1158
1270
  * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
1159
1271
  * options.</p>
1160
1272
  */
1161
1273
  loggingConfiguration?: LoggingConfiguration;
1162
1274
  /**
1275
+ * @public
1163
1276
  * <p>Selects whether X-Ray tracing is enabled.</p>
1164
1277
  */
1165
1278
  tracingConfiguration?: TracingConfiguration;
1166
1279
  /**
1280
+ * @public
1167
1281
  * <p>A user-defined or an auto-generated string that identifies a <code>Map</code> state. This parameter is present only if the <code>stateMachineArn</code> specified in input is a qualified state machine ARN.</p>
1168
1282
  */
1169
1283
  label?: string;
1170
1284
  /**
1285
+ * @public
1171
1286
  * <p>The revision identifier for the state machine.</p>
1172
1287
  * <p>Use the <code>revisionId</code> parameter to compare between versions of a state machine
1173
1288
  * configuration used for executions without performing a diff of the properties, such as
@@ -1175,6 +1290,7 @@ export interface DescribeStateMachineOutput {
1175
1290
  */
1176
1291
  revisionId?: string;
1177
1292
  /**
1293
+ * @public
1178
1294
  * <p>The description of the state machine version.</p>
1179
1295
  */
1180
1296
  description?: string;
@@ -1196,6 +1312,7 @@ export declare class StateMachineDoesNotExist extends __BaseException {
1196
1312
  */
1197
1313
  export interface DescribeStateMachineAliasInput {
1198
1314
  /**
1315
+ * @public
1199
1316
  * <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
1200
1317
  */
1201
1318
  stateMachineAliasArn: string | undefined;
@@ -1205,26 +1322,32 @@ export interface DescribeStateMachineAliasInput {
1205
1322
  */
1206
1323
  export interface DescribeStateMachineAliasOutput {
1207
1324
  /**
1325
+ * @public
1208
1326
  * <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
1209
1327
  */
1210
1328
  stateMachineAliasArn?: string;
1211
1329
  /**
1330
+ * @public
1212
1331
  * <p>The name of the state machine alias.</p>
1213
1332
  */
1214
1333
  name?: string;
1215
1334
  /**
1335
+ * @public
1216
1336
  * <p>A description of the alias.</p>
1217
1337
  */
1218
1338
  description?: string;
1219
1339
  /**
1340
+ * @public
1220
1341
  * <p>The routing configuration of the alias.</p>
1221
1342
  */
1222
1343
  routingConfiguration?: RoutingConfigurationListItem[];
1223
1344
  /**
1345
+ * @public
1224
1346
  * <p>The date the state machine alias was created.</p>
1225
1347
  */
1226
1348
  creationDate?: Date;
1227
1349
  /**
1350
+ * @public
1228
1351
  * <p>The date the state machine alias was last updated.</p>
1229
1352
  * <p>For a newly created state machine, this is the same as the creation date.</p>
1230
1353
  */
@@ -1235,6 +1358,7 @@ export interface DescribeStateMachineAliasOutput {
1235
1358
  */
1236
1359
  export interface DescribeStateMachineForExecutionInput {
1237
1360
  /**
1361
+ * @public
1238
1362
  * <p>The Amazon Resource Name (ARN) of the execution you want state machine information for.</p>
1239
1363
  */
1240
1364
  executionArn: string | undefined;
@@ -1244,44 +1368,54 @@ export interface DescribeStateMachineForExecutionInput {
1244
1368
  */
1245
1369
  export interface DescribeStateMachineForExecutionOutput {
1246
1370
  /**
1371
+ * @public
1247
1372
  * <p>The Amazon Resource Name (ARN) of the state machine associated with the execution.</p>
1248
1373
  */
1249
1374
  stateMachineArn: string | undefined;
1250
1375
  /**
1376
+ * @public
1251
1377
  * <p>The name of the state machine associated with the execution.</p>
1252
1378
  */
1253
1379
  name: string | undefined;
1254
1380
  /**
1381
+ * @public
1255
1382
  * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
1256
1383
  */
1257
1384
  definition: string | undefined;
1258
1385
  /**
1386
+ * @public
1259
1387
  * <p>The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. </p>
1260
1388
  */
1261
1389
  roleArn: string | undefined;
1262
1390
  /**
1391
+ * @public
1263
1392
  * <p>The date and time the state machine associated with an execution was updated. For a newly
1264
1393
  * created state machine, this is the creation date.</p>
1265
1394
  */
1266
1395
  updateDate: Date | undefined;
1267
1396
  /**
1397
+ * @public
1268
1398
  * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
1269
1399
  * options.</p>
1270
1400
  */
1271
1401
  loggingConfiguration?: LoggingConfiguration;
1272
1402
  /**
1403
+ * @public
1273
1404
  * <p>Selects whether X-Ray tracing is enabled.</p>
1274
1405
  */
1275
1406
  tracingConfiguration?: TracingConfiguration;
1276
1407
  /**
1408
+ * @public
1277
1409
  * <p>The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the <code>executionArn</code> is a child workflow execution that was started by a Distributed Map state.</p>
1278
1410
  */
1279
1411
  mapRunArn?: string;
1280
1412
  /**
1413
+ * @public
1281
1414
  * <p>A user-defined or an auto-generated string that identifies a <code>Map</code> state. This field is returned only if the <code>executionArn</code> is a child workflow execution that was started by a Distributed Map state.</p>
1282
1415
  */
1283
1416
  label?: string;
1284
1417
  /**
1418
+ * @public
1285
1419
  * <p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p>
1286
1420
  * <p>Use the state machine <code>revisionId</code> parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.</p>
1287
1421
  */
@@ -1292,11 +1426,13 @@ export interface DescribeStateMachineForExecutionOutput {
1292
1426
  */
1293
1427
  export interface GetActivityTaskInput {
1294
1428
  /**
1429
+ * @public
1295
1430
  * <p>The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task
1296
1431
  * using <a>CreateActivity</a>.)</p>
1297
1432
  */
1298
1433
  activityArn: string | undefined;
1299
1434
  /**
1435
+ * @public
1300
1436
  * <p>You can provide an arbitrary name in order to identify the worker that the task is
1301
1437
  * assigned to. This name is used when it is logged in the execution history.</p>
1302
1438
  */
@@ -1307,6 +1443,7 @@ export interface GetActivityTaskInput {
1307
1443
  */
1308
1444
  export interface GetActivityTaskOutput {
1309
1445
  /**
1446
+ * @public
1310
1447
  * <p>A token that identifies the scheduled task. This token must be copied and included in
1311
1448
  * subsequent calls to <a>SendTaskHeartbeat</a>, <a>SendTaskSuccess</a> or
1312
1449
  * <a>SendTaskFailure</a> in order to report the progress or completion of the
@@ -1314,6 +1451,7 @@ export interface GetActivityTaskOutput {
1314
1451
  */
1315
1452
  taskToken?: string;
1316
1453
  /**
1454
+ * @public
1317
1455
  * <p>The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1318
1456
  */
1319
1457
  input?: string;
@@ -1323,25 +1461,30 @@ export interface GetActivityTaskOutput {
1323
1461
  */
1324
1462
  export interface GetExecutionHistoryInput {
1325
1463
  /**
1464
+ * @public
1326
1465
  * <p>The Amazon Resource Name (ARN) of the execution.</p>
1327
1466
  */
1328
1467
  executionArn: string | undefined;
1329
1468
  /**
1469
+ * @public
1330
1470
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
1331
1471
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
1332
1472
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
1333
1473
  */
1334
1474
  maxResults?: number;
1335
1475
  /**
1476
+ * @public
1336
1477
  * <p>Lists events in descending order of their <code>timeStamp</code>.</p>
1337
1478
  */
1338
1479
  reverseOrder?: boolean;
1339
1480
  /**
1481
+ * @public
1340
1482
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
1341
1483
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
1342
1484
  */
1343
1485
  nextToken?: string;
1344
1486
  /**
1487
+ * @public
1345
1488
  * <p>You can select whether execution data (input or output of a history event) is returned.
1346
1489
  * The default is <code>true</code>.</p>
1347
1490
  */
@@ -1353,10 +1496,12 @@ export interface GetExecutionHistoryInput {
1353
1496
  */
1354
1497
  export interface ExecutionAbortedEventDetails {
1355
1498
  /**
1499
+ * @public
1356
1500
  * <p>The error code of the failure.</p>
1357
1501
  */
1358
1502
  error?: string;
1359
1503
  /**
1504
+ * @public
1360
1505
  * <p>A more detailed explanation of the cause of the failure.</p>
1361
1506
  */
1362
1507
  cause?: string;
@@ -1367,10 +1512,12 @@ export interface ExecutionAbortedEventDetails {
1367
1512
  */
1368
1513
  export interface ExecutionFailedEventDetails {
1369
1514
  /**
1515
+ * @public
1370
1516
  * <p>The error code of the failure.</p>
1371
1517
  */
1372
1518
  error?: string;
1373
1519
  /**
1520
+ * @public
1374
1521
  * <p>A more detailed explanation of the cause of the failure.</p>
1375
1522
  */
1376
1523
  cause?: string;
@@ -1381,22 +1528,27 @@ export interface ExecutionFailedEventDetails {
1381
1528
  */
1382
1529
  export interface ExecutionStartedEventDetails {
1383
1530
  /**
1531
+ * @public
1384
1532
  * <p>The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1385
1533
  */
1386
1534
  input?: string;
1387
1535
  /**
1536
+ * @public
1388
1537
  * <p>Contains details about the input for an execution history event.</p>
1389
1538
  */
1390
1539
  inputDetails?: HistoryEventExecutionDataDetails;
1391
1540
  /**
1541
+ * @public
1392
1542
  * <p>The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.</p>
1393
1543
  */
1394
1544
  roleArn?: string;
1395
1545
  /**
1546
+ * @public
1396
1547
  * <p>The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.</p>
1397
1548
  */
1398
1549
  stateMachineAliasArn?: string;
1399
1550
  /**
1551
+ * @public
1400
1552
  * <p>The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.</p>
1401
1553
  */
1402
1554
  stateMachineVersionArn?: string;
@@ -1407,10 +1559,12 @@ export interface ExecutionStartedEventDetails {
1407
1559
  */
1408
1560
  export interface ExecutionSucceededEventDetails {
1409
1561
  /**
1562
+ * @public
1410
1563
  * <p>The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1411
1564
  */
1412
1565
  output?: string;
1413
1566
  /**
1567
+ * @public
1414
1568
  * <p>Contains details about the output of an execution history event.</p>
1415
1569
  */
1416
1570
  outputDetails?: HistoryEventExecutionDataDetails;
@@ -1421,10 +1575,12 @@ export interface ExecutionSucceededEventDetails {
1421
1575
  */
1422
1576
  export interface ExecutionTimedOutEventDetails {
1423
1577
  /**
1578
+ * @public
1424
1579
  * <p>The error code of the failure.</p>
1425
1580
  */
1426
1581
  error?: string;
1427
1582
  /**
1583
+ * @public
1428
1584
  * <p>A more detailed explanation of the cause of the timeout.</p>
1429
1585
  */
1430
1586
  cause?: string;
@@ -1435,10 +1591,12 @@ export interface ExecutionTimedOutEventDetails {
1435
1591
  */
1436
1592
  export interface LambdaFunctionFailedEventDetails {
1437
1593
  /**
1594
+ * @public
1438
1595
  * <p>The error code of the failure.</p>
1439
1596
  */
1440
1597
  error?: string;
1441
1598
  /**
1599
+ * @public
1442
1600
  * <p>A more detailed explanation of the cause of the failure.</p>
1443
1601
  */
1444
1602
  cause?: string;
@@ -1449,6 +1607,7 @@ export interface LambdaFunctionFailedEventDetails {
1449
1607
  */
1450
1608
  export interface TaskCredentials {
1451
1609
  /**
1610
+ * @public
1452
1611
  * <p>The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.</p>
1453
1612
  */
1454
1613
  roleArn?: string;
@@ -1459,22 +1618,27 @@ export interface TaskCredentials {
1459
1618
  */
1460
1619
  export interface LambdaFunctionScheduledEventDetails {
1461
1620
  /**
1621
+ * @public
1462
1622
  * <p>The Amazon Resource Name (ARN) of the scheduled Lambda function.</p>
1463
1623
  */
1464
1624
  resource: string | undefined;
1465
1625
  /**
1626
+ * @public
1466
1627
  * <p>The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1467
1628
  */
1468
1629
  input?: string;
1469
1630
  /**
1631
+ * @public
1470
1632
  * <p>Contains details about input for an execution history event.</p>
1471
1633
  */
1472
1634
  inputDetails?: HistoryEventExecutionDataDetails;
1473
1635
  /**
1636
+ * @public
1474
1637
  * <p>The maximum allowed duration of the Lambda function.</p>
1475
1638
  */
1476
1639
  timeoutInSeconds?: number;
1477
1640
  /**
1641
+ * @public
1478
1642
  * <p>The credentials that Step Functions uses for the task.</p>
1479
1643
  */
1480
1644
  taskCredentials?: TaskCredentials;
@@ -1486,10 +1650,12 @@ export interface LambdaFunctionScheduledEventDetails {
1486
1650
  */
1487
1651
  export interface LambdaFunctionScheduleFailedEventDetails {
1488
1652
  /**
1653
+ * @public
1489
1654
  * <p>The error code of the failure.</p>
1490
1655
  */
1491
1656
  error?: string;
1492
1657
  /**
1658
+ * @public
1493
1659
  * <p>A more detailed explanation of the cause of the failure.</p>
1494
1660
  */
1495
1661
  cause?: string;
@@ -1500,10 +1666,12 @@ export interface LambdaFunctionScheduleFailedEventDetails {
1500
1666
  */
1501
1667
  export interface LambdaFunctionStartFailedEventDetails {
1502
1668
  /**
1669
+ * @public
1503
1670
  * <p>The error code of the failure.</p>
1504
1671
  */
1505
1672
  error?: string;
1506
1673
  /**
1674
+ * @public
1507
1675
  * <p>A more detailed explanation of the cause of the failure.</p>
1508
1676
  */
1509
1677
  cause?: string;
@@ -1515,10 +1683,12 @@ export interface LambdaFunctionStartFailedEventDetails {
1515
1683
  */
1516
1684
  export interface LambdaFunctionSucceededEventDetails {
1517
1685
  /**
1686
+ * @public
1518
1687
  * <p>The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1519
1688
  */
1520
1689
  output?: string;
1521
1690
  /**
1691
+ * @public
1522
1692
  * <p>Contains details about the output of an execution history event.</p>
1523
1693
  */
1524
1694
  outputDetails?: HistoryEventExecutionDataDetails;
@@ -1529,10 +1699,12 @@ export interface LambdaFunctionSucceededEventDetails {
1529
1699
  */
1530
1700
  export interface LambdaFunctionTimedOutEventDetails {
1531
1701
  /**
1702
+ * @public
1532
1703
  * <p>The error code of the failure.</p>
1533
1704
  */
1534
1705
  error?: string;
1535
1706
  /**
1707
+ * @public
1536
1708
  * <p>A more detailed explanation of the cause of the timeout.</p>
1537
1709
  */
1538
1710
  cause?: string;
@@ -1543,10 +1715,12 @@ export interface LambdaFunctionTimedOutEventDetails {
1543
1715
  */
1544
1716
  export interface MapIterationEventDetails {
1545
1717
  /**
1718
+ * @public
1546
1719
  * <p>The name of the iteration’s parent Map state.</p>
1547
1720
  */
1548
1721
  name?: string;
1549
1722
  /**
1723
+ * @public
1550
1724
  * <p>The index of the array belonging to the Map state iteration.</p>
1551
1725
  */
1552
1726
  index?: number;
@@ -1557,10 +1731,12 @@ export interface MapIterationEventDetails {
1557
1731
  */
1558
1732
  export interface MapRunFailedEventDetails {
1559
1733
  /**
1734
+ * @public
1560
1735
  * <p>The error code of the Map Run failure.</p>
1561
1736
  */
1562
1737
  error?: string;
1563
1738
  /**
1739
+ * @public
1564
1740
  * <p>A more detailed explanation of the cause of the failure.</p>
1565
1741
  */
1566
1742
  cause?: string;
@@ -1571,6 +1747,7 @@ export interface MapRunFailedEventDetails {
1571
1747
  */
1572
1748
  export interface MapRunStartedEventDetails {
1573
1749
  /**
1750
+ * @public
1574
1751
  * <p>The Amazon Resource Name (ARN) of a Map Run that was started.</p>
1575
1752
  */
1576
1753
  mapRunArn?: string;
@@ -1581,6 +1758,7 @@ export interface MapRunStartedEventDetails {
1581
1758
  */
1582
1759
  export interface MapStateStartedEventDetails {
1583
1760
  /**
1761
+ * @public
1584
1762
  * <p>The size of the array for Map state iterations.</p>
1585
1763
  */
1586
1764
  length?: number;
@@ -1591,14 +1769,17 @@ export interface MapStateStartedEventDetails {
1591
1769
  */
1592
1770
  export interface StateEnteredEventDetails {
1593
1771
  /**
1772
+ * @public
1594
1773
  * <p>The name of the state.</p>
1595
1774
  */
1596
1775
  name: string | undefined;
1597
1776
  /**
1777
+ * @public
1598
1778
  * <p>The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1599
1779
  */
1600
1780
  input?: string;
1601
1781
  /**
1782
+ * @public
1602
1783
  * <p>Contains details about the input for an execution history event.</p>
1603
1784
  */
1604
1785
  inputDetails?: HistoryEventExecutionDataDetails;
@@ -1609,6 +1790,7 @@ export interface StateEnteredEventDetails {
1609
1790
  */
1610
1791
  export interface StateExitedEventDetails {
1611
1792
  /**
1793
+ * @public
1612
1794
  * <p>The name of the state.</p>
1613
1795
  * <p>A name must <i>not</i> contain:</p>
1614
1796
  * <ul>
@@ -1635,10 +1817,12 @@ export interface StateExitedEventDetails {
1635
1817
  */
1636
1818
  name: string | undefined;
1637
1819
  /**
1820
+ * @public
1638
1821
  * <p>The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1639
1822
  */
1640
1823
  output?: string;
1641
1824
  /**
1825
+ * @public
1642
1826
  * <p>Contains details about the output of an execution history event.</p>
1643
1827
  */
1644
1828
  outputDetails?: HistoryEventExecutionDataDetails;
@@ -1649,18 +1833,22 @@ export interface StateExitedEventDetails {
1649
1833
  */
1650
1834
  export interface TaskFailedEventDetails {
1651
1835
  /**
1836
+ * @public
1652
1837
  * <p>The service name of the resource in a task state.</p>
1653
1838
  */
1654
1839
  resourceType: string | undefined;
1655
1840
  /**
1841
+ * @public
1656
1842
  * <p>The action of the resource called by a task state.</p>
1657
1843
  */
1658
1844
  resource: string | undefined;
1659
1845
  /**
1846
+ * @public
1660
1847
  * <p>The error code of the failure.</p>
1661
1848
  */
1662
1849
  error?: string;
1663
1850
  /**
1851
+ * @public
1664
1852
  * <p>A more detailed explanation of the cause of the failure.</p>
1665
1853
  */
1666
1854
  cause?: string;
@@ -1671,31 +1859,38 @@ export interface TaskFailedEventDetails {
1671
1859
  */
1672
1860
  export interface TaskScheduledEventDetails {
1673
1861
  /**
1862
+ * @public
1674
1863
  * <p>The service name of the resource in a task state.</p>
1675
1864
  */
1676
1865
  resourceType: string | undefined;
1677
1866
  /**
1867
+ * @public
1678
1868
  * <p>The action of the resource called by a task state.</p>
1679
1869
  */
1680
1870
  resource: string | undefined;
1681
1871
  /**
1872
+ * @public
1682
1873
  * <p>The region of the scheduled task</p>
1683
1874
  */
1684
1875
  region: string | undefined;
1685
1876
  /**
1877
+ * @public
1686
1878
  * <p>The JSON data passed to the resource referenced in a task state.
1687
1879
  * Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1688
1880
  */
1689
1881
  parameters: string | undefined;
1690
1882
  /**
1883
+ * @public
1691
1884
  * <p>The maximum allowed duration of the task.</p>
1692
1885
  */
1693
1886
  timeoutInSeconds?: number;
1694
1887
  /**
1888
+ * @public
1695
1889
  * <p>The maximum allowed duration between two heartbeats for the task.</p>
1696
1890
  */
1697
1891
  heartbeatInSeconds?: number;
1698
1892
  /**
1893
+ * @public
1699
1894
  * <p>The credentials that Step Functions uses for the task.</p>
1700
1895
  */
1701
1896
  taskCredentials?: TaskCredentials;
@@ -1706,10 +1901,12 @@ export interface TaskScheduledEventDetails {
1706
1901
  */
1707
1902
  export interface TaskStartedEventDetails {
1708
1903
  /**
1904
+ * @public
1709
1905
  * <p>The service name of the resource in a task state.</p>
1710
1906
  */
1711
1907
  resourceType: string | undefined;
1712
1908
  /**
1909
+ * @public
1713
1910
  * <p>The action of the resource called by a task state.</p>
1714
1911
  */
1715
1912
  resource: string | undefined;
@@ -1720,18 +1917,22 @@ export interface TaskStartedEventDetails {
1720
1917
  */
1721
1918
  export interface TaskStartFailedEventDetails {
1722
1919
  /**
1920
+ * @public
1723
1921
  * <p>The service name of the resource in a task state.</p>
1724
1922
  */
1725
1923
  resourceType: string | undefined;
1726
1924
  /**
1925
+ * @public
1727
1926
  * <p>The action of the resource called by a task state.</p>
1728
1927
  */
1729
1928
  resource: string | undefined;
1730
1929
  /**
1930
+ * @public
1731
1931
  * <p>The error code of the failure.</p>
1732
1932
  */
1733
1933
  error?: string;
1734
1934
  /**
1935
+ * @public
1735
1936
  * <p>A more detailed explanation of the cause of the failure.</p>
1736
1937
  */
1737
1938
  cause?: string;
@@ -1742,18 +1943,22 @@ export interface TaskStartFailedEventDetails {
1742
1943
  */
1743
1944
  export interface TaskSubmitFailedEventDetails {
1744
1945
  /**
1946
+ * @public
1745
1947
  * <p>The service name of the resource in a task state.</p>
1746
1948
  */
1747
1949
  resourceType: string | undefined;
1748
1950
  /**
1951
+ * @public
1749
1952
  * <p>The action of the resource called by a task state.</p>
1750
1953
  */
1751
1954
  resource: string | undefined;
1752
1955
  /**
1956
+ * @public
1753
1957
  * <p>The error code of the failure.</p>
1754
1958
  */
1755
1959
  error?: string;
1756
1960
  /**
1961
+ * @public
1757
1962
  * <p>A more detailed explanation of the cause of the failure.</p>
1758
1963
  */
1759
1964
  cause?: string;
@@ -1764,18 +1969,22 @@ export interface TaskSubmitFailedEventDetails {
1764
1969
  */
1765
1970
  export interface TaskSubmittedEventDetails {
1766
1971
  /**
1972
+ * @public
1767
1973
  * <p>The service name of the resource in a task state.</p>
1768
1974
  */
1769
1975
  resourceType: string | undefined;
1770
1976
  /**
1977
+ * @public
1771
1978
  * <p>The action of the resource called by a task state.</p>
1772
1979
  */
1773
1980
  resource: string | undefined;
1774
1981
  /**
1982
+ * @public
1775
1983
  * <p>The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1776
1984
  */
1777
1985
  output?: string;
1778
1986
  /**
1987
+ * @public
1779
1988
  * <p>Contains details about the output of an execution history event.</p>
1780
1989
  */
1781
1990
  outputDetails?: HistoryEventExecutionDataDetails;
@@ -1786,19 +1995,23 @@ export interface TaskSubmittedEventDetails {
1786
1995
  */
1787
1996
  export interface TaskSucceededEventDetails {
1788
1997
  /**
1998
+ * @public
1789
1999
  * <p>The service name of the resource in a task state.</p>
1790
2000
  */
1791
2001
  resourceType: string | undefined;
1792
2002
  /**
2003
+ * @public
1793
2004
  * <p>The action of the resource called by a task state.</p>
1794
2005
  */
1795
2006
  resource: string | undefined;
1796
2007
  /**
2008
+ * @public
1797
2009
  * <p>The full JSON response from a resource when a task has succeeded. This response becomes
1798
2010
  * the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1799
2011
  */
1800
2012
  output?: string;
1801
2013
  /**
2014
+ * @public
1802
2015
  * <p>Contains details about the output of an execution history event.</p>
1803
2016
  */
1804
2017
  outputDetails?: HistoryEventExecutionDataDetails;
@@ -1809,18 +2022,22 @@ export interface TaskSucceededEventDetails {
1809
2022
  */
1810
2023
  export interface TaskTimedOutEventDetails {
1811
2024
  /**
2025
+ * @public
1812
2026
  * <p>The service name of the resource in a task state.</p>
1813
2027
  */
1814
2028
  resourceType: string | undefined;
1815
2029
  /**
2030
+ * @public
1816
2031
  * <p>The action of the resource called by a task state.</p>
1817
2032
  */
1818
2033
  resource: string | undefined;
1819
2034
  /**
2035
+ * @public
1820
2036
  * <p>The error code of the failure.</p>
1821
2037
  */
1822
2038
  error?: string;
1823
2039
  /**
2040
+ * @public
1824
2041
  * <p>A more detailed explanation of the cause of the failure.</p>
1825
2042
  */
1826
2043
  cause?: string;
@@ -1900,157 +2117,195 @@ export type HistoryEventType = (typeof HistoryEventType)[keyof typeof HistoryEve
1900
2117
  */
1901
2118
  export interface HistoryEvent {
1902
2119
  /**
2120
+ * @public
1903
2121
  * <p>The date and time the event occurred.</p>
1904
2122
  */
1905
2123
  timestamp: Date | undefined;
1906
2124
  /**
2125
+ * @public
1907
2126
  * <p>The type of the event.</p>
1908
2127
  */
1909
2128
  type: HistoryEventType | string | undefined;
1910
2129
  /**
2130
+ * @public
1911
2131
  * <p>The id of the event. Events are numbered sequentially, starting at one.</p>
1912
2132
  */
1913
2133
  id: number | undefined;
1914
2134
  /**
2135
+ * @public
1915
2136
  * <p>The id of the previous event.</p>
1916
2137
  */
1917
2138
  previousEventId?: number;
1918
2139
  /**
2140
+ * @public
1919
2141
  * <p>Contains details about an activity that failed during an execution.</p>
1920
2142
  */
1921
2143
  activityFailedEventDetails?: ActivityFailedEventDetails;
1922
2144
  /**
2145
+ * @public
1923
2146
  * <p>Contains details about an activity schedule event that failed during an execution.</p>
1924
2147
  */
1925
2148
  activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails;
1926
2149
  /**
2150
+ * @public
1927
2151
  * <p>Contains details about an activity scheduled during an execution.</p>
1928
2152
  */
1929
2153
  activityScheduledEventDetails?: ActivityScheduledEventDetails;
1930
2154
  /**
2155
+ * @public
1931
2156
  * <p>Contains details about the start of an activity during an execution.</p>
1932
2157
  */
1933
2158
  activityStartedEventDetails?: ActivityStartedEventDetails;
1934
2159
  /**
2160
+ * @public
1935
2161
  * <p>Contains details about an activity that successfully terminated during an
1936
2162
  * execution.</p>
1937
2163
  */
1938
2164
  activitySucceededEventDetails?: ActivitySucceededEventDetails;
1939
2165
  /**
2166
+ * @public
1940
2167
  * <p>Contains details about an activity timeout that occurred during an execution.</p>
1941
2168
  */
1942
2169
  activityTimedOutEventDetails?: ActivityTimedOutEventDetails;
1943
2170
  /**
2171
+ * @public
1944
2172
  * <p>Contains details about the failure of a task.</p>
1945
2173
  */
1946
2174
  taskFailedEventDetails?: TaskFailedEventDetails;
1947
2175
  /**
2176
+ * @public
1948
2177
  * <p>Contains details about a task that was scheduled.</p>
1949
2178
  */
1950
2179
  taskScheduledEventDetails?: TaskScheduledEventDetails;
1951
2180
  /**
2181
+ * @public
1952
2182
  * <p>Contains details about a task that failed to start.</p>
1953
2183
  */
1954
2184
  taskStartFailedEventDetails?: TaskStartFailedEventDetails;
1955
2185
  /**
2186
+ * @public
1956
2187
  * <p>Contains details about a task that was started.</p>
1957
2188
  */
1958
2189
  taskStartedEventDetails?: TaskStartedEventDetails;
1959
2190
  /**
2191
+ * @public
1960
2192
  * <p>Contains details about a task that where the submit failed.</p>
1961
2193
  */
1962
2194
  taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails;
1963
2195
  /**
2196
+ * @public
1964
2197
  * <p>Contains details about a submitted task.</p>
1965
2198
  */
1966
2199
  taskSubmittedEventDetails?: TaskSubmittedEventDetails;
1967
2200
  /**
2201
+ * @public
1968
2202
  * <p>Contains details about a task that succeeded.</p>
1969
2203
  */
1970
2204
  taskSucceededEventDetails?: TaskSucceededEventDetails;
1971
2205
  /**
2206
+ * @public
1972
2207
  * <p>Contains details about a task that timed out.</p>
1973
2208
  */
1974
2209
  taskTimedOutEventDetails?: TaskTimedOutEventDetails;
1975
2210
  /**
2211
+ * @public
1976
2212
  * <p>Contains details about an execution failure event.</p>
1977
2213
  */
1978
2214
  executionFailedEventDetails?: ExecutionFailedEventDetails;
1979
2215
  /**
2216
+ * @public
1980
2217
  * <p>Contains details about the start of the execution.</p>
1981
2218
  */
1982
2219
  executionStartedEventDetails?: ExecutionStartedEventDetails;
1983
2220
  /**
2221
+ * @public
1984
2222
  * <p>Contains details about the successful termination of the execution.</p>
1985
2223
  */
1986
2224
  executionSucceededEventDetails?: ExecutionSucceededEventDetails;
1987
2225
  /**
2226
+ * @public
1988
2227
  * <p>Contains details about an abort of an execution.</p>
1989
2228
  */
1990
2229
  executionAbortedEventDetails?: ExecutionAbortedEventDetails;
1991
2230
  /**
2231
+ * @public
1992
2232
  * <p>Contains details about the execution timeout that occurred during the execution.</p>
1993
2233
  */
1994
2234
  executionTimedOutEventDetails?: ExecutionTimedOutEventDetails;
1995
2235
  /**
2236
+ * @public
1996
2237
  * <p>Contains details about Map state that was started.</p>
1997
2238
  */
1998
2239
  mapStateStartedEventDetails?: MapStateStartedEventDetails;
1999
2240
  /**
2241
+ * @public
2000
2242
  * <p>Contains details about an iteration of a Map state that was started.</p>
2001
2243
  */
2002
2244
  mapIterationStartedEventDetails?: MapIterationEventDetails;
2003
2245
  /**
2246
+ * @public
2004
2247
  * <p>Contains details about an iteration of a Map state that succeeded.</p>
2005
2248
  */
2006
2249
  mapIterationSucceededEventDetails?: MapIterationEventDetails;
2007
2250
  /**
2251
+ * @public
2008
2252
  * <p>Contains details about an iteration of a Map state that failed.</p>
2009
2253
  */
2010
2254
  mapIterationFailedEventDetails?: MapIterationEventDetails;
2011
2255
  /**
2256
+ * @public
2012
2257
  * <p>Contains details about an iteration of a Map state that was aborted.</p>
2013
2258
  */
2014
2259
  mapIterationAbortedEventDetails?: MapIterationEventDetails;
2015
2260
  /**
2261
+ * @public
2016
2262
  * <p>Contains details about a Lambda function that failed during an execution.</p>
2017
2263
  */
2018
2264
  lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails;
2019
2265
  /**
2266
+ * @public
2020
2267
  * <p>Contains details about a failed Lambda function schedule event that occurred during an
2021
2268
  * execution.</p>
2022
2269
  */
2023
2270
  lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails;
2024
2271
  /**
2272
+ * @public
2025
2273
  * <p>Contains details about a Lambda function scheduled during an execution.</p>
2026
2274
  */
2027
2275
  lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails;
2028
2276
  /**
2277
+ * @public
2029
2278
  * <p>Contains details about a lambda function that failed to start during an execution.</p>
2030
2279
  */
2031
2280
  lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails;
2032
2281
  /**
2282
+ * @public
2033
2283
  * <p>Contains details about a Lambda function that terminated successfully during an
2034
2284
  * execution.</p>
2035
2285
  */
2036
2286
  lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails;
2037
2287
  /**
2288
+ * @public
2038
2289
  * <p>Contains details about a Lambda function timeout that occurred during an execution.</p>
2039
2290
  */
2040
2291
  lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails;
2041
2292
  /**
2293
+ * @public
2042
2294
  * <p>Contains details about a state entered during an execution.</p>
2043
2295
  */
2044
2296
  stateEnteredEventDetails?: StateEnteredEventDetails;
2045
2297
  /**
2298
+ * @public
2046
2299
  * <p>Contains details about an exit from a state during an execution.</p>
2047
2300
  */
2048
2301
  stateExitedEventDetails?: StateExitedEventDetails;
2049
2302
  /**
2303
+ * @public
2050
2304
  * <p>Contains details, such as <code>mapRunArn</code>, and the start date and time of a Map Run. <code>mapRunArn</code> is the Amazon Resource Name (ARN) of the Map Run that was started.</p>
2051
2305
  */
2052
2306
  mapRunStartedEventDetails?: MapRunStartedEventDetails;
2053
2307
  /**
2308
+ * @public
2054
2309
  * <p>Contains error and cause details about a Map Run that failed.</p>
2055
2310
  */
2056
2311
  mapRunFailedEventDetails?: MapRunFailedEventDetails;
@@ -2060,10 +2315,12 @@ export interface HistoryEvent {
2060
2315
  */
2061
2316
  export interface GetExecutionHistoryOutput {
2062
2317
  /**
2318
+ * @public
2063
2319
  * <p>The list of events that occurred in the execution.</p>
2064
2320
  */
2065
2321
  events: HistoryEvent[] | undefined;
2066
2322
  /**
2323
+ * @public
2067
2324
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2068
2325
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2069
2326
  */
@@ -2086,12 +2343,14 @@ export declare class InvalidToken extends __BaseException {
2086
2343
  */
2087
2344
  export interface ListActivitiesInput {
2088
2345
  /**
2346
+ * @public
2089
2347
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2090
2348
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2091
2349
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2092
2350
  */
2093
2351
  maxResults?: number;
2094
2352
  /**
2353
+ * @public
2095
2354
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2096
2355
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2097
2356
  */
@@ -2102,10 +2361,12 @@ export interface ListActivitiesInput {
2102
2361
  */
2103
2362
  export interface ListActivitiesOutput {
2104
2363
  /**
2364
+ * @public
2105
2365
  * <p>The list of activities.</p>
2106
2366
  */
2107
2367
  activities: ActivityListItem[] | undefined;
2108
2368
  /**
2369
+ * @public
2109
2370
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2110
2371
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2111
2372
  */
@@ -2116,28 +2377,33 @@ export interface ListActivitiesOutput {
2116
2377
  */
2117
2378
  export interface ListExecutionsInput {
2118
2379
  /**
2380
+ * @public
2119
2381
  * <p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p>
2120
2382
  * <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
2121
2383
  * <p>You can also return a list of executions associated with a specific <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, by specifying an alias ARN or a version ARN in the <code>stateMachineArn</code> parameter.</p>
2122
2384
  */
2123
2385
  stateMachineArn?: string;
2124
2386
  /**
2387
+ * @public
2125
2388
  * <p>If specified, only list the executions whose current execution status matches the given
2126
2389
  * filter.</p>
2127
2390
  */
2128
2391
  statusFilter?: ExecutionStatus | string;
2129
2392
  /**
2393
+ * @public
2130
2394
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2131
2395
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2132
2396
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2133
2397
  */
2134
2398
  maxResults?: number;
2135
2399
  /**
2400
+ * @public
2136
2401
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2137
2402
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2138
2403
  */
2139
2404
  nextToken?: string;
2140
2405
  /**
2406
+ * @public
2141
2407
  * <p>The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the <code>mapRunArn</code> field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p>
2142
2408
  * <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
2143
2409
  */
@@ -2149,14 +2415,17 @@ export interface ListExecutionsInput {
2149
2415
  */
2150
2416
  export interface ExecutionListItem {
2151
2417
  /**
2418
+ * @public
2152
2419
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
2153
2420
  */
2154
2421
  executionArn: string | undefined;
2155
2422
  /**
2423
+ * @public
2156
2424
  * <p>The Amazon Resource Name (ARN) of the state machine that ran the execution.</p>
2157
2425
  */
2158
2426
  stateMachineArn: string | undefined;
2159
2427
  /**
2428
+ * @public
2160
2429
  * <p>The name of the execution.</p>
2161
2430
  * <p>A name must <i>not</i> contain:</p>
2162
2431
  * <ul>
@@ -2183,32 +2452,39 @@ export interface ExecutionListItem {
2183
2452
  */
2184
2453
  name: string | undefined;
2185
2454
  /**
2455
+ * @public
2186
2456
  * <p>The current status of the execution.</p>
2187
2457
  */
2188
2458
  status: ExecutionStatus | string | undefined;
2189
2459
  /**
2460
+ * @public
2190
2461
  * <p>The date the execution started.</p>
2191
2462
  */
2192
2463
  startDate: Date | undefined;
2193
2464
  /**
2465
+ * @public
2194
2466
  * <p>If the execution already ended, the date the execution stopped.</p>
2195
2467
  */
2196
2468
  stopDate?: Date;
2197
2469
  /**
2470
+ * @public
2198
2471
  * <p>The Amazon Resource Name (ARN) of a Map Run. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>mapRunArn</code> isn't returned.</p>
2199
2472
  */
2200
2473
  mapRunArn?: string;
2201
2474
  /**
2475
+ * @public
2202
2476
  * <p>The total number of items processed in a child workflow execution. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>itemCount</code> field isn't returned.</p>
2203
2477
  */
2204
2478
  itemCount?: number;
2205
2479
  /**
2480
+ * @public
2206
2481
  * <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p>
2207
2482
  * <p>If the state machine execution was started with an unqualified ARN, it returns null.</p>
2208
2483
  * <p>If the execution was started using a <code>stateMachineAliasArn</code>, both the <code>stateMachineAliasArn</code> and <code>stateMachineVersionArn</code> parameters contain the respective values.</p>
2209
2484
  */
2210
2485
  stateMachineVersionArn?: string;
2211
2486
  /**
2487
+ * @public
2212
2488
  * <p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p>
2213
2489
  * <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>
2214
2490
  */
@@ -2219,10 +2495,12 @@ export interface ExecutionListItem {
2219
2495
  */
2220
2496
  export interface ListExecutionsOutput {
2221
2497
  /**
2498
+ * @public
2222
2499
  * <p>The list of matching executions.</p>
2223
2500
  */
2224
2501
  executions: ExecutionListItem[] | undefined;
2225
2502
  /**
2503
+ * @public
2226
2504
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2227
2505
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2228
2506
  */
@@ -2233,16 +2511,19 @@ export interface ListExecutionsOutput {
2233
2511
  */
2234
2512
  export interface ListMapRunsInput {
2235
2513
  /**
2514
+ * @public
2236
2515
  * <p>The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.</p>
2237
2516
  */
2238
2517
  executionArn: string | undefined;
2239
2518
  /**
2519
+ * @public
2240
2520
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2241
2521
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2242
2522
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2243
2523
  */
2244
2524
  maxResults?: number;
2245
2525
  /**
2526
+ * @public
2246
2527
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2247
2528
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2248
2529
  */
@@ -2254,22 +2535,27 @@ export interface ListMapRunsInput {
2254
2535
  */
2255
2536
  export interface MapRunListItem {
2256
2537
  /**
2538
+ * @public
2257
2539
  * <p>The <code>executionArn</code> of the execution from which the Map Run was started.</p>
2258
2540
  */
2259
2541
  executionArn: string | undefined;
2260
2542
  /**
2543
+ * @public
2261
2544
  * <p>The Amazon Resource Name (ARN) of the Map Run.</p>
2262
2545
  */
2263
2546
  mapRunArn: string | undefined;
2264
2547
  /**
2548
+ * @public
2265
2549
  * <p>The Amazon Resource Name (ARN) of the executed state machine.</p>
2266
2550
  */
2267
2551
  stateMachineArn: string | undefined;
2268
2552
  /**
2553
+ * @public
2269
2554
  * <p>The date on which the Map Run started.</p>
2270
2555
  */
2271
2556
  startDate: Date | undefined;
2272
2557
  /**
2558
+ * @public
2273
2559
  * <p>The date on which the Map Run stopped.</p>
2274
2560
  */
2275
2561
  stopDate?: Date;
@@ -2279,10 +2565,12 @@ export interface MapRunListItem {
2279
2565
  */
2280
2566
  export interface ListMapRunsOutput {
2281
2567
  /**
2568
+ * @public
2282
2569
  * <p>An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.</p>
2283
2570
  */
2284
2571
  mapRuns: MapRunListItem[] | undefined;
2285
2572
  /**
2573
+ * @public
2286
2574
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2287
2575
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2288
2576
  */
@@ -2293,16 +2581,19 @@ export interface ListMapRunsOutput {
2293
2581
  */
2294
2582
  export interface ListStateMachineAliasesInput {
2295
2583
  /**
2584
+ * @public
2296
2585
  * <p>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</p>
2297
2586
  * <p>If you specify a state machine version ARN, this API returns a list of aliases for that version.</p>
2298
2587
  */
2299
2588
  stateMachineArn: string | undefined;
2300
2589
  /**
2590
+ * @public
2301
2591
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2302
2592
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2303
2593
  */
2304
2594
  nextToken?: string;
2305
2595
  /**
2596
+ * @public
2306
2597
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2307
2598
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2308
2599
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
@@ -2315,10 +2606,12 @@ export interface ListStateMachineAliasesInput {
2315
2606
  */
2316
2607
  export interface StateMachineAliasListItem {
2317
2608
  /**
2609
+ * @public
2318
2610
  * <p>The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, <code>stateMachineARN:PROD</code>.</p>
2319
2611
  */
2320
2612
  stateMachineAliasArn: string | undefined;
2321
2613
  /**
2614
+ * @public
2322
2615
  * <p>The creation date of a state machine alias.</p>
2323
2616
  */
2324
2617
  creationDate: Date | undefined;
@@ -2328,10 +2621,12 @@ export interface StateMachineAliasListItem {
2328
2621
  */
2329
2622
  export interface ListStateMachineAliasesOutput {
2330
2623
  /**
2624
+ * @public
2331
2625
  * <p>Aliases for the state machine.</p>
2332
2626
  */
2333
2627
  stateMachineAliases: StateMachineAliasListItem[] | undefined;
2334
2628
  /**
2629
+ * @public
2335
2630
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2336
2631
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2337
2632
  */
@@ -2342,12 +2637,14 @@ export interface ListStateMachineAliasesOutput {
2342
2637
  */
2343
2638
  export interface ListStateMachinesInput {
2344
2639
  /**
2640
+ * @public
2345
2641
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2346
2642
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2347
2643
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2348
2644
  */
2349
2645
  maxResults?: number;
2350
2646
  /**
2647
+ * @public
2351
2648
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2352
2649
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2353
2650
  */
@@ -2359,10 +2656,12 @@ export interface ListStateMachinesInput {
2359
2656
  */
2360
2657
  export interface StateMachineListItem {
2361
2658
  /**
2659
+ * @public
2362
2660
  * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
2363
2661
  */
2364
2662
  stateMachineArn: string | undefined;
2365
2663
  /**
2664
+ * @public
2366
2665
  * <p>The name of the state machine.</p>
2367
2666
  * <p>A name must <i>not</i> contain:</p>
2368
2667
  * <ul>
@@ -2389,10 +2688,12 @@ export interface StateMachineListItem {
2389
2688
  */
2390
2689
  name: string | undefined;
2391
2690
  /**
2691
+ * @public
2392
2692
  * <p></p>
2393
2693
  */
2394
2694
  type: StateMachineType | string | undefined;
2395
2695
  /**
2696
+ * @public
2396
2697
  * <p>The date the state machine is created.</p>
2397
2698
  */
2398
2699
  creationDate: Date | undefined;
@@ -2403,6 +2704,7 @@ export interface StateMachineListItem {
2403
2704
  export interface ListStateMachinesOutput {
2404
2705
  stateMachines: StateMachineListItem[] | undefined;
2405
2706
  /**
2707
+ * @public
2406
2708
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2407
2709
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2408
2710
  */
@@ -2413,15 +2715,18 @@ export interface ListStateMachinesOutput {
2413
2715
  */
2414
2716
  export interface ListStateMachineVersionsInput {
2415
2717
  /**
2718
+ * @public
2416
2719
  * <p>The Amazon Resource Name (ARN) of the state machine.</p>
2417
2720
  */
2418
2721
  stateMachineArn: string | undefined;
2419
2722
  /**
2723
+ * @public
2420
2724
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2421
2725
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2422
2726
  */
2423
2727
  nextToken?: string;
2424
2728
  /**
2729
+ * @public
2425
2730
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2426
2731
  * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2427
2732
  * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
@@ -2434,10 +2739,12 @@ export interface ListStateMachineVersionsInput {
2434
2739
  */
2435
2740
  export interface StateMachineVersionListItem {
2436
2741
  /**
2742
+ * @public
2437
2743
  * <p>The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
2438
2744
  */
2439
2745
  stateMachineVersionArn: string | undefined;
2440
2746
  /**
2747
+ * @public
2441
2748
  * <p>The creation date of a state machine version.</p>
2442
2749
  */
2443
2750
  creationDate: Date | undefined;
@@ -2447,10 +2754,12 @@ export interface StateMachineVersionListItem {
2447
2754
  */
2448
2755
  export interface ListStateMachineVersionsOutput {
2449
2756
  /**
2757
+ * @public
2450
2758
  * <p>Versions for the state machine.</p>
2451
2759
  */
2452
2760
  stateMachineVersions: StateMachineVersionListItem[] | undefined;
2453
2761
  /**
2762
+ * @public
2454
2763
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2455
2764
  * 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 <i>HTTP 400 InvalidToken</i> error.</p>
2456
2765
  */
@@ -2461,6 +2770,7 @@ export interface ListStateMachineVersionsOutput {
2461
2770
  */
2462
2771
  export interface ListTagsForResourceInput {
2463
2772
  /**
2773
+ * @public
2464
2774
  * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
2465
2775
  */
2466
2776
  resourceArn: string | undefined;
@@ -2470,6 +2780,7 @@ export interface ListTagsForResourceInput {
2470
2780
  */
2471
2781
  export interface ListTagsForResourceOutput {
2472
2782
  /**
2783
+ * @public
2473
2784
  * <p>An array of tags associated with the resource.</p>
2474
2785
  */
2475
2786
  tags?: Tag[];
@@ -2479,10 +2790,12 @@ export interface ListTagsForResourceOutput {
2479
2790
  */
2480
2791
  export interface PublishStateMachineVersionInput {
2481
2792
  /**
2793
+ * @public
2482
2794
  * <p>The Amazon Resource Name (ARN) of the state machine.</p>
2483
2795
  */
2484
2796
  stateMachineArn: string | undefined;
2485
2797
  /**
2798
+ * @public
2486
2799
  * <p>Only publish the state machine version if the current state machine's revision ID matches the specified ID.</p>
2487
2800
  * <p>Use this option to avoid publishing a version if the state machine changed since you last
2488
2801
  * updated it. If the specified revision ID doesn't match the state machine's current revision
@@ -2496,6 +2809,7 @@ export interface PublishStateMachineVersionInput {
2496
2809
  */
2497
2810
  revisionId?: string;
2498
2811
  /**
2812
+ * @public
2499
2813
  * <p>An optional description of the state machine version.</p>
2500
2814
  */
2501
2815
  description?: string;
@@ -2505,10 +2819,12 @@ export interface PublishStateMachineVersionInput {
2505
2819
  */
2506
2820
  export interface PublishStateMachineVersionOutput {
2507
2821
  /**
2822
+ * @public
2508
2823
  * <p>The date the version was created.</p>
2509
2824
  */
2510
2825
  creationDate: Date | undefined;
2511
2826
  /**
2827
+ * @public
2512
2828
  * <p>The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.</p>
2513
2829
  */
2514
2830
  stateMachineVersionArn: string | undefined;
@@ -2518,16 +2834,19 @@ export interface PublishStateMachineVersionOutput {
2518
2834
  */
2519
2835
  export interface SendTaskFailureInput {
2520
2836
  /**
2837
+ * @public
2521
2838
  * <p>The token that represents this task. Task tokens are generated by Step Functions when
2522
2839
  * tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a
2523
2840
  * workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
2524
2841
  */
2525
2842
  taskToken: string | undefined;
2526
2843
  /**
2844
+ * @public
2527
2845
  * <p>The error code of the failure.</p>
2528
2846
  */
2529
2847
  error?: string;
2530
2848
  /**
2849
+ * @public
2531
2850
  * <p>A more detailed explanation of the cause of the failure.</p>
2532
2851
  */
2533
2852
  cause?: string;
@@ -2564,6 +2883,7 @@ export declare class TaskTimedOut extends __BaseException {
2564
2883
  */
2565
2884
  export interface SendTaskHeartbeatInput {
2566
2885
  /**
2886
+ * @public
2567
2887
  * <p>The token that represents this task. Task tokens are generated by Step Functions when
2568
2888
  * tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a
2569
2889
  * workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
@@ -2592,12 +2912,14 @@ export declare class InvalidOutput extends __BaseException {
2592
2912
  */
2593
2913
  export interface SendTaskSuccessInput {
2594
2914
  /**
2915
+ * @public
2595
2916
  * <p>The token that represents this task. Task tokens are generated by Step Functions when
2596
2917
  * tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a
2597
2918
  * workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
2598
2919
  */
2599
2920
  taskToken: string | undefined;
2600
2921
  /**
2922
+ * @public
2601
2923
  * <p>The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2602
2924
  */
2603
2925
  output: string | undefined;
@@ -2654,6 +2976,7 @@ export declare class InvalidExecutionInput extends __BaseException {
2654
2976
  */
2655
2977
  export interface StartExecutionInput {
2656
2978
  /**
2979
+ * @public
2657
2980
  * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
2658
2981
  * <p>The <code>stateMachineArn</code> parameter accepts one of the following inputs:</p>
2659
2982
  * <ul>
@@ -2687,6 +3010,7 @@ export interface StartExecutionInput {
2687
3010
  */
2688
3011
  stateMachineArn: string | undefined;
2689
3012
  /**
3013
+ * @public
2690
3014
  * <p>Optional name of the execution.
2691
3015
  * This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,
2692
3016
  * see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
@@ -2716,6 +3040,7 @@ export interface StartExecutionInput {
2716
3040
  */
2717
3041
  name?: string;
2718
3042
  /**
3043
+ * @public
2719
3044
  * <p>The string that contains the JSON input data for the execution, for example:</p>
2720
3045
  * <p>
2721
3046
  * <code>"input": "\{\"first_name\" : \"test\"\}"</code>
@@ -2729,6 +3054,7 @@ export interface StartExecutionInput {
2729
3054
  */
2730
3055
  input?: string;
2731
3056
  /**
3057
+ * @public
2732
3058
  * <p>Passes the X-Ray trace header. The trace header can also be passed in the request
2733
3059
  * payload.</p>
2734
3060
  */
@@ -2739,10 +3065,12 @@ export interface StartExecutionInput {
2739
3065
  */
2740
3066
  export interface StartExecutionOutput {
2741
3067
  /**
3068
+ * @public
2742
3069
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
2743
3070
  */
2744
3071
  executionArn: string | undefined;
2745
3072
  /**
3073
+ * @public
2746
3074
  * <p>The date the execution is started.</p>
2747
3075
  */
2748
3076
  startDate: Date | undefined;
@@ -2752,14 +3080,17 @@ export interface StartExecutionOutput {
2752
3080
  */
2753
3081
  export interface StartSyncExecutionInput {
2754
3082
  /**
3083
+ * @public
2755
3084
  * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
2756
3085
  */
2757
3086
  stateMachineArn: string | undefined;
2758
3087
  /**
3088
+ * @public
2759
3089
  * <p>The name of the execution.</p>
2760
3090
  */
2761
3091
  name?: string;
2762
3092
  /**
3093
+ * @public
2763
3094
  * <p>The string that contains the JSON input data for the execution, for example:</p>
2764
3095
  * <p>
2765
3096
  * <code>"input": "\{\"first_name\" : \"test\"\}"</code>
@@ -2773,6 +3104,7 @@ export interface StartSyncExecutionInput {
2773
3104
  */
2774
3105
  input?: string;
2775
3106
  /**
3107
+ * @public
2776
3108
  * <p>Passes the X-Ray trace header. The trace header can also be passed in the request
2777
3109
  * payload.</p>
2778
3110
  */
@@ -2784,10 +3116,12 @@ export interface StartSyncExecutionInput {
2784
3116
  */
2785
3117
  export interface BillingDetails {
2786
3118
  /**
3119
+ * @public
2787
3120
  * <p>Billed memory consumption of your workflow, in MB.</p>
2788
3121
  */
2789
3122
  billedMemoryUsedInMB?: number;
2790
3123
  /**
3124
+ * @public
2791
3125
  * <p>Billed duration of your workflow, in milliseconds.</p>
2792
3126
  */
2793
3127
  billedDurationInMilliseconds?: number;
@@ -2810,46 +3144,57 @@ export type SyncExecutionStatus = (typeof SyncExecutionStatus)[keyof typeof Sync
2810
3144
  */
2811
3145
  export interface StartSyncExecutionOutput {
2812
3146
  /**
3147
+ * @public
2813
3148
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
2814
3149
  */
2815
3150
  executionArn: string | undefined;
2816
3151
  /**
3152
+ * @public
2817
3153
  * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
2818
3154
  */
2819
3155
  stateMachineArn?: string;
2820
3156
  /**
3157
+ * @public
2821
3158
  * <p>The name of the execution.</p>
2822
3159
  */
2823
3160
  name?: string;
2824
3161
  /**
3162
+ * @public
2825
3163
  * <p>The date the execution is started.</p>
2826
3164
  */
2827
3165
  startDate: Date | undefined;
2828
3166
  /**
3167
+ * @public
2829
3168
  * <p>If the execution has already ended, the date the execution stopped.</p>
2830
3169
  */
2831
3170
  stopDate: Date | undefined;
2832
3171
  /**
3172
+ * @public
2833
3173
  * <p>The current status of the execution.</p>
2834
3174
  */
2835
3175
  status: SyncExecutionStatus | string | undefined;
2836
3176
  /**
3177
+ * @public
2837
3178
  * <p>The error code of the failure.</p>
2838
3179
  */
2839
3180
  error?: string;
2840
3181
  /**
3182
+ * @public
2841
3183
  * <p>A more detailed explanation of the cause of the failure.</p>
2842
3184
  */
2843
3185
  cause?: string;
2844
3186
  /**
3187
+ * @public
2845
3188
  * <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2846
3189
  */
2847
3190
  input?: string;
2848
3191
  /**
3192
+ * @public
2849
3193
  * <p>Provides details about execution input or output.</p>
2850
3194
  */
2851
3195
  inputDetails?: CloudWatchEventsExecutionDataDetails;
2852
3196
  /**
3197
+ * @public
2853
3198
  * <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2854
3199
  * <note>
2855
3200
  * <p>This field is set only if the execution succeeds. If the execution fails, this field is
@@ -2858,14 +3203,17 @@ export interface StartSyncExecutionOutput {
2858
3203
  */
2859
3204
  output?: string;
2860
3205
  /**
3206
+ * @public
2861
3207
  * <p>Provides details about execution input or output.</p>
2862
3208
  */
2863
3209
  outputDetails?: CloudWatchEventsExecutionDataDetails;
2864
3210
  /**
3211
+ * @public
2865
3212
  * <p>The X-Ray trace header that was passed to the execution.</p>
2866
3213
  */
2867
3214
  traceHeader?: string;
2868
3215
  /**
3216
+ * @public
2869
3217
  * <p>An object that describes workflow billing details, including billed duration and memory
2870
3218
  * use.</p>
2871
3219
  */
@@ -2876,14 +3224,17 @@ export interface StartSyncExecutionOutput {
2876
3224
  */
2877
3225
  export interface StopExecutionInput {
2878
3226
  /**
3227
+ * @public
2879
3228
  * <p>The Amazon Resource Name (ARN) of the execution to stop.</p>
2880
3229
  */
2881
3230
  executionArn: string | undefined;
2882
3231
  /**
3232
+ * @public
2883
3233
  * <p>The error code of the failure.</p>
2884
3234
  */
2885
3235
  error?: string;
2886
3236
  /**
3237
+ * @public
2887
3238
  * <p>A more detailed explanation of the cause of the failure.</p>
2888
3239
  */
2889
3240
  cause?: string;
@@ -2893,6 +3244,7 @@ export interface StopExecutionInput {
2893
3244
  */
2894
3245
  export interface StopExecutionOutput {
2895
3246
  /**
3247
+ * @public
2896
3248
  * <p>The date the execution is stopped.</p>
2897
3249
  */
2898
3250
  stopDate: Date | undefined;
@@ -2902,10 +3254,12 @@ export interface StopExecutionOutput {
2902
3254
  */
2903
3255
  export interface TagResourceInput {
2904
3256
  /**
3257
+ * @public
2905
3258
  * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
2906
3259
  */
2907
3260
  resourceArn: string | undefined;
2908
3261
  /**
3262
+ * @public
2909
3263
  * <p>The list of tags to add to a resource.</p>
2910
3264
  * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
2911
3265
  */
@@ -2921,10 +3275,12 @@ export interface TagResourceOutput {
2921
3275
  */
2922
3276
  export interface UntagResourceInput {
2923
3277
  /**
3278
+ * @public
2924
3279
  * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
2925
3280
  */
2926
3281
  resourceArn: string | undefined;
2927
3282
  /**
3283
+ * @public
2928
3284
  * <p>The list of tags to remove from the resource.</p>
2929
3285
  */
2930
3286
  tagKeys: string[] | undefined;
@@ -2939,18 +3295,22 @@ export interface UntagResourceOutput {
2939
3295
  */
2940
3296
  export interface UpdateMapRunInput {
2941
3297
  /**
3298
+ * @public
2942
3299
  * <p>The Amazon Resource Name (ARN) of a Map Run.</p>
2943
3300
  */
2944
3301
  mapRunArn: string | undefined;
2945
3302
  /**
3303
+ * @public
2946
3304
  * <p>The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.</p>
2947
3305
  */
2948
3306
  maxConcurrency?: number;
2949
3307
  /**
3308
+ * @public
2950
3309
  * <p>The maximum percentage of failed items before the Map Run fails.</p>
2951
3310
  */
2952
3311
  toleratedFailurePercentage?: number;
2953
3312
  /**
3313
+ * @public
2954
3314
  * <p>The maximum number of failed items before the Map Run fails.</p>
2955
3315
  */
2956
3316
  toleratedFailureCount?: number;
@@ -2978,33 +3338,40 @@ export declare class MissingRequiredParameter extends __BaseException {
2978
3338
  */
2979
3339
  export interface UpdateStateMachineInput {
2980
3340
  /**
3341
+ * @public
2981
3342
  * <p>The Amazon Resource Name (ARN) of the state machine.</p>
2982
3343
  */
2983
3344
  stateMachineArn: string | undefined;
2984
3345
  /**
3346
+ * @public
2985
3347
  * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
2986
3348
  */
2987
3349
  definition?: string;
2988
3350
  /**
3351
+ * @public
2989
3352
  * <p>The Amazon Resource Name (ARN) of the IAM role of the state machine.</p>
2990
3353
  */
2991
3354
  roleArn?: string;
2992
3355
  /**
3356
+ * @public
2993
3357
  * <p>Use the <code>LoggingConfiguration</code> data type to set CloudWatch Logs
2994
3358
  * options.</p>
2995
3359
  */
2996
3360
  loggingConfiguration?: LoggingConfiguration;
2997
3361
  /**
3362
+ * @public
2998
3363
  * <p>Selects whether X-Ray tracing is enabled.</p>
2999
3364
  */
3000
3365
  tracingConfiguration?: TracingConfiguration;
3001
3366
  /**
3367
+ * @public
3002
3368
  * <p>Specifies whether the state machine version is published. The default is
3003
3369
  * <code>false</code>. To publish a version after updating the state machine, set
3004
3370
  * <code>publish</code> to <code>true</code>.</p>
3005
3371
  */
3006
3372
  publish?: boolean;
3007
3373
  /**
3374
+ * @public
3008
3375
  * <p>An optional description of the state machine version to publish.</p>
3009
3376
  * <p>You can only specify the <code>versionDescription</code> parameter if you've set <code>publish</code> to <code>true</code>.</p>
3010
3377
  */
@@ -3015,14 +3382,17 @@ export interface UpdateStateMachineInput {
3015
3382
  */
3016
3383
  export interface UpdateStateMachineOutput {
3017
3384
  /**
3385
+ * @public
3018
3386
  * <p>The date and time the state machine was updated.</p>
3019
3387
  */
3020
3388
  updateDate: Date | undefined;
3021
3389
  /**
3390
+ * @public
3022
3391
  * <p>The revision identifier for the updated state machine.</p>
3023
3392
  */
3024
3393
  revisionId?: string;
3025
3394
  /**
3395
+ * @public
3026
3396
  * <p>The Amazon Resource Name (ARN) of the published state machine version.</p>
3027
3397
  * <p>If the <code>publish</code> parameter isn't set to <code>true</code>, this field returns null.</p>
3028
3398
  */
@@ -3033,14 +3403,17 @@ export interface UpdateStateMachineOutput {
3033
3403
  */
3034
3404
  export interface UpdateStateMachineAliasInput {
3035
3405
  /**
3406
+ * @public
3036
3407
  * <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
3037
3408
  */
3038
3409
  stateMachineAliasArn: string | undefined;
3039
3410
  /**
3411
+ * @public
3040
3412
  * <p>A description of the state machine alias.</p>
3041
3413
  */
3042
3414
  description?: string;
3043
3415
  /**
3416
+ * @public
3044
3417
  * <p>The routing configuration of the state machine alias.</p>
3045
3418
  * <p>An array of <code>RoutingConfig</code> objects that specifies up to two state machine versions that the alias starts executions for.</p>
3046
3419
  */
@@ -3051,6 +3424,7 @@ export interface UpdateStateMachineAliasInput {
3051
3424
  */
3052
3425
  export interface UpdateStateMachineAliasOutput {
3053
3426
  /**
3427
+ * @public
3054
3428
  * <p>The date and time the state machine alias was updated.</p>
3055
3429
  */
3056
3430
  updateDate: Date | undefined;