@aws-sdk/client-sfn 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist-types/SFN.d.ts +27 -0
  2. package/dist-types/SFNClient.d.ts +24 -4
  3. package/dist-types/commands/CreateActivityCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateStateMachineCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteActivityCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteStateMachineCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeActivityCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeExecutionCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeMapRunCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeStateMachineCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts +16 -0
  12. package/dist-types/commands/GetActivityTaskCommand.d.ts +16 -0
  13. package/dist-types/commands/GetExecutionHistoryCommand.d.ts +16 -0
  14. package/dist-types/commands/ListActivitiesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListExecutionsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListMapRunsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListStateMachinesCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/SendTaskFailureCommand.d.ts +16 -0
  20. package/dist-types/commands/SendTaskHeartbeatCommand.d.ts +16 -0
  21. package/dist-types/commands/SendTaskSuccessCommand.d.ts +16 -0
  22. package/dist-types/commands/StartExecutionCommand.d.ts +16 -0
  23. package/dist-types/commands/StartSyncExecutionCommand.d.ts +16 -0
  24. package/dist-types/commands/StopExecutionCommand.d.ts +16 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateMapRunCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateStateMachineCommand.d.ts +16 -0
  29. package/dist-types/models/SFNServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +270 -14
  31. package/dist-types/pagination/GetExecutionHistoryPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListActivitiesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListExecutionsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListMapRunsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListStateMachinesPaginator.d.ts +3 -0
  37. package/package.json +29 -29
@@ -27,6 +27,7 @@ import { UpdateMapRunCommandInput, UpdateMapRunCommandOutput } from "./commands/
27
27
  import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from "./commands/UpdateStateMachineCommand";
28
28
  import { SFNClient } from "./SFNClient";
29
29
  /**
30
+ * @public
30
31
  * <fullname>Step Functions</fullname>
31
32
  * <p>Step Functions is a service that lets you coordinate the components of distributed applications
32
33
  * and microservices using visual workflows.</p>
@@ -46,6 +47,7 @@ import { SFNClient } from "./SFNClient";
46
47
  */
47
48
  export declare class SFN extends SFNClient {
48
49
  /**
50
+ * @public
49
51
  * <p>Creates an activity. An activity is a task that you write in any programming language and
50
52
  * host on any machine that has access to Step Functions. Activities must poll Step Functions using the
51
53
  * <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API
@@ -68,6 +70,7 @@ export declare class SFN extends SFNClient {
68
70
  createActivity(args: CreateActivityCommandInput, cb: (err: any, data?: CreateActivityCommandOutput) => void): void;
69
71
  createActivity(args: CreateActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActivityCommandOutput) => void): void;
70
72
  /**
73
+ * @public
71
74
  * <p>Creates a state machine. A state machine consists of a collection of states that can do
72
75
  * work (<code>Task</code> states), determine to which states to transition next
73
76
  * (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states),
@@ -93,12 +96,14 @@ export declare class SFN extends SFNClient {
93
96
  createStateMachine(args: CreateStateMachineCommandInput, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
94
97
  createStateMachine(args: CreateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
95
98
  /**
99
+ * @public
96
100
  * <p>Deletes an activity.</p>
97
101
  */
98
102
  deleteActivity(args: DeleteActivityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteActivityCommandOutput>;
99
103
  deleteActivity(args: DeleteActivityCommandInput, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void;
100
104
  deleteActivity(args: DeleteActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void;
101
105
  /**
106
+ * @public
102
107
  * <p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's
103
108
  * status to <code>DELETING</code> and begins the deletion process. </p>
104
109
  *
@@ -116,6 +121,7 @@ export declare class SFN extends SFNClient {
116
121
  deleteStateMachine(args: DeleteStateMachineCommandInput, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
117
122
  deleteStateMachine(args: DeleteStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
118
123
  /**
124
+ * @public
119
125
  * <p>Describes an activity.</p>
120
126
  * <note>
121
127
  * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -125,6 +131,7 @@ export declare class SFN extends SFNClient {
125
131
  describeActivity(args: DescribeActivityCommandInput, cb: (err: any, data?: DescribeActivityCommandOutput) => void): void;
126
132
  describeActivity(args: DescribeActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivityCommandOutput) => void): void;
127
133
  /**
134
+ * @public
128
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>
129
136
  * <note>
130
137
  * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -135,12 +142,14 @@ export declare class SFN extends SFNClient {
135
142
  describeExecution(args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
136
143
  describeExecution(args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
137
144
  /**
145
+ * @public
138
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>
139
147
  */
140
148
  describeMapRun(args: DescribeMapRunCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMapRunCommandOutput>;
141
149
  describeMapRun(args: DescribeMapRunCommandInput, cb: (err: any, data?: DescribeMapRunCommandOutput) => void): void;
142
150
  describeMapRun(args: DescribeMapRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMapRunCommandOutput) => void): void;
143
151
  /**
152
+ * @public
144
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>
145
154
  *
146
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>
@@ -153,6 +162,7 @@ export declare class SFN extends SFNClient {
153
162
  describeStateMachine(args: DescribeStateMachineCommandInput, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
154
163
  describeStateMachine(args: DescribeStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
155
164
  /**
165
+ * @public
156
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>
157
167
  * <note>
158
168
  * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -163,6 +173,7 @@ export declare class SFN extends SFNClient {
163
173
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void): void;
164
174
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void): void;
165
175
  /**
176
+ * @public
166
177
  * <p>Used by workers to retrieve a task (with the specified activity ARN) which has been
167
178
  * scheduled for execution by a running state machine. This initiates a long poll, where the
168
179
  * service holds the HTTP connection open and responds as soon as a task becomes available (i.e.
@@ -186,6 +197,7 @@ export declare class SFN extends SFNClient {
186
197
  getActivityTask(args: GetActivityTaskCommandInput, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void;
187
198
  getActivityTask(args: GetActivityTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void;
188
199
  /**
200
+ * @public
189
201
  * <p>Returns the history of the specified execution as a list of events. By default, the
190
202
  * results are returned in ascending order of the <code>timeStamp</code> of the events. Use the
191
203
  * <code>reverseOrder</code> parameter to get the latest events first.</p>
@@ -197,6 +209,7 @@ export declare class SFN extends SFNClient {
197
209
  getExecutionHistory(args: GetExecutionHistoryCommandInput, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void): void;
198
210
  getExecutionHistory(args: GetExecutionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void): void;
199
211
  /**
212
+ * @public
200
213
  * <p>Lists the existing activities.</p>
201
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.
202
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>
@@ -208,6 +221,7 @@ export declare class SFN extends SFNClient {
208
221
  listActivities(args: ListActivitiesCommandInput, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void;
209
222
  listActivities(args: ListActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void;
210
223
  /**
224
+ * @public
211
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>
212
226
  * <p>Results are
213
227
  * sorted by time, with the most recent execution first.</p>
@@ -222,12 +236,14 @@ export declare class SFN extends SFNClient {
222
236
  listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
223
237
  listExecutions(args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
224
238
  /**
239
+ * @public
225
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>
226
241
  */
227
242
  listMapRuns(args: ListMapRunsCommandInput, options?: __HttpHandlerOptions): Promise<ListMapRunsCommandOutput>;
228
243
  listMapRuns(args: ListMapRunsCommandInput, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void;
229
244
  listMapRuns(args: ListMapRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void;
230
245
  /**
246
+ * @public
231
247
  * <p>Lists the existing state machines.</p>
232
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.
233
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>
@@ -239,6 +255,7 @@ export declare class SFN extends SFNClient {
239
255
  listStateMachines(args: ListStateMachinesCommandInput, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
240
256
  listStateMachines(args: ListStateMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
241
257
  /**
258
+ * @public
242
259
  * <p>List tags for a given resource.</p>
243
260
  * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
244
261
  */
@@ -246,6 +263,7 @@ export declare class SFN extends SFNClient {
246
263
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
247
264
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
248
265
  /**
266
+ * @public
249
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>
250
268
  * pattern to report that the task identified by the <code>taskToken</code> failed.</p>
251
269
  */
@@ -253,6 +271,7 @@ export declare class SFN extends SFNClient {
253
271
  sendTaskFailure(args: SendTaskFailureCommandInput, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void;
254
272
  sendTaskFailure(args: SendTaskFailureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void;
255
273
  /**
274
+ * @public
256
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>
257
276
  * pattern to report to Step Functions that the task represented by the specified
258
277
  * <code>taskToken</code> is still making progress. This action resets the
@@ -273,6 +292,7 @@ export declare class SFN extends SFNClient {
273
292
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void): void;
274
293
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void): void;
275
294
  /**
295
+ * @public
276
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>
277
297
  * pattern to report that the task identified by the <code>taskToken</code> completed
278
298
  * successfully.</p>
@@ -281,6 +301,7 @@ export declare class SFN extends SFNClient {
281
301
  sendTaskSuccess(args: SendTaskSuccessCommandInput, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void;
282
302
  sendTaskSuccess(args: SendTaskSuccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void;
283
303
  /**
304
+ * @public
284
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>
285
306
  *
286
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>
@@ -300,6 +321,7 @@ export declare class SFN extends SFNClient {
300
321
  startExecution(args: StartExecutionCommandInput, cb: (err: any, data?: StartExecutionCommandOutput) => void): void;
301
322
  startExecution(args: StartExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExecutionCommandOutput) => void): void;
302
323
  /**
324
+ * @public
303
325
  * <p>Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code>
304
326
  * is not available for <code>STANDARD</code> workflows.</p>
305
327
  * <note>
@@ -318,6 +340,7 @@ export declare class SFN extends SFNClient {
318
340
  startSyncExecution(args: StartSyncExecutionCommandInput, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void): void;
319
341
  startSyncExecution(args: StartSyncExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void): void;
320
342
  /**
343
+ * @public
321
344
  * <p>Stops an execution.</p>
322
345
  * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
323
346
  */
@@ -325,6 +348,7 @@ export declare class SFN extends SFNClient {
325
348
  stopExecution(args: StopExecutionCommandInput, cb: (err: any, data?: StopExecutionCommandOutput) => void): void;
326
349
  stopExecution(args: StopExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopExecutionCommandOutput) => void): void;
327
350
  /**
351
+ * @public
328
352
  * <p>Add a tag to a Step Functions resource.</p>
329
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
330
354
  * Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
@@ -336,18 +360,21 @@ export declare class SFN extends SFNClient {
336
360
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
337
361
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
338
362
  /**
363
+ * @public
339
364
  * <p>Remove a tag from a Step Functions resource</p>
340
365
  */
341
366
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
342
367
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
343
368
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
344
369
  /**
370
+ * @public
345
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>
346
372
  */
347
373
  updateMapRun(args: UpdateMapRunCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMapRunCommandOutput>;
348
374
  updateMapRun(args: UpdateMapRunCommandInput, cb: (err: any, data?: UpdateMapRunCommandOutput) => void): void;
349
375
  updateMapRun(args: UpdateMapRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMapRunCommandOutput) => void): void;
350
376
  /**
377
+ * @public
351
378
  * <p>Updates an existing state machine by modifying its <code>definition</code>,
352
379
  * <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue
353
380
  * to use the previous <code>definition</code> and <code>roleArn</code>. You must include at
@@ -34,15 +34,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
34
34
  import { UpdateMapRunCommandInput, UpdateMapRunCommandOutput } from "./commands/UpdateMapRunCommand";
35
35
  import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from "./commands/UpdateStateMachineCommand";
36
36
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
37
+ /**
38
+ * @public
39
+ */
37
40
  export type ServiceInputTypes = CreateActivityCommandInput | CreateStateMachineCommandInput | DeleteActivityCommandInput | DeleteStateMachineCommandInput | DescribeActivityCommandInput | DescribeExecutionCommandInput | DescribeMapRunCommandInput | DescribeStateMachineCommandInput | DescribeStateMachineForExecutionCommandInput | GetActivityTaskCommandInput | GetExecutionHistoryCommandInput | ListActivitiesCommandInput | ListExecutionsCommandInput | ListMapRunsCommandInput | ListStateMachinesCommandInput | ListTagsForResourceCommandInput | SendTaskFailureCommandInput | SendTaskHeartbeatCommandInput | SendTaskSuccessCommandInput | StartExecutionCommandInput | StartSyncExecutionCommandInput | StopExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMapRunCommandInput | UpdateStateMachineCommandInput;
41
+ /**
42
+ * @public
43
+ */
38
44
  export type ServiceOutputTypes = CreateActivityCommandOutput | CreateStateMachineCommandOutput | DeleteActivityCommandOutput | DeleteStateMachineCommandOutput | DescribeActivityCommandOutput | DescribeExecutionCommandOutput | DescribeMapRunCommandOutput | DescribeStateMachineCommandOutput | DescribeStateMachineForExecutionCommandOutput | GetActivityTaskCommandOutput | GetExecutionHistoryCommandOutput | ListActivitiesCommandOutput | ListExecutionsCommandOutput | ListMapRunsCommandOutput | ListStateMachinesCommandOutput | ListTagsForResourceCommandOutput | SendTaskFailureCommandOutput | SendTaskHeartbeatCommandOutput | SendTaskSuccessCommandOutput | StartExecutionCommandOutput | StartSyncExecutionCommandOutput | StopExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMapRunCommandOutput | UpdateStateMachineCommandOutput;
45
+ /**
46
+ * @public
47
+ */
39
48
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
40
49
  /**
41
50
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
42
51
  */
43
52
  requestHandler?: __HttpHandler;
44
53
  /**
45
- * A constructor for a class implementing the {@link __Checksum} interface
54
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
46
55
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
47
56
  * @internal
48
57
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type SFNClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of SFNClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of SFNClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface SFNClientConfig extends SFNClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type SFNClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of SFNClient class. This is resolved and normalized from the {@link SFNClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of SFNClient class. This is resolved and normalized from the {@link SFNClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface SFNClientResolvedConfig extends SFNClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <fullname>Step Functions</fullname>
153
173
  * <p>Step Functions is a service that lets you coordinate the components of distributed applications
154
174
  * and microservices using visual workflows.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateActivityInput, CreateActivityOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateActivityCommand}.
8
10
  */
9
11
  export interface CreateActivityCommandInput extends CreateActivityInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateActivityCommand}.
13
17
  */
14
18
  export interface CreateActivityCommandOutput extends CreateActivityOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an activity. An activity is a task that you write in any programming language and
18
23
  * host on any machine that has access to Step Functions. Activities must poll Step Functions using the
19
24
  * <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API
@@ -41,6 +46,8 @@ export interface CreateActivityCommandOutput extends CreateActivityOutput, __Met
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param CreateActivityCommandInput - {@link CreateActivityCommandInput}
50
+ * @returns {@link CreateActivityCommandOutput}
44
51
  * @see {@link CreateActivityCommandInput} for command's `input` shape.
45
52
  * @see {@link CreateActivityCommandOutput} for command's `response` shape.
46
53
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateActivityCommandOutput extends CreateActivityOutput, __Met
61
68
  export declare class CreateActivityCommand extends $Command<CreateActivityCommandInput, CreateActivityCommandOutput, SFNClientResolvedConfig> {
62
69
  readonly input: CreateActivityCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: CreateActivityCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateActivityCommandInput, CreateActivityCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateStateMachineInput, CreateStateMachineOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateStateMachineCommand}.
8
10
  */
9
11
  export interface CreateStateMachineCommandInput extends CreateStateMachineInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateStateMachineCommand}.
13
17
  */
14
18
  export interface CreateStateMachineCommandOutput extends CreateStateMachineOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a state machine. A state machine consists of a collection of states that can do
18
23
  * work (<code>Task</code> states), determine to which states to transition next
19
24
  * (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states),
@@ -44,6 +49,8 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param CreateStateMachineCommandInput - {@link CreateStateMachineCommandInput}
53
+ * @returns {@link CreateStateMachineCommandOutput}
47
54
  * @see {@link CreateStateMachineCommandInput} for command's `input` shape.
48
55
  * @see {@link CreateStateMachineCommandOutput} for command's `response` shape.
49
56
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -87,11 +94,20 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
87
94
  export declare class CreateStateMachineCommand extends $Command<CreateStateMachineCommandInput, CreateStateMachineCommandOutput, SFNClientResolvedConfig> {
88
95
  readonly input: CreateStateMachineCommandInput;
89
96
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
97
+ /**
98
+ * @public
99
+ */
90
100
  constructor(input: CreateStateMachineCommandInput);
91
101
  /**
92
102
  * @internal
93
103
  */
94
104
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStateMachineCommandInput, CreateStateMachineCommandOutput>;
105
+ /**
106
+ * @internal
107
+ */
95
108
  private serialize;
109
+ /**
110
+ * @internal
111
+ */
96
112
  private deserialize;
97
113
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteActivityInput, DeleteActivityOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteActivityCommand}.
8
10
  */
9
11
  export interface DeleteActivityCommandInput extends DeleteActivityInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteActivityCommand}.
13
17
  */
14
18
  export interface DeleteActivityCommandOutput extends DeleteActivityOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an activity.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteActivityCommandOutput extends DeleteActivityOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteActivityCommandInput - {@link DeleteActivityCommandInput}
34
+ * @returns {@link DeleteActivityCommandOutput}
28
35
  * @see {@link DeleteActivityCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteActivityCommandOutput} for command's `response` shape.
30
37
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -37,11 +44,20 @@ export interface DeleteActivityCommandOutput extends DeleteActivityOutput, __Met
37
44
  export declare class DeleteActivityCommand extends $Command<DeleteActivityCommandInput, DeleteActivityCommandOutput, SFNClientResolvedConfig> {
38
45
  readonly input: DeleteActivityCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: DeleteActivityCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteActivityCommandInput, DeleteActivityCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteStateMachineInput, DeleteStateMachineOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteStateMachineCommand}.
8
10
  */
9
11
  export interface DeleteStateMachineCommandInput extends DeleteStateMachineInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteStateMachineCommand}.
13
17
  */
14
18
  export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's
18
23
  * status to <code>DELETING</code> and begins the deletion process. </p>
19
24
  *
@@ -36,6 +41,8 @@ export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutpu
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param DeleteStateMachineCommandInput - {@link DeleteStateMachineCommandInput}
45
+ * @returns {@link DeleteStateMachineCommandOutput}
39
46
  * @see {@link DeleteStateMachineCommandInput} for command's `input` shape.
40
47
  * @see {@link DeleteStateMachineCommandOutput} for command's `response` shape.
41
48
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutpu
51
58
  export declare class DeleteStateMachineCommand extends $Command<DeleteStateMachineCommandInput, DeleteStateMachineCommandOutput, SFNClientResolvedConfig> {
52
59
  readonly input: DeleteStateMachineCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DeleteStateMachineCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStateMachineCommandInput, DeleteStateMachineCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeActivityInput, DescribeActivityOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeActivityCommand}.
8
10
  */
9
11
  export interface DescribeActivityCommandInput extends DescribeActivityInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeActivityCommand}.
13
17
  */
14
18
  export interface DescribeActivityCommandOutput extends DescribeActivityOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes an activity.</p>
18
23
  * <note>
19
24
  * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -28,6 +33,8 @@ export interface DescribeActivityCommandOutput extends DescribeActivityOutput, _
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeActivityCommandInput - {@link DescribeActivityCommandInput}
37
+ * @returns {@link DescribeActivityCommandOutput}
31
38
  * @see {@link DescribeActivityCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeActivityCommandOutput} for command's `response` shape.
33
40
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeActivityCommandOutput extends DescribeActivityOutput, _
43
50
  export declare class DescribeActivityCommand extends $Command<DescribeActivityCommandInput, DescribeActivityCommandOutput, SFNClientResolvedConfig> {
44
51
  readonly input: DescribeActivityCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeActivityCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeActivityCommandInput, DescribeActivityCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeExecutionInput, DescribeExecutionOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeExecutionCommand}.
8
10
  */
9
11
  export interface DescribeExecutionCommandInput extends DescribeExecutionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeExecutionCommand}.
13
17
  */
14
18
  export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <note>
19
24
  * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -29,6 +34,8 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeExecutionCommandInput - {@link DescribeExecutionCommandInput}
38
+ * @returns {@link DescribeExecutionCommandOutput}
32
39
  * @see {@link DescribeExecutionCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeExecutionCommandOutput} for command's `response` shape.
34
41
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
44
51
  export declare class DescribeExecutionCommand extends $Command<DescribeExecutionCommandInput, DescribeExecutionCommandOutput, SFNClientResolvedConfig> {
45
52
  readonly input: DescribeExecutionCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeExecutionCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExecutionCommandInput, DescribeExecutionCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeMapRunInput, DescribeMapRunOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeMapRunCommand}.
8
10
  */
9
11
  export interface DescribeMapRunCommandInput extends DescribeMapRunInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeMapRunCommand}.
13
17
  */
14
18
  export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeMapRunCommandInput - {@link DescribeMapRunCommandInput}
34
+ * @returns {@link DescribeMapRunCommandOutput}
28
35
  * @see {@link DescribeMapRunCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeMapRunCommandOutput} for command's `response` shape.
30
37
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __Met
41
48
  export declare class DescribeMapRunCommand extends $Command<DescribeMapRunCommandInput, DescribeMapRunCommandOutput, SFNClientResolvedConfig> {
42
49
  readonly input: DescribeMapRunCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DescribeMapRunCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeMapRunCommandInput, DescribeMapRunCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }