@aws-sdk/client-sfn 3.295.0 → 3.297.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 (37) hide show
  1. package/dist-types/SFN.d.ts +27 -0
  2. package/dist-types/SFNClient.d.ts +24 -4
  3. package/dist-types/commands/CreateActivityCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateStateMachineCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteActivityCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteStateMachineCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeActivityCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeExecutionCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeMapRunCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeStateMachineCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts +16 -0
  12. package/dist-types/commands/GetActivityTaskCommand.d.ts +16 -0
  13. package/dist-types/commands/GetExecutionHistoryCommand.d.ts +16 -0
  14. package/dist-types/commands/ListActivitiesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListExecutionsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListMapRunsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListStateMachinesCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/SendTaskFailureCommand.d.ts +16 -0
  20. package/dist-types/commands/SendTaskHeartbeatCommand.d.ts +16 -0
  21. package/dist-types/commands/SendTaskSuccessCommand.d.ts +16 -0
  22. package/dist-types/commands/StartExecutionCommand.d.ts +16 -0
  23. package/dist-types/commands/StartSyncExecutionCommand.d.ts +16 -0
  24. package/dist-types/commands/StopExecutionCommand.d.ts +16 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateMapRunCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateStateMachineCommand.d.ts +16 -0
  29. package/dist-types/models/SFNServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +270 -14
  31. package/dist-types/pagination/GetExecutionHistoryPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListActivitiesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListExecutionsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListMapRunsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListStateMachinesPaginator.d.ts +3 -0
  37. package/package.json +29 -29
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { SFNServiceException as __BaseException } from "./SFNServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The specified activity does not exist.</p>
5
6
  */
6
7
  export declare class ActivityDoesNotExist extends __BaseException {
@@ -12,6 +13,7 @@ export declare class ActivityDoesNotExist extends __BaseException {
12
13
  constructor(opts: __ExceptionOptionType<ActivityDoesNotExist, __BaseException>);
13
14
  }
14
15
  /**
16
+ * @public
15
17
  * <p>Contains details about an activity that failed during an execution.</p>
16
18
  */
17
19
  export interface ActivityFailedEventDetails {
@@ -25,6 +27,7 @@ export interface ActivityFailedEventDetails {
25
27
  cause?: string;
26
28
  }
27
29
  /**
30
+ * @public
28
31
  * <p>The maximum number of activities has been reached. Existing activities must be deleted
29
32
  * before a new activity can be created.</p>
30
33
  */
@@ -37,6 +40,7 @@ export declare class ActivityLimitExceeded extends __BaseException {
37
40
  constructor(opts: __ExceptionOptionType<ActivityLimitExceeded, __BaseException>);
38
41
  }
39
42
  /**
43
+ * @public
40
44
  * <p>Contains details about an activity.</p>
41
45
  */
42
46
  export interface ActivityListItem {
@@ -52,7 +56,7 @@ export interface ActivityListItem {
52
56
  * <p>white space</p>
53
57
  * </li>
54
58
  * <li>
55
- * <p>brackets <code>< > { } [ ]</code>
59
+ * <p>brackets <code>< > \{ \} [ ]</code>
56
60
  * </p>
57
61
  * </li>
58
62
  * <li>
@@ -76,6 +80,7 @@ export interface ActivityListItem {
76
80
  creationDate: Date | undefined;
77
81
  }
78
82
  /**
83
+ * @public
79
84
  * <p>Provides details about input or output in an execution history event.</p>
80
85
  */
81
86
  export interface HistoryEventExecutionDataDetails {
@@ -86,6 +91,7 @@ export interface HistoryEventExecutionDataDetails {
86
91
  truncated?: boolean;
87
92
  }
88
93
  /**
94
+ * @public
89
95
  * <p>Contains details about an activity scheduled during an execution.</p>
90
96
  */
91
97
  export interface ActivityScheduledEventDetails {
@@ -111,6 +117,7 @@ export interface ActivityScheduledEventDetails {
111
117
  heartbeatInSeconds?: number;
112
118
  }
113
119
  /**
120
+ * @public
114
121
  * <p>Contains details about an activity schedule failure that occurred during an
115
122
  * execution.</p>
116
123
  */
@@ -125,6 +132,7 @@ export interface ActivityScheduleFailedEventDetails {
125
132
  cause?: string;
126
133
  }
127
134
  /**
135
+ * @public
128
136
  * <p>Contains details about the start of an activity during an execution.</p>
129
137
  */
130
138
  export interface ActivityStartedEventDetails {
@@ -135,6 +143,7 @@ export interface ActivityStartedEventDetails {
135
143
  workerName?: string;
136
144
  }
137
145
  /**
146
+ * @public
138
147
  * <p>Contains details about an activity that successfully terminated during an
139
148
  * execution.</p>
140
149
  */
@@ -149,6 +158,7 @@ export interface ActivitySucceededEventDetails {
149
158
  outputDetails?: HistoryEventExecutionDataDetails;
150
159
  }
151
160
  /**
161
+ * @public
152
162
  * <p>Contains details about an activity timeout that occurred during an execution.</p>
153
163
  */
154
164
  export interface ActivityTimedOutEventDetails {
@@ -162,6 +172,7 @@ export interface ActivityTimedOutEventDetails {
162
172
  cause?: string;
163
173
  }
164
174
  /**
175
+ * @public
165
176
  * <p>The maximum number of workers concurrently polling for activity tasks has been
166
177
  * reached.</p>
167
178
  */
@@ -174,6 +185,7 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
174
185
  constructor(opts: __ExceptionOptionType<ActivityWorkerLimitExceeded, __BaseException>);
175
186
  }
176
187
  /**
188
+ * @public
177
189
  * <p>Tags are key-value pairs that can be associated with Step Functions state machines and
178
190
  * activities.</p>
179
191
  * <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
@@ -192,6 +204,9 @@ export interface Tag {
192
204
  */
193
205
  value?: string;
194
206
  }
207
+ /**
208
+ * @public
209
+ */
195
210
  export interface CreateActivityInput {
196
211
  /**
197
212
  * <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,
@@ -203,7 +218,7 @@ export interface CreateActivityInput {
203
218
  * <p>white space</p>
204
219
  * </li>
205
220
  * <li>
206
- * <p>brackets <code>< > { } [ ]</code>
221
+ * <p>brackets <code>< > \{ \} [ ]</code>
207
222
  * </p>
208
223
  * </li>
209
224
  * <li>
@@ -231,6 +246,9 @@ export interface CreateActivityInput {
231
246
  */
232
247
  tags?: Tag[];
233
248
  }
249
+ /**
250
+ * @public
251
+ */
234
252
  export interface CreateActivityOutput {
235
253
  /**
236
254
  * <p>The Amazon Resource Name (ARN) that identifies the created activity.</p>
@@ -242,6 +260,7 @@ export interface CreateActivityOutput {
242
260
  creationDate: Date | undefined;
243
261
  }
244
262
  /**
263
+ * @public
245
264
  * <p>The provided name is not valid.</p>
246
265
  */
247
266
  export declare class InvalidName extends __BaseException {
@@ -253,6 +272,7 @@ export declare class InvalidName extends __BaseException {
253
272
  constructor(opts: __ExceptionOptionType<InvalidName, __BaseException>);
254
273
  }
255
274
  /**
275
+ * @public
256
276
  * <p>You've exceeded the number of tags allowed for a resource. See the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html"> Limits Topic</a> in the
257
277
  * Step Functions Developer Guide.</p>
258
278
  */
@@ -266,6 +286,7 @@ export declare class TooManyTags extends __BaseException {
266
286
  constructor(opts: __ExceptionOptionType<TooManyTags, __BaseException>);
267
287
  }
268
288
  /**
289
+ * @public
269
290
  * <p></p>
270
291
  */
271
292
  export interface CloudWatchLogsLogGroup {
@@ -277,6 +298,7 @@ export interface CloudWatchLogsLogGroup {
277
298
  logGroupArn?: string;
278
299
  }
279
300
  /**
301
+ * @public
280
302
  * <p></p>
281
303
  */
282
304
  export interface LogDestination {
@@ -285,6 +307,9 @@ export interface LogDestination {
285
307
  */
286
308
  cloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
287
309
  }
310
+ /**
311
+ * @public
312
+ */
288
313
  export declare enum LogLevel {
289
314
  ALL = "ALL",
290
315
  ERROR = "ERROR",
@@ -292,6 +317,7 @@ export declare enum LogLevel {
292
317
  OFF = "OFF"
293
318
  }
294
319
  /**
320
+ * @public
295
321
  * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
296
322
  * options.</p>
297
323
  */
@@ -312,6 +338,7 @@ export interface LoggingConfiguration {
312
338
  destinations?: LogDestination[];
313
339
  }
314
340
  /**
341
+ * @public
315
342
  * <p>Selects whether or not the state machine's X-Ray tracing is enabled. Default is
316
343
  * <code>false</code>
317
344
  * </p>
@@ -322,10 +349,16 @@ export interface TracingConfiguration {
322
349
  */
323
350
  enabled?: boolean;
324
351
  }
352
+ /**
353
+ * @public
354
+ */
325
355
  export declare enum StateMachineType {
326
356
  EXPRESS = "EXPRESS",
327
357
  STANDARD = "STANDARD"
328
358
  }
359
+ /**
360
+ * @public
361
+ */
329
362
  export interface CreateStateMachineInput {
330
363
  /**
331
364
  * <p>The name of the state machine. </p>
@@ -335,7 +368,7 @@ export interface CreateStateMachineInput {
335
368
  * <p>white space</p>
336
369
  * </li>
337
370
  * <li>
338
- * <p>brackets <code>< > { } [ ]</code>
371
+ * <p>brackets <code>< > \{ \} [ ]</code>
339
372
  * </p>
340
373
  * </li>
341
374
  * <li>
@@ -390,6 +423,9 @@ export interface CreateStateMachineInput {
390
423
  */
391
424
  tracingConfiguration?: TracingConfiguration;
392
425
  }
426
+ /**
427
+ * @public
428
+ */
393
429
  export interface CreateStateMachineOutput {
394
430
  /**
395
431
  * <p>The Amazon Resource Name (ARN) that identifies the created state machine.</p>
@@ -401,6 +437,7 @@ export interface CreateStateMachineOutput {
401
437
  creationDate: Date | undefined;
402
438
  }
403
439
  /**
440
+ * @public
404
441
  * <p>The provided Amazon Resource Name (ARN) is not valid.</p>
405
442
  */
406
443
  export declare class InvalidArn extends __BaseException {
@@ -412,6 +449,7 @@ export declare class InvalidArn extends __BaseException {
412
449
  constructor(opts: __ExceptionOptionType<InvalidArn, __BaseException>);
413
450
  }
414
451
  /**
452
+ * @public
415
453
  * <p>The provided Amazon States Language definition is not valid.</p>
416
454
  */
417
455
  export declare class InvalidDefinition extends __BaseException {
@@ -423,6 +461,7 @@ export declare class InvalidDefinition extends __BaseException {
423
461
  constructor(opts: __ExceptionOptionType<InvalidDefinition, __BaseException>);
424
462
  }
425
463
  /**
464
+ * @public
426
465
  * <p></p>
427
466
  */
428
467
  export declare class InvalidLoggingConfiguration extends __BaseException {
@@ -434,6 +473,7 @@ export declare class InvalidLoggingConfiguration extends __BaseException {
434
473
  constructor(opts: __ExceptionOptionType<InvalidLoggingConfiguration, __BaseException>);
435
474
  }
436
475
  /**
476
+ * @public
437
477
  * <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not
438
478
  * been set to <code>true</code> or <code>false</code>.</p>
439
479
  */
@@ -446,6 +486,7 @@ export declare class InvalidTracingConfiguration extends __BaseException {
446
486
  constructor(opts: __ExceptionOptionType<InvalidTracingConfiguration, __BaseException>);
447
487
  }
448
488
  /**
489
+ * @public
449
490
  * <p>A state machine with the same name but a different definition or role ARN already
450
491
  * exists.</p>
451
492
  */
@@ -458,6 +499,7 @@ export declare class StateMachineAlreadyExists extends __BaseException {
458
499
  constructor(opts: __ExceptionOptionType<StateMachineAlreadyExists, __BaseException>);
459
500
  }
460
501
  /**
502
+ * @public
461
503
  * <p>The specified state machine is being deleted.</p>
462
504
  */
463
505
  export declare class StateMachineDeleting extends __BaseException {
@@ -469,6 +511,7 @@ export declare class StateMachineDeleting extends __BaseException {
469
511
  constructor(opts: __ExceptionOptionType<StateMachineDeleting, __BaseException>);
470
512
  }
471
513
  /**
514
+ * @public
472
515
  * <p>The maximum number of state machines has been reached. Existing state machines must be
473
516
  * deleted before a new state machine can be created.</p>
474
517
  */
@@ -481,6 +524,7 @@ export declare class StateMachineLimitExceeded extends __BaseException {
481
524
  constructor(opts: __ExceptionOptionType<StateMachineLimitExceeded, __BaseException>);
482
525
  }
483
526
  /**
527
+ * @public
484
528
  * <p></p>
485
529
  */
486
530
  export declare class StateMachineTypeNotSupported extends __BaseException {
@@ -491,28 +535,44 @@ export declare class StateMachineTypeNotSupported extends __BaseException {
491
535
  */
492
536
  constructor(opts: __ExceptionOptionType<StateMachineTypeNotSupported, __BaseException>);
493
537
  }
538
+ /**
539
+ * @public
540
+ */
494
541
  export interface DeleteActivityInput {
495
542
  /**
496
543
  * <p>The Amazon Resource Name (ARN) of the activity to delete.</p>
497
544
  */
498
545
  activityArn: string | undefined;
499
546
  }
547
+ /**
548
+ * @public
549
+ */
500
550
  export interface DeleteActivityOutput {
501
551
  }
552
+ /**
553
+ * @public
554
+ */
502
555
  export interface DeleteStateMachineInput {
503
556
  /**
504
557
  * <p>The Amazon Resource Name (ARN) of the state machine to delete.</p>
505
558
  */
506
559
  stateMachineArn: string | undefined;
507
560
  }
561
+ /**
562
+ * @public
563
+ */
508
564
  export interface DeleteStateMachineOutput {
509
565
  }
566
+ /**
567
+ * @public
568
+ */
510
569
  export declare enum ValidationExceptionReason {
511
570
  API_DOES_NOT_SUPPORT_LABELED_ARNS = "API_DOES_NOT_SUPPORT_LABELED_ARNS",
512
571
  CANNOT_UPDATE_COMPLETED_MAP_RUN = "CANNOT_UPDATE_COMPLETED_MAP_RUN",
513
572
  MISSING_REQUIRED_PARAMETER = "MISSING_REQUIRED_PARAMETER"
514
573
  }
515
574
  /**
575
+ * @public
516
576
  * <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
517
577
  */
518
578
  export declare class ValidationException extends __BaseException {
@@ -527,12 +587,18 @@ export declare class ValidationException extends __BaseException {
527
587
  */
528
588
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
529
589
  }
590
+ /**
591
+ * @public
592
+ */
530
593
  export interface DescribeActivityInput {
531
594
  /**
532
595
  * <p>The Amazon Resource Name (ARN) of the activity to describe.</p>
533
596
  */
534
597
  activityArn: string | undefined;
535
598
  }
599
+ /**
600
+ * @public
601
+ */
536
602
  export interface DescribeActivityOutput {
537
603
  /**
538
604
  * <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
@@ -546,7 +612,7 @@ export interface DescribeActivityOutput {
546
612
  * <p>white space</p>
547
613
  * </li>
548
614
  * <li>
549
- * <p>brackets <code>< > { } [ ]</code>
615
+ * <p>brackets <code>< > \{ \} [ ]</code>
550
616
  * </p>
551
617
  * </li>
552
618
  * <li>
@@ -569,6 +635,9 @@ export interface DescribeActivityOutput {
569
635
  */
570
636
  creationDate: Date | undefined;
571
637
  }
638
+ /**
639
+ * @public
640
+ */
572
641
  export interface DescribeExecutionInput {
573
642
  /**
574
643
  * <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
@@ -576,6 +645,7 @@ export interface DescribeExecutionInput {
576
645
  executionArn: string | undefined;
577
646
  }
578
647
  /**
648
+ * @public
579
649
  * <p>Provides details about execution input or output.</p>
580
650
  */
581
651
  export interface CloudWatchEventsExecutionDataDetails {
@@ -585,6 +655,9 @@ export interface CloudWatchEventsExecutionDataDetails {
585
655
  */
586
656
  included?: boolean;
587
657
  }
658
+ /**
659
+ * @public
660
+ */
588
661
  export declare enum ExecutionStatus {
589
662
  ABORTED = "ABORTED",
590
663
  FAILED = "FAILED",
@@ -592,6 +665,9 @@ export declare enum ExecutionStatus {
592
665
  SUCCEEDED = "SUCCEEDED",
593
666
  TIMED_OUT = "TIMED_OUT"
594
667
  }
668
+ /**
669
+ * @public
670
+ */
595
671
  export interface DescribeExecutionOutput {
596
672
  /**
597
673
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
@@ -609,7 +685,7 @@ export interface DescribeExecutionOutput {
609
685
  * <p>white space</p>
610
686
  * </li>
611
687
  * <li>
612
- * <p>brackets <code>< > { } [ ]</code>
688
+ * <p>brackets <code>< > \{ \} [ ]</code>
613
689
  * </p>
614
690
  * </li>
615
691
  * <li>
@@ -677,6 +753,7 @@ export interface DescribeExecutionOutput {
677
753
  cause?: string;
678
754
  }
679
755
  /**
756
+ * @public
680
757
  * <p>The specified execution does not exist.</p>
681
758
  */
682
759
  export declare class ExecutionDoesNotExist extends __BaseException {
@@ -687,6 +764,9 @@ export declare class ExecutionDoesNotExist extends __BaseException {
687
764
  */
688
765
  constructor(opts: __ExceptionOptionType<ExecutionDoesNotExist, __BaseException>);
689
766
  }
767
+ /**
768
+ * @public
769
+ */
690
770
  export interface DescribeMapRunInput {
691
771
  /**
692
772
  * <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
@@ -694,6 +774,7 @@ export interface DescribeMapRunInput {
694
774
  mapRunArn: string | undefined;
695
775
  }
696
776
  /**
777
+ * @public
697
778
  * <p>Contains details about all of the child workflow executions started by a Map Run.</p>
698
779
  */
699
780
  export interface MapRunExecutionCounts {
@@ -731,6 +812,7 @@ export interface MapRunExecutionCounts {
731
812
  resultsWritten: number | undefined;
732
813
  }
733
814
  /**
815
+ * @public
734
816
  * <p>Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.</p>
735
817
  */
736
818
  export interface MapRunItemCounts {
@@ -767,12 +849,18 @@ export interface MapRunItemCounts {
767
849
  */
768
850
  resultsWritten: number | undefined;
769
851
  }
852
+ /**
853
+ * @public
854
+ */
770
855
  export declare enum MapRunStatus {
771
856
  ABORTED = "ABORTED",
772
857
  FAILED = "FAILED",
773
858
  RUNNING = "RUNNING",
774
859
  SUCCEEDED = "SUCCEEDED"
775
860
  }
861
+ /**
862
+ * @public
863
+ */
776
864
  export interface DescribeMapRunOutput {
777
865
  /**
778
866
  * <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
@@ -816,6 +904,7 @@ export interface DescribeMapRunOutput {
816
904
  executionCounts: MapRunExecutionCounts | undefined;
817
905
  }
818
906
  /**
907
+ * @public
819
908
  * <p>Could not find the referenced resource. Only state machine and activity ARNs are
820
909
  * supported.</p>
821
910
  */
@@ -828,16 +917,25 @@ export declare class ResourceNotFound extends __BaseException {
828
917
  */
829
918
  constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
830
919
  }
920
+ /**
921
+ * @public
922
+ */
831
923
  export interface DescribeStateMachineInput {
832
924
  /**
833
925
  * <p>The Amazon Resource Name (ARN) of the state machine to describe.</p>
834
926
  */
835
927
  stateMachineArn: string | undefined;
836
928
  }
929
+ /**
930
+ * @public
931
+ */
837
932
  export declare enum StateMachineStatus {
838
933
  ACTIVE = "ACTIVE",
839
934
  DELETING = "DELETING"
840
935
  }
936
+ /**
937
+ * @public
938
+ */
841
939
  export interface DescribeStateMachineOutput {
842
940
  /**
843
941
  * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
@@ -851,7 +949,7 @@ export interface DescribeStateMachineOutput {
851
949
  * <p>white space</p>
852
950
  * </li>
853
951
  * <li>
854
- * <p>brackets <code>< > { } [ ]</code>
952
+ * <p>brackets <code>< > \{ \} [ ]</code>
855
953
  * </p>
856
954
  * </li>
857
955
  * <li>
@@ -906,6 +1004,7 @@ export interface DescribeStateMachineOutput {
906
1004
  label?: string;
907
1005
  }
908
1006
  /**
1007
+ * @public
909
1008
  * <p>The specified state machine does not exist.</p>
910
1009
  */
911
1010
  export declare class StateMachineDoesNotExist extends __BaseException {
@@ -916,12 +1015,18 @@ export declare class StateMachineDoesNotExist extends __BaseException {
916
1015
  */
917
1016
  constructor(opts: __ExceptionOptionType<StateMachineDoesNotExist, __BaseException>);
918
1017
  }
1018
+ /**
1019
+ * @public
1020
+ */
919
1021
  export interface DescribeStateMachineForExecutionInput {
920
1022
  /**
921
1023
  * <p>The Amazon Resource Name (ARN) of the execution you want state machine information for.</p>
922
1024
  */
923
1025
  executionArn: string | undefined;
924
1026
  }
1027
+ /**
1028
+ * @public
1029
+ */
925
1030
  export interface DescribeStateMachineForExecutionOutput {
926
1031
  /**
927
1032
  * <p>The Amazon Resource Name (ARN) of the state machine associated with the execution.</p>
@@ -962,6 +1067,9 @@ export interface DescribeStateMachineForExecutionOutput {
962
1067
  */
963
1068
  label?: string;
964
1069
  }
1070
+ /**
1071
+ * @public
1072
+ */
965
1073
  export interface GetActivityTaskInput {
966
1074
  /**
967
1075
  * <p>The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task
@@ -974,6 +1082,9 @@ export interface GetActivityTaskInput {
974
1082
  */
975
1083
  workerName?: string;
976
1084
  }
1085
+ /**
1086
+ * @public
1087
+ */
977
1088
  export interface GetActivityTaskOutput {
978
1089
  /**
979
1090
  * <p>A token that identifies the scheduled task. This token must be copied and included in
@@ -987,6 +1098,9 @@ export interface GetActivityTaskOutput {
987
1098
  */
988
1099
  input?: string;
989
1100
  }
1101
+ /**
1102
+ * @public
1103
+ */
990
1104
  export interface GetExecutionHistoryInput {
991
1105
  /**
992
1106
  * <p>The Amazon Resource Name (ARN) of the execution.</p>
@@ -1014,6 +1128,7 @@ export interface GetExecutionHistoryInput {
1014
1128
  includeExecutionData?: boolean;
1015
1129
  }
1016
1130
  /**
1131
+ * @public
1017
1132
  * <p>Contains details about an abort of an execution.</p>
1018
1133
  */
1019
1134
  export interface ExecutionAbortedEventDetails {
@@ -1027,6 +1142,7 @@ export interface ExecutionAbortedEventDetails {
1027
1142
  cause?: string;
1028
1143
  }
1029
1144
  /**
1145
+ * @public
1030
1146
  * <p>Contains details about an execution failure event.</p>
1031
1147
  */
1032
1148
  export interface ExecutionFailedEventDetails {
@@ -1040,6 +1156,7 @@ export interface ExecutionFailedEventDetails {
1040
1156
  cause?: string;
1041
1157
  }
1042
1158
  /**
1159
+ * @public
1043
1160
  * <p>Contains details about the start of the execution.</p>
1044
1161
  */
1045
1162
  export interface ExecutionStartedEventDetails {
@@ -1057,6 +1174,7 @@ export interface ExecutionStartedEventDetails {
1057
1174
  roleArn?: string;
1058
1175
  }
1059
1176
  /**
1177
+ * @public
1060
1178
  * <p>Contains details about the successful termination of the execution.</p>
1061
1179
  */
1062
1180
  export interface ExecutionSucceededEventDetails {
@@ -1070,6 +1188,7 @@ export interface ExecutionSucceededEventDetails {
1070
1188
  outputDetails?: HistoryEventExecutionDataDetails;
1071
1189
  }
1072
1190
  /**
1191
+ * @public
1073
1192
  * <p>Contains details about the execution timeout that occurred during the execution.</p>
1074
1193
  */
1075
1194
  export interface ExecutionTimedOutEventDetails {
@@ -1083,6 +1202,7 @@ export interface ExecutionTimedOutEventDetails {
1083
1202
  cause?: string;
1084
1203
  }
1085
1204
  /**
1205
+ * @public
1086
1206
  * <p>Contains details about a Lambda function that failed during an execution.</p>
1087
1207
  */
1088
1208
  export interface LambdaFunctionFailedEventDetails {
@@ -1096,6 +1216,7 @@ export interface LambdaFunctionFailedEventDetails {
1096
1216
  cause?: string;
1097
1217
  }
1098
1218
  /**
1219
+ * @public
1099
1220
  * <p>Contains details about the credentials that Step Functions uses for a task.</p>
1100
1221
  */
1101
1222
  export interface TaskCredentials {
@@ -1105,6 +1226,7 @@ export interface TaskCredentials {
1105
1226
  roleArn?: string;
1106
1227
  }
1107
1228
  /**
1229
+ * @public
1108
1230
  * <p>Contains details about a Lambda function scheduled during an execution.</p>
1109
1231
  */
1110
1232
  export interface LambdaFunctionScheduledEventDetails {
@@ -1130,6 +1252,7 @@ export interface LambdaFunctionScheduledEventDetails {
1130
1252
  taskCredentials?: TaskCredentials;
1131
1253
  }
1132
1254
  /**
1255
+ * @public
1133
1256
  * <p>Contains details about a failed Lambda function schedule event that occurred during an
1134
1257
  * execution.</p>
1135
1258
  */
@@ -1144,6 +1267,7 @@ export interface LambdaFunctionScheduleFailedEventDetails {
1144
1267
  cause?: string;
1145
1268
  }
1146
1269
  /**
1270
+ * @public
1147
1271
  * <p>Contains details about a lambda function that failed to start during an execution.</p>
1148
1272
  */
1149
1273
  export interface LambdaFunctionStartFailedEventDetails {
@@ -1157,6 +1281,7 @@ export interface LambdaFunctionStartFailedEventDetails {
1157
1281
  cause?: string;
1158
1282
  }
1159
1283
  /**
1284
+ * @public
1160
1285
  * <p>Contains details about a Lambda function that successfully terminated during an
1161
1286
  * execution.</p>
1162
1287
  */
@@ -1171,6 +1296,7 @@ export interface LambdaFunctionSucceededEventDetails {
1171
1296
  outputDetails?: HistoryEventExecutionDataDetails;
1172
1297
  }
1173
1298
  /**
1299
+ * @public
1174
1300
  * <p>Contains details about a Lambda function timeout that occurred during an execution.</p>
1175
1301
  */
1176
1302
  export interface LambdaFunctionTimedOutEventDetails {
@@ -1184,6 +1310,7 @@ export interface LambdaFunctionTimedOutEventDetails {
1184
1310
  cause?: string;
1185
1311
  }
1186
1312
  /**
1313
+ * @public
1187
1314
  * <p>Contains details about an iteration of a Map state.</p>
1188
1315
  */
1189
1316
  export interface MapIterationEventDetails {
@@ -1197,6 +1324,7 @@ export interface MapIterationEventDetails {
1197
1324
  index?: number;
1198
1325
  }
1199
1326
  /**
1327
+ * @public
1200
1328
  * <p>Contains details about a Map Run failure event that occurred during a state machine execution.</p>
1201
1329
  */
1202
1330
  export interface MapRunFailedEventDetails {
@@ -1210,6 +1338,7 @@ export interface MapRunFailedEventDetails {
1210
1338
  cause?: string;
1211
1339
  }
1212
1340
  /**
1341
+ * @public
1213
1342
  * <p>Contains details about a Map Run that was started during a state machine execution.</p>
1214
1343
  */
1215
1344
  export interface MapRunStartedEventDetails {
@@ -1219,6 +1348,7 @@ export interface MapRunStartedEventDetails {
1219
1348
  mapRunArn?: string;
1220
1349
  }
1221
1350
  /**
1351
+ * @public
1222
1352
  * <p>Details about a Map state that was started.</p>
1223
1353
  */
1224
1354
  export interface MapStateStartedEventDetails {
@@ -1228,6 +1358,7 @@ export interface MapStateStartedEventDetails {
1228
1358
  length?: number;
1229
1359
  }
1230
1360
  /**
1361
+ * @public
1231
1362
  * <p>Contains details about a state entered during an execution.</p>
1232
1363
  */
1233
1364
  export interface StateEnteredEventDetails {
@@ -1245,6 +1376,7 @@ export interface StateEnteredEventDetails {
1245
1376
  inputDetails?: HistoryEventExecutionDataDetails;
1246
1377
  }
1247
1378
  /**
1379
+ * @public
1248
1380
  * <p>Contains details about an exit from a state during an execution.</p>
1249
1381
  */
1250
1382
  export interface StateExitedEventDetails {
@@ -1256,7 +1388,7 @@ export interface StateExitedEventDetails {
1256
1388
  * <p>white space</p>
1257
1389
  * </li>
1258
1390
  * <li>
1259
- * <p>brackets <code>< > { } [ ]</code>
1391
+ * <p>brackets <code>< > \{ \} [ ]</code>
1260
1392
  * </p>
1261
1393
  * </li>
1262
1394
  * <li>
@@ -1284,6 +1416,7 @@ export interface StateExitedEventDetails {
1284
1416
  outputDetails?: HistoryEventExecutionDataDetails;
1285
1417
  }
1286
1418
  /**
1419
+ * @public
1287
1420
  * <p>Contains details about a task failure event.</p>
1288
1421
  */
1289
1422
  export interface TaskFailedEventDetails {
@@ -1305,6 +1438,7 @@ export interface TaskFailedEventDetails {
1305
1438
  cause?: string;
1306
1439
  }
1307
1440
  /**
1441
+ * @public
1308
1442
  * <p>Contains details about a task scheduled during an execution.</p>
1309
1443
  */
1310
1444
  export interface TaskScheduledEventDetails {
@@ -1339,6 +1473,7 @@ export interface TaskScheduledEventDetails {
1339
1473
  taskCredentials?: TaskCredentials;
1340
1474
  }
1341
1475
  /**
1476
+ * @public
1342
1477
  * <p>Contains details about the start of a task during an execution.</p>
1343
1478
  */
1344
1479
  export interface TaskStartedEventDetails {
@@ -1352,6 +1487,7 @@ export interface TaskStartedEventDetails {
1352
1487
  resource: string | undefined;
1353
1488
  }
1354
1489
  /**
1490
+ * @public
1355
1491
  * <p>Contains details about a task that failed to start during an execution.</p>
1356
1492
  */
1357
1493
  export interface TaskStartFailedEventDetails {
@@ -1373,6 +1509,7 @@ export interface TaskStartFailedEventDetails {
1373
1509
  cause?: string;
1374
1510
  }
1375
1511
  /**
1512
+ * @public
1376
1513
  * <p>Contains details about a task that failed to submit during an execution.</p>
1377
1514
  */
1378
1515
  export interface TaskSubmitFailedEventDetails {
@@ -1394,6 +1531,7 @@ export interface TaskSubmitFailedEventDetails {
1394
1531
  cause?: string;
1395
1532
  }
1396
1533
  /**
1534
+ * @public
1397
1535
  * <p>Contains details about a task submitted to a resource .</p>
1398
1536
  */
1399
1537
  export interface TaskSubmittedEventDetails {
@@ -1415,6 +1553,7 @@ export interface TaskSubmittedEventDetails {
1415
1553
  outputDetails?: HistoryEventExecutionDataDetails;
1416
1554
  }
1417
1555
  /**
1556
+ * @public
1418
1557
  * <p>Contains details about the successful completion of a task state.</p>
1419
1558
  */
1420
1559
  export interface TaskSucceededEventDetails {
@@ -1437,6 +1576,7 @@ export interface TaskSucceededEventDetails {
1437
1576
  outputDetails?: HistoryEventExecutionDataDetails;
1438
1577
  }
1439
1578
  /**
1579
+ * @public
1440
1580
  * <p>Contains details about a resource timeout that occurred during an execution.</p>
1441
1581
  */
1442
1582
  export interface TaskTimedOutEventDetails {
@@ -1457,6 +1597,9 @@ export interface TaskTimedOutEventDetails {
1457
1597
  */
1458
1598
  cause?: string;
1459
1599
  }
1600
+ /**
1601
+ * @public
1602
+ */
1460
1603
  export declare enum HistoryEventType {
1461
1604
  ActivityFailed = "ActivityFailed",
1462
1605
  ActivityScheduleFailed = "ActivityScheduleFailed",
@@ -1519,6 +1662,7 @@ export declare enum HistoryEventType {
1519
1662
  WaitStateExited = "WaitStateExited"
1520
1663
  }
1521
1664
  /**
1665
+ * @public
1522
1666
  * <p>Contains details about the events of an execution.</p>
1523
1667
  */
1524
1668
  export interface HistoryEvent {
@@ -1678,6 +1822,9 @@ export interface HistoryEvent {
1678
1822
  */
1679
1823
  mapRunFailedEventDetails?: MapRunFailedEventDetails;
1680
1824
  }
1825
+ /**
1826
+ * @public
1827
+ */
1681
1828
  export interface GetExecutionHistoryOutput {
1682
1829
  /**
1683
1830
  * <p>The list of events that occurred in the execution.</p>
@@ -1690,6 +1837,7 @@ export interface GetExecutionHistoryOutput {
1690
1837
  nextToken?: string;
1691
1838
  }
1692
1839
  /**
1840
+ * @public
1693
1841
  * <p>The provided token is not valid.</p>
1694
1842
  */
1695
1843
  export declare class InvalidToken extends __BaseException {
@@ -1700,6 +1848,9 @@ export declare class InvalidToken extends __BaseException {
1700
1848
  */
1701
1849
  constructor(opts: __ExceptionOptionType<InvalidToken, __BaseException>);
1702
1850
  }
1851
+ /**
1852
+ * @public
1853
+ */
1703
1854
  export interface ListActivitiesInput {
1704
1855
  /**
1705
1856
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
@@ -1713,6 +1864,9 @@ export interface ListActivitiesInput {
1713
1864
  */
1714
1865
  nextToken?: string;
1715
1866
  }
1867
+ /**
1868
+ * @public
1869
+ */
1716
1870
  export interface ListActivitiesOutput {
1717
1871
  /**
1718
1872
  * <p>The list of activities.</p>
@@ -1724,6 +1878,9 @@ export interface ListActivitiesOutput {
1724
1878
  */
1725
1879
  nextToken?: string;
1726
1880
  }
1881
+ /**
1882
+ * @public
1883
+ */
1727
1884
  export interface ListExecutionsInput {
1728
1885
  /**
1729
1886
  * <p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p>
@@ -1753,6 +1910,7 @@ export interface ListExecutionsInput {
1753
1910
  mapRunArn?: string;
1754
1911
  }
1755
1912
  /**
1913
+ * @public
1756
1914
  * <p>Contains details about an execution.</p>
1757
1915
  */
1758
1916
  export interface ExecutionListItem {
@@ -1772,7 +1930,7 @@ export interface ExecutionListItem {
1772
1930
  * <p>white space</p>
1773
1931
  * </li>
1774
1932
  * <li>
1775
- * <p>brackets <code>< > { } [ ]</code>
1933
+ * <p>brackets <code>< > \{ \} [ ]</code>
1776
1934
  * </p>
1777
1935
  * </li>
1778
1936
  * <li>
@@ -1811,6 +1969,9 @@ export interface ExecutionListItem {
1811
1969
  */
1812
1970
  itemCount?: number;
1813
1971
  }
1972
+ /**
1973
+ * @public
1974
+ */
1814
1975
  export interface ListExecutionsOutput {
1815
1976
  /**
1816
1977
  * <p>The list of matching executions.</p>
@@ -1822,6 +1983,9 @@ export interface ListExecutionsOutput {
1822
1983
  */
1823
1984
  nextToken?: string;
1824
1985
  }
1986
+ /**
1987
+ * @public
1988
+ */
1825
1989
  export interface ListMapRunsInput {
1826
1990
  /**
1827
1991
  * <p>The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.</p>
@@ -1840,6 +2004,7 @@ export interface ListMapRunsInput {
1840
2004
  nextToken?: string;
1841
2005
  }
1842
2006
  /**
2007
+ * @public
1843
2008
  * <p>Contains details about a specific Map Run.</p>
1844
2009
  */
1845
2010
  export interface MapRunListItem {
@@ -1864,6 +2029,9 @@ export interface MapRunListItem {
1864
2029
  */
1865
2030
  stopDate?: Date;
1866
2031
  }
2032
+ /**
2033
+ * @public
2034
+ */
1867
2035
  export interface ListMapRunsOutput {
1868
2036
  /**
1869
2037
  * <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>
@@ -1875,6 +2043,9 @@ export interface ListMapRunsOutput {
1875
2043
  */
1876
2044
  nextToken?: string;
1877
2045
  }
2046
+ /**
2047
+ * @public
2048
+ */
1878
2049
  export interface ListStateMachinesInput {
1879
2050
  /**
1880
2051
  * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
@@ -1889,6 +2060,7 @@ export interface ListStateMachinesInput {
1889
2060
  nextToken?: string;
1890
2061
  }
1891
2062
  /**
2063
+ * @public
1892
2064
  * <p>Contains details about the state machine.</p>
1893
2065
  */
1894
2066
  export interface StateMachineListItem {
@@ -1904,7 +2076,7 @@ export interface StateMachineListItem {
1904
2076
  * <p>white space</p>
1905
2077
  * </li>
1906
2078
  * <li>
1907
- * <p>brackets <code>< > { } [ ]</code>
2079
+ * <p>brackets <code>< > \{ \} [ ]</code>
1908
2080
  * </p>
1909
2081
  * </li>
1910
2082
  * <li>
@@ -1931,6 +2103,9 @@ export interface StateMachineListItem {
1931
2103
  */
1932
2104
  creationDate: Date | undefined;
1933
2105
  }
2106
+ /**
2107
+ * @public
2108
+ */
1934
2109
  export interface ListStateMachinesOutput {
1935
2110
  stateMachines: StateMachineListItem[] | undefined;
1936
2111
  /**
@@ -1939,18 +2114,27 @@ export interface ListStateMachinesOutput {
1939
2114
  */
1940
2115
  nextToken?: string;
1941
2116
  }
2117
+ /**
2118
+ * @public
2119
+ */
1942
2120
  export interface ListTagsForResourceInput {
1943
2121
  /**
1944
2122
  * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
1945
2123
  */
1946
2124
  resourceArn: string | undefined;
1947
2125
  }
2126
+ /**
2127
+ * @public
2128
+ */
1948
2129
  export interface ListTagsForResourceOutput {
1949
2130
  /**
1950
2131
  * <p>An array of tags associated with the resource.</p>
1951
2132
  */
1952
2133
  tags?: Tag[];
1953
2134
  }
2135
+ /**
2136
+ * @public
2137
+ */
1954
2138
  export interface SendTaskFailureInput {
1955
2139
  /**
1956
2140
  * <p>The token that represents this task. Task tokens are generated by Step Functions when
@@ -1967,8 +2151,14 @@ export interface SendTaskFailureInput {
1967
2151
  */
1968
2152
  cause?: string;
1969
2153
  }
2154
+ /**
2155
+ * @public
2156
+ */
1970
2157
  export interface SendTaskFailureOutput {
1971
2158
  }
2159
+ /**
2160
+ * @public
2161
+ */
1972
2162
  export declare class TaskDoesNotExist extends __BaseException {
1973
2163
  readonly name: "TaskDoesNotExist";
1974
2164
  readonly $fault: "client";
@@ -1977,6 +2167,9 @@ export declare class TaskDoesNotExist extends __BaseException {
1977
2167
  */
1978
2168
  constructor(opts: __ExceptionOptionType<TaskDoesNotExist, __BaseException>);
1979
2169
  }
2170
+ /**
2171
+ * @public
2172
+ */
1980
2173
  export declare class TaskTimedOut extends __BaseException {
1981
2174
  readonly name: "TaskTimedOut";
1982
2175
  readonly $fault: "client";
@@ -1985,6 +2178,9 @@ export declare class TaskTimedOut extends __BaseException {
1985
2178
  */
1986
2179
  constructor(opts: __ExceptionOptionType<TaskTimedOut, __BaseException>);
1987
2180
  }
2181
+ /**
2182
+ * @public
2183
+ */
1988
2184
  export interface SendTaskHeartbeatInput {
1989
2185
  /**
1990
2186
  * <p>The token that represents this task. Task tokens are generated by Step Functions when
@@ -1993,9 +2189,13 @@ export interface SendTaskHeartbeatInput {
1993
2189
  */
1994
2190
  taskToken: string | undefined;
1995
2191
  }
2192
+ /**
2193
+ * @public
2194
+ */
1996
2195
  export interface SendTaskHeartbeatOutput {
1997
2196
  }
1998
2197
  /**
2198
+ * @public
1999
2199
  * <p>The provided JSON output data is not valid.</p>
2000
2200
  */
2001
2201
  export declare class InvalidOutput extends __BaseException {
@@ -2006,6 +2206,9 @@ export declare class InvalidOutput extends __BaseException {
2006
2206
  */
2007
2207
  constructor(opts: __ExceptionOptionType<InvalidOutput, __BaseException>);
2008
2208
  }
2209
+ /**
2210
+ * @public
2211
+ */
2009
2212
  export interface SendTaskSuccessInput {
2010
2213
  /**
2011
2214
  * <p>The token that represents this task. Task tokens are generated by Step Functions when
@@ -2018,9 +2221,13 @@ export interface SendTaskSuccessInput {
2018
2221
  */
2019
2222
  output: string | undefined;
2020
2223
  }
2224
+ /**
2225
+ * @public
2226
+ */
2021
2227
  export interface SendTaskSuccessOutput {
2022
2228
  }
2023
2229
  /**
2230
+ * @public
2024
2231
  * <p>The execution has the same <code>name</code> as another execution (but a different
2025
2232
  * <code>input</code>).</p>
2026
2233
  * <note>
@@ -2037,6 +2244,7 @@ export declare class ExecutionAlreadyExists extends __BaseException {
2037
2244
  constructor(opts: __ExceptionOptionType<ExecutionAlreadyExists, __BaseException>);
2038
2245
  }
2039
2246
  /**
2247
+ * @public
2040
2248
  * <p>The maximum number of running executions has been reached. Running executions must end or
2041
2249
  * be stopped before a new execution can be started.</p>
2042
2250
  */
@@ -2049,6 +2257,7 @@ export declare class ExecutionLimitExceeded extends __BaseException {
2049
2257
  constructor(opts: __ExceptionOptionType<ExecutionLimitExceeded, __BaseException>);
2050
2258
  }
2051
2259
  /**
2260
+ * @public
2052
2261
  * <p>The provided JSON input data is not valid.</p>
2053
2262
  */
2054
2263
  export declare class InvalidExecutionInput extends __BaseException {
@@ -2059,6 +2268,9 @@ export declare class InvalidExecutionInput extends __BaseException {
2059
2268
  */
2060
2269
  constructor(opts: __ExceptionOptionType<InvalidExecutionInput, __BaseException>);
2061
2270
  }
2271
+ /**
2272
+ * @public
2273
+ */
2062
2274
  export interface StartExecutionInput {
2063
2275
  /**
2064
2276
  * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
@@ -2074,7 +2286,7 @@ export interface StartExecutionInput {
2074
2286
  * <p>white space</p>
2075
2287
  * </li>
2076
2288
  * <li>
2077
- * <p>brackets <code>< > { } [ ]</code>
2289
+ * <p>brackets <code>< > \{ \} [ ]</code>
2078
2290
  * </p>
2079
2291
  * </li>
2080
2292
  * <li>
@@ -2095,11 +2307,11 @@ export interface StartExecutionInput {
2095
2307
  /**
2096
2308
  * <p>The string that contains the JSON input data for the execution, for example:</p>
2097
2309
  * <p>
2098
- * <code>"input": "{\"first_name\" : \"test\"}"</code>
2310
+ * <code>"input": "\{\"first_name\" : \"test\"\}"</code>
2099
2311
  * </p>
2100
2312
  * <note>
2101
2313
  * <p>If you don't include any JSON input data, you still must include the two braces, for
2102
- * example: <code>"input": "{}"</code>
2314
+ * example: <code>"input": "\{\}"</code>
2103
2315
  * </p>
2104
2316
  * </note>
2105
2317
  * <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
@@ -2111,6 +2323,9 @@ export interface StartExecutionInput {
2111
2323
  */
2112
2324
  traceHeader?: string;
2113
2325
  }
2326
+ /**
2327
+ * @public
2328
+ */
2114
2329
  export interface StartExecutionOutput {
2115
2330
  /**
2116
2331
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
@@ -2121,6 +2336,9 @@ export interface StartExecutionOutput {
2121
2336
  */
2122
2337
  startDate: Date | undefined;
2123
2338
  }
2339
+ /**
2340
+ * @public
2341
+ */
2124
2342
  export interface StartSyncExecutionInput {
2125
2343
  /**
2126
2344
  * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
@@ -2133,11 +2351,11 @@ export interface StartSyncExecutionInput {
2133
2351
  /**
2134
2352
  * <p>The string that contains the JSON input data for the execution, for example:</p>
2135
2353
  * <p>
2136
- * <code>"input": "{\"first_name\" : \"test\"}"</code>
2354
+ * <code>"input": "\{\"first_name\" : \"test\"\}"</code>
2137
2355
  * </p>
2138
2356
  * <note>
2139
2357
  * <p>If you don't include any JSON input data, you still must include the two braces, for
2140
- * example: <code>"input": "{}"</code>
2358
+ * example: <code>"input": "\{\}"</code>
2141
2359
  * </p>
2142
2360
  * </note>
2143
2361
  * <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
@@ -2150,6 +2368,7 @@ export interface StartSyncExecutionInput {
2150
2368
  traceHeader?: string;
2151
2369
  }
2152
2370
  /**
2371
+ * @public
2153
2372
  * <p>An object that describes workflow billing details.</p>
2154
2373
  */
2155
2374
  export interface BillingDetails {
@@ -2162,11 +2381,17 @@ export interface BillingDetails {
2162
2381
  */
2163
2382
  billedDurationInMilliseconds?: number;
2164
2383
  }
2384
+ /**
2385
+ * @public
2386
+ */
2165
2387
  export declare enum SyncExecutionStatus {
2166
2388
  FAILED = "FAILED",
2167
2389
  SUCCEEDED = "SUCCEEDED",
2168
2390
  TIMED_OUT = "TIMED_OUT"
2169
2391
  }
2392
+ /**
2393
+ * @public
2394
+ */
2170
2395
  export interface StartSyncExecutionOutput {
2171
2396
  /**
2172
2397
  * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
@@ -2230,6 +2455,9 @@ export interface StartSyncExecutionOutput {
2230
2455
  */
2231
2456
  billingDetails?: BillingDetails;
2232
2457
  }
2458
+ /**
2459
+ * @public
2460
+ */
2233
2461
  export interface StopExecutionInput {
2234
2462
  /**
2235
2463
  * <p>The Amazon Resource Name (ARN) of the execution to stop.</p>
@@ -2244,12 +2472,18 @@ export interface StopExecutionInput {
2244
2472
  */
2245
2473
  cause?: string;
2246
2474
  }
2475
+ /**
2476
+ * @public
2477
+ */
2247
2478
  export interface StopExecutionOutput {
2248
2479
  /**
2249
2480
  * <p>The date the execution is stopped.</p>
2250
2481
  */
2251
2482
  stopDate: Date | undefined;
2252
2483
  }
2484
+ /**
2485
+ * @public
2486
+ */
2253
2487
  export interface TagResourceInput {
2254
2488
  /**
2255
2489
  * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
@@ -2261,8 +2495,14 @@ export interface TagResourceInput {
2261
2495
  */
2262
2496
  tags: Tag[] | undefined;
2263
2497
  }
2498
+ /**
2499
+ * @public
2500
+ */
2264
2501
  export interface TagResourceOutput {
2265
2502
  }
2503
+ /**
2504
+ * @public
2505
+ */
2266
2506
  export interface UntagResourceInput {
2267
2507
  /**
2268
2508
  * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
@@ -2273,8 +2513,14 @@ export interface UntagResourceInput {
2273
2513
  */
2274
2514
  tagKeys: string[] | undefined;
2275
2515
  }
2516
+ /**
2517
+ * @public
2518
+ */
2276
2519
  export interface UntagResourceOutput {
2277
2520
  }
2521
+ /**
2522
+ * @public
2523
+ */
2278
2524
  export interface UpdateMapRunInput {
2279
2525
  /**
2280
2526
  * <p>The Amazon Resource Name (ARN) of a Map Run.</p>
@@ -2293,9 +2539,13 @@ export interface UpdateMapRunInput {
2293
2539
  */
2294
2540
  toleratedFailureCount?: number;
2295
2541
  }
2542
+ /**
2543
+ * @public
2544
+ */
2296
2545
  export interface UpdateMapRunOutput {
2297
2546
  }
2298
2547
  /**
2548
+ * @public
2299
2549
  * <p>Request is missing a required parameter. This error occurs if both <code>definition</code>
2300
2550
  * and <code>roleArn</code> are not specified.</p>
2301
2551
  */
@@ -2307,6 +2557,9 @@ export declare class MissingRequiredParameter extends __BaseException {
2307
2557
  */
2308
2558
  constructor(opts: __ExceptionOptionType<MissingRequiredParameter, __BaseException>);
2309
2559
  }
2560
+ /**
2561
+ * @public
2562
+ */
2310
2563
  export interface UpdateStateMachineInput {
2311
2564
  /**
2312
2565
  * <p>The Amazon Resource Name (ARN) of the state machine.</p>
@@ -2330,6 +2583,9 @@ export interface UpdateStateMachineInput {
2330
2583
  */
2331
2584
  tracingConfiguration?: TracingConfiguration;
2332
2585
  }
2586
+ /**
2587
+ * @public
2588
+ */
2333
2589
  export interface UpdateStateMachineOutput {
2334
2590
  /**
2335
2591
  * <p>The date and time the state machine was updated.</p>