@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
@@ -1,338 +1,168 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>The specified activity does not exist.</p>
4
- */
2
+
5
3
  export interface ActivityDoesNotExist extends __SmithyException, $MetadataBearer {
6
4
  name: "ActivityDoesNotExist";
7
5
  $fault: "client";
8
6
  message?: string;
9
7
  }
10
8
  export declare namespace ActivityDoesNotExist {
11
- /**
12
- * @internal
13
- */
9
+
14
10
  const filterSensitiveLog: (obj: ActivityDoesNotExist) => any;
15
11
  }
16
- /**
17
- * <p>Contains details about an activity that failed during an execution.</p>
18
- */
12
+
19
13
  export interface ActivityFailedEventDetails {
20
- /**
21
- * <p>The error code of the failure.</p>
22
- */
14
+
23
15
  error?: string;
24
- /**
25
- * <p>A more detailed explanation of the cause of the failure.</p>
26
- */
16
+
27
17
  cause?: string;
28
18
  }
29
19
  export declare namespace ActivityFailedEventDetails {
30
- /**
31
- * @internal
32
- */
20
+
33
21
  const filterSensitiveLog: (obj: ActivityFailedEventDetails) => any;
34
22
  }
35
- /**
36
- * <p>The maximum number of activities has been reached. Existing activities must be deleted
37
- * before a new activity can be created.</p>
38
- */
23
+
39
24
  export interface ActivityLimitExceeded extends __SmithyException, $MetadataBearer {
40
25
  name: "ActivityLimitExceeded";
41
26
  $fault: "client";
42
27
  message?: string;
43
28
  }
44
29
  export declare namespace ActivityLimitExceeded {
45
- /**
46
- * @internal
47
- */
30
+
48
31
  const filterSensitiveLog: (obj: ActivityLimitExceeded) => any;
49
32
  }
50
- /**
51
- * <p>Contains details about an activity.</p>
52
- */
33
+
53
34
  export interface ActivityListItem {
54
- /**
55
- * <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
56
- */
35
+
57
36
  activityArn: string | undefined;
58
- /**
59
- * <p>The name of the activity.</p>
60
- * <p>A name must <i>not</i> contain:</p>
61
- * <ul>
62
- * <li>
63
- * <p>white space</p>
64
- * </li>
65
- * <li>
66
- * <p>brackets <code>< > { } [ ]</code>
67
- * </p>
68
- * </li>
69
- * <li>
70
- * <p>wildcard characters <code>? *</code>
71
- * </p>
72
- * </li>
73
- * <li>
74
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
75
- * </p>
76
- * </li>
77
- * <li>
78
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
79
- * </li>
80
- * </ul>
81
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
82
- */
37
+
83
38
  name: string | undefined;
84
- /**
85
- * <p>The date the activity is created.</p>
86
- */
39
+
87
40
  creationDate: Date | undefined;
88
41
  }
89
42
  export declare namespace ActivityListItem {
90
- /**
91
- * @internal
92
- */
43
+
93
44
  const filterSensitiveLog: (obj: ActivityListItem) => any;
94
45
  }
95
- /**
96
- * <p>Provides details about input or output in an execution history event.</p>
97
- */
46
+
98
47
  export interface HistoryEventExecutionDataDetails {
99
- /**
100
- * <p>Indicates whether input or output was truncated in the response. Always
101
- * <code>false</code> for API calls.</p>
102
- */
48
+
103
49
  truncated?: boolean;
104
50
  }
105
51
  export declare namespace HistoryEventExecutionDataDetails {
106
- /**
107
- * @internal
108
- */
52
+
109
53
  const filterSensitiveLog: (obj: HistoryEventExecutionDataDetails) => any;
110
54
  }
111
- /**
112
- * <p>Contains details about an activity scheduled during an execution.</p>
113
- */
55
+
114
56
  export interface ActivityScheduledEventDetails {
115
- /**
116
- * <p>The Amazon Resource Name (ARN) of the scheduled activity.</p>
117
- */
57
+
118
58
  resource: string | undefined;
119
- /**
120
- * <p>The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
121
- */
59
+
122
60
  input?: string;
123
- /**
124
- * <p>Contains details about the input for an execution history event.</p>
125
- */
61
+
126
62
  inputDetails?: HistoryEventExecutionDataDetails;
127
- /**
128
- * <p>The maximum allowed duration of the activity task.</p>
129
- */
63
+
130
64
  timeoutInSeconds?: number;
131
- /**
132
- * <p>The maximum allowed duration between two heartbeats for the activity task.</p>
133
- */
65
+
134
66
  heartbeatInSeconds?: number;
135
67
  }
136
68
  export declare namespace ActivityScheduledEventDetails {
137
- /**
138
- * @internal
139
- */
69
+
140
70
  const filterSensitiveLog: (obj: ActivityScheduledEventDetails) => any;
141
71
  }
142
- /**
143
- * <p>Contains details about an activity schedule failure that occurred during an
144
- * execution.</p>
145
- */
72
+
146
73
  export interface ActivityScheduleFailedEventDetails {
147
- /**
148
- * <p>The error code of the failure.</p>
149
- */
74
+
150
75
  error?: string;
151
- /**
152
- * <p>A more detailed explanation of the cause of the failure.</p>
153
- */
76
+
154
77
  cause?: string;
155
78
  }
156
79
  export declare namespace ActivityScheduleFailedEventDetails {
157
- /**
158
- * @internal
159
- */
80
+
160
81
  const filterSensitiveLog: (obj: ActivityScheduleFailedEventDetails) => any;
161
82
  }
162
- /**
163
- * <p>Contains details about the start of an activity during an execution.</p>
164
- */
83
+
165
84
  export interface ActivityStartedEventDetails {
166
- /**
167
- * <p>The name of the worker that the task is assigned to. These names are provided by the
168
- * workers when calling <a>GetActivityTask</a>.</p>
169
- */
85
+
170
86
  workerName?: string;
171
87
  }
172
88
  export declare namespace ActivityStartedEventDetails {
173
- /**
174
- * @internal
175
- */
89
+
176
90
  const filterSensitiveLog: (obj: ActivityStartedEventDetails) => any;
177
91
  }
178
- /**
179
- * <p>Contains details about an activity that successfully terminated during an
180
- * execution.</p>
181
- */
92
+
182
93
  export interface ActivitySucceededEventDetails {
183
- /**
184
- * <p>The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
185
- */
94
+
186
95
  output?: string;
187
- /**
188
- * <p>Contains details about the output of an execution history event.</p>
189
- */
96
+
190
97
  outputDetails?: HistoryEventExecutionDataDetails;
191
98
  }
192
99
  export declare namespace ActivitySucceededEventDetails {
193
- /**
194
- * @internal
195
- */
100
+
196
101
  const filterSensitiveLog: (obj: ActivitySucceededEventDetails) => any;
197
102
  }
198
- /**
199
- * <p>Contains details about an activity timeout that occurred during an execution.</p>
200
- */
103
+
201
104
  export interface ActivityTimedOutEventDetails {
202
- /**
203
- * <p>The error code of the failure.</p>
204
- */
105
+
205
106
  error?: string;
206
- /**
207
- * <p>A more detailed explanation of the cause of the timeout.</p>
208
- */
107
+
209
108
  cause?: string;
210
109
  }
211
110
  export declare namespace ActivityTimedOutEventDetails {
212
- /**
213
- * @internal
214
- */
111
+
215
112
  const filterSensitiveLog: (obj: ActivityTimedOutEventDetails) => any;
216
113
  }
217
- /**
218
- * <p>The maximum number of workers concurrently polling for activity tasks has been
219
- * reached.</p>
220
- */
114
+
221
115
  export interface ActivityWorkerLimitExceeded extends __SmithyException, $MetadataBearer {
222
116
  name: "ActivityWorkerLimitExceeded";
223
117
  $fault: "client";
224
118
  message?: string;
225
119
  }
226
120
  export declare namespace ActivityWorkerLimitExceeded {
227
- /**
228
- * @internal
229
- */
121
+
230
122
  const filterSensitiveLog: (obj: ActivityWorkerLimitExceeded) => any;
231
123
  }
232
- /**
233
- * <p>Tags are key-value pairs that can be associated with Step Functions state machines and
234
- * activities.</p>
235
- * <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
236
- * Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User
237
- * Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
238
- * Tags</a>.</p>
239
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
240
- */
124
+
241
125
  export interface Tag {
242
- /**
243
- * <p>The key of a tag.</p>
244
- */
126
+
245
127
  key?: string;
246
- /**
247
- * <p>The value of a tag.</p>
248
- */
128
+
249
129
  value?: string;
250
130
  }
251
131
  export declare namespace Tag {
252
- /**
253
- * @internal
254
- */
132
+
255
133
  const filterSensitiveLog: (obj: Tag) => any;
256
134
  }
257
135
  export interface CreateActivityInput {
258
- /**
259
- * <p>The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information,
260
- * see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
261
- * Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p>
262
- * <p>A name must <i>not</i> contain:</p>
263
- * <ul>
264
- * <li>
265
- * <p>white space</p>
266
- * </li>
267
- * <li>
268
- * <p>brackets <code>< > { } [ ]</code>
269
- * </p>
270
- * </li>
271
- * <li>
272
- * <p>wildcard characters <code>? *</code>
273
- * </p>
274
- * </li>
275
- * <li>
276
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
277
- * </p>
278
- * </li>
279
- * <li>
280
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
281
- * </li>
282
- * </ul>
283
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
284
- */
136
+
285
137
  name: string | undefined;
286
- /**
287
- * <p>The list of tags to add to a resource.</p>
288
- * <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
289
- * Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User
290
- * Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
291
- * Tags</a>.</p>
292
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
293
- */
138
+
294
139
  tags?: Tag[];
295
140
  }
296
141
  export declare namespace CreateActivityInput {
297
- /**
298
- * @internal
299
- */
142
+
300
143
  const filterSensitiveLog: (obj: CreateActivityInput) => any;
301
144
  }
302
145
  export interface CreateActivityOutput {
303
- /**
304
- * <p>The Amazon Resource Name (ARN) that identifies the created activity.</p>
305
- */
146
+
306
147
  activityArn: string | undefined;
307
- /**
308
- * <p>The date the activity is created.</p>
309
- */
148
+
310
149
  creationDate: Date | undefined;
311
150
  }
312
151
  export declare namespace CreateActivityOutput {
313
- /**
314
- * @internal
315
- */
152
+
316
153
  const filterSensitiveLog: (obj: CreateActivityOutput) => any;
317
154
  }
318
- /**
319
- * <p>The provided name is invalid.</p>
320
- */
155
+
321
156
  export interface InvalidName extends __SmithyException, $MetadataBearer {
322
157
  name: "InvalidName";
323
158
  $fault: "client";
324
159
  message?: string;
325
160
  }
326
161
  export declare namespace InvalidName {
327
- /**
328
- * @internal
329
- */
162
+
330
163
  const filterSensitiveLog: (obj: InvalidName) => any;
331
164
  }
332
- /**
333
- * <p>You've exceeded the number of tags allowed for a resource. See the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html"> Limits Topic</a> in the
334
- * AWS Step Functions Developer Guide.</p>
335
- */
165
+
336
166
  export interface TooManyTags extends __SmithyException, $MetadataBearer {
337
167
  name: "TooManyTags";
338
168
  $fault: "client";
@@ -340,1698 +170,879 @@ export interface TooManyTags extends __SmithyException, $MetadataBearer {
340
170
  resourceName?: string;
341
171
  }
342
172
  export declare namespace TooManyTags {
343
- /**
344
- * @internal
345
- */
173
+
346
174
  const filterSensitiveLog: (obj: TooManyTags) => any;
347
175
  }
348
- /**
349
- * <p></p>
350
- */
176
+
351
177
  export interface CloudWatchLogsLogGroup {
352
- /**
353
- * <p>The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN
354
- * must end with <code>:*</code>
355
- * </p>
356
- */
178
+
357
179
  logGroupArn?: string;
358
180
  }
359
181
  export declare namespace CloudWatchLogsLogGroup {
360
- /**
361
- * @internal
362
- */
182
+
363
183
  const filterSensitiveLog: (obj: CloudWatchLogsLogGroup) => any;
364
184
  }
365
- /**
366
- * <p></p>
367
- */
185
+
368
186
  export interface LogDestination {
369
- /**
370
- * <p>An object describing a CloudWatch log group. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html">AWS::Logs::LogGroup</a> in the AWS CloudFormation User Guide.</p>
371
- */
187
+
372
188
  cloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
373
189
  }
374
190
  export declare namespace LogDestination {
375
- /**
376
- * @internal
377
- */
191
+
378
192
  const filterSensitiveLog: (obj: LogDestination) => any;
379
193
  }
380
194
  export declare type LogLevel = "ALL" | "ERROR" | "FATAL" | "OFF";
381
- /**
382
- * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
383
- * options.</p>
384
- */
195
+
385
196
  export interface LoggingConfiguration {
386
- /**
387
- * <p>Defines which category of execution history events are logged.</p>
388
- */
197
+
389
198
  level?: LogLevel | string;
390
- /**
391
- * <p>Determines whether execution data is included in your log. When set to <code>false</code>,
392
- * data is excluded.</p>
393
- */
199
+
394
200
  includeExecutionData?: boolean;
395
- /**
396
- * <p>An array of objects that describes where your execution history events will be logged.
397
- * Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</p>
398
- */
201
+
399
202
  destinations?: LogDestination[];
400
203
  }
401
204
  export declare namespace LoggingConfiguration {
402
- /**
403
- * @internal
404
- */
205
+
405
206
  const filterSensitiveLog: (obj: LoggingConfiguration) => any;
406
207
  }
407
- /**
408
- * <p>Selects whether or not the state machine's AWS X-Ray tracing is enabled. Default is <code>false</code>
409
- * </p>
410
- */
208
+
411
209
  export interface TracingConfiguration {
412
- /**
413
- * <p>When set to <code>true</code>, AWS X-Ray tracing is enabled.</p>
414
- */
210
+
415
211
  enabled?: boolean;
416
212
  }
417
213
  export declare namespace TracingConfiguration {
418
- /**
419
- * @internal
420
- */
214
+
421
215
  const filterSensitiveLog: (obj: TracingConfiguration) => any;
422
216
  }
423
217
  export declare type StateMachineType = "EXPRESS" | "STANDARD";
424
218
  export interface CreateStateMachineInput {
425
- /**
426
- * <p>The name of the state machine. </p>
427
- * <p>A name must <i>not</i> contain:</p>
428
- * <ul>
429
- * <li>
430
- * <p>white space</p>
431
- * </li>
432
- * <li>
433
- * <p>brackets <code>< > { } [ ]</code>
434
- * </p>
435
- * </li>
436
- * <li>
437
- * <p>wildcard characters <code>? *</code>
438
- * </p>
439
- * </li>
440
- * <li>
441
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
442
- * </p>
443
- * </li>
444
- * <li>
445
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
446
- * </li>
447
- * </ul>
448
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
449
- */
219
+
450
220
  name: string | undefined;
451
- /**
452
- * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
453
- */
221
+
454
222
  definition: string | undefined;
455
- /**
456
- * <p>The Amazon Resource Name (ARN) of the IAM role to use for this state machine.</p>
457
- */
223
+
458
224
  roleArn: string | undefined;
459
- /**
460
- * <p>Determines whether a Standard or Express state machine is created. The default is
461
- * <code>STANDARD</code>. You cannot update the <code>type</code> of a state machine once it
462
- * has been created.</p>
463
- */
225
+
464
226
  type?: StateMachineType | string;
465
- /**
466
- * <p>Defines what execution history events are logged and where they are logged.</p>
467
- * <note>
468
- * <p>By default, the <code>level</code> is set to <code>OFF</code>. For more information see
469
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html">Log
470
- * Levels</a> in the AWS Step Functions User Guide.</p>
471
- * </note>
472
- */
227
+
473
228
  loggingConfiguration?: LoggingConfiguration;
474
- /**
475
- * <p>Tags to be added when creating a state machine.</p>
476
- * <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
477
- * Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User
478
- * Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
479
- * Tags</a>.</p>
480
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
481
- */
229
+
482
230
  tags?: Tag[];
483
- /**
484
- * <p>Selects whether AWS X-Ray tracing is enabled.</p>
485
- */
231
+
486
232
  tracingConfiguration?: TracingConfiguration;
487
233
  }
488
234
  export declare namespace CreateStateMachineInput {
489
- /**
490
- * @internal
491
- */
235
+
492
236
  const filterSensitiveLog: (obj: CreateStateMachineInput) => any;
493
237
  }
494
238
  export interface CreateStateMachineOutput {
495
- /**
496
- * <p>The Amazon Resource Name (ARN) that identifies the created state machine.</p>
497
- */
239
+
498
240
  stateMachineArn: string | undefined;
499
- /**
500
- * <p>The date the state machine is created.</p>
501
- */
241
+
502
242
  creationDate: Date | undefined;
503
243
  }
504
244
  export declare namespace CreateStateMachineOutput {
505
- /**
506
- * @internal
507
- */
245
+
508
246
  const filterSensitiveLog: (obj: CreateStateMachineOutput) => any;
509
247
  }
510
- /**
511
- * <p>The provided Amazon Resource Name (ARN) is invalid.</p>
512
- */
248
+
513
249
  export interface InvalidArn extends __SmithyException, $MetadataBearer {
514
250
  name: "InvalidArn";
515
251
  $fault: "client";
516
252
  message?: string;
517
253
  }
518
254
  export declare namespace InvalidArn {
519
- /**
520
- * @internal
521
- */
255
+
522
256
  const filterSensitiveLog: (obj: InvalidArn) => any;
523
257
  }
524
- /**
525
- * <p>The provided Amazon States Language definition is invalid.</p>
526
- */
258
+
527
259
  export interface InvalidDefinition extends __SmithyException, $MetadataBearer {
528
260
  name: "InvalidDefinition";
529
261
  $fault: "client";
530
262
  message?: string;
531
263
  }
532
264
  export declare namespace InvalidDefinition {
533
- /**
534
- * @internal
535
- */
265
+
536
266
  const filterSensitiveLog: (obj: InvalidDefinition) => any;
537
267
  }
538
- /**
539
- * <p></p>
540
- */
268
+
541
269
  export interface InvalidLoggingConfiguration extends __SmithyException, $MetadataBearer {
542
270
  name: "InvalidLoggingConfiguration";
543
271
  $fault: "client";
544
272
  message?: string;
545
273
  }
546
274
  export declare namespace InvalidLoggingConfiguration {
547
- /**
548
- * @internal
549
- */
275
+
550
276
  const filterSensitiveLog: (obj: InvalidLoggingConfiguration) => any;
551
277
  }
552
- /**
553
- * <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not been set to <code>true</code> or <code>false</code>.</p>
554
- */
278
+
555
279
  export interface InvalidTracingConfiguration extends __SmithyException, $MetadataBearer {
556
280
  name: "InvalidTracingConfiguration";
557
281
  $fault: "client";
558
282
  message?: string;
559
283
  }
560
284
  export declare namespace InvalidTracingConfiguration {
561
- /**
562
- * @internal
563
- */
285
+
564
286
  const filterSensitiveLog: (obj: InvalidTracingConfiguration) => any;
565
287
  }
566
- /**
567
- * <p>A state machine with the same name but a different definition or role ARN already
568
- * exists.</p>
569
- */
288
+
570
289
  export interface StateMachineAlreadyExists extends __SmithyException, $MetadataBearer {
571
290
  name: "StateMachineAlreadyExists";
572
291
  $fault: "client";
573
292
  message?: string;
574
293
  }
575
294
  export declare namespace StateMachineAlreadyExists {
576
- /**
577
- * @internal
578
- */
295
+
579
296
  const filterSensitiveLog: (obj: StateMachineAlreadyExists) => any;
580
297
  }
581
- /**
582
- * <p>The specified state machine is being deleted.</p>
583
- */
298
+
584
299
  export interface StateMachineDeleting extends __SmithyException, $MetadataBearer {
585
300
  name: "StateMachineDeleting";
586
301
  $fault: "client";
587
302
  message?: string;
588
303
  }
589
304
  export declare namespace StateMachineDeleting {
590
- /**
591
- * @internal
592
- */
305
+
593
306
  const filterSensitiveLog: (obj: StateMachineDeleting) => any;
594
307
  }
595
- /**
596
- * <p>The maximum number of state machines has been reached. Existing state machines must be
597
- * deleted before a new state machine can be created.</p>
598
- */
308
+
599
309
  export interface StateMachineLimitExceeded extends __SmithyException, $MetadataBearer {
600
310
  name: "StateMachineLimitExceeded";
601
311
  $fault: "client";
602
312
  message?: string;
603
313
  }
604
314
  export declare namespace StateMachineLimitExceeded {
605
- /**
606
- * @internal
607
- */
315
+
608
316
  const filterSensitiveLog: (obj: StateMachineLimitExceeded) => any;
609
317
  }
610
- /**
611
- * <p></p>
612
- */
318
+
613
319
  export interface StateMachineTypeNotSupported extends __SmithyException, $MetadataBearer {
614
320
  name: "StateMachineTypeNotSupported";
615
321
  $fault: "client";
616
322
  message?: string;
617
323
  }
618
324
  export declare namespace StateMachineTypeNotSupported {
619
- /**
620
- * @internal
621
- */
325
+
622
326
  const filterSensitiveLog: (obj: StateMachineTypeNotSupported) => any;
623
327
  }
624
328
  export interface DeleteActivityInput {
625
- /**
626
- * <p>The Amazon Resource Name (ARN) of the activity to delete.</p>
627
- */
329
+
628
330
  activityArn: string | undefined;
629
331
  }
630
332
  export declare namespace DeleteActivityInput {
631
- /**
632
- * @internal
633
- */
333
+
634
334
  const filterSensitiveLog: (obj: DeleteActivityInput) => any;
635
335
  }
636
336
  export interface DeleteActivityOutput {
637
337
  }
638
338
  export declare namespace DeleteActivityOutput {
639
- /**
640
- * @internal
641
- */
339
+
642
340
  const filterSensitiveLog: (obj: DeleteActivityOutput) => any;
643
341
  }
644
342
  export interface DeleteStateMachineInput {
645
- /**
646
- * <p>The Amazon Resource Name (ARN) of the state machine to delete.</p>
647
- */
343
+
648
344
  stateMachineArn: string | undefined;
649
345
  }
650
346
  export declare namespace DeleteStateMachineInput {
651
- /**
652
- * @internal
653
- */
347
+
654
348
  const filterSensitiveLog: (obj: DeleteStateMachineInput) => any;
655
349
  }
656
350
  export interface DeleteStateMachineOutput {
657
351
  }
658
352
  export declare namespace DeleteStateMachineOutput {
659
- /**
660
- * @internal
661
- */
353
+
662
354
  const filterSensitiveLog: (obj: DeleteStateMachineOutput) => any;
663
355
  }
664
356
  export interface DescribeActivityInput {
665
- /**
666
- * <p>The Amazon Resource Name (ARN) of the activity to describe.</p>
667
- */
357
+
668
358
  activityArn: string | undefined;
669
359
  }
670
360
  export declare namespace DescribeActivityInput {
671
- /**
672
- * @internal
673
- */
361
+
674
362
  const filterSensitiveLog: (obj: DescribeActivityInput) => any;
675
363
  }
676
364
  export interface DescribeActivityOutput {
677
- /**
678
- * <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
679
- */
365
+
680
366
  activityArn: string | undefined;
681
- /**
682
- * <p>The name of the activity.</p>
683
- * <p>A name must <i>not</i> contain:</p>
684
- * <ul>
685
- * <li>
686
- * <p>white space</p>
687
- * </li>
688
- * <li>
689
- * <p>brackets <code>< > { } [ ]</code>
690
- * </p>
691
- * </li>
692
- * <li>
693
- * <p>wildcard characters <code>? *</code>
694
- * </p>
695
- * </li>
696
- * <li>
697
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
698
- * </p>
699
- * </li>
700
- * <li>
701
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
702
- * </li>
703
- * </ul>
704
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
705
- */
367
+
706
368
  name: string | undefined;
707
- /**
708
- * <p>The date the activity is created.</p>
709
- */
369
+
710
370
  creationDate: Date | undefined;
711
371
  }
712
372
  export declare namespace DescribeActivityOutput {
713
- /**
714
- * @internal
715
- */
373
+
716
374
  const filterSensitiveLog: (obj: DescribeActivityOutput) => any;
717
375
  }
718
376
  export interface DescribeExecutionInput {
719
- /**
720
- * <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
721
- */
377
+
722
378
  executionArn: string | undefined;
723
379
  }
724
380
  export declare namespace DescribeExecutionInput {
725
- /**
726
- * @internal
727
- */
381
+
728
382
  const filterSensitiveLog: (obj: DescribeExecutionInput) => any;
729
383
  }
730
- /**
731
- * <p>Provides details about execution input or output.</p>
732
- */
384
+
733
385
  export interface CloudWatchEventsExecutionDataDetails {
734
- /**
735
- * <p>Indicates whether input or output was included in the response. Always <code>true</code>
736
- * for API calls. </p>
737
- */
386
+
738
387
  included?: boolean;
739
388
  }
740
389
  export declare namespace CloudWatchEventsExecutionDataDetails {
741
- /**
742
- * @internal
743
- */
390
+
744
391
  const filterSensitiveLog: (obj: CloudWatchEventsExecutionDataDetails) => any;
745
392
  }
746
393
  export declare type ExecutionStatus = "ABORTED" | "FAILED" | "RUNNING" | "SUCCEEDED" | "TIMED_OUT";
747
394
  export interface DescribeExecutionOutput {
748
- /**
749
- * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
750
- */
395
+
751
396
  executionArn: string | undefined;
752
- /**
753
- * <p>The Amazon Resource Name (ARN) of the executed stated machine.</p>
754
- */
397
+
755
398
  stateMachineArn: string | undefined;
756
- /**
757
- * <p>The name of the execution.</p>
758
- * <p>A name must <i>not</i> contain:</p>
759
- * <ul>
760
- * <li>
761
- * <p>white space</p>
762
- * </li>
763
- * <li>
764
- * <p>brackets <code>< > { } [ ]</code>
765
- * </p>
766
- * </li>
767
- * <li>
768
- * <p>wildcard characters <code>? *</code>
769
- * </p>
770
- * </li>
771
- * <li>
772
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
773
- * </p>
774
- * </li>
775
- * <li>
776
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
777
- * </li>
778
- * </ul>
779
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
780
- */
399
+
781
400
  name?: string;
782
- /**
783
- * <p>The current status of the execution.</p>
784
- */
401
+
785
402
  status: ExecutionStatus | string | undefined;
786
- /**
787
- * <p>The date the execution is started.</p>
788
- */
403
+
789
404
  startDate: Date | undefined;
790
- /**
791
- * <p>If the execution has already ended, the date the execution stopped.</p>
792
- */
405
+
793
406
  stopDate?: Date;
794
- /**
795
- * <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
796
- */
407
+
797
408
  input?: string;
798
- /**
799
- * <p>Provides details about execution input or output.</p>
800
- */
409
+
801
410
  inputDetails?: CloudWatchEventsExecutionDataDetails;
802
- /**
803
- * <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
804
- * <note>
805
- * <p>This field is set only if the execution succeeds. If the execution fails, this field is
806
- * null.</p>
807
- * </note>
808
- */
411
+
809
412
  output?: string;
810
- /**
811
- * <p>Provides details about execution input or output.</p>
812
- */
413
+
813
414
  outputDetails?: CloudWatchEventsExecutionDataDetails;
814
- /**
815
- * <p>The AWS X-Ray trace header that was passed to the execution.</p>
816
- */
415
+
817
416
  traceHeader?: string;
818
417
  }
819
418
  export declare namespace DescribeExecutionOutput {
820
- /**
821
- * @internal
822
- */
419
+
823
420
  const filterSensitiveLog: (obj: DescribeExecutionOutput) => any;
824
421
  }
825
- /**
826
- * <p>The specified execution does not exist.</p>
827
- */
422
+
828
423
  export interface ExecutionDoesNotExist extends __SmithyException, $MetadataBearer {
829
424
  name: "ExecutionDoesNotExist";
830
425
  $fault: "client";
831
426
  message?: string;
832
427
  }
833
428
  export declare namespace ExecutionDoesNotExist {
834
- /**
835
- * @internal
836
- */
429
+
837
430
  const filterSensitiveLog: (obj: ExecutionDoesNotExist) => any;
838
431
  }
839
432
  export interface DescribeStateMachineInput {
840
- /**
841
- * <p>The Amazon Resource Name (ARN) of the state machine to describe.</p>
842
- */
433
+
843
434
  stateMachineArn: string | undefined;
844
435
  }
845
436
  export declare namespace DescribeStateMachineInput {
846
- /**
847
- * @internal
848
- */
437
+
849
438
  const filterSensitiveLog: (obj: DescribeStateMachineInput) => any;
850
439
  }
851
440
  export declare type StateMachineStatus = "ACTIVE" | "DELETING";
852
441
  export interface DescribeStateMachineOutput {
853
- /**
854
- * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
855
- */
442
+
856
443
  stateMachineArn: string | undefined;
857
- /**
858
- * <p>The name of the state machine.</p>
859
- * <p>A name must <i>not</i> contain:</p>
860
- * <ul>
861
- * <li>
862
- * <p>white space</p>
863
- * </li>
864
- * <li>
865
- * <p>brackets <code>< > { } [ ]</code>
866
- * </p>
867
- * </li>
868
- * <li>
869
- * <p>wildcard characters <code>? *</code>
870
- * </p>
871
- * </li>
872
- * <li>
873
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
874
- * </p>
875
- * </li>
876
- * <li>
877
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
878
- * </li>
879
- * </ul>
880
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
881
- */
444
+
882
445
  name: string | undefined;
883
- /**
884
- * <p>The current status of the state machine.</p>
885
- */
446
+
886
447
  status?: StateMachineStatus | string;
887
- /**
888
- * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
889
- */
448
+
890
449
  definition: string | undefined;
891
- /**
892
- * <p>The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role
893
- * maintains security by granting Step Functions access to AWS resources.)</p>
894
- */
450
+
895
451
  roleArn: string | undefined;
896
- /**
897
- * <p>The <code>type</code> of the state machine (<code>STANDARD</code> or
898
- * <code>EXPRESS</code>).</p>
899
- */
452
+
900
453
  type: StateMachineType | string | undefined;
901
- /**
902
- * <p>The date the state machine is created.</p>
903
- */
454
+
904
455
  creationDate: Date | undefined;
905
- /**
906
- * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
907
- * options.</p>
908
- */
456
+
909
457
  loggingConfiguration?: LoggingConfiguration;
910
- /**
911
- * <p>Selects whether AWS X-Ray tracing is enabled.</p>
912
- */
458
+
913
459
  tracingConfiguration?: TracingConfiguration;
914
460
  }
915
461
  export declare namespace DescribeStateMachineOutput {
916
- /**
917
- * @internal
918
- */
462
+
919
463
  const filterSensitiveLog: (obj: DescribeStateMachineOutput) => any;
920
464
  }
921
- /**
922
- * <p>The specified state machine does not exist.</p>
923
- */
465
+
924
466
  export interface StateMachineDoesNotExist extends __SmithyException, $MetadataBearer {
925
467
  name: "StateMachineDoesNotExist";
926
468
  $fault: "client";
927
469
  message?: string;
928
470
  }
929
471
  export declare namespace StateMachineDoesNotExist {
930
- /**
931
- * @internal
932
- */
472
+
933
473
  const filterSensitiveLog: (obj: StateMachineDoesNotExist) => any;
934
474
  }
935
475
  export interface DescribeStateMachineForExecutionInput {
936
- /**
937
- * <p>The Amazon Resource Name (ARN) of the execution you want state machine information for.</p>
938
- */
476
+
939
477
  executionArn: string | undefined;
940
478
  }
941
479
  export declare namespace DescribeStateMachineForExecutionInput {
942
- /**
943
- * @internal
944
- */
480
+
945
481
  const filterSensitiveLog: (obj: DescribeStateMachineForExecutionInput) => any;
946
482
  }
947
483
  export interface DescribeStateMachineForExecutionOutput {
948
- /**
949
- * <p>The Amazon Resource Name (ARN) of the state machine associated with the execution.</p>
950
- */
484
+
951
485
  stateMachineArn: string | undefined;
952
- /**
953
- * <p>The name of the state machine associated with the execution.</p>
954
- */
486
+
955
487
  name: string | undefined;
956
- /**
957
- * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
958
- */
488
+
959
489
  definition: string | undefined;
960
- /**
961
- * <p>The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. </p>
962
- */
490
+
963
491
  roleArn: string | undefined;
964
- /**
965
- * <p>The date and time the state machine associated with an execution was updated. For a newly
966
- * created state machine, this is the creation date.</p>
967
- */
492
+
968
493
  updateDate: Date | undefined;
969
- /**
970
- * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
971
- * options.</p>
972
- */
494
+
973
495
  loggingConfiguration?: LoggingConfiguration;
974
- /**
975
- * <p>Selects whether AWS X-Ray tracing is enabled.</p>
976
- */
496
+
977
497
  tracingConfiguration?: TracingConfiguration;
978
498
  }
979
499
  export declare namespace DescribeStateMachineForExecutionOutput {
980
- /**
981
- * @internal
982
- */
500
+
983
501
  const filterSensitiveLog: (obj: DescribeStateMachineForExecutionOutput) => any;
984
502
  }
985
503
  export interface GetActivityTaskInput {
986
- /**
987
- * <p>The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task
988
- * using <a>CreateActivity</a>.)</p>
989
- */
504
+
990
505
  activityArn: string | undefined;
991
- /**
992
- * <p>You can provide an arbitrary name in order to identify the worker that the task is
993
- * assigned to. This name is used when it is logged in the execution history.</p>
994
- */
506
+
995
507
  workerName?: string;
996
508
  }
997
509
  export declare namespace GetActivityTaskInput {
998
- /**
999
- * @internal
1000
- */
510
+
1001
511
  const filterSensitiveLog: (obj: GetActivityTaskInput) => any;
1002
512
  }
1003
513
  export interface GetActivityTaskOutput {
1004
- /**
1005
- * <p>A token that identifies the scheduled task. This token must be copied and included in
1006
- * subsequent calls to <a>SendTaskHeartbeat</a>, <a>SendTaskSuccess</a> or
1007
- * <a>SendTaskFailure</a> in order to report the progress or completion of the
1008
- * task.</p>
1009
- */
514
+
1010
515
  taskToken?: string;
1011
- /**
1012
- * <p>The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1013
- */
516
+
1014
517
  input?: string;
1015
518
  }
1016
519
  export declare namespace GetActivityTaskOutput {
1017
- /**
1018
- * @internal
1019
- */
520
+
1020
521
  const filterSensitiveLog: (obj: GetActivityTaskOutput) => any;
1021
522
  }
1022
523
  export interface GetExecutionHistoryInput {
1023
- /**
1024
- * <p>The Amazon Resource Name (ARN) of the execution.</p>
1025
- */
524
+
1026
525
  executionArn: string | undefined;
1027
- /**
1028
- * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
1029
- * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
1030
- * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
1031
- */
526
+
1032
527
  maxResults?: number;
1033
- /**
1034
- * <p>Lists events in descending order of their <code>timeStamp</code>.</p>
1035
- */
528
+
1036
529
  reverseOrder?: boolean;
1037
- /**
1038
- * <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.
1039
- * 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>
1040
- */
530
+
1041
531
  nextToken?: string;
1042
- /**
1043
- * <p>You can select whether execution data (input or output of a history event) is returned.
1044
- * The default is <code>true</code>.</p>
1045
- */
532
+
1046
533
  includeExecutionData?: boolean;
1047
534
  }
1048
535
  export declare namespace GetExecutionHistoryInput {
1049
- /**
1050
- * @internal
1051
- */
536
+
1052
537
  const filterSensitiveLog: (obj: GetExecutionHistoryInput) => any;
1053
538
  }
1054
- /**
1055
- * <p>Contains details about an abort of an execution.</p>
1056
- */
539
+
1057
540
  export interface ExecutionAbortedEventDetails {
1058
- /**
1059
- * <p>The error code of the failure.</p>
1060
- */
541
+
1061
542
  error?: string;
1062
- /**
1063
- * <p>A more detailed explanation of the cause of the failure.</p>
1064
- */
543
+
1065
544
  cause?: string;
1066
545
  }
1067
546
  export declare namespace ExecutionAbortedEventDetails {
1068
- /**
1069
- * @internal
1070
- */
547
+
1071
548
  const filterSensitiveLog: (obj: ExecutionAbortedEventDetails) => any;
1072
549
  }
1073
- /**
1074
- * <p>Contains details about an execution failure event.</p>
1075
- */
550
+
1076
551
  export interface ExecutionFailedEventDetails {
1077
- /**
1078
- * <p>The error code of the failure.</p>
1079
- */
552
+
1080
553
  error?: string;
1081
- /**
1082
- * <p>A more detailed explanation of the cause of the failure.</p>
1083
- */
554
+
1084
555
  cause?: string;
1085
556
  }
1086
557
  export declare namespace ExecutionFailedEventDetails {
1087
- /**
1088
- * @internal
1089
- */
558
+
1090
559
  const filterSensitiveLog: (obj: ExecutionFailedEventDetails) => any;
1091
560
  }
1092
- /**
1093
- * <p>Contains details about the start of the execution.</p>
1094
- */
561
+
1095
562
  export interface ExecutionStartedEventDetails {
1096
- /**
1097
- * <p>The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1098
- */
563
+
1099
564
  input?: string;
1100
- /**
1101
- * <p>Contains details about the input for an execution history event.</p>
1102
- */
565
+
1103
566
  inputDetails?: HistoryEventExecutionDataDetails;
1104
- /**
1105
- * <p>The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.</p>
1106
- */
567
+
1107
568
  roleArn?: string;
1108
569
  }
1109
570
  export declare namespace ExecutionStartedEventDetails {
1110
- /**
1111
- * @internal
1112
- */
571
+
1113
572
  const filterSensitiveLog: (obj: ExecutionStartedEventDetails) => any;
1114
573
  }
1115
- /**
1116
- * <p>Contains details about the successful termination of the execution.</p>
1117
- */
574
+
1118
575
  export interface ExecutionSucceededEventDetails {
1119
- /**
1120
- * <p>The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1121
- */
576
+
1122
577
  output?: string;
1123
- /**
1124
- * <p>Contains details about the output of an execution history event.</p>
1125
- */
578
+
1126
579
  outputDetails?: HistoryEventExecutionDataDetails;
1127
580
  }
1128
581
  export declare namespace ExecutionSucceededEventDetails {
1129
- /**
1130
- * @internal
1131
- */
582
+
1132
583
  const filterSensitiveLog: (obj: ExecutionSucceededEventDetails) => any;
1133
584
  }
1134
- /**
1135
- * <p>Contains details about the execution timeout that occurred during the execution.</p>
1136
- */
585
+
1137
586
  export interface ExecutionTimedOutEventDetails {
1138
- /**
1139
- * <p>The error code of the failure.</p>
1140
- */
587
+
1141
588
  error?: string;
1142
- /**
1143
- * <p>A more detailed explanation of the cause of the timeout.</p>
1144
- */
589
+
1145
590
  cause?: string;
1146
591
  }
1147
592
  export declare namespace ExecutionTimedOutEventDetails {
1148
- /**
1149
- * @internal
1150
- */
593
+
1151
594
  const filterSensitiveLog: (obj: ExecutionTimedOutEventDetails) => any;
1152
595
  }
1153
- /**
1154
- * <p>Contains details about a lambda function that failed during an execution.</p>
1155
- */
596
+
1156
597
  export interface LambdaFunctionFailedEventDetails {
1157
- /**
1158
- * <p>The error code of the failure.</p>
1159
- */
598
+
1160
599
  error?: string;
1161
- /**
1162
- * <p>A more detailed explanation of the cause of the failure.</p>
1163
- */
600
+
1164
601
  cause?: string;
1165
602
  }
1166
603
  export declare namespace LambdaFunctionFailedEventDetails {
1167
- /**
1168
- * @internal
1169
- */
604
+
1170
605
  const filterSensitiveLog: (obj: LambdaFunctionFailedEventDetails) => any;
1171
606
  }
1172
- /**
1173
- * <p>Contains details about a lambda function scheduled during an execution.</p>
1174
- */
607
+
1175
608
  export interface LambdaFunctionScheduledEventDetails {
1176
- /**
1177
- * <p>The Amazon Resource Name (ARN) of the scheduled lambda function.</p>
1178
- */
609
+
1179
610
  resource: string | undefined;
1180
- /**
1181
- * <p>The JSON data input to the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1182
- */
611
+
1183
612
  input?: string;
1184
- /**
1185
- * <p>Contains details about input for an execution history event.</p>
1186
- */
613
+
1187
614
  inputDetails?: HistoryEventExecutionDataDetails;
1188
- /**
1189
- * <p>The maximum allowed duration of the lambda function.</p>
1190
- */
615
+
1191
616
  timeoutInSeconds?: number;
1192
617
  }
1193
618
  export declare namespace LambdaFunctionScheduledEventDetails {
1194
- /**
1195
- * @internal
1196
- */
619
+
1197
620
  const filterSensitiveLog: (obj: LambdaFunctionScheduledEventDetails) => any;
1198
621
  }
1199
- /**
1200
- * <p>Contains details about a failed lambda function schedule event that occurred during an
1201
- * execution.</p>
1202
- */
622
+
1203
623
  export interface LambdaFunctionScheduleFailedEventDetails {
1204
- /**
1205
- * <p>The error code of the failure.</p>
1206
- */
624
+
1207
625
  error?: string;
1208
- /**
1209
- * <p>A more detailed explanation of the cause of the failure.</p>
1210
- */
626
+
1211
627
  cause?: string;
1212
628
  }
1213
629
  export declare namespace LambdaFunctionScheduleFailedEventDetails {
1214
- /**
1215
- * @internal
1216
- */
630
+
1217
631
  const filterSensitiveLog: (obj: LambdaFunctionScheduleFailedEventDetails) => any;
1218
632
  }
1219
- /**
1220
- * <p>Contains details about a lambda function that failed to start during an execution.</p>
1221
- */
633
+
1222
634
  export interface LambdaFunctionStartFailedEventDetails {
1223
- /**
1224
- * <p>The error code of the failure.</p>
1225
- */
635
+
1226
636
  error?: string;
1227
- /**
1228
- * <p>A more detailed explanation of the cause of the failure.</p>
1229
- */
637
+
1230
638
  cause?: string;
1231
639
  }
1232
640
  export declare namespace LambdaFunctionStartFailedEventDetails {
1233
- /**
1234
- * @internal
1235
- */
641
+
1236
642
  const filterSensitiveLog: (obj: LambdaFunctionStartFailedEventDetails) => any;
1237
643
  }
1238
- /**
1239
- * <p>Contains details about a lambda function that successfully terminated during an
1240
- * execution.</p>
1241
- */
644
+
1242
645
  export interface LambdaFunctionSucceededEventDetails {
1243
- /**
1244
- * <p>The JSON data output by the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1245
- */
646
+
1246
647
  output?: string;
1247
- /**
1248
- * <p>Contains details about the output of an execution history event.</p>
1249
- */
648
+
1250
649
  outputDetails?: HistoryEventExecutionDataDetails;
1251
650
  }
1252
651
  export declare namespace LambdaFunctionSucceededEventDetails {
1253
- /**
1254
- * @internal
1255
- */
652
+
1256
653
  const filterSensitiveLog: (obj: LambdaFunctionSucceededEventDetails) => any;
1257
654
  }
1258
- /**
1259
- * <p>Contains details about a lambda function timeout that occurred during an execution.</p>
1260
- */
655
+
1261
656
  export interface LambdaFunctionTimedOutEventDetails {
1262
- /**
1263
- * <p>The error code of the failure.</p>
1264
- */
657
+
1265
658
  error?: string;
1266
- /**
1267
- * <p>A more detailed explanation of the cause of the timeout.</p>
1268
- */
659
+
1269
660
  cause?: string;
1270
661
  }
1271
662
  export declare namespace LambdaFunctionTimedOutEventDetails {
1272
- /**
1273
- * @internal
1274
- */
663
+
1275
664
  const filterSensitiveLog: (obj: LambdaFunctionTimedOutEventDetails) => any;
1276
665
  }
1277
- /**
1278
- * <p>Contains details about an iteration of a Map state.</p>
1279
- */
666
+
1280
667
  export interface MapIterationEventDetails {
1281
- /**
1282
- * <p>The name of the iteration’s parent Map state.</p>
1283
- */
668
+
1284
669
  name?: string;
1285
- /**
1286
- * <p>The index of the array belonging to the Map state iteration.</p>
1287
- */
670
+
1288
671
  index?: number;
1289
672
  }
1290
673
  export declare namespace MapIterationEventDetails {
1291
- /**
1292
- * @internal
1293
- */
674
+
1294
675
  const filterSensitiveLog: (obj: MapIterationEventDetails) => any;
1295
676
  }
1296
- /**
1297
- * <p>Details about a Map state that was started.</p>
1298
- */
677
+
1299
678
  export interface MapStateStartedEventDetails {
1300
- /**
1301
- * <p>The size of the array for Map state iterations.</p>
1302
- */
679
+
1303
680
  length?: number;
1304
681
  }
1305
682
  export declare namespace MapStateStartedEventDetails {
1306
- /**
1307
- * @internal
1308
- */
683
+
1309
684
  const filterSensitiveLog: (obj: MapStateStartedEventDetails) => any;
1310
685
  }
1311
- /**
1312
- * <p>Contains details about a state entered during an execution.</p>
1313
- */
686
+
1314
687
  export interface StateEnteredEventDetails {
1315
- /**
1316
- * <p>The name of the state.</p>
1317
- */
688
+
1318
689
  name: string | undefined;
1319
- /**
1320
- * <p>The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1321
- */
690
+
1322
691
  input?: string;
1323
- /**
1324
- * <p>Contains details about the input for an execution history event.</p>
1325
- */
692
+
1326
693
  inputDetails?: HistoryEventExecutionDataDetails;
1327
694
  }
1328
695
  export declare namespace StateEnteredEventDetails {
1329
- /**
1330
- * @internal
1331
- */
696
+
1332
697
  const filterSensitiveLog: (obj: StateEnteredEventDetails) => any;
1333
698
  }
1334
- /**
1335
- * <p>Contains details about an exit from a state during an execution.</p>
1336
- */
699
+
1337
700
  export interface StateExitedEventDetails {
1338
- /**
1339
- * <p>The name of the state.</p>
1340
- * <p>A name must <i>not</i> contain:</p>
1341
- * <ul>
1342
- * <li>
1343
- * <p>white space</p>
1344
- * </li>
1345
- * <li>
1346
- * <p>brackets <code>< > { } [ ]</code>
1347
- * </p>
1348
- * </li>
1349
- * <li>
1350
- * <p>wildcard characters <code>? *</code>
1351
- * </p>
1352
- * </li>
1353
- * <li>
1354
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
1355
- * </p>
1356
- * </li>
1357
- * <li>
1358
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
1359
- * </li>
1360
- * </ul>
1361
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
1362
- */
701
+
1363
702
  name: string | undefined;
1364
- /**
1365
- * <p>The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1366
- */
703
+
1367
704
  output?: string;
1368
- /**
1369
- * <p>Contains details about the output of an execution history event.</p>
1370
- */
705
+
1371
706
  outputDetails?: HistoryEventExecutionDataDetails;
1372
707
  }
1373
708
  export declare namespace StateExitedEventDetails {
1374
- /**
1375
- * @internal
1376
- */
709
+
1377
710
  const filterSensitiveLog: (obj: StateExitedEventDetails) => any;
1378
711
  }
1379
- /**
1380
- * <p>Contains details about a task failure event.</p>
1381
- */
712
+
1382
713
  export interface TaskFailedEventDetails {
1383
- /**
1384
- * <p>The action of the resource called by a task state.</p>
1385
- */
714
+
1386
715
  resourceType: string | undefined;
1387
- /**
1388
- * <p>The service name of the resource in a task state.</p>
1389
- */
716
+
1390
717
  resource: string | undefined;
1391
- /**
1392
- * <p>The error code of the failure.</p>
1393
- */
718
+
1394
719
  error?: string;
1395
- /**
1396
- * <p>A more detailed explanation of the cause of the failure.</p>
1397
- */
720
+
1398
721
  cause?: string;
1399
722
  }
1400
723
  export declare namespace TaskFailedEventDetails {
1401
- /**
1402
- * @internal
1403
- */
724
+
1404
725
  const filterSensitiveLog: (obj: TaskFailedEventDetails) => any;
1405
726
  }
1406
- /**
1407
- * <p>Contains details about a task scheduled during an execution.</p>
1408
- */
727
+
1409
728
  export interface TaskScheduledEventDetails {
1410
- /**
1411
- * <p>The action of the resource called by a task state.</p>
1412
- */
729
+
1413
730
  resourceType: string | undefined;
1414
- /**
1415
- * <p>The service name of the resource in a task state.</p>
1416
- */
731
+
1417
732
  resource: string | undefined;
1418
- /**
1419
- * <p>The region of the scheduled task</p>
1420
- */
733
+
1421
734
  region: string | undefined;
1422
- /**
1423
- * <p>The JSON data passed to the resource referenced in a task state.
1424
- * Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1425
- */
735
+
1426
736
  parameters: string | undefined;
1427
- /**
1428
- * <p>The maximum allowed duration of the task.</p>
1429
- */
737
+
1430
738
  timeoutInSeconds?: number;
1431
- /**
1432
- * <p>The maximum allowed duration between two heartbeats for the task.</p>
1433
- */
739
+
1434
740
  heartbeatInSeconds?: number;
1435
741
  }
1436
742
  export declare namespace TaskScheduledEventDetails {
1437
- /**
1438
- * @internal
1439
- */
743
+
1440
744
  const filterSensitiveLog: (obj: TaskScheduledEventDetails) => any;
1441
745
  }
1442
- /**
1443
- * <p>Contains details about the start of a task during an execution.</p>
1444
- */
746
+
1445
747
  export interface TaskStartedEventDetails {
1446
- /**
1447
- * <p>The action of the resource called by a task state.</p>
1448
- */
748
+
1449
749
  resourceType: string | undefined;
1450
- /**
1451
- * <p>The service name of the resource in a task state.</p>
1452
- */
750
+
1453
751
  resource: string | undefined;
1454
752
  }
1455
753
  export declare namespace TaskStartedEventDetails {
1456
- /**
1457
- * @internal
1458
- */
754
+
1459
755
  const filterSensitiveLog: (obj: TaskStartedEventDetails) => any;
1460
756
  }
1461
- /**
1462
- * <p>Contains details about a task that failed to start during an execution.</p>
1463
- */
757
+
1464
758
  export interface TaskStartFailedEventDetails {
1465
- /**
1466
- * <p>The action of the resource called by a task state.</p>
1467
- */
759
+
1468
760
  resourceType: string | undefined;
1469
- /**
1470
- * <p>The service name of the resource in a task state.</p>
1471
- */
761
+
1472
762
  resource: string | undefined;
1473
- /**
1474
- * <p>The error code of the failure.</p>
1475
- */
763
+
1476
764
  error?: string;
1477
- /**
1478
- * <p>A more detailed explanation of the cause of the failure.</p>
1479
- */
765
+
1480
766
  cause?: string;
1481
767
  }
1482
768
  export declare namespace TaskStartFailedEventDetails {
1483
- /**
1484
- * @internal
1485
- */
769
+
1486
770
  const filterSensitiveLog: (obj: TaskStartFailedEventDetails) => any;
1487
771
  }
1488
- /**
1489
- * <p>Contains details about a task that failed to submit during an execution.</p>
1490
- */
772
+
1491
773
  export interface TaskSubmitFailedEventDetails {
1492
- /**
1493
- * <p>The action of the resource called by a task state.</p>
1494
- */
774
+
1495
775
  resourceType: string | undefined;
1496
- /**
1497
- * <p>The service name of the resource in a task state.</p>
1498
- */
776
+
1499
777
  resource: string | undefined;
1500
- /**
1501
- * <p>The error code of the failure.</p>
1502
- */
778
+
1503
779
  error?: string;
1504
- /**
1505
- * <p>A more detailed explanation of the cause of the failure.</p>
1506
- */
780
+
1507
781
  cause?: string;
1508
782
  }
1509
783
  export declare namespace TaskSubmitFailedEventDetails {
1510
- /**
1511
- * @internal
1512
- */
784
+
1513
785
  const filterSensitiveLog: (obj: TaskSubmitFailedEventDetails) => any;
1514
786
  }
1515
- /**
1516
- * <p>Contains details about a task submitted to a resource .</p>
1517
- */
787
+
1518
788
  export interface TaskSubmittedEventDetails {
1519
- /**
1520
- * <p>The action of the resource called by a task state.</p>
1521
- */
789
+
1522
790
  resourceType: string | undefined;
1523
- /**
1524
- * <p>The service name of the resource in a task state.</p>
1525
- */
791
+
1526
792
  resource: string | undefined;
1527
- /**
1528
- * <p>The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1529
- */
793
+
1530
794
  output?: string;
1531
- /**
1532
- * <p>Contains details about the output of an execution history event.</p>
1533
- */
795
+
1534
796
  outputDetails?: HistoryEventExecutionDataDetails;
1535
797
  }
1536
798
  export declare namespace TaskSubmittedEventDetails {
1537
- /**
1538
- * @internal
1539
- */
799
+
1540
800
  const filterSensitiveLog: (obj: TaskSubmittedEventDetails) => any;
1541
801
  }
1542
- /**
1543
- * <p>Contains details about the successful completion of a task state.</p>
1544
- */
802
+
1545
803
  export interface TaskSucceededEventDetails {
1546
- /**
1547
- * <p>The action of the resource called by a task state.</p>
1548
- */
804
+
1549
805
  resourceType: string | undefined;
1550
- /**
1551
- * <p>The service name of the resource in a task state.</p>
1552
- */
806
+
1553
807
  resource: string | undefined;
1554
- /**
1555
- * <p>The full JSON response from a resource when a task has succeeded. This response becomes
1556
- * the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
1557
- */
808
+
1558
809
  output?: string;
1559
- /**
1560
- * <p>Contains details about the output of an execution history event.</p>
1561
- */
810
+
1562
811
  outputDetails?: HistoryEventExecutionDataDetails;
1563
812
  }
1564
813
  export declare namespace TaskSucceededEventDetails {
1565
- /**
1566
- * @internal
1567
- */
814
+
1568
815
  const filterSensitiveLog: (obj: TaskSucceededEventDetails) => any;
1569
816
  }
1570
- /**
1571
- * <p>Contains details about a resource timeout that occurred during an execution.</p>
1572
- */
817
+
1573
818
  export interface TaskTimedOutEventDetails {
1574
- /**
1575
- * <p>The action of the resource called by a task state.</p>
1576
- */
819
+
1577
820
  resourceType: string | undefined;
1578
- /**
1579
- * <p>The service name of the resource in a task state.</p>
1580
- */
821
+
1581
822
  resource: string | undefined;
1582
- /**
1583
- * <p>The error code of the failure.</p>
1584
- */
823
+
1585
824
  error?: string;
1586
- /**
1587
- * <p>A more detailed explanation of the cause of the failure.</p>
1588
- */
825
+
1589
826
  cause?: string;
1590
827
  }
1591
828
  export declare namespace TaskTimedOutEventDetails {
1592
- /**
1593
- * @internal
1594
- */
829
+
1595
830
  const filterSensitiveLog: (obj: TaskTimedOutEventDetails) => any;
1596
831
  }
1597
832
  export declare type HistoryEventType = "ActivityFailed" | "ActivityScheduleFailed" | "ActivityScheduled" | "ActivityStarted" | "ActivitySucceeded" | "ActivityTimedOut" | "ChoiceStateEntered" | "ChoiceStateExited" | "ExecutionAborted" | "ExecutionFailed" | "ExecutionStarted" | "ExecutionSucceeded" | "ExecutionTimedOut" | "FailStateEntered" | "LambdaFunctionFailed" | "LambdaFunctionScheduleFailed" | "LambdaFunctionScheduled" | "LambdaFunctionStartFailed" | "LambdaFunctionStarted" | "LambdaFunctionSucceeded" | "LambdaFunctionTimedOut" | "MapIterationAborted" | "MapIterationFailed" | "MapIterationStarted" | "MapIterationSucceeded" | "MapStateAborted" | "MapStateEntered" | "MapStateExited" | "MapStateFailed" | "MapStateStarted" | "MapStateSucceeded" | "ParallelStateAborted" | "ParallelStateEntered" | "ParallelStateExited" | "ParallelStateFailed" | "ParallelStateStarted" | "ParallelStateSucceeded" | "PassStateEntered" | "PassStateExited" | "SucceedStateEntered" | "SucceedStateExited" | "TaskFailed" | "TaskScheduled" | "TaskStartFailed" | "TaskStarted" | "TaskStateAborted" | "TaskStateEntered" | "TaskStateExited" | "TaskSubmitFailed" | "TaskSubmitted" | "TaskSucceeded" | "TaskTimedOut" | "WaitStateAborted" | "WaitStateEntered" | "WaitStateExited";
1598
- /**
1599
- * <p>Contains details about the events of an execution.</p>
1600
- */
833
+
1601
834
  export interface HistoryEvent {
1602
- /**
1603
- * <p>The date and time the event occurred.</p>
1604
- */
835
+
1605
836
  timestamp: Date | undefined;
1606
- /**
1607
- * <p>The type of the event.</p>
1608
- */
837
+
1609
838
  type: HistoryEventType | string | undefined;
1610
- /**
1611
- * <p>The id of the event. Events are numbered sequentially, starting at one.</p>
1612
- */
839
+
1613
840
  id: number | undefined;
1614
- /**
1615
- * <p>The id of the previous event.</p>
1616
- */
841
+
1617
842
  previousEventId?: number;
1618
- /**
1619
- * <p>Contains details about an activity that failed during an execution.</p>
1620
- */
843
+
1621
844
  activityFailedEventDetails?: ActivityFailedEventDetails;
1622
- /**
1623
- * <p>Contains details about an activity schedule event that failed during an execution.</p>
1624
- */
845
+
1625
846
  activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails;
1626
- /**
1627
- * <p>Contains details about an activity scheduled during an execution.</p>
1628
- */
847
+
1629
848
  activityScheduledEventDetails?: ActivityScheduledEventDetails;
1630
- /**
1631
- * <p>Contains details about the start of an activity during an execution.</p>
1632
- */
849
+
1633
850
  activityStartedEventDetails?: ActivityStartedEventDetails;
1634
- /**
1635
- * <p>Contains details about an activity that successfully terminated during an
1636
- * execution.</p>
1637
- */
851
+
1638
852
  activitySucceededEventDetails?: ActivitySucceededEventDetails;
1639
- /**
1640
- * <p>Contains details about an activity timeout that occurred during an execution.</p>
1641
- */
853
+
1642
854
  activityTimedOutEventDetails?: ActivityTimedOutEventDetails;
1643
- /**
1644
- * <p>Contains details about the failure of a task.</p>
1645
- */
855
+
1646
856
  taskFailedEventDetails?: TaskFailedEventDetails;
1647
- /**
1648
- * <p>Contains details about a task that was scheduled.</p>
1649
- */
857
+
1650
858
  taskScheduledEventDetails?: TaskScheduledEventDetails;
1651
- /**
1652
- * <p>Contains details about a task that failed to start.</p>
1653
- */
859
+
1654
860
  taskStartFailedEventDetails?: TaskStartFailedEventDetails;
1655
- /**
1656
- * <p>Contains details about a task that was started.</p>
1657
- */
861
+
1658
862
  taskStartedEventDetails?: TaskStartedEventDetails;
1659
- /**
1660
- * <p>Contains details about a task that where the submit failed.</p>
1661
- */
863
+
1662
864
  taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails;
1663
- /**
1664
- * <p>Contains details about a submitted task.</p>
1665
- */
865
+
1666
866
  taskSubmittedEventDetails?: TaskSubmittedEventDetails;
1667
- /**
1668
- * <p>Contains details about a task that succeeded.</p>
1669
- */
867
+
1670
868
  taskSucceededEventDetails?: TaskSucceededEventDetails;
1671
- /**
1672
- * <p>Contains details about a task that timed out.</p>
1673
- */
869
+
1674
870
  taskTimedOutEventDetails?: TaskTimedOutEventDetails;
1675
- /**
1676
- * <p>Contains details about an execution failure event.</p>
1677
- */
871
+
1678
872
  executionFailedEventDetails?: ExecutionFailedEventDetails;
1679
- /**
1680
- * <p>Contains details about the start of the execution.</p>
1681
- */
873
+
1682
874
  executionStartedEventDetails?: ExecutionStartedEventDetails;
1683
- /**
1684
- * <p>Contains details about the successful termination of the execution.</p>
1685
- */
875
+
1686
876
  executionSucceededEventDetails?: ExecutionSucceededEventDetails;
1687
- /**
1688
- * <p>Contains details about an abort of an execution.</p>
1689
- */
877
+
1690
878
  executionAbortedEventDetails?: ExecutionAbortedEventDetails;
1691
- /**
1692
- * <p>Contains details about the execution timeout that occurred during the execution.</p>
1693
- */
879
+
1694
880
  executionTimedOutEventDetails?: ExecutionTimedOutEventDetails;
1695
- /**
1696
- * <p>Contains details about Map state that was started.</p>
1697
- */
881
+
1698
882
  mapStateStartedEventDetails?: MapStateStartedEventDetails;
1699
- /**
1700
- * <p>Contains details about an iteration of a Map state that was started.</p>
1701
- */
883
+
1702
884
  mapIterationStartedEventDetails?: MapIterationEventDetails;
1703
- /**
1704
- * <p>Contains details about an iteration of a Map state that succeeded.</p>
1705
- */
885
+
1706
886
  mapIterationSucceededEventDetails?: MapIterationEventDetails;
1707
- /**
1708
- * <p>Contains details about an iteration of a Map state that failed.</p>
1709
- */
887
+
1710
888
  mapIterationFailedEventDetails?: MapIterationEventDetails;
1711
- /**
1712
- * <p>Contains details about an iteration of a Map state that was aborted.</p>
1713
- */
889
+
1714
890
  mapIterationAbortedEventDetails?: MapIterationEventDetails;
1715
- /**
1716
- * <p>Contains details about a lambda function that failed during an execution.</p>
1717
- */
891
+
1718
892
  lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails;
1719
- /**
1720
- * <p>Contains details about a failed lambda function schedule event that occurred during an
1721
- * execution.</p>
1722
- */
893
+
1723
894
  lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails;
1724
- /**
1725
- * <p>Contains details about a lambda function scheduled during an execution.</p>
1726
- */
895
+
1727
896
  lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails;
1728
- /**
1729
- * <p>Contains details about a lambda function that failed to start during an execution.</p>
1730
- */
897
+
1731
898
  lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails;
1732
- /**
1733
- * <p>Contains details about a lambda function that terminated successfully during an
1734
- * execution.</p>
1735
- */
899
+
1736
900
  lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails;
1737
- /**
1738
- * <p>Contains details about a lambda function timeout that occurred during an execution.</p>
1739
- */
901
+
1740
902
  lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails;
1741
- /**
1742
- * <p>Contains details about a state entered during an execution.</p>
1743
- */
903
+
1744
904
  stateEnteredEventDetails?: StateEnteredEventDetails;
1745
- /**
1746
- * <p>Contains details about an exit from a state during an execution.</p>
1747
- */
905
+
1748
906
  stateExitedEventDetails?: StateExitedEventDetails;
1749
907
  }
1750
908
  export declare namespace HistoryEvent {
1751
- /**
1752
- * @internal
1753
- */
909
+
1754
910
  const filterSensitiveLog: (obj: HistoryEvent) => any;
1755
911
  }
1756
912
  export interface GetExecutionHistoryOutput {
1757
- /**
1758
- * <p>The list of events that occurred in the execution.</p>
1759
- */
913
+
1760
914
  events: HistoryEvent[] | undefined;
1761
- /**
1762
- * <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.
1763
- * 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>
1764
- */
915
+
1765
916
  nextToken?: string;
1766
917
  }
1767
918
  export declare namespace GetExecutionHistoryOutput {
1768
- /**
1769
- * @internal
1770
- */
919
+
1771
920
  const filterSensitiveLog: (obj: GetExecutionHistoryOutput) => any;
1772
921
  }
1773
- /**
1774
- * <p>The provided token is invalid.</p>
1775
- */
922
+
1776
923
  export interface InvalidToken extends __SmithyException, $MetadataBearer {
1777
924
  name: "InvalidToken";
1778
925
  $fault: "client";
1779
926
  message?: string;
1780
927
  }
1781
928
  export declare namespace InvalidToken {
1782
- /**
1783
- * @internal
1784
- */
929
+
1785
930
  const filterSensitiveLog: (obj: InvalidToken) => any;
1786
931
  }
1787
932
  export interface ListActivitiesInput {
1788
- /**
1789
- * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
1790
- * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
1791
- * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
1792
- */
933
+
1793
934
  maxResults?: number;
1794
- /**
1795
- * <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.
1796
- * 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>
1797
- */
935
+
1798
936
  nextToken?: string;
1799
937
  }
1800
938
  export declare namespace ListActivitiesInput {
1801
- /**
1802
- * @internal
1803
- */
939
+
1804
940
  const filterSensitiveLog: (obj: ListActivitiesInput) => any;
1805
941
  }
1806
942
  export interface ListActivitiesOutput {
1807
- /**
1808
- * <p>The list of activities.</p>
1809
- */
943
+
1810
944
  activities: ActivityListItem[] | undefined;
1811
- /**
1812
- * <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.
1813
- * 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>
1814
- */
945
+
1815
946
  nextToken?: string;
1816
947
  }
1817
948
  export declare namespace ListActivitiesOutput {
1818
- /**
1819
- * @internal
1820
- */
949
+
1821
950
  const filterSensitiveLog: (obj: ListActivitiesOutput) => any;
1822
951
  }
1823
952
  export interface ListExecutionsInput {
1824
- /**
1825
- * <p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p>
1826
- */
953
+
1827
954
  stateMachineArn: string | undefined;
1828
- /**
1829
- * <p>If specified, only list the executions whose current execution status matches the given
1830
- * filter.</p>
1831
- */
955
+
1832
956
  statusFilter?: ExecutionStatus | string;
1833
- /**
1834
- * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
1835
- * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
1836
- * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
1837
- */
957
+
1838
958
  maxResults?: number;
1839
- /**
1840
- * <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.
1841
- * 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>
1842
- */
959
+
1843
960
  nextToken?: string;
1844
961
  }
1845
962
  export declare namespace ListExecutionsInput {
1846
- /**
1847
- * @internal
1848
- */
963
+
1849
964
  const filterSensitiveLog: (obj: ListExecutionsInput) => any;
1850
965
  }
1851
- /**
1852
- * <p>Contains details about an execution.</p>
1853
- */
966
+
1854
967
  export interface ExecutionListItem {
1855
- /**
1856
- * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
1857
- */
968
+
1858
969
  executionArn: string | undefined;
1859
- /**
1860
- * <p>The Amazon Resource Name (ARN) of the executed state machine.</p>
1861
- */
970
+
1862
971
  stateMachineArn: string | undefined;
1863
- /**
1864
- * <p>The name of the execution.</p>
1865
- * <p>A name must <i>not</i> contain:</p>
1866
- * <ul>
1867
- * <li>
1868
- * <p>white space</p>
1869
- * </li>
1870
- * <li>
1871
- * <p>brackets <code>< > { } [ ]</code>
1872
- * </p>
1873
- * </li>
1874
- * <li>
1875
- * <p>wildcard characters <code>? *</code>
1876
- * </p>
1877
- * </li>
1878
- * <li>
1879
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
1880
- * </p>
1881
- * </li>
1882
- * <li>
1883
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
1884
- * </li>
1885
- * </ul>
1886
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
1887
- */
972
+
1888
973
  name: string | undefined;
1889
- /**
1890
- * <p>The current status of the execution.</p>
1891
- */
974
+
1892
975
  status: ExecutionStatus | string | undefined;
1893
- /**
1894
- * <p>The date the execution started.</p>
1895
- */
976
+
1896
977
  startDate: Date | undefined;
1897
- /**
1898
- * <p>If the execution already ended, the date the execution stopped.</p>
1899
- */
978
+
1900
979
  stopDate?: Date;
1901
980
  }
1902
981
  export declare namespace ExecutionListItem {
1903
- /**
1904
- * @internal
1905
- */
982
+
1906
983
  const filterSensitiveLog: (obj: ExecutionListItem) => any;
1907
984
  }
1908
985
  export interface ListExecutionsOutput {
1909
- /**
1910
- * <p>The list of matching executions.</p>
1911
- */
986
+
1912
987
  executions: ExecutionListItem[] | undefined;
1913
- /**
1914
- * <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.
1915
- * 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>
1916
- */
988
+
1917
989
  nextToken?: string;
1918
990
  }
1919
991
  export declare namespace ListExecutionsOutput {
1920
- /**
1921
- * @internal
1922
- */
992
+
1923
993
  const filterSensitiveLog: (obj: ListExecutionsOutput) => any;
1924
994
  }
1925
995
  export interface ListStateMachinesInput {
1926
- /**
1927
- * <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
1928
- * The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
1929
- * <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
1930
- */
996
+
1931
997
  maxResults?: number;
1932
- /**
1933
- * <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.
1934
- * 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>
1935
- */
998
+
1936
999
  nextToken?: string;
1937
1000
  }
1938
1001
  export declare namespace ListStateMachinesInput {
1939
- /**
1940
- * @internal
1941
- */
1002
+
1942
1003
  const filterSensitiveLog: (obj: ListStateMachinesInput) => any;
1943
1004
  }
1944
- /**
1945
- * <p>Contains details about the state machine.</p>
1946
- */
1005
+
1947
1006
  export interface StateMachineListItem {
1948
- /**
1949
- * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
1950
- */
1007
+
1951
1008
  stateMachineArn: string | undefined;
1952
- /**
1953
- * <p>The name of the state machine.</p>
1954
- * <p>A name must <i>not</i> contain:</p>
1955
- * <ul>
1956
- * <li>
1957
- * <p>white space</p>
1958
- * </li>
1959
- * <li>
1960
- * <p>brackets <code>< > { } [ ]</code>
1961
- * </p>
1962
- * </li>
1963
- * <li>
1964
- * <p>wildcard characters <code>? *</code>
1965
- * </p>
1966
- * </li>
1967
- * <li>
1968
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
1969
- * </p>
1970
- * </li>
1971
- * <li>
1972
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
1973
- * </li>
1974
- * </ul>
1975
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
1976
- */
1009
+
1977
1010
  name: string | undefined;
1978
- /**
1979
- * <p></p>
1980
- */
1011
+
1981
1012
  type: StateMachineType | string | undefined;
1982
- /**
1983
- * <p>The date the state machine is created.</p>
1984
- */
1013
+
1985
1014
  creationDate: Date | undefined;
1986
1015
  }
1987
1016
  export declare namespace StateMachineListItem {
1988
- /**
1989
- * @internal
1990
- */
1017
+
1991
1018
  const filterSensitiveLog: (obj: StateMachineListItem) => any;
1992
1019
  }
1993
1020
  export interface ListStateMachinesOutput {
1994
1021
  stateMachines: StateMachineListItem[] | undefined;
1995
- /**
1996
- * <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.
1997
- * 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>
1998
- */
1022
+
1999
1023
  nextToken?: string;
2000
1024
  }
2001
1025
  export declare namespace ListStateMachinesOutput {
2002
- /**
2003
- * @internal
2004
- */
1026
+
2005
1027
  const filterSensitiveLog: (obj: ListStateMachinesOutput) => any;
2006
1028
  }
2007
1029
  export interface ListTagsForResourceInput {
2008
- /**
2009
- * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
2010
- */
1030
+
2011
1031
  resourceArn: string | undefined;
2012
1032
  }
2013
1033
  export declare namespace ListTagsForResourceInput {
2014
- /**
2015
- * @internal
2016
- */
1034
+
2017
1035
  const filterSensitiveLog: (obj: ListTagsForResourceInput) => any;
2018
1036
  }
2019
1037
  export interface ListTagsForResourceOutput {
2020
- /**
2021
- * <p>An array of tags associated with the resource.</p>
2022
- */
1038
+
2023
1039
  tags?: Tag[];
2024
1040
  }
2025
1041
  export declare namespace ListTagsForResourceOutput {
2026
- /**
2027
- * @internal
2028
- */
1042
+
2029
1043
  const filterSensitiveLog: (obj: ListTagsForResourceOutput) => any;
2030
1044
  }
2031
- /**
2032
- * <p>Could not find the referenced resource. Only state machine and activity ARNs are
2033
- * supported.</p>
2034
- */
1045
+
2035
1046
  export interface ResourceNotFound extends __SmithyException, $MetadataBearer {
2036
1047
  name: "ResourceNotFound";
2037
1048
  $fault: "client";
@@ -2039,39 +1050,25 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer {
2039
1050
  resourceName?: string;
2040
1051
  }
2041
1052
  export declare namespace ResourceNotFound {
2042
- /**
2043
- * @internal
2044
- */
1053
+
2045
1054
  const filterSensitiveLog: (obj: ResourceNotFound) => any;
2046
1055
  }
2047
1056
  export interface SendTaskFailureInput {
2048
- /**
2049
- * <p>The token that represents this task. Task tokens are generated by Step Functions when
2050
- * tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a
2051
- * workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
2052
- */
1057
+
2053
1058
  taskToken: string | undefined;
2054
- /**
2055
- * <p>The error code of the failure.</p>
2056
- */
1059
+
2057
1060
  error?: string;
2058
- /**
2059
- * <p>A more detailed explanation of the cause of the failure.</p>
2060
- */
1061
+
2061
1062
  cause?: string;
2062
1063
  }
2063
1064
  export declare namespace SendTaskFailureInput {
2064
- /**
2065
- * @internal
2066
- */
1065
+
2067
1066
  const filterSensitiveLog: (obj: SendTaskFailureInput) => any;
2068
1067
  }
2069
1068
  export interface SendTaskFailureOutput {
2070
1069
  }
2071
1070
  export declare namespace SendTaskFailureOutput {
2072
- /**
2073
- * @internal
2074
- */
1071
+
2075
1072
  const filterSensitiveLog: (obj: SendTaskFailureOutput) => any;
2076
1073
  }
2077
1074
  export interface TaskDoesNotExist extends __SmithyException, $MetadataBearer {
@@ -2080,9 +1077,7 @@ export interface TaskDoesNotExist extends __SmithyException, $MetadataBearer {
2080
1077
  message?: string;
2081
1078
  }
2082
1079
  export declare namespace TaskDoesNotExist {
2083
- /**
2084
- * @internal
2085
- */
1080
+
2086
1081
  const filterSensitiveLog: (obj: TaskDoesNotExist) => any;
2087
1082
  }
2088
1083
  export interface TaskTimedOut extends __SmithyException, $MetadataBearer {
@@ -2091,450 +1086,246 @@ export interface TaskTimedOut extends __SmithyException, $MetadataBearer {
2091
1086
  message?: string;
2092
1087
  }
2093
1088
  export declare namespace TaskTimedOut {
2094
- /**
2095
- * @internal
2096
- */
1089
+
2097
1090
  const filterSensitiveLog: (obj: TaskTimedOut) => any;
2098
1091
  }
2099
1092
  export interface SendTaskHeartbeatInput {
2100
- /**
2101
- * <p>The token that represents this task. Task tokens are generated by Step Functions when
2102
- * tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a
2103
- * workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
2104
- */
1093
+
2105
1094
  taskToken: string | undefined;
2106
1095
  }
2107
1096
  export declare namespace SendTaskHeartbeatInput {
2108
- /**
2109
- * @internal
2110
- */
1097
+
2111
1098
  const filterSensitiveLog: (obj: SendTaskHeartbeatInput) => any;
2112
1099
  }
2113
1100
  export interface SendTaskHeartbeatOutput {
2114
1101
  }
2115
1102
  export declare namespace SendTaskHeartbeatOutput {
2116
- /**
2117
- * @internal
2118
- */
1103
+
2119
1104
  const filterSensitiveLog: (obj: SendTaskHeartbeatOutput) => any;
2120
1105
  }
2121
- /**
2122
- * <p>The provided JSON output data is invalid.</p>
2123
- */
1106
+
2124
1107
  export interface InvalidOutput extends __SmithyException, $MetadataBearer {
2125
1108
  name: "InvalidOutput";
2126
1109
  $fault: "client";
2127
1110
  message?: string;
2128
1111
  }
2129
1112
  export declare namespace InvalidOutput {
2130
- /**
2131
- * @internal
2132
- */
1113
+
2133
1114
  const filterSensitiveLog: (obj: InvalidOutput) => any;
2134
1115
  }
2135
1116
  export interface SendTaskSuccessInput {
2136
- /**
2137
- * <p>The token that represents this task. Task tokens are generated by Step Functions when
2138
- * tasks are assigned to a worker, or in the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html">context object</a> when a
2139
- * workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
2140
- */
1117
+
2141
1118
  taskToken: string | undefined;
2142
- /**
2143
- * <p>The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2144
- */
1119
+
2145
1120
  output: string | undefined;
2146
1121
  }
2147
1122
  export declare namespace SendTaskSuccessInput {
2148
- /**
2149
- * @internal
2150
- */
1123
+
2151
1124
  const filterSensitiveLog: (obj: SendTaskSuccessInput) => any;
2152
1125
  }
2153
1126
  export interface SendTaskSuccessOutput {
2154
1127
  }
2155
1128
  export declare namespace SendTaskSuccessOutput {
2156
- /**
2157
- * @internal
2158
- */
1129
+
2159
1130
  const filterSensitiveLog: (obj: SendTaskSuccessOutput) => any;
2160
1131
  }
2161
- /**
2162
- * <p>The execution has the same <code>name</code> as another execution (but a different
2163
- * <code>input</code>).</p>
2164
- * <note>
2165
- * <p>Executions with the same <code>name</code> and <code>input</code> are considered
2166
- * idempotent.</p>
2167
- * </note>
2168
- */
1132
+
2169
1133
  export interface ExecutionAlreadyExists extends __SmithyException, $MetadataBearer {
2170
1134
  name: "ExecutionAlreadyExists";
2171
1135
  $fault: "client";
2172
1136
  message?: string;
2173
1137
  }
2174
1138
  export declare namespace ExecutionAlreadyExists {
2175
- /**
2176
- * @internal
2177
- */
1139
+
2178
1140
  const filterSensitiveLog: (obj: ExecutionAlreadyExists) => any;
2179
1141
  }
2180
- /**
2181
- * <p>The maximum number of running executions has been reached. Running executions must end or
2182
- * be stopped before a new execution can be started.</p>
2183
- */
1142
+
2184
1143
  export interface ExecutionLimitExceeded extends __SmithyException, $MetadataBearer {
2185
1144
  name: "ExecutionLimitExceeded";
2186
1145
  $fault: "client";
2187
1146
  message?: string;
2188
1147
  }
2189
1148
  export declare namespace ExecutionLimitExceeded {
2190
- /**
2191
- * @internal
2192
- */
1149
+
2193
1150
  const filterSensitiveLog: (obj: ExecutionLimitExceeded) => any;
2194
1151
  }
2195
- /**
2196
- * <p>The provided JSON input data is invalid.</p>
2197
- */
1152
+
2198
1153
  export interface InvalidExecutionInput extends __SmithyException, $MetadataBearer {
2199
1154
  name: "InvalidExecutionInput";
2200
1155
  $fault: "client";
2201
1156
  message?: string;
2202
1157
  }
2203
1158
  export declare namespace InvalidExecutionInput {
2204
- /**
2205
- * @internal
2206
- */
1159
+
2207
1160
  const filterSensitiveLog: (obj: InvalidExecutionInput) => any;
2208
1161
  }
2209
1162
  export interface StartExecutionInput {
2210
- /**
2211
- * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
2212
- */
1163
+
2213
1164
  stateMachineArn: string | undefined;
2214
- /**
2215
- * <p>The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information,
2216
- * see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
2217
- * Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p>
2218
- * <p>A name must <i>not</i> contain:</p>
2219
- * <ul>
2220
- * <li>
2221
- * <p>white space</p>
2222
- * </li>
2223
- * <li>
2224
- * <p>brackets <code>< > { } [ ]</code>
2225
- * </p>
2226
- * </li>
2227
- * <li>
2228
- * <p>wildcard characters <code>? *</code>
2229
- * </p>
2230
- * </li>
2231
- * <li>
2232
- * <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code>
2233
- * </p>
2234
- * </li>
2235
- * <li>
2236
- * <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p>
2237
- * </li>
2238
- * </ul>
2239
- * <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
2240
- */
1165
+
2241
1166
  name?: string;
2242
- /**
2243
- * <p>The string that contains the JSON input data for the execution, for example:</p>
2244
- * <p>
2245
- * <code>"input": "{\"first_name\" : \"test\"}"</code>
2246
- * </p>
2247
- * <note>
2248
- * <p>If you don't include any JSON input data, you still must include the two braces, for
2249
- * example: <code>"input": "{}"</code>
2250
- * </p>
2251
- * </note>
2252
- * <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2253
- */
1167
+
2254
1168
  input?: string;
2255
- /**
2256
- * <p>Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.</p>
2257
- */
1169
+
2258
1170
  traceHeader?: string;
2259
1171
  }
2260
1172
  export declare namespace StartExecutionInput {
2261
- /**
2262
- * @internal
2263
- */
1173
+
2264
1174
  const filterSensitiveLog: (obj: StartExecutionInput) => any;
2265
1175
  }
2266
1176
  export interface StartExecutionOutput {
2267
- /**
2268
- * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
2269
- */
1177
+
2270
1178
  executionArn: string | undefined;
2271
- /**
2272
- * <p>The date the execution is started.</p>
2273
- */
1179
+
2274
1180
  startDate: Date | undefined;
2275
1181
  }
2276
1182
  export declare namespace StartExecutionOutput {
2277
- /**
2278
- * @internal
2279
- */
1183
+
2280
1184
  const filterSensitiveLog: (obj: StartExecutionOutput) => any;
2281
1185
  }
2282
1186
  export interface StartSyncExecutionInput {
2283
- /**
2284
- * <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
2285
- */
1187
+
2286
1188
  stateMachineArn: string | undefined;
2287
- /**
2288
- * <p>The name of the execution.</p>
2289
- */
1189
+
2290
1190
  name?: string;
2291
- /**
2292
- * <p>The string that contains the JSON input data for the execution, for example:</p>
2293
- * <p>
2294
- * <code>"input": "{\"first_name\" : \"test\"}"</code>
2295
- * </p>
2296
- * <note>
2297
- * <p>If you don't include any JSON input data, you still must include the two braces, for
2298
- * example: <code>"input": "{}"</code>
2299
- * </p>
2300
- * </note>
2301
- * <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2302
- */
1191
+
2303
1192
  input?: string;
2304
- /**
2305
- * <p>Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.</p>
2306
- */
1193
+
2307
1194
  traceHeader?: string;
2308
1195
  }
2309
1196
  export declare namespace StartSyncExecutionInput {
2310
- /**
2311
- * @internal
2312
- */
1197
+
2313
1198
  const filterSensitiveLog: (obj: StartSyncExecutionInput) => any;
2314
1199
  }
2315
- /**
2316
- * <p>An object that describes workflow billing details.</p>
2317
- */
1200
+
2318
1201
  export interface BillingDetails {
2319
- /**
2320
- * <p>Billed memory consumption of your workflow, in MB.</p>
2321
- */
1202
+
2322
1203
  billedMemoryUsedInMB?: number;
2323
- /**
2324
- * <p>Billed duration of your workflow, in milliseconds.</p>
2325
- */
1204
+
2326
1205
  billedDurationInMilliseconds?: number;
2327
1206
  }
2328
1207
  export declare namespace BillingDetails {
2329
- /**
2330
- * @internal
2331
- */
1208
+
2332
1209
  const filterSensitiveLog: (obj: BillingDetails) => any;
2333
1210
  }
2334
1211
  export declare type SyncExecutionStatus = "FAILED" | "SUCCEEDED" | "TIMED_OUT";
2335
1212
  export interface StartSyncExecutionOutput {
2336
- /**
2337
- * <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
2338
- */
1213
+
2339
1214
  executionArn: string | undefined;
2340
- /**
2341
- * <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
2342
- */
1215
+
2343
1216
  stateMachineArn?: string;
2344
- /**
2345
- * <p>The name of the execution.</p>
2346
- */
1217
+
2347
1218
  name?: string;
2348
- /**
2349
- * <p>The date the execution is started.</p>
2350
- */
1219
+
2351
1220
  startDate: Date | undefined;
2352
- /**
2353
- * <p>If the execution has already ended, the date the execution stopped.</p>
2354
- */
1221
+
2355
1222
  stopDate: Date | undefined;
2356
- /**
2357
- * <p>The current status of the execution.</p>
2358
- */
1223
+
2359
1224
  status: SyncExecutionStatus | string | undefined;
2360
- /**
2361
- * <p>The error code of the failure.</p>
2362
- */
1225
+
2363
1226
  error?: string;
2364
- /**
2365
- * <p>A more detailed explanation of the cause of the failure.</p>
2366
- */
1227
+
2367
1228
  cause?: string;
2368
- /**
2369
- * <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2370
- */
1229
+
2371
1230
  input?: string;
2372
- /**
2373
- * <p>Provides details about execution input or output.</p>
2374
- */
1231
+
2375
1232
  inputDetails?: CloudWatchEventsExecutionDataDetails;
2376
- /**
2377
- * <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
2378
- * <note>
2379
- * <p>This field is set only if the execution succeeds. If the execution fails, this field is
2380
- * null.</p>
2381
- * </note>
2382
- */
1233
+
2383
1234
  output?: string;
2384
- /**
2385
- * <p>Provides details about execution input or output.</p>
2386
- */
1235
+
2387
1236
  outputDetails?: CloudWatchEventsExecutionDataDetails;
2388
- /**
2389
- * <p>The AWS X-Ray trace header that was passed to the execution.</p>
2390
- */
1237
+
2391
1238
  traceHeader?: string;
2392
- /**
2393
- * <p>An object that describes workflow billing details, including billed duration
2394
- * and memory use.</p>
2395
- */
1239
+
2396
1240
  billingDetails?: BillingDetails;
2397
1241
  }
2398
1242
  export declare namespace StartSyncExecutionOutput {
2399
- /**
2400
- * @internal
2401
- */
1243
+
2402
1244
  const filterSensitiveLog: (obj: StartSyncExecutionOutput) => any;
2403
1245
  }
2404
1246
  export interface StopExecutionInput {
2405
- /**
2406
- * <p>The Amazon Resource Name (ARN) of the execution to stop.</p>
2407
- */
1247
+
2408
1248
  executionArn: string | undefined;
2409
- /**
2410
- * <p>The error code of the failure.</p>
2411
- */
1249
+
2412
1250
  error?: string;
2413
- /**
2414
- * <p>A more detailed explanation of the cause of the failure.</p>
2415
- */
1251
+
2416
1252
  cause?: string;
2417
1253
  }
2418
1254
  export declare namespace StopExecutionInput {
2419
- /**
2420
- * @internal
2421
- */
1255
+
2422
1256
  const filterSensitiveLog: (obj: StopExecutionInput) => any;
2423
1257
  }
2424
1258
  export interface StopExecutionOutput {
2425
- /**
2426
- * <p>The date the execution is stopped.</p>
2427
- */
1259
+
2428
1260
  stopDate: Date | undefined;
2429
1261
  }
2430
1262
  export declare namespace StopExecutionOutput {
2431
- /**
2432
- * @internal
2433
- */
1263
+
2434
1264
  const filterSensitiveLog: (obj: StopExecutionOutput) => any;
2435
1265
  }
2436
1266
  export interface TagResourceInput {
2437
- /**
2438
- * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
2439
- */
1267
+
2440
1268
  resourceArn: string | undefined;
2441
- /**
2442
- * <p>The list of tags to add to a resource.</p>
2443
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
2444
- */
1269
+
2445
1270
  tags: Tag[] | undefined;
2446
1271
  }
2447
1272
  export declare namespace TagResourceInput {
2448
- /**
2449
- * @internal
2450
- */
1273
+
2451
1274
  const filterSensitiveLog: (obj: TagResourceInput) => any;
2452
1275
  }
2453
1276
  export interface TagResourceOutput {
2454
1277
  }
2455
1278
  export declare namespace TagResourceOutput {
2456
- /**
2457
- * @internal
2458
- */
1279
+
2459
1280
  const filterSensitiveLog: (obj: TagResourceOutput) => any;
2460
1281
  }
2461
1282
  export interface UntagResourceInput {
2462
- /**
2463
- * <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
2464
- */
1283
+
2465
1284
  resourceArn: string | undefined;
2466
- /**
2467
- * <p>The list of tags to remove from the resource.</p>
2468
- */
1285
+
2469
1286
  tagKeys: string[] | undefined;
2470
1287
  }
2471
1288
  export declare namespace UntagResourceInput {
2472
- /**
2473
- * @internal
2474
- */
1289
+
2475
1290
  const filterSensitiveLog: (obj: UntagResourceInput) => any;
2476
1291
  }
2477
1292
  export interface UntagResourceOutput {
2478
1293
  }
2479
1294
  export declare namespace UntagResourceOutput {
2480
- /**
2481
- * @internal
2482
- */
1295
+
2483
1296
  const filterSensitiveLog: (obj: UntagResourceOutput) => any;
2484
1297
  }
2485
- /**
2486
- * <p>Request is missing a required parameter. This error occurs if both <code>definition</code>
2487
- * and <code>roleArn</code> are not specified.</p>
2488
- */
1298
+
2489
1299
  export interface MissingRequiredParameter extends __SmithyException, $MetadataBearer {
2490
1300
  name: "MissingRequiredParameter";
2491
1301
  $fault: "client";
2492
1302
  message?: string;
2493
1303
  }
2494
1304
  export declare namespace MissingRequiredParameter {
2495
- /**
2496
- * @internal
2497
- */
1305
+
2498
1306
  const filterSensitiveLog: (obj: MissingRequiredParameter) => any;
2499
1307
  }
2500
1308
  export interface UpdateStateMachineInput {
2501
- /**
2502
- * <p>The Amazon Resource Name (ARN) of the state machine.</p>
2503
- */
1309
+
2504
1310
  stateMachineArn: string | undefined;
2505
- /**
2506
- * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
2507
- */
1311
+
2508
1312
  definition?: string;
2509
- /**
2510
- * <p>The Amazon Resource Name (ARN) of the IAM role of the state machine.</p>
2511
- */
1313
+
2512
1314
  roleArn?: string;
2513
- /**
2514
- * <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
2515
- * options.</p>
2516
- */
1315
+
2517
1316
  loggingConfiguration?: LoggingConfiguration;
2518
- /**
2519
- * <p>Selects whether AWS X-Ray tracing is enabled.</p>
2520
- */
1317
+
2521
1318
  tracingConfiguration?: TracingConfiguration;
2522
1319
  }
2523
1320
  export declare namespace UpdateStateMachineInput {
2524
- /**
2525
- * @internal
2526
- */
1321
+
2527
1322
  const filterSensitiveLog: (obj: UpdateStateMachineInput) => any;
2528
1323
  }
2529
1324
  export interface UpdateStateMachineOutput {
2530
- /**
2531
- * <p>The date and time the state machine was updated.</p>
2532
- */
1325
+
2533
1326
  updateDate: Date | undefined;
2534
1327
  }
2535
1328
  export declare namespace UpdateStateMachineOutput {
2536
- /**
2537
- * @internal
2538
- */
1329
+
2539
1330
  const filterSensitiveLog: (obj: UpdateStateMachineOutput) => any;
2540
1331
  }