@aws-sdk/client-sfn 3.357.0 → 3.358.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 (71) hide show
  1. package/README.md +64 -0
  2. package/dist-cjs/SFN.js +16 -0
  3. package/dist-cjs/commands/CreateStateMachineAliasCommand.js +47 -0
  4. package/dist-cjs/commands/DeleteStateMachineAliasCommand.js +46 -0
  5. package/dist-cjs/commands/DeleteStateMachineVersionCommand.js +46 -0
  6. package/dist-cjs/commands/DescribeStateMachineAliasCommand.js +47 -0
  7. package/dist-cjs/commands/ListStateMachineAliasesCommand.js +46 -0
  8. package/dist-cjs/commands/ListStateMachineVersionsCommand.js +46 -0
  9. package/dist-cjs/commands/PublishStateMachineVersionCommand.js +47 -0
  10. package/dist-cjs/commands/UpdateStateMachineAliasCommand.js +47 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/endpoint/ruleset.js +3 -3
  13. package/dist-cjs/models/models_0.js +66 -16
  14. package/dist-cjs/protocols/Aws_json1_0.js +510 -2
  15. package/dist-es/SFN.js +16 -0
  16. package/dist-es/commands/CreateStateMachineAliasCommand.js +43 -0
  17. package/dist-es/commands/DeleteStateMachineAliasCommand.js +42 -0
  18. package/dist-es/commands/DeleteStateMachineVersionCommand.js +42 -0
  19. package/dist-es/commands/DescribeStateMachineAliasCommand.js +43 -0
  20. package/dist-es/commands/ListStateMachineAliasesCommand.js +42 -0
  21. package/dist-es/commands/ListStateMachineVersionsCommand.js +42 -0
  22. package/dist-es/commands/PublishStateMachineVersionCommand.js +43 -0
  23. package/dist-es/commands/UpdateStateMachineAliasCommand.js +43 -0
  24. package/dist-es/commands/index.js +8 -0
  25. package/dist-es/endpoint/ruleset.js +3 -3
  26. package/dist-es/models/models_0.js +57 -13
  27. package/dist-es/protocols/Aws_json1_0.js +493 -1
  28. package/dist-types/SFN.d.ts +56 -0
  29. package/dist-types/SFNClient.d.ts +10 -2
  30. package/dist-types/commands/CreateStateMachineAliasCommand.d.ts +144 -0
  31. package/dist-types/commands/CreateStateMachineCommand.d.ts +14 -2
  32. package/dist-types/commands/DeleteStateMachineAliasCommand.d.ts +112 -0
  33. package/dist-types/commands/DeleteStateMachineCommand.d.ts +21 -6
  34. package/dist-types/commands/DeleteStateMachineVersionCommand.d.ts +106 -0
  35. package/dist-types/commands/DescribeExecutionCommand.d.ts +9 -2
  36. package/dist-types/commands/DescribeMapRunCommand.d.ts +1 -2
  37. package/dist-types/commands/DescribeStateMachineAliasCommand.d.ts +117 -0
  38. package/dist-types/commands/DescribeStateMachineCommand.d.ts +33 -4
  39. package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts +7 -1
  40. package/dist-types/commands/GetActivityTaskCommand.d.ts +0 -2
  41. package/dist-types/commands/GetExecutionHistoryCommand.d.ts +2 -0
  42. package/dist-types/commands/ListExecutionsCommand.d.ts +4 -2
  43. package/dist-types/commands/ListStateMachineAliasesCommand.d.ts +124 -0
  44. package/dist-types/commands/ListStateMachineVersionsCommand.d.ts +108 -0
  45. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
  46. package/dist-types/commands/PublishStateMachineVersionCommand.d.ts +122 -0
  47. package/dist-types/commands/StartExecutionCommand.d.ts +37 -9
  48. package/dist-types/commands/TagResourceCommand.d.ts +1 -2
  49. package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
  50. package/dist-types/commands/UpdateMapRunCommand.d.ts +1 -2
  51. package/dist-types/commands/UpdateStateMachineAliasCommand.d.ts +132 -0
  52. package/dist-types/commands/UpdateStateMachineCommand.d.ts +49 -7
  53. package/dist-types/commands/index.d.ts +8 -0
  54. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  55. package/dist-types/models/models_0.d.ts +475 -36
  56. package/dist-types/protocols/Aws_json1_0.d.ts +72 -0
  57. package/dist-types/ts3.4/SFN.d.ts +136 -0
  58. package/dist-types/ts3.4/SFNClient.d.ts +48 -0
  59. package/dist-types/ts3.4/commands/CreateStateMachineAliasCommand.d.ts +42 -0
  60. package/dist-types/ts3.4/commands/DeleteStateMachineAliasCommand.d.ts +42 -0
  61. package/dist-types/ts3.4/commands/DeleteStateMachineVersionCommand.d.ts +42 -0
  62. package/dist-types/ts3.4/commands/DescribeStateMachineAliasCommand.d.ts +42 -0
  63. package/dist-types/ts3.4/commands/ListStateMachineAliasesCommand.d.ts +42 -0
  64. package/dist-types/ts3.4/commands/ListStateMachineVersionsCommand.d.ts +42 -0
  65. package/dist-types/ts3.4/commands/PublishStateMachineVersionCommand.d.ts +42 -0
  66. package/dist-types/ts3.4/commands/UpdateStateMachineAliasCommand.d.ts +42 -0
  67. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  68. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  69. package/dist-types/ts3.4/models/models_0.d.ts +130 -14
  70. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
  71. package/package.json +6 -6
@@ -285,6 +285,19 @@ export declare class TooManyTags extends __BaseException {
285
285
  */
286
286
  constructor(opts: __ExceptionOptionType<TooManyTags, __BaseException>);
287
287
  }
288
+ /**
289
+ * @public
290
+ * <p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p>
291
+ * <p>HTTP Status Code: 409</p>
292
+ */
293
+ export declare class ConflictException extends __BaseException {
294
+ readonly name: "ConflictException";
295
+ readonly $fault: "client";
296
+ /**
297
+ * @internal
298
+ */
299
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
300
+ }
288
301
  /**
289
302
  * @public
290
303
  * <p></p>
@@ -432,6 +445,14 @@ export interface CreateStateMachineInput {
432
445
  * <p>Selects whether X-Ray tracing is enabled.</p>
433
446
  */
434
447
  tracingConfiguration?: TracingConfiguration;
448
+ /**
449
+ * <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
+ */
451
+ publish?: boolean;
452
+ /**
453
+ * <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
+ */
455
+ versionDescription?: string;
435
456
  }
436
457
  /**
437
458
  * @public
@@ -445,6 +466,10 @@ export interface CreateStateMachineOutput {
445
466
  * <p>The date the state machine is created.</p>
446
467
  */
447
468
  creationDate: Date | undefined;
469
+ /**
470
+ * <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
+ */
472
+ stateMachineVersionArn?: string;
448
473
  }
449
474
  /**
450
475
  * @public
@@ -545,6 +570,116 @@ export declare class StateMachineTypeNotSupported extends __BaseException {
545
570
  */
546
571
  constructor(opts: __ExceptionOptionType<StateMachineTypeNotSupported, __BaseException>);
547
572
  }
573
+ /**
574
+ * @public
575
+ * @enum
576
+ */
577
+ export declare const ValidationExceptionReason: {
578
+ readonly API_DOES_NOT_SUPPORT_LABELED_ARNS: "API_DOES_NOT_SUPPORT_LABELED_ARNS";
579
+ readonly CANNOT_UPDATE_COMPLETED_MAP_RUN: "CANNOT_UPDATE_COMPLETED_MAP_RUN";
580
+ readonly INVALID_ROUTING_CONFIGURATION: "INVALID_ROUTING_CONFIGURATION";
581
+ readonly MISSING_REQUIRED_PARAMETER: "MISSING_REQUIRED_PARAMETER";
582
+ };
583
+ /**
584
+ * @public
585
+ */
586
+ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
587
+ /**
588
+ * @public
589
+ * <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
590
+ */
591
+ export declare class ValidationException extends __BaseException {
592
+ readonly name: "ValidationException";
593
+ readonly $fault: "client";
594
+ /**
595
+ * <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
596
+ */
597
+ reason?: ValidationExceptionReason | string;
598
+ /**
599
+ * @internal
600
+ */
601
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
602
+ }
603
+ /**
604
+ * @public
605
+ * <p>Contains details about the routing configuration of a state machine alias. In a routing
606
+ * configuration, you define an array of objects that specify up to two state machine versions.
607
+ * You also specify the percentage of traffic to be routed to each version.</p>
608
+ */
609
+ export interface RoutingConfigurationListItem {
610
+ /**
611
+ * <p>The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.</p>
612
+ * <p>If you specify the ARN of a second version, it must belong to the same state machine as the first version.</p>
613
+ */
614
+ stateMachineVersionArn: string | undefined;
615
+ /**
616
+ * <p>The percentage of traffic you want to route to the second state machine
617
+ * version. The sum of the weights in the routing
618
+ * configuration must be equal to 100.</p>
619
+ */
620
+ weight: number | undefined;
621
+ }
622
+ /**
623
+ * @public
624
+ */
625
+ export interface CreateStateMachineAliasInput {
626
+ /**
627
+ * <p>A description for the state machine alias.</p>
628
+ */
629
+ description?: string;
630
+ /**
631
+ * <p>The name of the state machine alias.</p>
632
+ * <p>To avoid conflict with version ARNs, don't use an integer in the name of the alias.</p>
633
+ */
634
+ name: string | undefined;
635
+ /**
636
+ * <p>The routing configuration of a state machine alias. The routing configuration shifts
637
+ * execution traffic between two state machine versions. <code>routingConfiguration</code>
638
+ * contains an array of <code>RoutingConfig</code> objects that specify up to two state machine
639
+ * versions. Step Functions then randomly choses which version to run an execution with based
640
+ * on the weight assigned to each <code>RoutingConfig</code>.</p>
641
+ */
642
+ routingConfiguration: RoutingConfigurationListItem[] | undefined;
643
+ }
644
+ /**
645
+ * @public
646
+ */
647
+ export interface CreateStateMachineAliasOutput {
648
+ /**
649
+ * <p>The Amazon Resource Name (ARN) that identifies the created state machine alias.</p>
650
+ */
651
+ stateMachineAliasArn: string | undefined;
652
+ /**
653
+ * <p>The date the state machine alias was created.</p>
654
+ */
655
+ creationDate: Date | undefined;
656
+ }
657
+ /**
658
+ * @public
659
+ * <p>Could not find the referenced resource.</p>
660
+ */
661
+ export declare class ResourceNotFound extends __BaseException {
662
+ readonly name: "ResourceNotFound";
663
+ readonly $fault: "client";
664
+ resourceName?: string;
665
+ /**
666
+ * @internal
667
+ */
668
+ constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
669
+ }
670
+ /**
671
+ * @public
672
+ * <p>The request would cause a service quota to be exceeded.</p>
673
+ * <p>HTTP Status Code: 402</p>
674
+ */
675
+ export declare class ServiceQuotaExceededException extends __BaseException {
676
+ readonly name: "ServiceQuotaExceededException";
677
+ readonly $fault: "client";
678
+ /**
679
+ * @internal
680
+ */
681
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
682
+ }
548
683
  /**
549
684
  * @public
550
685
  */
@@ -575,32 +710,31 @@ export interface DeleteStateMachineOutput {
575
710
  }
576
711
  /**
577
712
  * @public
578
- * @enum
579
713
  */
580
- export declare const ValidationExceptionReason: {
581
- readonly API_DOES_NOT_SUPPORT_LABELED_ARNS: "API_DOES_NOT_SUPPORT_LABELED_ARNS";
582
- readonly CANNOT_UPDATE_COMPLETED_MAP_RUN: "CANNOT_UPDATE_COMPLETED_MAP_RUN";
583
- readonly MISSING_REQUIRED_PARAMETER: "MISSING_REQUIRED_PARAMETER";
584
- };
714
+ export interface DeleteStateMachineAliasInput {
715
+ /**
716
+ * <p>The Amazon Resource Name (ARN) of the state machine alias to delete.</p>
717
+ */
718
+ stateMachineAliasArn: string | undefined;
719
+ }
585
720
  /**
586
721
  * @public
587
722
  */
588
- export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
723
+ export interface DeleteStateMachineAliasOutput {
724
+ }
589
725
  /**
590
726
  * @public
591
- * <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
592
727
  */
593
- export declare class ValidationException extends __BaseException {
594
- readonly name: "ValidationException";
595
- readonly $fault: "client";
596
- /**
597
- * <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
598
- */
599
- reason?: ValidationExceptionReason | string;
728
+ export interface DeleteStateMachineVersionInput {
600
729
  /**
601
- * @internal
730
+ * <p>The Amazon Resource Name (ARN) of the state machine version to delete.</p>
602
731
  */
603
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
732
+ stateMachineVersionArn: string | undefined;
733
+ }
734
+ /**
735
+ * @public
736
+ */
737
+ export interface DeleteStateMachineVersionOutput {
604
738
  }
605
739
  /**
606
740
  * @public
@@ -732,7 +866,7 @@ export interface DescribeExecutionOutput {
732
866
  */
733
867
  startDate: Date | undefined;
734
868
  /**
735
- * <p>If the execution has already ended, the date the execution stopped.</p>
869
+ * <p>If the execution ended, the date the execution stopped.</p>
736
870
  */
737
871
  stopDate?: Date;
738
872
  /**
@@ -771,6 +905,18 @@ export interface DescribeExecutionOutput {
771
905
  * <p>The cause string if the state machine execution failed.</p>
772
906
  */
773
907
  cause?: string;
908
+ /**
909
+ * <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
+ * <p>If you start an execution from a <code>StartExecution</code> request without specifying a
911
+ * state machine version or alias ARN, Step Functions returns a null value.</p>
912
+ */
913
+ stateMachineVersionArn?: string;
914
+ /**
915
+ * <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
+ * <p>If you start an execution from a <code>StartExecution</code> request with a
917
+ * state machine version ARN, this field will be null.</p>
918
+ */
919
+ stateMachineAliasArn?: string;
774
920
  }
775
921
  /**
776
922
  * @public
@@ -928,26 +1074,13 @@ export interface DescribeMapRunOutput {
928
1074
  */
929
1075
  executionCounts: MapRunExecutionCounts | undefined;
930
1076
  }
931
- /**
932
- * @public
933
- * <p>Could not find the referenced resource. Only state machine and activity ARNs are
934
- * supported.</p>
935
- */
936
- export declare class ResourceNotFound extends __BaseException {
937
- readonly name: "ResourceNotFound";
938
- readonly $fault: "client";
939
- resourceName?: string;
940
- /**
941
- * @internal
942
- */
943
- constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
944
- }
945
1077
  /**
946
1078
  * @public
947
1079
  */
948
1080
  export interface DescribeStateMachineInput {
949
1081
  /**
950
- * <p>The Amazon Resource Name (ARN) of the state machine to describe.</p>
1082
+ * <p>The Amazon Resource Name (ARN) of the state machine for which you want the information.</p>
1083
+ * <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>
951
1084
  */
952
1085
  stateMachineArn: string | undefined;
953
1086
  }
@@ -969,6 +1102,7 @@ export type StateMachineStatus = (typeof StateMachineStatus)[keyof typeof StateM
969
1102
  export interface DescribeStateMachineOutput {
970
1103
  /**
971
1104
  * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
1105
+ * <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>
972
1106
  */
973
1107
  stateMachineArn: string | undefined;
974
1108
  /**
@@ -1017,6 +1151,7 @@ export interface DescribeStateMachineOutput {
1017
1151
  type: StateMachineType | string | undefined;
1018
1152
  /**
1019
1153
  * <p>The date the state machine is created.</p>
1154
+ * <p>For a state machine version, <code>creationDate</code> is the date the version was created.</p>
1020
1155
  */
1021
1156
  creationDate: Date | undefined;
1022
1157
  /**
@@ -1032,6 +1167,17 @@ export interface DescribeStateMachineOutput {
1032
1167
  * <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>
1033
1168
  */
1034
1169
  label?: string;
1170
+ /**
1171
+ * <p>The revision identifier for the state machine.</p>
1172
+ * <p>Use the <code>revisionId</code> parameter to compare between versions of a state machine
1173
+ * configuration used for executions without performing a diff of the properties, such as
1174
+ * <code>definition</code> and <code>roleArn</code>.</p>
1175
+ */
1176
+ revisionId?: string;
1177
+ /**
1178
+ * <p>The description of the state machine version.</p>
1179
+ */
1180
+ description?: string;
1035
1181
  }
1036
1182
  /**
1037
1183
  * @public
@@ -1045,6 +1191,45 @@ export declare class StateMachineDoesNotExist extends __BaseException {
1045
1191
  */
1046
1192
  constructor(opts: __ExceptionOptionType<StateMachineDoesNotExist, __BaseException>);
1047
1193
  }
1194
+ /**
1195
+ * @public
1196
+ */
1197
+ export interface DescribeStateMachineAliasInput {
1198
+ /**
1199
+ * <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
1200
+ */
1201
+ stateMachineAliasArn: string | undefined;
1202
+ }
1203
+ /**
1204
+ * @public
1205
+ */
1206
+ export interface DescribeStateMachineAliasOutput {
1207
+ /**
1208
+ * <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
1209
+ */
1210
+ stateMachineAliasArn?: string;
1211
+ /**
1212
+ * <p>The name of the state machine alias.</p>
1213
+ */
1214
+ name?: string;
1215
+ /**
1216
+ * <p>A description of the alias.</p>
1217
+ */
1218
+ description?: string;
1219
+ /**
1220
+ * <p>The routing configuration of the alias.</p>
1221
+ */
1222
+ routingConfiguration?: RoutingConfigurationListItem[];
1223
+ /**
1224
+ * <p>The date the state machine alias was created.</p>
1225
+ */
1226
+ creationDate?: Date;
1227
+ /**
1228
+ * <p>The date the state machine alias was last updated.</p>
1229
+ * <p>For a newly created state machine, this is the same as the creation date.</p>
1230
+ */
1231
+ updateDate?: Date;
1232
+ }
1048
1233
  /**
1049
1234
  * @public
1050
1235
  */
@@ -1096,6 +1281,11 @@ export interface DescribeStateMachineForExecutionOutput {
1096
1281
  * <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>
1097
1282
  */
1098
1283
  label?: string;
1284
+ /**
1285
+ * <p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p>
1286
+ * <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
+ */
1288
+ revisionId?: string;
1099
1289
  }
1100
1290
  /**
1101
1291
  * @public
@@ -1202,6 +1392,14 @@ export interface ExecutionStartedEventDetails {
1202
1392
  * <p>The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.</p>
1203
1393
  */
1204
1394
  roleArn?: string;
1395
+ /**
1396
+ * <p>The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.</p>
1397
+ */
1398
+ stateMachineAliasArn?: string;
1399
+ /**
1400
+ * <p>The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.</p>
1401
+ */
1402
+ stateMachineVersionArn?: string;
1205
1403
  }
1206
1404
  /**
1207
1405
  * @public
@@ -1920,6 +2118,7 @@ export interface ListExecutionsInput {
1920
2118
  /**
1921
2119
  * <p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p>
1922
2120
  * <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
2121
+ * <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>
1923
2122
  */
1924
2123
  stateMachineArn?: string;
1925
2124
  /**
@@ -1954,7 +2153,7 @@ export interface ExecutionListItem {
1954
2153
  */
1955
2154
  executionArn: string | undefined;
1956
2155
  /**
1957
- * <p>The Amazon Resource Name (ARN) of the executed state machine.</p>
2156
+ * <p>The Amazon Resource Name (ARN) of the state machine that ran the execution.</p>
1958
2157
  */
1959
2158
  stateMachineArn: string | undefined;
1960
2159
  /**
@@ -2003,6 +2202,17 @@ export interface ExecutionListItem {
2003
2202
  * <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>
2004
2203
  */
2005
2204
  itemCount?: number;
2205
+ /**
2206
+ * <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p>
2207
+ * <p>If the state machine execution was started with an unqualified ARN, it returns null.</p>
2208
+ * <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
+ */
2210
+ stateMachineVersionArn?: string;
2211
+ /**
2212
+ * <p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p>
2213
+ * <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>
2214
+ */
2215
+ stateMachineAliasArn?: string;
2006
2216
  }
2007
2217
  /**
2008
2218
  * @public
@@ -2078,6 +2288,55 @@ export interface ListMapRunsOutput {
2078
2288
  */
2079
2289
  nextToken?: string;
2080
2290
  }
2291
+ /**
2292
+ * @public
2293
+ */
2294
+ export interface ListStateMachineAliasesInput {
2295
+ /**
2296
+ * <p>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</p>
2297
+ * <p>If you specify a state machine version ARN, this API returns a list of aliases for that version.</p>
2298
+ */
2299
+ stateMachineArn: string | undefined;
2300
+ /**
2301
+ * <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
+ * 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
+ */
2304
+ nextToken?: string;
2305
+ /**
2306
+ * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2307
+ * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2308
+ * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2309
+ */
2310
+ maxResults?: number;
2311
+ }
2312
+ /**
2313
+ * @public
2314
+ * <p>Contains details about a specific state machine alias.</p>
2315
+ */
2316
+ export interface StateMachineAliasListItem {
2317
+ /**
2318
+ * <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
+ */
2320
+ stateMachineAliasArn: string | undefined;
2321
+ /**
2322
+ * <p>The creation date of a state machine alias.</p>
2323
+ */
2324
+ creationDate: Date | undefined;
2325
+ }
2326
+ /**
2327
+ * @public
2328
+ */
2329
+ export interface ListStateMachineAliasesOutput {
2330
+ /**
2331
+ * <p>Aliases for the state machine.</p>
2332
+ */
2333
+ stateMachineAliases: StateMachineAliasListItem[] | undefined;
2334
+ /**
2335
+ * <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
+ * 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
+ */
2338
+ nextToken?: string;
2339
+ }
2081
2340
  /**
2082
2341
  * @public
2083
2342
  */
@@ -2149,6 +2408,54 @@ export interface ListStateMachinesOutput {
2149
2408
  */
2150
2409
  nextToken?: string;
2151
2410
  }
2411
+ /**
2412
+ * @public
2413
+ */
2414
+ export interface ListStateMachineVersionsInput {
2415
+ /**
2416
+ * <p>The Amazon Resource Name (ARN) of the state machine.</p>
2417
+ */
2418
+ stateMachineArn: string | undefined;
2419
+ /**
2420
+ * <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
+ * 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
+ */
2423
+ nextToken?: string;
2424
+ /**
2425
+ * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
2426
+ * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
2427
+ * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2428
+ */
2429
+ maxResults?: number;
2430
+ }
2431
+ /**
2432
+ * @public
2433
+ * <p>Contains details about a specific state machine version.</p>
2434
+ */
2435
+ export interface StateMachineVersionListItem {
2436
+ /**
2437
+ * <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
+ */
2439
+ stateMachineVersionArn: string | undefined;
2440
+ /**
2441
+ * <p>The creation date of a state machine version.</p>
2442
+ */
2443
+ creationDate: Date | undefined;
2444
+ }
2445
+ /**
2446
+ * @public
2447
+ */
2448
+ export interface ListStateMachineVersionsOutput {
2449
+ /**
2450
+ * <p>Versions for the state machine.</p>
2451
+ */
2452
+ stateMachineVersions: StateMachineVersionListItem[] | undefined;
2453
+ /**
2454
+ * <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
+ * 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
+ */
2457
+ nextToken?: string;
2458
+ }
2152
2459
  /**
2153
2460
  * @public
2154
2461
  */
@@ -2167,6 +2474,45 @@ export interface ListTagsForResourceOutput {
2167
2474
  */
2168
2475
  tags?: Tag[];
2169
2476
  }
2477
+ /**
2478
+ * @public
2479
+ */
2480
+ export interface PublishStateMachineVersionInput {
2481
+ /**
2482
+ * <p>The Amazon Resource Name (ARN) of the state machine.</p>
2483
+ */
2484
+ stateMachineArn: string | undefined;
2485
+ /**
2486
+ * <p>Only publish the state machine version if the current state machine's revision ID matches the specified ID.</p>
2487
+ * <p>Use this option to avoid publishing a version if the state machine changed since you last
2488
+ * updated it. If the specified revision ID doesn't match the state machine's current revision
2489
+ * ID, the API returns <code>ConflictException</code>.</p>
2490
+ * <note>
2491
+ * <p>To specify an initial revision ID for a state machine with no revision ID assigned,
2492
+ * specify the string <code>INITIAL</code> for the <code>revisionId</code> parameter. For
2493
+ * example, you can specify a <code>revisionID</code> of <code>INITIAL</code> when you create a
2494
+ * state machine using the <a>CreateStateMachine</a> API action.</p>
2495
+ * </note>
2496
+ */
2497
+ revisionId?: string;
2498
+ /**
2499
+ * <p>An optional description of the state machine version.</p>
2500
+ */
2501
+ description?: string;
2502
+ }
2503
+ /**
2504
+ * @public
2505
+ */
2506
+ export interface PublishStateMachineVersionOutput {
2507
+ /**
2508
+ * <p>The date the version was created.</p>
2509
+ */
2510
+ creationDate: Date | undefined;
2511
+ /**
2512
+ * <p>The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.</p>
2513
+ */
2514
+ stateMachineVersionArn: string | undefined;
2515
+ }
2170
2516
  /**
2171
2517
  * @public
2172
2518
  */
@@ -2309,10 +2655,40 @@ export declare class InvalidExecutionInput extends __BaseException {
2309
2655
  export interface StartExecutionInput {
2310
2656
  /**
2311
2657
  * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
2658
+ * <p>The <code>stateMachineArn</code> parameter accepts one of the following inputs:</p>
2659
+ * <ul>
2660
+ * <li>
2661
+ * <p>
2662
+ * <b>An unqualified state machine ARN</b> – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.</p>
2663
+ * <p>
2664
+ * <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code>
2665
+ * </p>
2666
+ * <p>Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.</p>
2667
+ * </li>
2668
+ * <li>
2669
+ * <p>
2670
+ * <b>A state machine version ARN</b> – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10. </p>
2671
+ * <p>
2672
+ * <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10</code>
2673
+ * </p>
2674
+ * <p>Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.</p>
2675
+ * </li>
2676
+ * <li>
2677
+ * <p>
2678
+ * <b>A state machine alias ARN</b> – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named <code>PROD</code>.</p>
2679
+ * <p>
2680
+ * <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code>
2681
+ * </p>
2682
+ * <p>Step Functions associates executions
2683
+ * that you start with an alias ARN with that alias and the state machine version used for
2684
+ * that execution.</p>
2685
+ * </li>
2686
+ * </ul>
2312
2687
  */
2313
2688
  stateMachineArn: string | undefined;
2314
2689
  /**
2315
- * <p>The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information,
2690
+ * <p>Optional name of the execution.
2691
+ * This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,
2316
2692
  * see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
2317
2693
  * Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
2318
2694
  * <p>A name must <i>not</i> contain:</p>
@@ -2614,7 +2990,7 @@ export interface UpdateStateMachineInput {
2614
2990
  */
2615
2991
  roleArn?: string;
2616
2992
  /**
2617
- * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
2993
+ * <p>Use the <code>LoggingConfiguration</code> data type to set CloudWatch Logs
2618
2994
  * options.</p>
2619
2995
  */
2620
2996
  loggingConfiguration?: LoggingConfiguration;
@@ -2622,6 +2998,17 @@ export interface UpdateStateMachineInput {
2622
2998
  * <p>Selects whether X-Ray tracing is enabled.</p>
2623
2999
  */
2624
3000
  tracingConfiguration?: TracingConfiguration;
3001
+ /**
3002
+ * <p>Specifies whether the state machine version is published. The default is
3003
+ * <code>false</code>. To publish a version after updating the state machine, set
3004
+ * <code>publish</code> to <code>true</code>.</p>
3005
+ */
3006
+ publish?: boolean;
3007
+ /**
3008
+ * <p>An optional description of the state machine version to publish.</p>
3009
+ * <p>You can only specify the <code>versionDescription</code> parameter if you've set <code>publish</code> to <code>true</code>.</p>
3010
+ */
3011
+ versionDescription?: string;
2625
3012
  }
2626
3013
  /**
2627
3014
  * @public
@@ -2631,6 +3018,42 @@ export interface UpdateStateMachineOutput {
2631
3018
  * <p>The date and time the state machine was updated.</p>
2632
3019
  */
2633
3020
  updateDate: Date | undefined;
3021
+ /**
3022
+ * <p>The revision identifier for the updated state machine.</p>
3023
+ */
3024
+ revisionId?: string;
3025
+ /**
3026
+ * <p>The Amazon Resource Name (ARN) of the published state machine version.</p>
3027
+ * <p>If the <code>publish</code> parameter isn't set to <code>true</code>, this field returns null.</p>
3028
+ */
3029
+ stateMachineVersionArn?: string;
3030
+ }
3031
+ /**
3032
+ * @public
3033
+ */
3034
+ export interface UpdateStateMachineAliasInput {
3035
+ /**
3036
+ * <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
3037
+ */
3038
+ stateMachineAliasArn: string | undefined;
3039
+ /**
3040
+ * <p>A description of the state machine alias.</p>
3041
+ */
3042
+ description?: string;
3043
+ /**
3044
+ * <p>The routing configuration of the state machine alias.</p>
3045
+ * <p>An array of <code>RoutingConfig</code> objects that specifies up to two state machine versions that the alias starts executions for.</p>
3046
+ */
3047
+ routingConfiguration?: RoutingConfigurationListItem[];
3048
+ }
3049
+ /**
3050
+ * @public
3051
+ */
3052
+ export interface UpdateStateMachineAliasOutput {
3053
+ /**
3054
+ * <p>The date and time the state machine alias was updated.</p>
3055
+ */
3056
+ updateDate: Date | undefined;
2634
3057
  }
2635
3058
  /**
2636
3059
  * @internal
@@ -2656,6 +3079,10 @@ export declare const ActivityTimedOutEventDetailsFilterSensitiveLog: (obj: Activ
2656
3079
  * @internal
2657
3080
  */
2658
3081
  export declare const CreateStateMachineInputFilterSensitiveLog: (obj: CreateStateMachineInput) => any;
3082
+ /**
3083
+ * @internal
3084
+ */
3085
+ export declare const CreateStateMachineAliasInputFilterSensitiveLog: (obj: CreateStateMachineAliasInput) => any;
2659
3086
  /**
2660
3087
  * @internal
2661
3088
  */
@@ -2664,6 +3091,10 @@ export declare const DescribeExecutionOutputFilterSensitiveLog: (obj: DescribeEx
2664
3091
  * @internal
2665
3092
  */
2666
3093
  export declare const DescribeStateMachineOutputFilterSensitiveLog: (obj: DescribeStateMachineOutput) => any;
3094
+ /**
3095
+ * @internal
3096
+ */
3097
+ export declare const DescribeStateMachineAliasOutputFilterSensitiveLog: (obj: DescribeStateMachineAliasOutput) => any;
2667
3098
  /**
2668
3099
  * @internal
2669
3100
  */
@@ -2764,6 +3195,10 @@ export declare const HistoryEventFilterSensitiveLog: (obj: HistoryEvent) => any;
2764
3195
  * @internal
2765
3196
  */
2766
3197
  export declare const GetExecutionHistoryOutputFilterSensitiveLog: (obj: GetExecutionHistoryOutput) => any;
3198
+ /**
3199
+ * @internal
3200
+ */
3201
+ export declare const PublishStateMachineVersionInputFilterSensitiveLog: (obj: PublishStateMachineVersionInput) => any;
2767
3202
  /**
2768
3203
  * @internal
2769
3204
  */
@@ -2792,3 +3227,7 @@ export declare const StopExecutionInputFilterSensitiveLog: (obj: StopExecutionIn
2792
3227
  * @internal
2793
3228
  */
2794
3229
  export declare const UpdateStateMachineInputFilterSensitiveLog: (obj: UpdateStateMachineInput) => any;
3230
+ /**
3231
+ * @internal
3232
+ */
3233
+ export declare const UpdateStateMachineAliasInputFilterSensitiveLog: (obj: UpdateStateMachineAliasInput) => any;