@aws-sdk/client-sfn 3.36.0 → 3.39.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 (81) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/SFN.js +0 -18
  3. package/dist-cjs/SFNClient.js +0 -23
  4. package/dist-cjs/commands/CreateActivityCommand.js +0 -40
  5. package/dist-cjs/commands/CreateStateMachineCommand.js +0 -42
  6. package/dist-cjs/commands/DeleteActivityCommand.js +0 -24
  7. package/dist-cjs/commands/DeleteStateMachineCommand.js +0 -30
  8. package/dist-cjs/commands/DescribeActivityCommand.js +0 -27
  9. package/dist-cjs/commands/DescribeExecutionCommand.js +0 -28
  10. package/dist-cjs/commands/DescribeStateMachineCommand.js +0 -27
  11. package/dist-cjs/commands/DescribeStateMachineForExecutionCommand.js +0 -28
  12. package/dist-cjs/commands/GetActivityTaskCommand.js +0 -36
  13. package/dist-cjs/commands/GetExecutionHistoryCommand.js +0 -29
  14. package/dist-cjs/commands/ListActivitiesCommand.js +0 -29
  15. package/dist-cjs/commands/ListExecutionsCommand.js +0 -31
  16. package/dist-cjs/commands/ListStateMachinesCommand.js +0 -29
  17. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  18. package/dist-cjs/commands/SendTaskFailureCommand.js +0 -25
  19. package/dist-cjs/commands/SendTaskHeartbeatCommand.js +0 -38
  20. package/dist-cjs/commands/SendTaskSuccessCommand.js +0 -26
  21. package/dist-cjs/commands/StartExecutionCommand.js +0 -32
  22. package/dist-cjs/commands/StartSyncExecutionCommand.js +0 -24
  23. package/dist-cjs/commands/StopExecutionCommand.js +0 -25
  24. package/dist-cjs/commands/TagResourceCommand.js +0 -29
  25. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  26. package/dist-cjs/commands/UpdateStateMachineCommand.js +0 -34
  27. package/dist-cjs/commands/index.js +26 -0
  28. package/dist-cjs/endpoints.js +6 -1
  29. package/dist-cjs/index.js +4 -30
  30. package/dist-cjs/models/models_0.js +0 -333
  31. package/dist-cjs/pagination/GetExecutionHistoryPaginator.js +0 -10
  32. package/dist-cjs/pagination/ListActivitiesPaginator.js +0 -10
  33. package/dist-cjs/pagination/ListExecutionsPaginator.js +0 -10
  34. package/dist-cjs/pagination/ListStateMachinesPaginator.js +0 -10
  35. package/dist-cjs/pagination/index.js +8 -0
  36. package/dist-cjs/protocols/Aws_json1_0.js +0 -5
  37. package/dist-cjs/runtimeConfig.browser.js +1 -5
  38. package/dist-cjs/runtimeConfig.js +1 -5
  39. package/dist-cjs/runtimeConfig.native.js +0 -3
  40. package/dist-cjs/runtimeConfig.shared.js +0 -3
  41. package/dist-es/commands/index.js +23 -0
  42. package/dist-es/endpoints.js +6 -1
  43. package/dist-es/index.js +4 -30
  44. package/dist-es/pagination/index.js +5 -0
  45. package/dist-types/commands/index.d.ts +23 -0
  46. package/dist-types/index.d.ts +4 -30
  47. package/dist-types/pagination/index.d.ts +5 -0
  48. package/dist-types/ts3.4/SFN.d.ts +24 -217
  49. package/dist-types/ts3.4/SFNClient.d.ts +24 -104
  50. package/dist-types/ts3.4/commands/CreateActivityCommand.d.ts +2 -36
  51. package/dist-types/ts3.4/commands/CreateStateMachineCommand.d.ts +2 -38
  52. package/dist-types/ts3.4/commands/DeleteActivityCommand.d.ts +2 -20
  53. package/dist-types/ts3.4/commands/DeleteStateMachineCommand.d.ts +2 -26
  54. package/dist-types/ts3.4/commands/DescribeActivityCommand.d.ts +2 -23
  55. package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +2 -24
  56. package/dist-types/ts3.4/commands/DescribeStateMachineCommand.d.ts +2 -23
  57. package/dist-types/ts3.4/commands/DescribeStateMachineForExecutionCommand.d.ts +2 -24
  58. package/dist-types/ts3.4/commands/GetActivityTaskCommand.d.ts +2 -32
  59. package/dist-types/ts3.4/commands/GetExecutionHistoryCommand.d.ts +2 -25
  60. package/dist-types/ts3.4/commands/ListActivitiesCommand.d.ts +2 -25
  61. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +2 -27
  62. package/dist-types/ts3.4/commands/ListStateMachinesCommand.d.ts +2 -25
  63. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -21
  64. package/dist-types/ts3.4/commands/SendTaskFailureCommand.d.ts +2 -21
  65. package/dist-types/ts3.4/commands/SendTaskHeartbeatCommand.d.ts +2 -34
  66. package/dist-types/ts3.4/commands/SendTaskSuccessCommand.d.ts +2 -22
  67. package/dist-types/ts3.4/commands/StartExecutionCommand.d.ts +2 -28
  68. package/dist-types/ts3.4/commands/StartSyncExecutionCommand.d.ts +2 -20
  69. package/dist-types/ts3.4/commands/StopExecutionCommand.d.ts +2 -21
  70. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -25
  71. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  72. package/dist-types/ts3.4/commands/UpdateStateMachineCommand.d.ts +2 -30
  73. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  74. package/dist-types/ts3.4/index.d.ts +4 -30
  75. package/dist-types/ts3.4/models/models_0.d.ts +434 -1643
  76. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  77. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  78. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  79. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  80. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  81. package/package.json +32 -32
@@ -23,290 +23,97 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
23
23
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
24
24
  import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from "./commands/UpdateStateMachineCommand";
25
25
  import { SFNClient } from "./SFNClient";
26
- /**
27
- * <fullname>AWS Step Functions</fullname>
28
- * <p>AWS Step Functions is a service that lets you coordinate the components of distributed applications
29
- * and microservices using visual workflows.</p>
30
- * <p>You can use Step Functions to build applications from individual components, each of which performs
31
- * a discrete function, or <i>task</i>, allowing you to scale and change
32
- * applications quickly. Step Functions provides a console that helps visualize the components of your
33
- * application as a series of steps. Step Functions automatically triggers and tracks each step, and
34
- * retries steps when there are errors, so your application executes predictably and in the right
35
- * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
36
- * issues.</p>
37
- * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
38
- * available at any scale. You can run tasks on AWS, your own servers, or any system that has
39
- * access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API.
40
- * For more information about Step Functions, see the <i>
41
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">AWS Step Functions Developer Guide</a>
42
- * </i>.</p>
43
- */
26
+
44
27
  export declare class SFN extends SFNClient {
45
- /**
46
- * <p>Creates an activity. An activity is a task that you write in any programming language and
47
- * host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the
48
- * <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API
49
- * actions. This function lets Step Functions know the existence of your activity and returns an
50
- * identifier for use in a state machine and when polling from the activity.</p>
51
- * <note>
52
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
53
- * </note>
54
- * <note>
55
- * <p>
56
- * <code>CreateActivity</code> is an idempotent API. Subsequent requests won’t create a
57
- * duplicate resource if it was already created. <code>CreateActivity</code>'s idempotency
58
- * check is based on the activity <code>name</code>. If a following request has different
59
- * <code>tags</code> values, Step Functions will ignore these differences and treat it as an
60
- * idempotent request of the previous. In this case, <code>tags</code> will not be updated,
61
- * even if they are different.</p>
62
- * </note>
63
- */
28
+
64
29
  createActivity(args: CreateActivityCommandInput, options?: __HttpHandlerOptions): Promise<CreateActivityCommandOutput>;
65
30
  createActivity(args: CreateActivityCommandInput, cb: (err: any, data?: CreateActivityCommandOutput) => void): void;
66
31
  createActivity(args: CreateActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActivityCommandOutput) => void): void;
67
- /**
68
- * <p>Creates a state machine. A state machine consists of a collection of states that can do
69
- * work (<code>Task</code> states), determine to which states to transition next
70
- * (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states),
71
- * and so on. State machines are specified using a JSON-based, structured language. For more
72
- * information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States
73
- * Language</a> in the AWS Step Functions User Guide.</p>
74
- * <note>
75
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
76
- * </note>
77
- * <note>
78
- * <p>
79
- * <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a
80
- * duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency
81
- * check is based on the state machine <code>name</code>, <code>definition</code>,
82
- * <code>type</code>, <code>LoggingConfiguration</code> and <code>TracingConfiguration</code>. If a following request has a
83
- * different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and
84
- * treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and
85
- * <code>tags</code> will not be updated, even if they are different.</p>
86
- * </note>
87
- */
32
+
88
33
  createStateMachine(args: CreateStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<CreateStateMachineCommandOutput>;
89
34
  createStateMachine(args: CreateStateMachineCommandInput, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
90
35
  createStateMachine(args: CreateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
91
- /**
92
- * <p>Deletes an activity.</p>
93
- */
36
+
94
37
  deleteActivity(args: DeleteActivityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteActivityCommandOutput>;
95
38
  deleteActivity(args: DeleteActivityCommandInput, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void;
96
39
  deleteActivity(args: DeleteActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void;
97
- /**
98
- * <p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's
99
- * status to <code>DELETING</code> and begins the deletion process. </p>
100
- * <note>
101
- * <p>For <code>EXPRESS</code>state machines, the deletion will happen eventually (usually
102
- * less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code>
103
- * API is called.</p>
104
- * </note>
105
- */
40
+
106
41
  deleteStateMachine(args: DeleteStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStateMachineCommandOutput>;
107
42
  deleteStateMachine(args: DeleteStateMachineCommandInput, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
108
43
  deleteStateMachine(args: DeleteStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
109
- /**
110
- * <p>Describes an activity.</p>
111
- * <note>
112
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
113
- * </note>
114
- */
44
+
115
45
  describeActivity(args: DescribeActivityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeActivityCommandOutput>;
116
46
  describeActivity(args: DescribeActivityCommandInput, cb: (err: any, data?: DescribeActivityCommandOutput) => void): void;
117
47
  describeActivity(args: DescribeActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivityCommandOutput) => void): void;
118
- /**
119
- * <p>Describes an execution.</p>
120
- * <note>
121
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
122
- * </note>
123
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
124
- */
48
+
125
49
  describeExecution(args: DescribeExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExecutionCommandOutput>;
126
50
  describeExecution(args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
127
51
  describeExecution(args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void): void;
128
- /**
129
- * <p>Describes a state machine.</p>
130
- * <note>
131
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
132
- * </note>
133
- */
52
+
134
53
  describeStateMachine(args: DescribeStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStateMachineCommandOutput>;
135
54
  describeStateMachine(args: DescribeStateMachineCommandInput, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
136
55
  describeStateMachine(args: DescribeStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
137
- /**
138
- * <p>Describes the state machine associated with a specific execution.</p>
139
- * <note>
140
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
141
- * </note>
142
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
143
- */
56
+
144
57
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStateMachineForExecutionCommandOutput>;
145
58
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void): void;
146
59
  describeStateMachineForExecution(args: DescribeStateMachineForExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void): void;
147
- /**
148
- * <p>Used by workers to retrieve a task (with the specified activity ARN) which has been
149
- * scheduled for execution by a running state machine. This initiates a long poll, where the
150
- * service holds the HTTP connection open and responds as soon as a task becomes available (i.e.
151
- * an execution of a task of this type is needed.) The maximum time the service holds on to the
152
- * request before responding is 60 seconds. If no task is available within 60 seconds, the poll
153
- * returns a <code>taskToken</code> with a null string.</p>
154
- * <important>
155
- * <p>Workers should set their client side socket timeout to at least 65 seconds (5 seconds
156
- * higher than the maximum time the service may hold the poll request).</p>
157
- * <p>Polling with <code>GetActivityTask</code> can cause latency in some implementations. See
158
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html">Avoid
159
- * Latency When Polling for Activity Tasks</a> in the Step Functions Developer Guide.</p>
160
- * </important>
161
- */
60
+
162
61
  getActivityTask(args: GetActivityTaskCommandInput, options?: __HttpHandlerOptions): Promise<GetActivityTaskCommandOutput>;
163
62
  getActivityTask(args: GetActivityTaskCommandInput, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void;
164
63
  getActivityTask(args: GetActivityTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void;
165
- /**
166
- * <p>Returns the history of the specified execution as a list of events. By default, the
167
- * results are returned in ascending order of the <code>timeStamp</code> of the events. Use the
168
- * <code>reverseOrder</code> parameter to get the latest events first.</p>
169
- * <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.
170
- * 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>
171
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
172
- */
64
+
173
65
  getExecutionHistory(args: GetExecutionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetExecutionHistoryCommandOutput>;
174
66
  getExecutionHistory(args: GetExecutionHistoryCommandInput, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void): void;
175
67
  getExecutionHistory(args: GetExecutionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void): void;
176
- /**
177
- * <p>Lists the existing activities.</p>
178
- * <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.
179
- * 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>
180
- * <note>
181
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
182
- * </note>
183
- */
68
+
184
69
  listActivities(args: ListActivitiesCommandInput, options?: __HttpHandlerOptions): Promise<ListActivitiesCommandOutput>;
185
70
  listActivities(args: ListActivitiesCommandInput, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void;
186
71
  listActivities(args: ListActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void;
187
- /**
188
- * <p>Lists the executions of a state machine that meet the filtering criteria. Results are
189
- * sorted by time, with the most recent execution first.</p>
190
- * <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.
191
- * 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>
192
- * <note>
193
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
194
- * </note>
195
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
196
- */
72
+
197
73
  listExecutions(args: ListExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListExecutionsCommandOutput>;
198
74
  listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
199
75
  listExecutions(args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void;
200
- /**
201
- * <p>Lists the existing state machines.</p>
202
- * <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.
203
- * 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>
204
- * <note>
205
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
206
- * </note>
207
- */
76
+
208
77
  listStateMachines(args: ListStateMachinesCommandInput, options?: __HttpHandlerOptions): Promise<ListStateMachinesCommandOutput>;
209
78
  listStateMachines(args: ListStateMachinesCommandInput, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
210
79
  listStateMachines(args: ListStateMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
211
- /**
212
- * <p>List tags for a given resource.</p>
213
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
214
- */
80
+
215
81
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
216
82
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
217
83
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
218
- /**
219
- * <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>
220
- * pattern to report that the task identified by the <code>taskToken</code> failed.</p>
221
- */
84
+
222
85
  sendTaskFailure(args: SendTaskFailureCommandInput, options?: __HttpHandlerOptions): Promise<SendTaskFailureCommandOutput>;
223
86
  sendTaskFailure(args: SendTaskFailureCommandInput, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void;
224
87
  sendTaskFailure(args: SendTaskFailureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void;
225
- /**
226
- * <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>
227
- * pattern to report to Step Functions that the task represented by the specified
228
- * <code>taskToken</code> is still making progress. This action resets the
229
- * <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state
230
- * machine's Amazon States Language definition (<code>HeartbeatSeconds</code>). This action does not in itself
231
- * create an event in the execution history. However, if the task times out, the execution
232
- * history contains an <code>ActivityTimedOut</code> entry for activities, or a
233
- * <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
234
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
235
- * pattern.</p>
236
- * <note>
237
- * <p>The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is
238
- * its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received. Use <code>HeartbeatSeconds</code> to configure the timeout interval
239
- * for heartbeats.</p>
240
- * </note>
241
- */
88
+
242
89
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise<SendTaskHeartbeatCommandOutput>;
243
90
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void): void;
244
91
  sendTaskHeartbeat(args: SendTaskHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void): void;
245
- /**
246
- * <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>
247
- * pattern to report that the task identified by the <code>taskToken</code> completed
248
- * successfully.</p>
249
- */
92
+
250
93
  sendTaskSuccess(args: SendTaskSuccessCommandInput, options?: __HttpHandlerOptions): Promise<SendTaskSuccessCommandOutput>;
251
94
  sendTaskSuccess(args: SendTaskSuccessCommandInput, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void;
252
95
  sendTaskSuccess(args: SendTaskSuccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void;
253
- /**
254
- * <p>Starts a state machine execution.</p>
255
- * <note>
256
- * <p>
257
- * <code>StartExecution</code> is idempotent. If <code>StartExecution</code> is called with
258
- * the same name and input as a running execution, the call will succeed and return the same
259
- * response as the original request. If the execution is closed or if the input is different,
260
- * it will return a 400 <code>ExecutionAlreadyExists</code> error. Names can be reused after 90
261
- * days. </p>
262
- * </note>
263
- */
96
+
264
97
  startExecution(args: StartExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartExecutionCommandOutput>;
265
98
  startExecution(args: StartExecutionCommandInput, cb: (err: any, data?: StartExecutionCommandOutput) => void): void;
266
99
  startExecution(args: StartExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExecutionCommandOutput) => void): void;
267
- /**
268
- * <p>Starts a Synchronous Express state machine execution.</p>
269
- */
100
+
270
101
  startSyncExecution(args: StartSyncExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartSyncExecutionCommandOutput>;
271
102
  startSyncExecution(args: StartSyncExecutionCommandInput, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void): void;
272
103
  startSyncExecution(args: StartSyncExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void): void;
273
- /**
274
- * <p>Stops an execution.</p>
275
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
276
- */
104
+
277
105
  stopExecution(args: StopExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StopExecutionCommandOutput>;
278
106
  stopExecution(args: StopExecutionCommandInput, cb: (err: any, data?: StopExecutionCommandOutput) => void): void;
279
107
  stopExecution(args: StopExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopExecutionCommandOutput) => void): void;
280
- /**
281
- * <p>Add a tag to a Step Functions resource.</p>
282
- * <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
283
- * Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User
284
- * Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
285
- * Tags</a>.</p>
286
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
287
- */
108
+
288
109
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
289
110
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
290
111
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
291
- /**
292
- * <p>Remove a tag from a Step Functions resource</p>
293
- */
112
+
294
113
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
295
114
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
296
115
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
297
- /**
298
- * <p>Updates an existing state machine by modifying its <code>definition</code>,
299
- * <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue
300
- * to use the previous <code>definition</code> and <code>roleArn</code>. You must include at
301
- * least one of <code>definition</code> or <code>roleArn</code> or you will receive a
302
- * <code>MissingRequiredParameter</code> error.</p>
303
- * <note>
304
- * <p>All <code>StartExecution</code> calls within a few seconds will use the updated
305
- * <code>definition</code> and <code>roleArn</code>. Executions started immediately after
306
- * calling <code>UpdateStateMachine</code> may use the previous state machine
307
- * <code>definition</code> and <code>roleArn</code>. </p>
308
- * </note>
309
- */
116
+
310
117
  updateStateMachine(args: UpdateStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStateMachineCommandOutput>;
311
118
  updateStateMachine(args: UpdateStateMachineCommandInput, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void): void;
312
119
  updateStateMachine(args: UpdateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void): void;
@@ -32,139 +32,59 @@ import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from
32
32
  export declare type ServiceInputTypes = CreateActivityCommandInput | CreateStateMachineCommandInput | DeleteActivityCommandInput | DeleteStateMachineCommandInput | DescribeActivityCommandInput | DescribeExecutionCommandInput | DescribeStateMachineCommandInput | DescribeStateMachineForExecutionCommandInput | GetActivityTaskCommandInput | GetExecutionHistoryCommandInput | ListActivitiesCommandInput | ListExecutionsCommandInput | ListStateMachinesCommandInput | ListTagsForResourceCommandInput | SendTaskFailureCommandInput | SendTaskHeartbeatCommandInput | SendTaskSuccessCommandInput | StartExecutionCommandInput | StartSyncExecutionCommandInput | StopExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStateMachineCommandInput;
33
33
  export declare type ServiceOutputTypes = CreateActivityCommandOutput | CreateStateMachineCommandOutput | DeleteActivityCommandOutput | DeleteStateMachineCommandOutput | DescribeActivityCommandOutput | DescribeExecutionCommandOutput | DescribeStateMachineCommandOutput | DescribeStateMachineForExecutionCommandOutput | GetActivityTaskCommandOutput | GetExecutionHistoryCommandOutput | ListActivitiesCommandOutput | ListExecutionsCommandOutput | ListStateMachinesCommandOutput | ListTagsForResourceCommandOutput | SendTaskFailureCommandOutput | SendTaskHeartbeatCommandOutput | SendTaskSuccessCommandOutput | StartExecutionCommandOutput | StartSyncExecutionCommandOutput | StopExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStateMachineCommandOutput;
34
34
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
35
- /**
36
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
37
- */
35
+
38
36
  requestHandler?: __HttpHandler;
39
- /**
40
- * A constructor for a class implementing the {@link __Hash} interface
41
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
42
- * @internal
43
- */
37
+
44
38
  sha256?: __HashConstructor;
45
- /**
46
- * The function that will be used to convert strings into HTTP endpoints.
47
- * @internal
48
- */
39
+
49
40
  urlParser?: __UrlParser;
50
- /**
51
- * A function that can calculate the length of a request body.
52
- * @internal
53
- */
41
+
54
42
  bodyLengthChecker?: (body: any) => number | undefined;
55
- /**
56
- * A function that converts a stream into an array of bytes.
57
- * @internal
58
- */
43
+
59
44
  streamCollector?: __StreamCollector;
60
- /**
61
- * The function that will be used to convert a base64-encoded string to a byte array.
62
- * @internal
63
- */
45
+
64
46
  base64Decoder?: __Decoder;
65
- /**
66
- * The function that will be used to convert binary data to a base64-encoded string.
67
- * @internal
68
- */
47
+
69
48
  base64Encoder?: __Encoder;
70
- /**
71
- * The function that will be used to convert a UTF8-encoded string to a byte array.
72
- * @internal
73
- */
49
+
74
50
  utf8Decoder?: __Decoder;
75
- /**
76
- * The function that will be used to convert binary data to a UTF-8 encoded string.
77
- * @internal
78
- */
51
+
79
52
  utf8Encoder?: __Encoder;
80
- /**
81
- * The runtime environment.
82
- * @internal
83
- */
53
+
84
54
  runtime?: string;
85
- /**
86
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
87
- * trait of an operation.
88
- */
55
+
89
56
  disableHostPrefix?: boolean;
90
- /**
91
- * Value for how many times a request will be made at most in case of retry.
92
- */
57
+
93
58
  maxAttempts?: number | __Provider<number>;
94
- /**
95
- * Specifies which retry algorithm to use.
96
- */
59
+
97
60
  retryMode?: string | __Provider<string>;
98
- /**
99
- * Optional logger for logging debug/info/warn/error.
100
- */
61
+
101
62
  logger?: __Logger;
102
- /**
103
- * Unique service identifier.
104
- * @internal
105
- */
63
+
106
64
  serviceId?: string;
107
- /**
108
- * The AWS region to which this client will send requests
109
- */
65
+
110
66
  region?: string | __Provider<string>;
111
- /**
112
- * Default credentials provider; Not available in browser runtime.
113
- * @internal
114
- */
67
+
115
68
  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
116
- /**
117
- * Fetch related hostname, signing name or signing region with given region.
118
- * @internal
119
- */
69
+
120
70
  regionInfoProvider?: RegionInfoProvider;
121
- /**
122
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
123
- * @internal
124
- */
71
+
125
72
  defaultUserAgentProvider?: Provider<__UserAgent>;
126
73
  }
127
74
  declare type SFNClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
128
- /**
129
- * The configuration interface of SFNClient class constructor that set the region, credentials and other options.
130
- */
75
+
131
76
  export interface SFNClientConfig extends SFNClientConfigType {
132
77
  }
133
78
  declare type SFNClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
134
- /**
135
- * The resolved configuration interface of SFNClient class. This is resolved and normalized from the {@link SFNClientConfig | constructor configuration interface}.
136
- */
79
+
137
80
  export interface SFNClientResolvedConfig extends SFNClientResolvedConfigType {
138
81
  }
139
- /**
140
- * <fullname>AWS Step Functions</fullname>
141
- * <p>AWS Step Functions is a service that lets you coordinate the components of distributed applications
142
- * and microservices using visual workflows.</p>
143
- * <p>You can use Step Functions to build applications from individual components, each of which performs
144
- * a discrete function, or <i>task</i>, allowing you to scale and change
145
- * applications quickly. Step Functions provides a console that helps visualize the components of your
146
- * application as a series of steps. Step Functions automatically triggers and tracks each step, and
147
- * retries steps when there are errors, so your application executes predictably and in the right
148
- * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any
149
- * issues.</p>
150
- * <p>Step Functions manages operations and underlying infrastructure to ensure your application is
151
- * available at any scale. You can run tasks on AWS, your own servers, or any system that has
152
- * access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API.
153
- * For more information about Step Functions, see the <i>
154
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">AWS Step Functions Developer Guide</a>
155
- * </i>.</p>
156
- */
82
+
157
83
  export declare class SFNClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig> {
158
- /**
159
- * The resolved configuration of SFNClient class. This is resolved and normalized from the {@link SFNClientConfig | constructor configuration interface}.
160
- */
84
+
161
85
  readonly config: SFNClientResolvedConfig;
162
86
  constructor(configuration: SFNClientConfig);
163
- /**
164
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
165
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
166
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
167
- */
87
+
168
88
  destroy(): void;
169
89
  }
170
90
  export {};
@@ -6,45 +6,11 @@ export interface CreateActivityCommandInput extends CreateActivityInput {
6
6
  }
7
7
  export interface CreateActivityCommandOutput extends CreateActivityOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates an activity. An activity is a task that you write in any programming language and
11
- * host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the
12
- * <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API
13
- * actions. This function lets Step Functions know the existence of your activity and returns an
14
- * identifier for use in a state machine and when polling from the activity.</p>
15
- * <note>
16
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
17
- * </note>
18
- * <note>
19
- * <p>
20
- * <code>CreateActivity</code> is an idempotent API. Subsequent requests won’t create a
21
- * duplicate resource if it was already created. <code>CreateActivity</code>'s idempotency
22
- * check is based on the activity <code>name</code>. If a following request has different
23
- * <code>tags</code> values, Step Functions will ignore these differences and treat it as an
24
- * idempotent request of the previous. In this case, <code>tags</code> will not be updated,
25
- * even if they are different.</p>
26
- * </note>
27
- * @example
28
- * Use a bare-bones client and the command you need to make an API call.
29
- * ```javascript
30
- * import { SFNClient, CreateActivityCommand } from "@aws-sdk/client-sfn"; // ES Modules import
31
- * // const { SFNClient, CreateActivityCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
32
- * const client = new SFNClient(config);
33
- * const command = new CreateActivityCommand(input);
34
- * const response = await client.send(command);
35
- * ```
36
- *
37
- * @see {@link CreateActivityCommandInput} for command's `input` shape.
38
- * @see {@link CreateActivityCommandOutput} for command's `response` shape.
39
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
40
- *
41
- */
9
+
42
10
  export declare class CreateActivityCommand extends $Command<CreateActivityCommandInput, CreateActivityCommandOutput, SFNClientResolvedConfig> {
43
11
  readonly input: CreateActivityCommandInput;
44
12
  constructor(input: CreateActivityCommandInput);
45
- /**
46
- * @internal
47
- */
13
+
48
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateActivityCommandInput, CreateActivityCommandOutput>;
49
15
  private serialize;
50
16
  private deserialize;
@@ -6,47 +6,11 @@ export interface CreateStateMachineCommandInput extends CreateStateMachineInput
6
6
  }
7
7
  export interface CreateStateMachineCommandOutput extends CreateStateMachineOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a state machine. A state machine consists of a collection of states that can do
11
- * work (<code>Task</code> states), determine to which states to transition next
12
- * (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states),
13
- * and so on. State machines are specified using a JSON-based, structured language. For more
14
- * information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States
15
- * Language</a> in the AWS Step Functions User Guide.</p>
16
- * <note>
17
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
18
- * </note>
19
- * <note>
20
- * <p>
21
- * <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a
22
- * duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency
23
- * check is based on the state machine <code>name</code>, <code>definition</code>,
24
- * <code>type</code>, <code>LoggingConfiguration</code> and <code>TracingConfiguration</code>. If a following request has a
25
- * different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and
26
- * treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and
27
- * <code>tags</code> will not be updated, even if they are different.</p>
28
- * </note>
29
- * @example
30
- * Use a bare-bones client and the command you need to make an API call.
31
- * ```javascript
32
- * import { SFNClient, CreateStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import
33
- * // const { SFNClient, CreateStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
34
- * const client = new SFNClient(config);
35
- * const command = new CreateStateMachineCommand(input);
36
- * const response = await client.send(command);
37
- * ```
38
- *
39
- * @see {@link CreateStateMachineCommandInput} for command's `input` shape.
40
- * @see {@link CreateStateMachineCommandOutput} for command's `response` shape.
41
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
42
- *
43
- */
9
+
44
10
  export declare class CreateStateMachineCommand extends $Command<CreateStateMachineCommandInput, CreateStateMachineCommandOutput, SFNClientResolvedConfig> {
45
11
  readonly input: CreateStateMachineCommandInput;
46
12
  constructor(input: CreateStateMachineCommandInput);
47
- /**
48
- * @internal
49
- */
13
+
50
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStateMachineCommandInput, CreateStateMachineCommandOutput>;
51
15
  private serialize;
52
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface DeleteActivityCommandInput extends DeleteActivityInput {
6
6
  }
7
7
  export interface DeleteActivityCommandOutput extends DeleteActivityOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes an activity.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { SFNClient, DeleteActivityCommand } from "@aws-sdk/client-sfn"; // ES Modules import
15
- * // const { SFNClient, DeleteActivityCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
16
- * const client = new SFNClient(config);
17
- * const command = new DeleteActivityCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link DeleteActivityCommandInput} for command's `input` shape.
22
- * @see {@link DeleteActivityCommandOutput} for command's `response` shape.
23
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class DeleteActivityCommand extends $Command<DeleteActivityCommandInput, DeleteActivityCommandOutput, SFNClientResolvedConfig> {
27
11
  readonly input: DeleteActivityCommandInput;
28
12
  constructor(input: DeleteActivityCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteActivityCommandInput, DeleteActivityCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;