@aws-sdk/client-sfn 3.846.0 → 3.847.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 (7) hide show
  1. package/README.md +5 -14
  2. package/dist-types/SFN.d.ts +5 -14
  3. package/dist-types/SFNClient.d.ts +5 -14
  4. package/dist-types/commands/TestStateCommand.d.ts +1 -1
  5. package/dist-types/index.d.ts +5 -14
  6. package/dist-types/models/models_0.d.ts +101 -16
  7. package/package.json +1 -1
package/README.md CHANGED
@@ -8,23 +8,14 @@ AWS SDK for JavaScript SFN Client for Node.js, Browser and React Native.
8
8
 
9
9
  <fullname>Step Functions</fullname>
10
10
 
11
- <p>Step Functions coordinates the components of distributed applications
12
- and microservices using visual workflows.</p>
13
- <p>You can use Step Functions to build applications from individual components, each of which performs
14
- a discrete function, or <i>task</i>, allowing you to scale and change
15
- applications quickly. Step Functions provides a console that helps visualize the components of your
16
- application as a series of steps. Step Functions automatically triggers and tracks each step, and
17
- retries steps when there are errors, so your application executes predictably and in the right
18
- order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
19
- issues.</p>
20
- <p>Step Functions manages operations and underlying infrastructure to ensure your application is
21
- available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has
22
- access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.
23
- For more information about Step Functions, see the <i>
11
+ <p>With Step Functions, you can create workflows, also called <i>state machines</i>, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.</p>
12
+ <p>Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.</p>
13
+ <p>With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.</p>
14
+ <p>For more information about developing solutions with Step Functions, see the <i>
24
15
  <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
25
16
  </i>.</p>
26
17
  <important>
27
- <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
18
+ <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
28
19
  </important>
29
20
 
30
21
  ## Installing
package/dist-types/SFN.d.ts CHANGED
@@ -266,23 +266,14 @@ export interface SFN {
266
266
  }
267
267
  /**
268
268
  * <fullname>Step Functions</fullname>
269
- * <p>Step Functions coordinates the components of distributed applications
270
- * and microservices using visual workflows.</p>
271
- * <p>You can use Step Functions to build applications from individual components, each of which performs
272
- * a discrete function, or <i>task</i>, allowing you to scale and change
273
- * applications quickly. Step Functions provides a console that helps visualize the components of your
274
- * application as a series of steps. Step Functions automatically triggers and tracks each step, and
275
- * retries steps when there are errors, so your application executes predictably and in the right
276
- * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
277
- * issues.</p>
278
- * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
279
- * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has
280
- * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.
281
- * For more information about Step Functions, see the <i>
269
+ * <p>With Step Functions, you can create workflows, also called <i>state machines</i>, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.</p>
270
+ * <p>Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.</p>
271
+ * <p>With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.</p>
272
+ * <p>For more information about developing solutions with Step Functions, see the <i>
282
273
  * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
283
274
  * </i>.</p>
284
275
  * <important>
285
- * <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
276
+ * <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
286
277
  * </important>
287
278
  * @public
288
279
  */
package/dist-types/SFNClient.d.ts CHANGED
@@ -207,23 +207,14 @@ export interface SFNClientResolvedConfig extends SFNClientResolvedConfigType {
207
207
  }
208
208
  /**
209
209
  * <fullname>Step Functions</fullname>
210
- * <p>Step Functions coordinates the components of distributed applications
211
- * and microservices using visual workflows.</p>
212
- * <p>You can use Step Functions to build applications from individual components, each of which performs
213
- * a discrete function, or <i>task</i>, allowing you to scale and change
214
- * applications quickly. Step Functions provides a console that helps visualize the components of your
215
- * application as a series of steps. Step Functions automatically triggers and tracks each step, and
216
- * retries steps when there are errors, so your application executes predictably and in the right
217
- * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
218
- * issues.</p>
219
- * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
220
- * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has
221
- * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.
222
- * For more information about Step Functions, see the <i>
210
+ * <p>With Step Functions, you can create workflows, also called <i>state machines</i>, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.</p>
211
+ * <p>Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.</p>
212
+ * <p>With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.</p>
213
+ * <p>For more information about developing solutions with Step Functions, see the <i>
223
214
  * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
224
215
  * </i>.</p>
225
216
  * <important>
226
- * <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
217
+ * <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
227
218
  * </important>
228
219
  * @public
229
220
  */
package/dist-types/commands/TestStateCommand.d.ts CHANGED
@@ -36,7 +36,7 @@ declare const TestStateCommand_base: {
36
36
  * <p>An <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-services.html">Amazon Web Services service integration</a> request and response</p>
37
37
  * </li>
38
38
  * <li>
39
- * <p>An <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-third-party-apis.html">HTTP Task</a> request and response</p>
39
+ * <p>An <a href="https://docs.aws.amazon.com/step-functions/latest/dg/call-https-apis.html">HTTP Task</a> request and response</p>
40
40
  * </li>
41
41
  * </ul>
42
42
  * <p>You can call this API on only one state at a time. The states that you can test include the following:</p>
package/dist-types/index.d.ts CHANGED
@@ -1,22 +1,13 @@
1
1
  /**
2
2
  * <fullname>Step Functions</fullname>
3
- * <p>Step Functions coordinates the components of distributed applications
4
- * and microservices using visual workflows.</p>
5
- * <p>You can use Step Functions to build applications from individual components, each of which performs
6
- * a discrete function, or <i>task</i>, allowing you to scale and change
7
- * applications quickly. Step Functions provides a console that helps visualize the components of your
8
- * application as a series of steps. Step Functions automatically triggers and tracks each step, and
9
- * retries steps when there are errors, so your application executes predictably and in the right
10
- * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
11
- * issues.</p>
12
- * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
13
- * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has
14
- * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.
15
- * For more information about Step Functions, see the <i>
3
+ * <p>With Step Functions, you can create workflows, also called <i>state machines</i>, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.</p>
4
+ * <p>Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.</p>
5
+ * <p>With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.</p>
6
+ * <p>For more information about developing solutions with Step Functions, see the <i>
16
7
  * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
17
8
  * </i>.</p>
18
9
  * <important>
19
- * <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
10
+ * <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
20
11
  * </important>
21
12
  *
22
13
  * @packageDocumentation
package/dist-types/models/models_0.d.ts CHANGED
@@ -83,7 +83,13 @@ export interface ActivityListItem {
83
83
  * </p>
84
84
  * </li>
85
85
  * <li>
86
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
86
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
87
+ * </li>
88
+ * <li>
89
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
90
+ * </li>
91
+ * <li>
92
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
87
93
  * </li>
88
94
  * </ul>
89
95
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -315,7 +321,13 @@ export interface CreateActivityInput {
315
321
  * </p>
316
322
  * </li>
317
323
  * <li>
318
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
324
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
325
+ * </li>
326
+ * <li>
327
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
328
+ * </li>
329
+ * <li>
330
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
319
331
  * </li>
320
332
  * </ul>
321
333
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -539,7 +551,13 @@ export interface CreateStateMachineInput {
539
551
  * </p>
540
552
  * </li>
541
553
  * <li>
542
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
554
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
555
+ * </li>
556
+ * <li>
557
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
558
+ * </li>
559
+ * <li>
560
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
543
561
  * </li>
544
562
  * </ul>
545
563
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -939,7 +957,13 @@ export interface DescribeActivityOutput {
939
957
  * </p>
940
958
  * </li>
941
959
  * <li>
942
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
960
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
961
+ * </li>
962
+ * <li>
963
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
964
+ * </li>
965
+ * <li>
966
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
943
967
  * </li>
944
968
  * </ul>
945
969
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -1059,7 +1083,13 @@ export interface DescribeExecutionOutput {
1059
1083
  * </p>
1060
1084
  * </li>
1061
1085
  * <li>
1062
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
1086
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
1087
+ * </li>
1088
+ * <li>
1089
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
1090
+ * </li>
1091
+ * <li>
1092
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
1063
1093
  * </li>
1064
1094
  * </ul>
1065
1095
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -1107,6 +1137,11 @@ export interface DescribeExecutionOutput {
1107
1137
  outputDetails?: CloudWatchEventsExecutionDataDetails | undefined;
1108
1138
  /**
1109
1139
  * <p>The X-Ray trace header that was passed to the execution.</p>
1140
+ * <note>
1141
+ * <p>
1142
+ * For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.
1143
+ * </p>
1144
+ * </note>
1110
1145
  * @public
1111
1146
  */
1112
1147
  traceHeader?: string | undefined;
@@ -1519,7 +1554,13 @@ export interface DescribeStateMachineOutput {
1519
1554
  * </p>
1520
1555
  * </li>
1521
1556
  * <li>
1522
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
1557
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
1558
+ * </li>
1559
+ * <li>
1560
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
1561
+ * </li>
1562
+ * <li>
1563
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
1523
1564
  * </li>
1524
1565
  * </ul>
1525
1566
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -1715,7 +1756,7 @@ export interface DescribeStateMachineForExecutionOutput {
1715
1756
  */
1716
1757
  mapRunArn?: string | undefined;
1717
1758
  /**
1718
- * <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>
1759
+ * <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>
1719
1760
  * @public
1720
1761
  */
1721
1762
  label?: string | undefined;
@@ -2177,7 +2218,13 @@ export interface StateExitedEventDetails {
2177
2218
  * </p>
2178
2219
  * </li>
2179
2220
  * <li>
2180
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
2221
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
2222
+ * </li>
2223
+ * <li>
2224
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
2225
+ * </li>
2226
+ * <li>
2227
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
2181
2228
  * </li>
2182
2229
  * </ul>
2183
2230
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -2794,6 +2841,11 @@ export interface ListExecutionsInput {
2794
2841
  /**
2795
2842
  * <p>If specified, only list the executions whose current execution status matches the given
2796
2843
  * filter.</p>
2844
+ * <p>If you provide a <code>PENDING_REDRIVE</code> statusFilter, you must specify <code>mapRunArn</code>.
2845
+ * For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html#redrive-child-workflow-behavior">Child workflow execution redrive behaviour</a>
2846
+ * in the <i>Step Functions Developer Guide</i>.
2847
+ * </p>
2848
+ * <p>If you provide a stateMachineArn and a <code>PENDING_REDRIVE</code> statusFilter, the API returns a validation exception.</p>
2797
2849
  * @public
2798
2850
  */
2799
2851
  statusFilter?: ExecutionStatus | undefined;
@@ -2860,7 +2912,13 @@ export interface ExecutionListItem {
2860
2912
  * </p>
2861
2913
  * </li>
2862
2914
  * <li>
2863
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
2915
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
2916
+ * </li>
2917
+ * <li>
2918
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
2919
+ * </li>
2920
+ * <li>
2921
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
2864
2922
  * </li>
2865
2923
  * </ul>
2866
2924
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -3106,7 +3164,13 @@ export interface StateMachineListItem {
3106
3164
  * </p>
3107
3165
  * </li>
3108
3166
  * <li>
3109
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
3167
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
3168
+ * </li>
3169
+ * <li>
3170
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
3171
+ * </li>
3172
+ * <li>
3173
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
3110
3174
  * </li>
3111
3175
  * </ul>
3112
3176
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -3497,7 +3561,13 @@ export interface StartExecutionInput {
3497
3561
  * </p>
3498
3562
  * </li>
3499
3563
  * <li>
3500
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
3564
+ * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>, <code>U+FFFE-FFFF</code>)</p>
3565
+ * </li>
3566
+ * <li>
3567
+ * <p>surrogates (<code>U+D800-DFFF</code>)</p>
3568
+ * </li>
3569
+ * <li>
3570
+ * <p>invalid characters (<code> U+10FFFF</code>)</p>
3501
3571
  * </li>
3502
3572
  * </ul>
3503
3573
  * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
@@ -3507,11 +3577,11 @@ export interface StartExecutionInput {
3507
3577
  /**
3508
3578
  * <p>The string that contains the JSON input data for the execution, for example:</p>
3509
3579
  * <p>
3510
- * <code>"input": "\{\"first_name\" : \"test\"\}"</code>
3580
+ * <code>"\{\"first_name\" : \"Tim\"\}"</code>
3511
3581
  * </p>
3512
3582
  * <note>
3513
3583
  * <p>If you don't include any JSON input data, you still must include the two braces, for
3514
- * example: <code>"input": "\{\}"</code>
3584
+ * example: <code>"\{\}"</code>
3515
3585
  * </p>
3516
3586
  * </note>
3517
3587
  * <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
@@ -3521,6 +3591,11 @@ export interface StartExecutionInput {
3521
3591
  /**
3522
3592
  * <p>Passes the X-Ray trace header. The trace header can also be passed in the request
3523
3593
  * payload.</p>
3594
+ * <note>
3595
+ * <p>
3596
+ * For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.
3597
+ * </p>
3598
+ * </note>
3524
3599
  * @public
3525
3600
  */
3526
3601
  traceHeader?: string | undefined;
@@ -3557,11 +3632,11 @@ export interface StartSyncExecutionInput {
3557
3632
  /**
3558
3633
  * <p>The string that contains the JSON input data for the execution, for example:</p>
3559
3634
  * <p>
3560
- * <code>"input": "\{\"first_name\" : \"test\"\}"</code>
3635
+ * <code>"\{\"first_name\" : \"Tim\"\}"</code>
3561
3636
  * </p>
3562
3637
  * <note>
3563
3638
  * <p>If you don't include any JSON input data, you still must include the two braces, for
3564
- * example: <code>"input": "\{\}"</code>
3639
+ * example: <code>"\{\}"</code>
3565
3640
  * </p>
3566
3641
  * </note>
3567
3642
  * <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
@@ -3571,6 +3646,11 @@ export interface StartSyncExecutionInput {
3571
3646
  /**
3572
3647
  * <p>Passes the X-Ray trace header. The trace header can also be passed in the request
3573
3648
  * payload.</p>
3649
+ * <note>
3650
+ * <p>
3651
+ * For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.
3652
+ * </p>
3653
+ * </note>
3574
3654
  * @public
3575
3655
  */
3576
3656
  traceHeader?: string | undefined;
@@ -3679,6 +3759,11 @@ export interface StartSyncExecutionOutput {
3679
3759
  outputDetails?: CloudWatchEventsExecutionDataDetails | undefined;
3680
3760
  /**
3681
3761
  * <p>The X-Ray trace header that was passed to the execution.</p>
3762
+ * <note>
3763
+ * <p>
3764
+ * For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.
3765
+ * </p>
3766
+ * </note>
3682
3767
  * @public
3683
3768
  */
3684
3769
  traceHeader?: string | undefined;
@@ -3962,7 +4047,7 @@ export interface TestStateOutput {
3962
4047
  */
3963
4048
  inspectionData?: InspectionData | undefined;
3964
4049
  /**
3965
- * <p>The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.</p>
4050
+ * <p>The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.</p>
3966
4051
  * @public
3967
4052
  */
3968
4053
  nextState?: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sfn",
3
3
  "description": "AWS SDK for JavaScript Sfn Client for Node.js, Browser and React Native",
4
- "version": "3.846.0",
4
+ "version": "3.847.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-sfn",