@aws-sdk/client-sfn 3.312.0 → 3.316.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.
@@ -26,373 +26,182 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
26
26
  import { UpdateMapRunCommandInput, UpdateMapRunCommandOutput } from "./commands/UpdateMapRunCommand";
27
27
  import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from "./commands/UpdateStateMachineCommand";
28
28
  import { SFNClient } from "./SFNClient";
29
- /**
30
- * @public
31
- * <fullname>Step Functions</fullname>
32
- * <p>Step Functions is a service that lets you coordinate the components of distributed applications
33
- * and microservices using visual workflows.</p>
34
- * <p>You can use Step Functions to build applications from individual components, each of which performs
35
- * a discrete function, or <i>task</i>, allowing you to scale and change
36
- * applications quickly. Step Functions provides a console that helps visualize the components of your
37
- * application as a series of steps. Step Functions automatically triggers and tracks each step, and
38
- * retries steps when there are errors, so your application executes predictably and in the right
39
- * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
40
- * issues.</p>
41
- * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
42
- * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has
43
- * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.
44
- * For more information about Step Functions, see the <i>
45
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
46
- * </i>.</p>
47
- */
48
- export declare class SFN extends SFNClient {
29
+ export interface SFN {
49
30
  /**
50
- * @public
51
- * <p>Creates an activity. An activity is a task that you write in any programming language and
52
- * host on any machine that has access to Step Functions. Activities must poll Step Functions using the
53
- * <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API
54
- * actions. This function lets Step Functions know the existence of your activity and returns an
55
- * identifier for use in a state machine and when polling from the activity.</p>
56
- * <note>
57
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
58
- * </note>
59
- * <note>
60
- * <p>
61
- * <code>CreateActivity</code> is an idempotent API. Subsequent requests won’t create a
62
- * duplicate resource if it was already created. <code>CreateActivity</code>'s idempotency
63
- * check is based on the activity <code>name</code>. If a following request has different
64
- * <code>tags</code> values, Step Functions will ignore these differences and treat it as an
65
- * idempotent request of the previous. In this case, <code>tags</code> will not be updated,
66
- * even if they are different.</p>
67
- * </note>
31
+ * @see {@link CreateActivityCommand}
68
32
  */
69
33
  createActivity(args: CreateActivityCommandInput, options?: __HttpHandlerOptions): Promise<CreateActivityCommandOutput>;
70
34
  createActivity(args: CreateActivityCommandInput, cb: (err: any, data?: CreateActivityCommandOutput) => void): void;
71
35
  createActivity(args: CreateActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActivityCommandOutput) => void): void;
72
36
  /**
73
- * @public
74
- * <p>Creates a state machine. A state machine consists of a collection of states that can do
75
- * work (<code>Task</code> states), determine to which states to transition next
76
- * (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states),
77
- * and so on. State machines are specified using a JSON-based, structured language. For more
78
- * information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States
79
- * Language</a> in the Step Functions User Guide.</p>
80
- * <note>
81
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
82
- * </note>
83
- * <note>
84
- * <p>
85
- * <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a
86
- * duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency
87
- * check is based on the state machine <code>name</code>, <code>definition</code>,
88
- * <code>type</code>, <code>LoggingConfiguration</code> and
89
- * <code>TracingConfiguration</code>. If a following request has a different
90
- * <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat
91
- * it as an idempotent request of the previous. In this case, <code>roleArn</code> and
92
- * <code>tags</code> will not be updated, even if they are different.</p>
93
- * </note>
37
+ * @see {@link CreateStateMachineCommand}
94
38
  */
95
39
  createStateMachine(args: CreateStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<CreateStateMachineCommandOutput>;
96
40
  createStateMachine(args: CreateStateMachineCommandInput, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
97
41
  createStateMachine(args: CreateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
98
42
  /**
99
- * @public
100
- * <p>Deletes an activity.</p>
43
+ * @see {@link DeleteActivityCommand}
101
44
  */
102
45
  deleteActivity(args: DeleteActivityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteActivityCommandOutput>;
103
46
  deleteActivity(args: DeleteActivityCommandInput, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void;
104
47
  deleteActivity(args: DeleteActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void;
105
48
  /**
106
- * @public
107
- * <p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's
108
- * status to <code>DELETING</code> and begins the deletion process. </p>
109
- *
110
- * <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p>
111
- *
112
- * <p>A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>.</p>
113
- *
114
- * <note>
115
- * <p>For <code>EXPRESS</code> state machines, the deletion will happen eventually (usually
116
- * less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code>
117
- * API is called.</p>
118
- * </note>
49
+ * @see {@link DeleteStateMachineCommand}
119
50
  */
120
51
  deleteStateMachine(args: DeleteStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStateMachineCommandOutput>;
121
52
  deleteStateMachine(args: DeleteStateMachineCommandInput, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
122
53
  deleteStateMachine(args: DeleteStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
123
54
  /**
124
- * @public
125
- * <p>Describes an activity.</p>
126
- * <note>
127
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
128
- * </note>
55
+ * @see {@link DescribeActivityCommand}
129
56
  */
130
57
  describeActivity(args: DescribeActivityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeActivityCommandOutput>;
131
58
  describeActivity(args: DescribeActivityCommandInput, cb: (err: any, data?: DescribeActivityCommandOutput) => void): void;
132
59
  describeActivity(args: DescribeActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivityCommandOutput) => void): void;
133
60
  /**
134
- * @public
135
- * <p>Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.</p>
136
- * <note>
137
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
138
- * </note>
139
- * <p>This API action is not supported by <code>EXPRESS</code> state machine executions unless they were dispatched by a Map Run.</p>
61
+ * @see {@link DescribeExecutionCommand}
140
62
  */
141
63
  describeExecution(args: DescribeExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExecutionCommandOutput>;
142
64
  describeExecution(args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
143
65
  describeExecution(args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
144
66
  /**
145
- * @public
146
- * <p>Provides information about a Map Run's configuration, progress, and results. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p>
67
+ * @see {@link DescribeMapRunCommand}
147
68
  */
148
69
  describeMapRun(args: DescribeMapRunCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMapRunCommandOutput>;
149
70
  describeMapRun(args: DescribeMapRunCommandInput, cb: (err: any, data?: DescribeMapRunCommandOutput) => void): void;
150
71
  describeMapRun(args: DescribeMapRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMapRunCommandOutput) => void): void;
151
72
  /**
152
- * @public
153
- * <p>Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the <code>Map</code> state's label.</p>
154
- *
155
- * <p>A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>.</p>
156
- *
157
- * <note>
158
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
159
- * </note>
73
+ * @see {@link DescribeStateMachineCommand}
160
74
  */
161
75
  describeStateMachine(args: DescribeStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStateMachineCommandOutput>;
162
76
  describeStateMachine(args: DescribeStateMachineCommandInput, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
163
77
  describeStateMachine(args: DescribeStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
164
78
  /**
165
- * @public
166
- * <p>Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.</p>
167
- * <note>
168
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
169
- * </note>
170
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
79
+ * @see {@link DescribeStateMachineForExecutionCommand}
171
80
  */
172
81
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStateMachineForExecutionCommandOutput>;
173
82
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void): void;
174
83
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void): void;
175
84
  /**
176
- * @public
177
- * <p>Used by workers to retrieve a task (with the specified activity ARN) which has been
178
- * scheduled for execution by a running state machine. This initiates a long poll, where the
179
- * service holds the HTTP connection open and responds as soon as a task becomes available (i.e.
180
- * an execution of a task of this type is needed.) The maximum time the service holds on to the
181
- * request before responding is 60 seconds. If no task is available within 60 seconds, the poll
182
- * returns a <code>taskToken</code> with a null string.</p>
183
- *
184
- * <note>
185
- * <p>This API action isn't logged in CloudTrail.</p>
186
- * </note>
187
- *
188
- * <important>
189
- * <p>Workers should set their client side socket timeout to at least 65 seconds (5 seconds
190
- * higher than the maximum time the service may hold the poll request).</p>
191
- * <p>Polling with <code>GetActivityTask</code> can cause latency in some implementations. See
192
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html">Avoid
193
- * Latency When Polling for Activity Tasks</a> in the Step Functions Developer Guide.</p>
194
- * </important>
85
+ * @see {@link GetActivityTaskCommand}
195
86
  */
196
87
  getActivityTask(args: GetActivityTaskCommandInput, options?: __HttpHandlerOptions): Promise<GetActivityTaskCommandOutput>;
197
88
  getActivityTask(args: GetActivityTaskCommandInput, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void;
198
89
  getActivityTask(args: GetActivityTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void;
199
90
  /**
200
- * @public
201
- * <p>Returns the history of the specified execution as a list of events. By default, the
202
- * results are returned in ascending order of the <code>timeStamp</code> of the events. Use the
203
- * <code>reverseOrder</code> parameter to get the latest events first.</p>
204
- * <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.
205
- * 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>
206
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
91
+ * @see {@link GetExecutionHistoryCommand}
207
92
  */
208
93
  getExecutionHistory(args: GetExecutionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetExecutionHistoryCommandOutput>;
209
94
  getExecutionHistory(args: GetExecutionHistoryCommandInput, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void): void;
210
95
  getExecutionHistory(args: GetExecutionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void): void;
211
96
  /**
212
- * @public
213
- * <p>Lists the existing activities.</p>
214
- * <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.
215
- * 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>
216
- * <note>
217
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
218
- * </note>
97
+ * @see {@link ListActivitiesCommand}
219
98
  */
220
99
  listActivities(args: ListActivitiesCommandInput, options?: __HttpHandlerOptions): Promise<ListActivitiesCommandOutput>;
221
100
  listActivities(args: ListActivitiesCommandInput, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void;
222
101
  listActivities(args: ListActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void;
223
102
  /**
224
- * @public
225
- * <p>Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.</p>
226
- * <p>Results are
227
- * sorted by time, with the most recent execution first.</p>
228
- * <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.
229
- * 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>
230
- * <note>
231
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
232
- * </note>
233
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
103
+ * @see {@link ListExecutionsCommand}
234
104
  */
235
105
  listExecutions(args: ListExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListExecutionsCommandOutput>;
236
106
  listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
237
107
  listExecutions(args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
238
108
  /**
239
- * @public
240
- * <p>Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call <code>DescribeMapRun</code> to obtain more information, if needed.</p>
109
+ * @see {@link ListMapRunsCommand}
241
110
  */
242
111
  listMapRuns(args: ListMapRunsCommandInput, options?: __HttpHandlerOptions): Promise<ListMapRunsCommandOutput>;
243
112
  listMapRuns(args: ListMapRunsCommandInput, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void;
244
113
  listMapRuns(args: ListMapRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void;
245
114
  /**
246
- * @public
247
- * <p>Lists the existing state machines.</p>
248
- * <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.
249
- * 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>
250
- * <note>
251
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
252
- * </note>
115
+ * @see {@link ListStateMachinesCommand}
253
116
  */
254
117
  listStateMachines(args: ListStateMachinesCommandInput, options?: __HttpHandlerOptions): Promise<ListStateMachinesCommandOutput>;
255
118
  listStateMachines(args: ListStateMachinesCommandInput, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
256
119
  listStateMachines(args: ListStateMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
257
120
  /**
258
- * @public
259
- * <p>List tags for a given resource.</p>
260
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
121
+ * @see {@link ListTagsForResourceCommand}
261
122
  */
262
123
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
263
124
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
264
125
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
265
126
  /**
266
- * @public
267
- * <p>Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
268
- * pattern to report that the task identified by the <code>taskToken</code> failed.</p>
127
+ * @see {@link SendTaskFailureCommand}
269
128
  */
270
129
  sendTaskFailure(args: SendTaskFailureCommandInput, options?: __HttpHandlerOptions): Promise<SendTaskFailureCommandOutput>;
271
130
  sendTaskFailure(args: SendTaskFailureCommandInput, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void;
272
131
  sendTaskFailure(args: SendTaskFailureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void;
273
132
  /**
274
- * @public
275
- * <p>Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
276
- * pattern to report to Step Functions that the task represented by the specified
277
- * <code>taskToken</code> is still making progress. This action resets the
278
- * <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state
279
- * machine's Amazon States Language definition (<code>HeartbeatSeconds</code>). This action does not in itself
280
- * create an event in the execution history. However, if the task times out, the execution
281
- * history contains an <code>ActivityTimedOut</code> entry for activities, or a
282
- * <code>TaskTimedOut</code> entry for for tasks using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> or
283
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
284
- * pattern.</p>
285
- * <note>
286
- * <p>The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is
287
- * its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received. Use <code>HeartbeatSeconds</code> to configure the timeout interval
288
- * for heartbeats.</p>
289
- * </note>
133
+ * @see {@link SendTaskHeartbeatCommand}
290
134
  */
291
135
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise<SendTaskHeartbeatCommandOutput>;
292
136
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void): void;
293
137
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void): void;
294
138
  /**
295
- * @public
296
- * <p>Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
297
- * pattern to report that the task identified by the <code>taskToken</code> completed
298
- * successfully.</p>
139
+ * @see {@link SendTaskSuccessCommand}
299
140
  */
300
141
  sendTaskSuccess(args: SendTaskSuccessCommandInput, options?: __HttpHandlerOptions): Promise<SendTaskSuccessCommandOutput>;
301
142
  sendTaskSuccess(args: SendTaskSuccessCommandInput, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void;
302
143
  sendTaskSuccess(args: SendTaskSuccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void;
303
144
  /**
304
- * @public
305
- * <p>Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p>
306
- *
307
- * <p>A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>.</p>
308
- *
309
- * <note>
310
- * <p>
311
- * <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a
312
- * <code>STANDARD</code> workflow, if <code>StartExecution</code> is called with the same
313
- * name and input as a running execution, the call will succeed and return the same response as
314
- * the original request. If the execution is closed or if the input is different, it will
315
- * return a <code>400 ExecutionAlreadyExists</code> error. Names can be reused after 90 days. </p>
316
- * <p>
317
- * <code>StartExecution</code> is not idempotent for <code>EXPRESS</code> workflows. </p>
318
- * </note>
145
+ * @see {@link StartExecutionCommand}
319
146
  */
320
147
  startExecution(args: StartExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartExecutionCommandOutput>;
321
148
  startExecution(args: StartExecutionCommandInput, cb: (err: any, data?: StartExecutionCommandOutput) => void): void;
322
149
  startExecution(args: StartExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExecutionCommandOutput) => void): void;
323
150
  /**
324
- * @public
325
- * <p>Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code>
326
- * is not available for <code>STANDARD</code> workflows.</p>
327
- * <note>
328
- * <p>
329
- * <code>StartSyncExecution</code> will return a <code>200 OK</code> response, even if your
330
- * execution fails, because the status code in the API response doesn't reflect function
331
- * errors. Error codes are reserved for errors that prevent your execution from running, such
332
- * as permissions errors, limit errors, or issues with your state machine code and
333
- * configuration. </p>
334
- * </note>
335
- * <note>
336
- * <p>This API action isn't logged in CloudTrail.</p>
337
- * </note>
151
+ * @see {@link StartSyncExecutionCommand}
338
152
  */
339
153
  startSyncExecution(args: StartSyncExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartSyncExecutionCommandOutput>;
340
154
  startSyncExecution(args: StartSyncExecutionCommandInput, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void): void;
341
155
  startSyncExecution(args: StartSyncExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void): void;
342
156
  /**
343
- * @public
344
- * <p>Stops an execution.</p>
345
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
157
+ * @see {@link StopExecutionCommand}
346
158
  */
347
159
  stopExecution(args: StopExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StopExecutionCommandOutput>;
348
160
  stopExecution(args: StopExecutionCommandInput, cb: (err: any, data?: StopExecutionCommandOutput) => void): void;
349
161
  stopExecution(args: StopExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopExecutionCommandOutput) => void): void;
350
162
  /**
351
- * @public
352
- * <p>Add a tag to a Step Functions resource.</p>
353
- * <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
354
- * Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
355
- * Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
356
- * Tags</a>.</p>
357
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
163
+ * @see {@link TagResourceCommand}
358
164
  */
359
165
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
360
166
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
361
167
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
362
168
  /**
363
- * @public
364
- * <p>Remove a tag from a Step Functions resource</p>
169
+ * @see {@link UntagResourceCommand}
365
170
  */
366
171
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
367
172
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
368
173
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
369
174
  /**
370
- * @public
371
- * <p>Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.</p>
175
+ * @see {@link UpdateMapRunCommand}
372
176
  */
373
177
  updateMapRun(args: UpdateMapRunCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMapRunCommandOutput>;
374
178
  updateMapRun(args: UpdateMapRunCommandInput, cb: (err: any, data?: UpdateMapRunCommandOutput) => void): void;
375
179
  updateMapRun(args: UpdateMapRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMapRunCommandOutput) => void): void;
376
180
  /**
377
- * @public
378
- * <p>Updates an existing state machine by modifying its <code>definition</code>,
379
- * <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue
380
- * to use the previous <code>definition</code> and <code>roleArn</code>. You must include at
381
- * least one of <code>definition</code> or <code>roleArn</code> or you will receive a
382
- * <code>MissingRequiredParameter</code> error.</p>
383
- *
384
- * <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p>
385
- *
386
- * <p>A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>.</p>
387
- *
388
- * <note>
389
- * <p>All <code>StartExecution</code> calls within a few seconds will use the updated
390
- * <code>definition</code> and <code>roleArn</code>. Executions started immediately after
391
- * calling <code>UpdateStateMachine</code> may use the previous state machine
392
- * <code>definition</code> and <code>roleArn</code>. </p>
393
- * </note>
181
+ * @see {@link UpdateStateMachineCommand}
394
182
  */
395
183
  updateStateMachine(args: UpdateStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStateMachineCommandOutput>;
396
184
  updateStateMachine(args: UpdateStateMachineCommandInput, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void): void;
397
185
  updateStateMachine(args: UpdateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void): void;
398
186
  }
187
+ /**
188
+ * @public
189
+ * <fullname>Step Functions</fullname>
190
+ * <p>Step Functions is a service that lets you coordinate the components of distributed applications
191
+ * and microservices using visual workflows.</p>
192
+ * <p>You can use Step Functions to build applications from individual components, each of which performs
193
+ * a discrete function, or <i>task</i>, allowing you to scale and change
194
+ * applications quickly. Step Functions provides a console that helps visualize the components of your
195
+ * application as a series of steps. Step Functions automatically triggers and tracks each step, and
196
+ * retries steps when there are errors, so your application executes predictably and in the right
197
+ * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
198
+ * issues.</p>
199
+ * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
200
+ * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has
201
+ * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.
202
+ * For more information about Step Functions, see the <i>
203
+ * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
204
+ * </i>.</p>
205
+ */
206
+ export declare class SFN extends SFNClient implements SFN {
207
+ }
@@ -104,7 +104,7 @@ import {
104
104
  UpdateStateMachineCommandOutput,
105
105
  } from "./commands/UpdateStateMachineCommand";
106
106
  import { SFNClient } from "./SFNClient";
107
- export declare class SFN extends SFNClient {
107
+ export interface SFN {
108
108
  createActivity(
109
109
  args: CreateActivityCommandInput,
110
110
  options?: __HttpHandlerOptions
@@ -444,3 +444,4 @@ export declare class SFN extends SFNClient {
444
444
  cb: (err: any, data?: UpdateStateMachineCommandOutput) => void
445
445
  ): void;
446
446
  }
447
+ export declare class SFN extends SFNClient implements SFN {}
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.312.0",
4
+ "version": "3.316.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.312.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.310.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.310.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.310.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",