@aws-sdk/client-sfn 3.529.1 → 3.535.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.
- package/dist-types/SFN.d.ts +4 -1
- package/dist-types/SFNClient.d.ts +1 -1
- package/dist-types/commands/CreateActivityCommand.d.ts +2 -1
- package/dist-types/commands/CreateStateMachineAliasCommand.d.ts +2 -1
- package/dist-types/commands/CreateStateMachineCommand.d.ts +2 -1
- package/dist-types/commands/DeleteActivityCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStateMachineAliasCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStateMachineCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStateMachineVersionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeActivityCommand.d.ts +2 -1
- package/dist-types/commands/DescribeExecutionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeMapRunCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStateMachineAliasCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStateMachineCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GetActivityTaskCommand.d.ts +2 -1
- package/dist-types/commands/GetExecutionHistoryCommand.d.ts +2 -1
- package/dist-types/commands/ListActivitiesCommand.d.ts +2 -1
- package/dist-types/commands/ListExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListMapRunsCommand.d.ts +2 -1
- package/dist-types/commands/ListStateMachineAliasesCommand.d.ts +2 -1
- package/dist-types/commands/ListStateMachineVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListStateMachinesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PublishStateMachineVersionCommand.d.ts +2 -1
- package/dist-types/commands/RedriveExecutionCommand.d.ts +2 -1
- package/dist-types/commands/SendTaskFailureCommand.d.ts +2 -1
- package/dist-types/commands/SendTaskHeartbeatCommand.d.ts +2 -1
- package/dist-types/commands/SendTaskSuccessCommand.d.ts +2 -1
- package/dist-types/commands/StartExecutionCommand.d.ts +2 -1
- package/dist-types/commands/StartSyncExecutionCommand.d.ts +2 -1
- package/dist-types/commands/StopExecutionCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/TestStateCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateMapRunCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStateMachineAliasCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStateMachineCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +507 -507
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/SFN.d.ts +3 -0
- package/dist-types/ts3.4/commands/CreateActivityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStateMachineAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStateMachineCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteActivityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStateMachineAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStateMachineCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStateMachineVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeActivityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeMapRunCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStateMachineAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStateMachineCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStateMachineForExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetActivityTaskCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetExecutionHistoryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListActivitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListMapRunsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStateMachineAliasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStateMachineVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStateMachinesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PublishStateMachineVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RedriveExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendTaskFailureCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendTaskHeartbeatCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendTaskSuccessCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartSyncExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopExecutionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TestStateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateMapRunCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStateMachineAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStateMachineCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SFNServiceException as __BaseException } from "./SFNServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>The specified activity does not exist.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class ActivityDoesNotExist extends __BaseException {
|
|
8
8
|
readonly name: "ActivityDoesNotExist";
|
|
@@ -13,25 +13,25 @@ export declare class ActivityDoesNotExist extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<ActivityDoesNotExist, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>Contains details about an activity that failed during an execution.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
export interface ActivityFailedEventDetails {
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p>The error code of the failure.</p>
|
|
22
|
+
* @public
|
|
23
23
|
*/
|
|
24
24
|
error?: string;
|
|
25
25
|
/**
|
|
26
|
-
* @public
|
|
27
26
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
cause?: string;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>The maximum number of activities has been reached. Existing activities must be deleted
|
|
34
33
|
* before a new activity can be created.</p>
|
|
34
|
+
* @public
|
|
35
35
|
*/
|
|
36
36
|
export declare class ActivityLimitExceeded extends __BaseException {
|
|
37
37
|
readonly name: "ActivityLimitExceeded";
|
|
@@ -42,17 +42,16 @@ export declare class ActivityLimitExceeded extends __BaseException {
|
|
|
42
42
|
constructor(opts: __ExceptionOptionType<ActivityLimitExceeded, __BaseException>);
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>Contains details about an activity.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
export interface ActivityListItem {
|
|
49
49
|
/**
|
|
50
|
-
* @public
|
|
51
50
|
* <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
|
|
51
|
+
* @public
|
|
52
52
|
*/
|
|
53
53
|
activityArn: string | undefined;
|
|
54
54
|
/**
|
|
55
|
-
* @public
|
|
56
55
|
* <p>The name of the activity.</p>
|
|
57
56
|
* <p>A name must <i>not</i> contain:</p>
|
|
58
57
|
* <ul>
|
|
@@ -76,123 +75,124 @@ export interface ActivityListItem {
|
|
|
76
75
|
* </li>
|
|
77
76
|
* </ul>
|
|
78
77
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
78
|
+
* @public
|
|
79
79
|
*/
|
|
80
80
|
name: string | undefined;
|
|
81
81
|
/**
|
|
82
|
-
* @public
|
|
83
82
|
* <p>The date the activity is created.</p>
|
|
83
|
+
* @public
|
|
84
84
|
*/
|
|
85
85
|
creationDate: Date | undefined;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>Provides details about input or output in an execution history event.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
export interface HistoryEventExecutionDataDetails {
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>Indicates whether input or output was truncated in the response. Always <code>false</code>
|
|
95
94
|
* for API calls.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
truncated?: boolean;
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
* @public
|
|
101
100
|
* <p>Contains details about an activity scheduled during an execution.</p>
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
export interface ActivityScheduledEventDetails {
|
|
104
104
|
/**
|
|
105
|
-
* @public
|
|
106
105
|
* <p>The Amazon Resource Name (ARN) of the scheduled activity.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
resource: string | undefined;
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <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>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
input?: string;
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>Contains details about the input for an execution history event.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
inputDetails?: HistoryEventExecutionDataDetails;
|
|
119
119
|
/**
|
|
120
|
-
* @public
|
|
121
120
|
* <p>The maximum allowed duration of the activity task.</p>
|
|
121
|
+
* @public
|
|
122
122
|
*/
|
|
123
123
|
timeoutInSeconds?: number;
|
|
124
124
|
/**
|
|
125
|
-
* @public
|
|
126
125
|
* <p>The maximum allowed duration between two heartbeats for the activity task.</p>
|
|
126
|
+
* @public
|
|
127
127
|
*/
|
|
128
128
|
heartbeatInSeconds?: number;
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
|
-
* @public
|
|
132
131
|
* <p>Contains details about an activity schedule failure that occurred during an
|
|
133
132
|
* execution.</p>
|
|
133
|
+
* @public
|
|
134
134
|
*/
|
|
135
135
|
export interface ActivityScheduleFailedEventDetails {
|
|
136
136
|
/**
|
|
137
|
-
* @public
|
|
138
137
|
* <p>The error code of the failure.</p>
|
|
138
|
+
* @public
|
|
139
139
|
*/
|
|
140
140
|
error?: string;
|
|
141
141
|
/**
|
|
142
|
-
* @public
|
|
143
142
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
143
|
+
* @public
|
|
144
144
|
*/
|
|
145
145
|
cause?: string;
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
* @public
|
|
149
148
|
* <p>Contains details about the start of an activity during an execution.</p>
|
|
149
|
+
* @public
|
|
150
150
|
*/
|
|
151
151
|
export interface ActivityStartedEventDetails {
|
|
152
152
|
/**
|
|
153
|
-
* @public
|
|
154
153
|
* <p>The name of the worker that the task is assigned to. These names are provided by the
|
|
155
154
|
* workers when calling <a>GetActivityTask</a>.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
workerName?: string;
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* @public
|
|
161
160
|
* <p>Contains details about an activity that successfully terminated during an
|
|
162
161
|
* execution.</p>
|
|
162
|
+
* @public
|
|
163
163
|
*/
|
|
164
164
|
export interface ActivitySucceededEventDetails {
|
|
165
165
|
/**
|
|
166
|
-
* @public
|
|
167
166
|
* <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>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
output?: string;
|
|
170
170
|
/**
|
|
171
|
-
* @public
|
|
172
171
|
* <p>Contains details about the output of an execution history event.</p>
|
|
172
|
+
* @public
|
|
173
173
|
*/
|
|
174
174
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
* @public
|
|
178
177
|
* <p>Contains details about an activity timeout that occurred during an execution.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
export interface ActivityTimedOutEventDetails {
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>The error code of the failure.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
error?: string;
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>A more detailed explanation of the cause of the timeout.</p>
|
|
188
|
+
* @public
|
|
189
189
|
*/
|
|
190
190
|
cause?: string;
|
|
191
191
|
}
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>The maximum number of workers concurrently polling for activity tasks has been
|
|
195
194
|
* reached.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
export declare class ActivityWorkerLimitExceeded extends __BaseException {
|
|
198
198
|
readonly name: "ActivityWorkerLimitExceeded";
|
|
@@ -203,7 +203,6 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
|
|
|
203
203
|
constructor(opts: __ExceptionOptionType<ActivityWorkerLimitExceeded, __BaseException>);
|
|
204
204
|
}
|
|
205
205
|
/**
|
|
206
|
-
* @public
|
|
207
206
|
* <p>Tags are key-value pairs that can be associated with Step Functions state machines and
|
|
208
207
|
* activities.</p>
|
|
209
208
|
* <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
|
|
@@ -211,16 +210,17 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
|
|
|
211
210
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
212
211
|
* Tags</a>.</p>
|
|
213
212
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
export interface Tag {
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>The key of a tag.</p>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
key?: string;
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>The value of a tag.</p>
|
|
223
|
+
* @public
|
|
224
224
|
*/
|
|
225
225
|
value?: string;
|
|
226
226
|
}
|
|
@@ -229,7 +229,6 @@ export interface Tag {
|
|
|
229
229
|
*/
|
|
230
230
|
export interface CreateActivityInput {
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information,
|
|
234
233
|
* see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
|
|
235
234
|
* Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
@@ -255,16 +254,17 @@ export interface CreateActivityInput {
|
|
|
255
254
|
* </li>
|
|
256
255
|
* </ul>
|
|
257
256
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
name: string | undefined;
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>The list of tags to add to a resource.</p>
|
|
263
262
|
* <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
|
|
264
263
|
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
265
264
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
266
265
|
* Tags</a>.</p>
|
|
267
266
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
267
|
+
* @public
|
|
268
268
|
*/
|
|
269
269
|
tags?: Tag[];
|
|
270
270
|
}
|
|
@@ -273,19 +273,19 @@ export interface CreateActivityInput {
|
|
|
273
273
|
*/
|
|
274
274
|
export interface CreateActivityOutput {
|
|
275
275
|
/**
|
|
276
|
-
* @public
|
|
277
276
|
* <p>The Amazon Resource Name (ARN) that identifies the created activity.</p>
|
|
277
|
+
* @public
|
|
278
278
|
*/
|
|
279
279
|
activityArn: string | undefined;
|
|
280
280
|
/**
|
|
281
|
-
* @public
|
|
282
281
|
* <p>The date the activity is created.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
creationDate: Date | undefined;
|
|
285
285
|
}
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>The provided name is not valid.</p>
|
|
288
|
+
* @public
|
|
289
289
|
*/
|
|
290
290
|
export declare class InvalidName extends __BaseException {
|
|
291
291
|
readonly name: "InvalidName";
|
|
@@ -296,9 +296,9 @@ export declare class InvalidName extends __BaseException {
|
|
|
296
296
|
constructor(opts: __ExceptionOptionType<InvalidName, __BaseException>);
|
|
297
297
|
}
|
|
298
298
|
/**
|
|
299
|
-
* @public
|
|
300
299
|
* <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
|
|
301
300
|
* Step Functions Developer Guide.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
export declare class TooManyTags extends __BaseException {
|
|
304
304
|
readonly name: "TooManyTags";
|
|
@@ -310,9 +310,9 @@ export declare class TooManyTags extends __BaseException {
|
|
|
310
310
|
constructor(opts: __ExceptionOptionType<TooManyTags, __BaseException>);
|
|
311
311
|
}
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p>
|
|
315
314
|
* <p>HTTP Status Code: 409</p>
|
|
315
|
+
* @public
|
|
316
316
|
*/
|
|
317
317
|
export declare class ConflictException extends __BaseException {
|
|
318
318
|
readonly name: "ConflictException";
|
|
@@ -323,26 +323,26 @@ export declare class ConflictException extends __BaseException {
|
|
|
323
323
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p></p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
export interface CloudWatchLogsLogGroup {
|
|
330
330
|
/**
|
|
331
|
-
* @public
|
|
332
331
|
* <p>The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN
|
|
333
332
|
* must end with <code>:*</code>
|
|
334
333
|
* </p>
|
|
334
|
+
* @public
|
|
335
335
|
*/
|
|
336
336
|
logGroupArn?: string;
|
|
337
337
|
}
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p></p>
|
|
340
|
+
* @public
|
|
341
341
|
*/
|
|
342
342
|
export interface LogDestination {
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <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 CloudFormation User Guide.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
cloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
|
|
348
348
|
}
|
|
@@ -361,39 +361,39 @@ export declare const LogLevel: {
|
|
|
361
361
|
*/
|
|
362
362
|
export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
|
|
363
363
|
/**
|
|
364
|
-
* @public
|
|
365
364
|
* <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
|
|
366
365
|
* options.</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
export interface LoggingConfiguration {
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>Defines which category of execution history events are logged.</p>
|
|
371
|
+
* @public
|
|
372
372
|
*/
|
|
373
373
|
level?: LogLevel;
|
|
374
374
|
/**
|
|
375
|
-
* @public
|
|
376
375
|
* <p>Determines whether execution data is included in your log. When set to <code>false</code>,
|
|
377
376
|
* data is excluded.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
includeExecutionData?: boolean;
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>An array of objects that describes where your execution history events will be logged.
|
|
383
382
|
* Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</p>
|
|
383
|
+
* @public
|
|
384
384
|
*/
|
|
385
385
|
destinations?: LogDestination[];
|
|
386
386
|
}
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>Selects whether or not the state machine's X-Ray tracing is enabled. Default is
|
|
390
389
|
* <code>false</code>
|
|
391
390
|
* </p>
|
|
391
|
+
* @public
|
|
392
392
|
*/
|
|
393
393
|
export interface TracingConfiguration {
|
|
394
394
|
/**
|
|
395
|
-
* @public
|
|
396
395
|
* <p>When set to <code>true</code>, X-Ray tracing is enabled.</p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
enabled?: boolean;
|
|
399
399
|
}
|
|
@@ -414,7 +414,6 @@ export type StateMachineType = (typeof StateMachineType)[keyof typeof StateMachi
|
|
|
414
414
|
*/
|
|
415
415
|
export interface CreateStateMachineInput {
|
|
416
416
|
/**
|
|
417
|
-
* @public
|
|
418
417
|
* <p>The name of the state machine. </p>
|
|
419
418
|
* <p>A name must <i>not</i> contain:</p>
|
|
420
419
|
* <ul>
|
|
@@ -438,58 +437,59 @@ export interface CreateStateMachineInput {
|
|
|
438
437
|
* </li>
|
|
439
438
|
* </ul>
|
|
440
439
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
name: string | undefined;
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <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>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
definition: string | undefined;
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>The Amazon Resource Name (ARN) of the IAM role to use for this state machine.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
roleArn: string | undefined;
|
|
453
453
|
/**
|
|
454
|
-
* @public
|
|
455
454
|
* <p>Determines whether a Standard or Express state machine is created. The default is
|
|
456
455
|
* <code>STANDARD</code>. You cannot update the <code>type</code> of a state machine once it
|
|
457
456
|
* has been created.</p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
type?: StateMachineType;
|
|
460
460
|
/**
|
|
461
|
-
* @public
|
|
462
461
|
* <p>Defines what execution history events are logged and where they are logged.</p>
|
|
463
462
|
* <note>
|
|
464
463
|
* <p>By default, the <code>level</code> is set to <code>OFF</code>. For more information see
|
|
465
464
|
* <a href="https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html">Log
|
|
466
465
|
* Levels</a> in the Step Functions User Guide.</p>
|
|
467
466
|
* </note>
|
|
467
|
+
* @public
|
|
468
468
|
*/
|
|
469
469
|
loggingConfiguration?: LoggingConfiguration;
|
|
470
470
|
/**
|
|
471
|
-
* @public
|
|
472
471
|
* <p>Tags to be added when creating a state machine.</p>
|
|
473
472
|
* <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
|
|
474
473
|
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
475
474
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
476
475
|
* Tags</a>.</p>
|
|
477
476
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
tags?: Tag[];
|
|
480
480
|
/**
|
|
481
|
-
* @public
|
|
482
481
|
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
482
|
+
* @public
|
|
483
483
|
*/
|
|
484
484
|
tracingConfiguration?: TracingConfiguration;
|
|
485
485
|
/**
|
|
486
|
-
* @public
|
|
487
486
|
* <p>Set to <code>true</code> to publish the first version of the state machine during creation. The default is <code>false</code>.</p>
|
|
487
|
+
* @public
|
|
488
488
|
*/
|
|
489
489
|
publish?: boolean;
|
|
490
490
|
/**
|
|
491
|
-
* @public
|
|
492
491
|
* <p>Sets description about the state machine version. You can only set the description if the <code>publish</code> parameter is set to <code>true</code>. Otherwise, if you set <code>versionDescription</code>, but <code>publish</code> to <code>false</code>, this API action throws <code>ValidationException</code>.</p>
|
|
492
|
+
* @public
|
|
493
493
|
*/
|
|
494
494
|
versionDescription?: string;
|
|
495
495
|
}
|
|
@@ -498,24 +498,24 @@ export interface CreateStateMachineInput {
|
|
|
498
498
|
*/
|
|
499
499
|
export interface CreateStateMachineOutput {
|
|
500
500
|
/**
|
|
501
|
-
* @public
|
|
502
501
|
* <p>The Amazon Resource Name (ARN) that identifies the created state machine.</p>
|
|
502
|
+
* @public
|
|
503
503
|
*/
|
|
504
504
|
stateMachineArn: string | undefined;
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p>The date the state machine is created.</p>
|
|
507
|
+
* @public
|
|
508
508
|
*/
|
|
509
509
|
creationDate: Date | undefined;
|
|
510
510
|
/**
|
|
511
|
-
* @public
|
|
512
511
|
* <p>The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the <code>publish</code> parameter to <code>true</code>, this field returns null value.</p>
|
|
512
|
+
* @public
|
|
513
513
|
*/
|
|
514
514
|
stateMachineVersionArn?: string;
|
|
515
515
|
}
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
export declare class InvalidArn extends __BaseException {
|
|
521
521
|
readonly name: "InvalidArn";
|
|
@@ -526,8 +526,8 @@ export declare class InvalidArn extends __BaseException {
|
|
|
526
526
|
constructor(opts: __ExceptionOptionType<InvalidArn, __BaseException>);
|
|
527
527
|
}
|
|
528
528
|
/**
|
|
529
|
-
* @public
|
|
530
529
|
* <p>The provided Amazon States Language definition is not valid.</p>
|
|
530
|
+
* @public
|
|
531
531
|
*/
|
|
532
532
|
export declare class InvalidDefinition extends __BaseException {
|
|
533
533
|
readonly name: "InvalidDefinition";
|
|
@@ -538,8 +538,8 @@ export declare class InvalidDefinition extends __BaseException {
|
|
|
538
538
|
constructor(opts: __ExceptionOptionType<InvalidDefinition, __BaseException>);
|
|
539
539
|
}
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <p></p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
export declare class InvalidLoggingConfiguration extends __BaseException {
|
|
545
545
|
readonly name: "InvalidLoggingConfiguration";
|
|
@@ -550,9 +550,9 @@ export declare class InvalidLoggingConfiguration extends __BaseException {
|
|
|
550
550
|
constructor(opts: __ExceptionOptionType<InvalidLoggingConfiguration, __BaseException>);
|
|
551
551
|
}
|
|
552
552
|
/**
|
|
553
|
-
* @public
|
|
554
553
|
* <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not
|
|
555
554
|
* been set to <code>true</code> or <code>false</code>.</p>
|
|
555
|
+
* @public
|
|
556
556
|
*/
|
|
557
557
|
export declare class InvalidTracingConfiguration extends __BaseException {
|
|
558
558
|
readonly name: "InvalidTracingConfiguration";
|
|
@@ -563,9 +563,9 @@ export declare class InvalidTracingConfiguration extends __BaseException {
|
|
|
563
563
|
constructor(opts: __ExceptionOptionType<InvalidTracingConfiguration, __BaseException>);
|
|
564
564
|
}
|
|
565
565
|
/**
|
|
566
|
-
* @public
|
|
567
566
|
* <p>A state machine with the same name but a different definition or role ARN already
|
|
568
567
|
* exists.</p>
|
|
568
|
+
* @public
|
|
569
569
|
*/
|
|
570
570
|
export declare class StateMachineAlreadyExists extends __BaseException {
|
|
571
571
|
readonly name: "StateMachineAlreadyExists";
|
|
@@ -576,8 +576,8 @@ export declare class StateMachineAlreadyExists extends __BaseException {
|
|
|
576
576
|
constructor(opts: __ExceptionOptionType<StateMachineAlreadyExists, __BaseException>);
|
|
577
577
|
}
|
|
578
578
|
/**
|
|
579
|
-
* @public
|
|
580
579
|
* <p>The specified state machine is being deleted.</p>
|
|
580
|
+
* @public
|
|
581
581
|
*/
|
|
582
582
|
export declare class StateMachineDeleting extends __BaseException {
|
|
583
583
|
readonly name: "StateMachineDeleting";
|
|
@@ -588,9 +588,9 @@ export declare class StateMachineDeleting extends __BaseException {
|
|
|
588
588
|
constructor(opts: __ExceptionOptionType<StateMachineDeleting, __BaseException>);
|
|
589
589
|
}
|
|
590
590
|
/**
|
|
591
|
-
* @public
|
|
592
591
|
* <p>The maximum number of state machines has been reached. Existing state machines must be
|
|
593
592
|
* deleted before a new state machine can be created.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
export declare class StateMachineLimitExceeded extends __BaseException {
|
|
596
596
|
readonly name: "StateMachineLimitExceeded";
|
|
@@ -601,8 +601,8 @@ export declare class StateMachineLimitExceeded extends __BaseException {
|
|
|
601
601
|
constructor(opts: __ExceptionOptionType<StateMachineLimitExceeded, __BaseException>);
|
|
602
602
|
}
|
|
603
603
|
/**
|
|
604
|
-
* @public
|
|
605
604
|
* <p></p>
|
|
605
|
+
* @public
|
|
606
606
|
*/
|
|
607
607
|
export declare class StateMachineTypeNotSupported extends __BaseException {
|
|
608
608
|
readonly name: "StateMachineTypeNotSupported";
|
|
@@ -627,15 +627,15 @@ export declare const ValidationExceptionReason: {
|
|
|
627
627
|
*/
|
|
628
628
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
629
629
|
/**
|
|
630
|
-
* @public
|
|
631
630
|
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
export declare class ValidationException extends __BaseException {
|
|
634
634
|
readonly name: "ValidationException";
|
|
635
635
|
readonly $fault: "client";
|
|
636
636
|
/**
|
|
637
|
-
* @public
|
|
638
637
|
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
reason?: ValidationExceptionReason;
|
|
641
641
|
/**
|
|
@@ -644,23 +644,23 @@ export declare class ValidationException extends __BaseException {
|
|
|
644
644
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
645
645
|
}
|
|
646
646
|
/**
|
|
647
|
-
* @public
|
|
648
647
|
* <p>Contains details about the routing configuration of a state machine alias. In a routing
|
|
649
648
|
* configuration, you define an array of objects that specify up to two state machine versions.
|
|
650
649
|
* You also specify the percentage of traffic to be routed to each version.</p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
export interface RoutingConfigurationListItem {
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.</p>
|
|
656
655
|
* <p>If you specify the ARN of a second version, it must belong to the same state machine as the first version.</p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
stateMachineVersionArn: string | undefined;
|
|
659
659
|
/**
|
|
660
|
-
* @public
|
|
661
660
|
* <p>The percentage of traffic you want to route to a state machine
|
|
662
661
|
* version. The sum of the weights in the routing
|
|
663
662
|
* configuration must be equal to 100.</p>
|
|
663
|
+
* @public
|
|
664
664
|
*/
|
|
665
665
|
weight: number | undefined;
|
|
666
666
|
}
|
|
@@ -669,23 +669,23 @@ export interface RoutingConfigurationListItem {
|
|
|
669
669
|
*/
|
|
670
670
|
export interface CreateStateMachineAliasInput {
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>A description for the state machine alias.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
description?: string;
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The name of the state machine alias.</p>
|
|
679
678
|
* <p>To avoid conflict with version ARNs, don't use an integer in the name of the alias.</p>
|
|
679
|
+
* @public
|
|
680
680
|
*/
|
|
681
681
|
name: string | undefined;
|
|
682
682
|
/**
|
|
683
|
-
* @public
|
|
684
683
|
* <p>The routing configuration of a state machine alias. The routing configuration shifts
|
|
685
684
|
* execution traffic between two state machine versions. <code>routingConfiguration</code>
|
|
686
685
|
* contains an array of <code>RoutingConfig</code> objects that specify up to two state machine
|
|
687
686
|
* versions. Step Functions then randomly choses which version to run an execution with based
|
|
688
687
|
* on the weight assigned to each <code>RoutingConfig</code>.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
routingConfiguration: RoutingConfigurationListItem[] | undefined;
|
|
691
691
|
}
|
|
@@ -694,19 +694,19 @@ export interface CreateStateMachineAliasInput {
|
|
|
694
694
|
*/
|
|
695
695
|
export interface CreateStateMachineAliasOutput {
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>The Amazon Resource Name (ARN) that identifies the created state machine alias.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
stateMachineAliasArn: string | undefined;
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The date the state machine alias was created.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
creationDate: Date | undefined;
|
|
706
706
|
}
|
|
707
707
|
/**
|
|
708
|
-
* @public
|
|
709
708
|
* <p>Could not find the referenced resource.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
export declare class ResourceNotFound extends __BaseException {
|
|
712
712
|
readonly name: "ResourceNotFound";
|
|
@@ -718,9 +718,9 @@ export declare class ResourceNotFound extends __BaseException {
|
|
|
718
718
|
constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
|
|
719
719
|
}
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
723
722
|
* <p>HTTP Status Code: 402</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
726
726
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -735,8 +735,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
735
735
|
*/
|
|
736
736
|
export interface DeleteActivityInput {
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>The Amazon Resource Name (ARN) of the activity to delete.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
activityArn: string | undefined;
|
|
742
742
|
}
|
|
@@ -750,8 +750,8 @@ export interface DeleteActivityOutput {
|
|
|
750
750
|
*/
|
|
751
751
|
export interface DeleteStateMachineInput {
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <p>The Amazon Resource Name (ARN) of the state machine to delete.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
stateMachineArn: string | undefined;
|
|
757
757
|
}
|
|
@@ -765,8 +765,8 @@ export interface DeleteStateMachineOutput {
|
|
|
765
765
|
*/
|
|
766
766
|
export interface DeleteStateMachineAliasInput {
|
|
767
767
|
/**
|
|
768
|
-
* @public
|
|
769
768
|
* <p>The Amazon Resource Name (ARN) of the state machine alias to delete.</p>
|
|
769
|
+
* @public
|
|
770
770
|
*/
|
|
771
771
|
stateMachineAliasArn: string | undefined;
|
|
772
772
|
}
|
|
@@ -780,8 +780,8 @@ export interface DeleteStateMachineAliasOutput {
|
|
|
780
780
|
*/
|
|
781
781
|
export interface DeleteStateMachineVersionInput {
|
|
782
782
|
/**
|
|
783
|
-
* @public
|
|
784
783
|
* <p>The Amazon Resource Name (ARN) of the state machine version to delete.</p>
|
|
784
|
+
* @public
|
|
785
785
|
*/
|
|
786
786
|
stateMachineVersionArn: string | undefined;
|
|
787
787
|
}
|
|
@@ -795,8 +795,8 @@ export interface DeleteStateMachineVersionOutput {
|
|
|
795
795
|
*/
|
|
796
796
|
export interface DescribeActivityInput {
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>The Amazon Resource Name (ARN) of the activity to describe.</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
activityArn: string | undefined;
|
|
802
802
|
}
|
|
@@ -805,12 +805,11 @@ export interface DescribeActivityInput {
|
|
|
805
805
|
*/
|
|
806
806
|
export interface DescribeActivityOutput {
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>The Amazon Resource Name (ARN) that identifies the activity.</p>
|
|
809
|
+
* @public
|
|
810
810
|
*/
|
|
811
811
|
activityArn: string | undefined;
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The name of the activity.</p>
|
|
815
814
|
* <p>A name must <i>not</i> contain:</p>
|
|
816
815
|
* <ul>
|
|
@@ -834,11 +833,12 @@ export interface DescribeActivityOutput {
|
|
|
834
833
|
* </li>
|
|
835
834
|
* </ul>
|
|
836
835
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
name: string | undefined;
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The date the activity is created.</p>
|
|
841
|
+
* @public
|
|
842
842
|
*/
|
|
843
843
|
creationDate: Date | undefined;
|
|
844
844
|
}
|
|
@@ -847,20 +847,20 @@ export interface DescribeActivityOutput {
|
|
|
847
847
|
*/
|
|
848
848
|
export interface DescribeExecutionInput {
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>The Amazon Resource Name (ARN) of the execution to describe.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
executionArn: string | undefined;
|
|
854
854
|
}
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>Provides details about execution input or output.</p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
export interface CloudWatchEventsExecutionDataDetails {
|
|
860
860
|
/**
|
|
861
|
-
* @public
|
|
862
861
|
* <p>Indicates whether input or output was included in the response. Always <code>true</code>
|
|
863
862
|
* for API calls. </p>
|
|
863
|
+
* @public
|
|
864
864
|
*/
|
|
865
865
|
included?: boolean;
|
|
866
866
|
}
|
|
@@ -898,17 +898,16 @@ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionSta
|
|
|
898
898
|
*/
|
|
899
899
|
export interface DescribeExecutionOutput {
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
executionArn: string | undefined;
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>The Amazon Resource Name (ARN) of the executed stated machine.</p>
|
|
907
|
+
* @public
|
|
908
908
|
*/
|
|
909
909
|
stateMachineArn: string | undefined;
|
|
910
910
|
/**
|
|
911
|
-
* @public
|
|
912
911
|
* <p>The name of the execution.</p>
|
|
913
912
|
* <p>A name must <i>not</i> contain:</p>
|
|
914
913
|
* <ul>
|
|
@@ -932,94 +931,94 @@ export interface DescribeExecutionOutput {
|
|
|
932
931
|
* </li>
|
|
933
932
|
* </ul>
|
|
934
933
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
934
|
+
* @public
|
|
935
935
|
*/
|
|
936
936
|
name?: string;
|
|
937
937
|
/**
|
|
938
|
-
* @public
|
|
939
938
|
* <p>The current status of the execution.</p>
|
|
939
|
+
* @public
|
|
940
940
|
*/
|
|
941
941
|
status: ExecutionStatus | undefined;
|
|
942
942
|
/**
|
|
943
|
-
* @public
|
|
944
943
|
* <p>The date the execution is started.</p>
|
|
944
|
+
* @public
|
|
945
945
|
*/
|
|
946
946
|
startDate: Date | undefined;
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p>If the execution ended, the date the execution stopped.</p>
|
|
949
|
+
* @public
|
|
950
950
|
*/
|
|
951
951
|
stopDate?: Date;
|
|
952
952
|
/**
|
|
953
|
-
* @public
|
|
954
953
|
* <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>
|
|
954
|
+
* @public
|
|
955
955
|
*/
|
|
956
956
|
input?: string;
|
|
957
957
|
/**
|
|
958
|
-
* @public
|
|
959
958
|
* <p>Provides details about execution input or output.</p>
|
|
959
|
+
* @public
|
|
960
960
|
*/
|
|
961
961
|
inputDetails?: CloudWatchEventsExecutionDataDetails;
|
|
962
962
|
/**
|
|
963
|
-
* @public
|
|
964
963
|
* <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>
|
|
965
964
|
* <note>
|
|
966
965
|
* <p>This field is set only if the execution succeeds. If the execution fails, this field is
|
|
967
966
|
* null.</p>
|
|
968
967
|
* </note>
|
|
968
|
+
* @public
|
|
969
969
|
*/
|
|
970
970
|
output?: string;
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>Provides details about execution input or output.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
outputDetails?: CloudWatchEventsExecutionDataDetails;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The X-Ray trace header that was passed to the execution.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
traceHeader?: string;
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
mapRunArn?: string;
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>The error string if the state machine execution failed.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
error?: string;
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>The cause string if the state machine execution failed.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
cause?: string;
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
|
|
999
998
|
* <p>If you start an execution from a <code>StartExecution</code> request without specifying a
|
|
1000
999
|
* state machine version or alias ARN, Step Functions returns a null value.</p>
|
|
1000
|
+
* @public
|
|
1001
1001
|
*/
|
|
1002
1002
|
stateMachineVersionArn?: string;
|
|
1003
1003
|
/**
|
|
1004
|
-
* @public
|
|
1005
1004
|
* <p>The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, <code>stateMachineARN:PROD</code>.</p>
|
|
1006
1005
|
* <p>If you start an execution from a <code>StartExecution</code> request with a
|
|
1007
1006
|
* state machine version ARN, this field will be null.</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
stateMachineAliasArn?: string;
|
|
1010
1010
|
/**
|
|
1011
|
-
* @public
|
|
1012
1011
|
* <p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is only updated if you successfully redrive an execution.</p>
|
|
1012
|
+
* @public
|
|
1013
1013
|
*/
|
|
1014
1014
|
redriveCount?: number;
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The date the execution was last redriven. If you have not yet redriven an execution, the <code>redriveDate</code> is null.</p>
|
|
1018
1017
|
* <p>The <code>redriveDate</code> is unavailable if you redrive a Map Run that starts child workflow executions of type <code>EXPRESS</code>.</p>
|
|
1018
|
+
* @public
|
|
1019
1019
|
*/
|
|
1020
1020
|
redriveDate?: Date;
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>Indicates whether or not an execution can be redriven at a given point in time.</p>
|
|
1024
1023
|
* <ul>
|
|
1025
1024
|
* <li>
|
|
@@ -1033,10 +1032,10 @@ export interface DescribeExecutionOutput {
|
|
|
1033
1032
|
* <p>You can redrive failed or timed out <code>EXPRESS</code> workflows <i>only if</i> they're a part of a Map Run. When you <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">redrive</a> the Map Run, these workflows are restarted using the <a>StartExecution</a> API action.</p>
|
|
1034
1033
|
* </li>
|
|
1035
1034
|
* </ul>
|
|
1035
|
+
* @public
|
|
1036
1036
|
*/
|
|
1037
1037
|
redriveStatus?: ExecutionRedriveStatus;
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>When <code>redriveStatus</code> is <code>NOT_REDRIVABLE</code>, <code>redriveStatusReason</code> specifies the reason why an execution cannot be redriven.</p>
|
|
1041
1040
|
* <ul>
|
|
1042
1041
|
* <li>
|
|
@@ -1076,12 +1075,13 @@ export interface DescribeExecutionOutput {
|
|
|
1076
1075
|
* <p>For a Distributed Map that includes child workflows of type <code>EXPRESS</code>, <code>redriveStatusReason</code> is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.</p>
|
|
1077
1076
|
* </li>
|
|
1078
1077
|
* </ul>
|
|
1078
|
+
* @public
|
|
1079
1079
|
*/
|
|
1080
1080
|
redriveStatusReason?: string;
|
|
1081
1081
|
}
|
|
1082
1082
|
/**
|
|
1083
|
-
* @public
|
|
1084
1083
|
* <p>The specified execution does not exist.</p>
|
|
1084
|
+
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
export declare class ExecutionDoesNotExist extends __BaseException {
|
|
1087
1087
|
readonly name: "ExecutionDoesNotExist";
|
|
@@ -1096,120 +1096,120 @@ export declare class ExecutionDoesNotExist extends __BaseException {
|
|
|
1096
1096
|
*/
|
|
1097
1097
|
export interface DescribeMapRunInput {
|
|
1098
1098
|
/**
|
|
1099
|
-
* @public
|
|
1100
1099
|
* <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
mapRunArn: string | undefined;
|
|
1103
1103
|
}
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>Contains details about all of the child workflow executions started by a Map Run.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
export interface MapRunExecutionCounts {
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>The total number of child workflow executions that were started by a Map Run, but haven't started executing yet. </p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
pending: number | undefined;
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The total number of child workflow executions that were started by a Map Run and are currently in-progress.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
running: number | undefined;
|
|
1119
1119
|
/**
|
|
1120
|
-
* @public
|
|
1121
1120
|
* <p>The total number of child workflow executions that were started by a Map Run and have completed successfully.</p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
succeeded: number | undefined;
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>The total number of child workflow executions that were started by a Map Run, but have failed.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
failed: number | undefined;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>The total number of child workflow executions that were started by a Map Run and have timed out.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
timedOut: number | undefined;
|
|
1134
1134
|
/**
|
|
1135
|
-
* @public
|
|
1136
1135
|
* <p>The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed. </p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
aborted: number | undefined;
|
|
1139
1139
|
/**
|
|
1140
|
-
* @public
|
|
1141
1140
|
* <p>The total number of child workflow executions that were started by a Map Run.</p>
|
|
1141
|
+
* @public
|
|
1142
1142
|
*/
|
|
1143
1143
|
total: number | undefined;
|
|
1144
1144
|
/**
|
|
1145
|
-
* @public
|
|
1146
1145
|
* <p>Returns the count of child workflow executions whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
1146
|
+
* @public
|
|
1147
1147
|
*/
|
|
1148
1148
|
resultsWritten: number | undefined;
|
|
1149
1149
|
/**
|
|
1150
|
-
* @public
|
|
1151
1150
|
* <p>The number of <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> child workflow executions that cannot be redriven because their execution status is terminal. For example, child workflows with an execution status of <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> and a <code>redriveStatus</code> of <code>NOT_REDRIVABLE</code>.</p>
|
|
1151
|
+
* @public
|
|
1152
1152
|
*/
|
|
1153
1153
|
failuresNotRedrivable?: number;
|
|
1154
1154
|
/**
|
|
1155
|
-
* @public
|
|
1156
1155
|
* <p>The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> in the original execution attempt or a previous redrive attempt.</p>
|
|
1156
|
+
* @public
|
|
1157
1157
|
*/
|
|
1158
1158
|
pendingRedrive?: number;
|
|
1159
1159
|
}
|
|
1160
1160
|
/**
|
|
1161
|
-
* @public
|
|
1162
1161
|
* <p>Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
export interface MapRunItemCounts {
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p>The total number of items to process in child workflow executions that haven't started running yet.</p>
|
|
1167
|
+
* @public
|
|
1168
1168
|
*/
|
|
1169
1169
|
pending: number | undefined;
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>The total number of items being processed in child workflow executions that are currently in-progress.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
running: number | undefined;
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The total number of items processed in child workflow executions that have completed successfully.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
succeeded: number | undefined;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The total number of items processed in child workflow executions that have failed.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
failed: number | undefined;
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The total number of items processed in child workflow executions that have timed out.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
timedOut: number | undefined;
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
aborted: number | undefined;
|
|
1195
1195
|
/**
|
|
1196
|
-
* @public
|
|
1197
1196
|
* <p>The total number of items processed in all the child workflow executions started by a Map Run.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
total: number | undefined;
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>Returns the count of items whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
resultsWritten: number | undefined;
|
|
1205
1205
|
/**
|
|
1206
|
-
* @public
|
|
1207
1206
|
* <p>The number of <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> and a <code>redriveStatus</code> of <code>NOT_REDRIVABLE</code>.</p>
|
|
1207
|
+
* @public
|
|
1208
1208
|
*/
|
|
1209
1209
|
failuresNotRedrivable?: number;
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>The number of unsuccessful items in child workflow executions currently waiting to be redriven.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
pendingRedrive?: number;
|
|
1215
1215
|
}
|
|
@@ -1232,63 +1232,63 @@ export type MapRunStatus = (typeof MapRunStatus)[keyof typeof MapRunStatus];
|
|
|
1232
1232
|
*/
|
|
1233
1233
|
export interface DescribeMapRunOutput {
|
|
1234
1234
|
/**
|
|
1235
|
-
* @public
|
|
1236
1235
|
* <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
|
|
1236
|
+
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
mapRunArn: string | undefined;
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
executionArn: string | undefined;
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>The current status of the Map Run.</p>
|
|
1246
|
+
* @public
|
|
1247
1247
|
*/
|
|
1248
1248
|
status: MapRunStatus | undefined;
|
|
1249
1249
|
/**
|
|
1250
|
-
* @public
|
|
1251
1250
|
* <p>The date when the Map Run was started.</p>
|
|
1251
|
+
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
startDate: Date | undefined;
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>The date when the Map Run was stopped.</p>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
stopDate?: Date;
|
|
1259
1259
|
/**
|
|
1260
|
-
* @public
|
|
1261
1260
|
* <p>The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.</p>
|
|
1261
|
+
* @public
|
|
1262
1262
|
*/
|
|
1263
1263
|
maxConcurrency: number | undefined;
|
|
1264
1264
|
/**
|
|
1265
|
-
* @public
|
|
1266
1265
|
* <p>The maximum percentage of failed child workflow executions before the Map Run fails.</p>
|
|
1266
|
+
* @public
|
|
1267
1267
|
*/
|
|
1268
1268
|
toleratedFailurePercentage: number | undefined;
|
|
1269
1269
|
/**
|
|
1270
|
-
* @public
|
|
1271
1270
|
* <p>The maximum number of failed child workflow executions before the Map Run fails.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
toleratedFailureCount: number | undefined;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>A JSON object that contains information about the total number of items, and the item count for each processing status, such as <code>pending</code> and <code>failed</code>.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
itemCounts: MapRunItemCounts | undefined;
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as <code>failed</code> and <code>succeeded</code>.</p>
|
|
1281
|
+
* @public
|
|
1282
1282
|
*/
|
|
1283
1283
|
executionCounts: MapRunExecutionCounts | undefined;
|
|
1284
1284
|
/**
|
|
1285
|
-
* @public
|
|
1286
1285
|
* <p>The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the <code>redriveCount</code> is 0. This count is only updated if you successfully redrive a Map Run.</p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
redriveCount?: number;
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>The date a Map Run was last redriven. If you have not yet redriven a Map Run, the <code>redriveDate</code> is null.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
redriveDate?: Date;
|
|
1294
1294
|
}
|
|
@@ -1297,9 +1297,9 @@ export interface DescribeMapRunOutput {
|
|
|
1297
1297
|
*/
|
|
1298
1298
|
export interface DescribeStateMachineInput {
|
|
1299
1299
|
/**
|
|
1300
|
-
* @public
|
|
1301
1300
|
* <p>The Amazon Resource Name (ARN) of the state machine for which you want the information.</p>
|
|
1302
1301
|
* <p>If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
|
|
1302
|
+
* @public
|
|
1303
1303
|
*/
|
|
1304
1304
|
stateMachineArn: string | undefined;
|
|
1305
1305
|
}
|
|
@@ -1320,13 +1320,12 @@ export type StateMachineStatus = (typeof StateMachineStatus)[keyof typeof StateM
|
|
|
1320
1320
|
*/
|
|
1321
1321
|
export interface DescribeStateMachineOutput {
|
|
1322
1322
|
/**
|
|
1323
|
-
* @public
|
|
1324
1323
|
* <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
|
|
1325
1324
|
* <p>If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
stateMachineArn: string | undefined;
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>The name of the state machine.</p>
|
|
1331
1330
|
* <p>A name must <i>not</i> contain:</p>
|
|
1332
1331
|
* <ul>
|
|
@@ -1350,69 +1349,70 @@ export interface DescribeStateMachineOutput {
|
|
|
1350
1349
|
* </li>
|
|
1351
1350
|
* </ul>
|
|
1352
1351
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
1352
|
+
* @public
|
|
1353
1353
|
*/
|
|
1354
1354
|
name: string | undefined;
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>The current status of the state machine.</p>
|
|
1357
|
+
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
status?: StateMachineStatus;
|
|
1360
1360
|
/**
|
|
1361
|
-
* @public
|
|
1362
1361
|
* <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>
|
|
1362
|
+
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
definition: string | undefined;
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role
|
|
1368
1367
|
* maintains security by granting Step Functions access to Amazon Web Services resources.)</p>
|
|
1368
|
+
* @public
|
|
1369
1369
|
*/
|
|
1370
1370
|
roleArn: string | undefined;
|
|
1371
1371
|
/**
|
|
1372
|
-
* @public
|
|
1373
1372
|
* <p>The <code>type</code> of the state machine (<code>STANDARD</code> or
|
|
1374
1373
|
* <code>EXPRESS</code>).</p>
|
|
1374
|
+
* @public
|
|
1375
1375
|
*/
|
|
1376
1376
|
type: StateMachineType | undefined;
|
|
1377
1377
|
/**
|
|
1378
|
-
* @public
|
|
1379
1378
|
* <p>The date the state machine is created.</p>
|
|
1380
1379
|
* <p>For a state machine version, <code>creationDate</code> is the date the version was created.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
creationDate: Date | undefined;
|
|
1383
1383
|
/**
|
|
1384
|
-
* @public
|
|
1385
1384
|
* <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
|
|
1386
1385
|
* options.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
loggingConfiguration?: LoggingConfiguration;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
tracingConfiguration?: TracingConfiguration;
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>A user-defined or an auto-generated string that identifies a <code>Map</code> state. This parameter is present only if the <code>stateMachineArn</code> specified in input is a qualified state machine ARN.</p>
|
|
1396
|
+
* @public
|
|
1397
1397
|
*/
|
|
1398
1398
|
label?: string;
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* <p>The revision identifier for the state machine.</p>
|
|
1402
1401
|
* <p>Use the <code>revisionId</code> parameter to compare between versions of a state machine
|
|
1403
1402
|
* configuration used for executions without performing a diff of the properties, such as
|
|
1404
1403
|
* <code>definition</code> and <code>roleArn</code>.</p>
|
|
1404
|
+
* @public
|
|
1405
1405
|
*/
|
|
1406
1406
|
revisionId?: string;
|
|
1407
1407
|
/**
|
|
1408
|
-
* @public
|
|
1409
1408
|
* <p>The description of the state machine version.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
description?: string;
|
|
1412
1412
|
}
|
|
1413
1413
|
/**
|
|
1414
|
-
* @public
|
|
1415
1414
|
* <p>The specified state machine does not exist.</p>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
export declare class StateMachineDoesNotExist extends __BaseException {
|
|
1418
1418
|
readonly name: "StateMachineDoesNotExist";
|
|
@@ -1427,8 +1427,8 @@ export declare class StateMachineDoesNotExist extends __BaseException {
|
|
|
1427
1427
|
*/
|
|
1428
1428
|
export interface DescribeStateMachineAliasInput {
|
|
1429
1429
|
/**
|
|
1430
|
-
* @public
|
|
1431
1430
|
* <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
|
|
1431
|
+
* @public
|
|
1432
1432
|
*/
|
|
1433
1433
|
stateMachineAliasArn: string | undefined;
|
|
1434
1434
|
}
|
|
@@ -1437,34 +1437,34 @@ export interface DescribeStateMachineAliasInput {
|
|
|
1437
1437
|
*/
|
|
1438
1438
|
export interface DescribeStateMachineAliasOutput {
|
|
1439
1439
|
/**
|
|
1440
|
-
* @public
|
|
1441
1440
|
* <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
stateMachineAliasArn?: string;
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>The name of the state machine alias.</p>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
name?: string;
|
|
1449
1449
|
/**
|
|
1450
|
-
* @public
|
|
1451
1450
|
* <p>A description of the alias.</p>
|
|
1451
|
+
* @public
|
|
1452
1452
|
*/
|
|
1453
1453
|
description?: string;
|
|
1454
1454
|
/**
|
|
1455
|
-
* @public
|
|
1456
1455
|
* <p>The routing configuration of the alias.</p>
|
|
1456
|
+
* @public
|
|
1457
1457
|
*/
|
|
1458
1458
|
routingConfiguration?: RoutingConfigurationListItem[];
|
|
1459
1459
|
/**
|
|
1460
|
-
* @public
|
|
1461
1460
|
* <p>The date the state machine alias was created.</p>
|
|
1461
|
+
* @public
|
|
1462
1462
|
*/
|
|
1463
1463
|
creationDate?: Date;
|
|
1464
1464
|
/**
|
|
1465
|
-
* @public
|
|
1466
1465
|
* <p>The date the state machine alias was last updated.</p>
|
|
1467
1466
|
* <p>For a newly created state machine, this is the same as the creation date.</p>
|
|
1467
|
+
* @public
|
|
1468
1468
|
*/
|
|
1469
1469
|
updateDate?: Date;
|
|
1470
1470
|
}
|
|
@@ -1473,8 +1473,8 @@ export interface DescribeStateMachineAliasOutput {
|
|
|
1473
1473
|
*/
|
|
1474
1474
|
export interface DescribeStateMachineForExecutionInput {
|
|
1475
1475
|
/**
|
|
1476
|
-
* @public
|
|
1477
1476
|
* <p>The Amazon Resource Name (ARN) of the execution you want state machine information for.</p>
|
|
1477
|
+
* @public
|
|
1478
1478
|
*/
|
|
1479
1479
|
executionArn: string | undefined;
|
|
1480
1480
|
}
|
|
@@ -1483,56 +1483,56 @@ export interface DescribeStateMachineForExecutionInput {
|
|
|
1483
1483
|
*/
|
|
1484
1484
|
export interface DescribeStateMachineForExecutionOutput {
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>The Amazon Resource Name (ARN) of the state machine associated with the execution.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
stateMachineArn: string | undefined;
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>The name of the state machine associated with the execution.</p>
|
|
1492
|
+
* @public
|
|
1493
1493
|
*/
|
|
1494
1494
|
name: string | undefined;
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <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>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
definition: string | undefined;
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. </p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
roleArn: string | undefined;
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>The date and time the state machine associated with an execution was updated. For a newly
|
|
1508
1507
|
* created state machine, this is the creation date.</p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
updateDate: Date | undefined;
|
|
1511
1511
|
/**
|
|
1512
|
-
* @public
|
|
1513
1512
|
* <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
|
|
1514
1513
|
* options.</p>
|
|
1514
|
+
* @public
|
|
1515
1515
|
*/
|
|
1516
1516
|
loggingConfiguration?: LoggingConfiguration;
|
|
1517
1517
|
/**
|
|
1518
|
-
* @public
|
|
1519
1518
|
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
1519
|
+
* @public
|
|
1520
1520
|
*/
|
|
1521
1521
|
tracingConfiguration?: TracingConfiguration;
|
|
1522
1522
|
/**
|
|
1523
|
-
* @public
|
|
1524
1523
|
* <p>The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the <code>executionArn</code> is a child workflow execution that was started by a Distributed Map state.</p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
mapRunArn?: string;
|
|
1527
1527
|
/**
|
|
1528
|
-
* @public
|
|
1529
1528
|
* <p>A user-defined or an auto-generated string that identifies a <code>Map</code> state. This field is returned only if the <code>executionArn</code> is a child workflow execution that was started by a Distributed Map state.</p>
|
|
1529
|
+
* @public
|
|
1530
1530
|
*/
|
|
1531
1531
|
label?: string;
|
|
1532
1532
|
/**
|
|
1533
|
-
* @public
|
|
1534
1533
|
* <p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p>
|
|
1535
1534
|
* <p>Use the state machine <code>revisionId</code> parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.</p>
|
|
1535
|
+
* @public
|
|
1536
1536
|
*/
|
|
1537
1537
|
revisionId?: string;
|
|
1538
1538
|
}
|
|
@@ -1541,15 +1541,15 @@ export interface DescribeStateMachineForExecutionOutput {
|
|
|
1541
1541
|
*/
|
|
1542
1542
|
export interface GetActivityTaskInput {
|
|
1543
1543
|
/**
|
|
1544
|
-
* @public
|
|
1545
1544
|
* <p>The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task
|
|
1546
1545
|
* using <a>CreateActivity</a>.)</p>
|
|
1546
|
+
* @public
|
|
1547
1547
|
*/
|
|
1548
1548
|
activityArn: string | undefined;
|
|
1549
1549
|
/**
|
|
1550
|
-
* @public
|
|
1551
1550
|
* <p>You can provide an arbitrary name in order to identify the worker that the task is
|
|
1552
1551
|
* assigned to. This name is used when it is logged in the execution history.</p>
|
|
1552
|
+
* @public
|
|
1553
1553
|
*/
|
|
1554
1554
|
workerName?: string;
|
|
1555
1555
|
}
|
|
@@ -1558,16 +1558,16 @@ export interface GetActivityTaskInput {
|
|
|
1558
1558
|
*/
|
|
1559
1559
|
export interface GetActivityTaskOutput {
|
|
1560
1560
|
/**
|
|
1561
|
-
* @public
|
|
1562
1561
|
* <p>A token that identifies the scheduled task. This token must be copied and included in
|
|
1563
1562
|
* subsequent calls to <a>SendTaskHeartbeat</a>, <a>SendTaskSuccess</a> or
|
|
1564
1563
|
* <a>SendTaskFailure</a> in order to report the progress or completion of the
|
|
1565
1564
|
* task.</p>
|
|
1565
|
+
* @public
|
|
1566
1566
|
*/
|
|
1567
1567
|
taskToken?: string;
|
|
1568
1568
|
/**
|
|
1569
|
-
* @public
|
|
1570
1569
|
* <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>
|
|
1570
|
+
* @public
|
|
1571
1571
|
*/
|
|
1572
1572
|
input?: string;
|
|
1573
1573
|
}
|
|
@@ -1576,363 +1576,362 @@ export interface GetActivityTaskOutput {
|
|
|
1576
1576
|
*/
|
|
1577
1577
|
export interface GetExecutionHistoryInput {
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>The Amazon Resource Name (ARN) of the execution.</p>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
executionArn: string | undefined;
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
1586
1585
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
1587
1586
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
1587
|
+
* @public
|
|
1588
1588
|
*/
|
|
1589
1589
|
maxResults?: number;
|
|
1590
1590
|
/**
|
|
1591
|
-
* @public
|
|
1592
1591
|
* <p>Lists events in descending order of their <code>timeStamp</code>.</p>
|
|
1592
|
+
* @public
|
|
1593
1593
|
*/
|
|
1594
1594
|
reverseOrder?: boolean;
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <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.
|
|
1598
1597
|
* 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>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
nextToken?: string;
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <p>You can select whether execution data (input or output of a history event) is returned.
|
|
1604
1603
|
* The default is <code>true</code>.</p>
|
|
1604
|
+
* @public
|
|
1605
1605
|
*/
|
|
1606
1606
|
includeExecutionData?: boolean;
|
|
1607
1607
|
}
|
|
1608
1608
|
/**
|
|
1609
|
-
* @public
|
|
1610
1609
|
* <p>Contains details about an abort of an execution.</p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
export interface ExecutionAbortedEventDetails {
|
|
1613
1613
|
/**
|
|
1614
|
-
* @public
|
|
1615
1614
|
* <p>The error code of the failure.</p>
|
|
1615
|
+
* @public
|
|
1616
1616
|
*/
|
|
1617
1617
|
error?: string;
|
|
1618
1618
|
/**
|
|
1619
|
-
* @public
|
|
1620
1619
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1620
|
+
* @public
|
|
1621
1621
|
*/
|
|
1622
1622
|
cause?: string;
|
|
1623
1623
|
}
|
|
1624
1624
|
/**
|
|
1625
|
-
* @public
|
|
1626
1625
|
* <p>Contains details about an execution failure event.</p>
|
|
1626
|
+
* @public
|
|
1627
1627
|
*/
|
|
1628
1628
|
export interface ExecutionFailedEventDetails {
|
|
1629
1629
|
/**
|
|
1630
|
-
* @public
|
|
1631
1630
|
* <p>The error code of the failure.</p>
|
|
1631
|
+
* @public
|
|
1632
1632
|
*/
|
|
1633
1633
|
error?: string;
|
|
1634
1634
|
/**
|
|
1635
|
-
* @public
|
|
1636
1635
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1636
|
+
* @public
|
|
1637
1637
|
*/
|
|
1638
1638
|
cause?: string;
|
|
1639
1639
|
}
|
|
1640
1640
|
/**
|
|
1641
|
-
* @public
|
|
1642
1641
|
* <p>Contains details about a redriven execution.</p>
|
|
1642
|
+
* @public
|
|
1643
1643
|
*/
|
|
1644
1644
|
export interface ExecutionRedrivenEventDetails {
|
|
1645
1645
|
/**
|
|
1646
|
-
* @public
|
|
1647
1646
|
* <p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is not updated for redrives that failed to start or are pending to be redriven.</p>
|
|
1647
|
+
* @public
|
|
1648
1648
|
*/
|
|
1649
1649
|
redriveCount?: number;
|
|
1650
1650
|
}
|
|
1651
1651
|
/**
|
|
1652
|
-
* @public
|
|
1653
1652
|
* <p>Contains details about the start of the execution.</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
export interface ExecutionStartedEventDetails {
|
|
1656
1656
|
/**
|
|
1657
|
-
* @public
|
|
1658
1657
|
* <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>
|
|
1658
|
+
* @public
|
|
1659
1659
|
*/
|
|
1660
1660
|
input?: string;
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>Contains details about the input for an execution history event.</p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
inputDetails?: HistoryEventExecutionDataDetails;
|
|
1666
1666
|
/**
|
|
1667
|
-
* @public
|
|
1668
1667
|
* <p>The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.</p>
|
|
1668
|
+
* @public
|
|
1669
1669
|
*/
|
|
1670
1670
|
roleArn?: string;
|
|
1671
1671
|
/**
|
|
1672
|
-
* @public
|
|
1673
1672
|
* <p>The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.</p>
|
|
1673
|
+
* @public
|
|
1674
1674
|
*/
|
|
1675
1675
|
stateMachineAliasArn?: string;
|
|
1676
1676
|
/**
|
|
1677
|
-
* @public
|
|
1678
1677
|
* <p>The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.</p>
|
|
1678
|
+
* @public
|
|
1679
1679
|
*/
|
|
1680
1680
|
stateMachineVersionArn?: string;
|
|
1681
1681
|
}
|
|
1682
1682
|
/**
|
|
1683
|
-
* @public
|
|
1684
1683
|
* <p>Contains details about the successful termination of the execution.</p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
export interface ExecutionSucceededEventDetails {
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <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>
|
|
1689
|
+
* @public
|
|
1690
1690
|
*/
|
|
1691
1691
|
output?: string;
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>Contains details about the output of an execution history event.</p>
|
|
1694
|
+
* @public
|
|
1695
1695
|
*/
|
|
1696
1696
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
1697
1697
|
}
|
|
1698
1698
|
/**
|
|
1699
|
-
* @public
|
|
1700
1699
|
* <p>Contains details about the execution timeout that occurred during the execution.</p>
|
|
1700
|
+
* @public
|
|
1701
1701
|
*/
|
|
1702
1702
|
export interface ExecutionTimedOutEventDetails {
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>The error code of the failure.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
error?: string;
|
|
1708
1708
|
/**
|
|
1709
|
-
* @public
|
|
1710
1709
|
* <p>A more detailed explanation of the cause of the timeout.</p>
|
|
1710
|
+
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
cause?: string;
|
|
1713
1713
|
}
|
|
1714
1714
|
/**
|
|
1715
|
-
* @public
|
|
1716
1715
|
* <p>Contains details about a Lambda function that failed during an execution.</p>
|
|
1716
|
+
* @public
|
|
1717
1717
|
*/
|
|
1718
1718
|
export interface LambdaFunctionFailedEventDetails {
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p>The error code of the failure.</p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
error?: string;
|
|
1724
1724
|
/**
|
|
1725
|
-
* @public
|
|
1726
1725
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
cause?: string;
|
|
1729
1729
|
}
|
|
1730
1730
|
/**
|
|
1731
|
-
* @public
|
|
1732
1731
|
* <p>Contains details about the credentials that Step Functions uses for a task.</p>
|
|
1732
|
+
* @public
|
|
1733
1733
|
*/
|
|
1734
1734
|
export interface TaskCredentials {
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
roleArn?: string;
|
|
1740
1740
|
}
|
|
1741
1741
|
/**
|
|
1742
|
-
* @public
|
|
1743
1742
|
* <p>Contains details about a Lambda function scheduled during an execution.</p>
|
|
1743
|
+
* @public
|
|
1744
1744
|
*/
|
|
1745
1745
|
export interface LambdaFunctionScheduledEventDetails {
|
|
1746
1746
|
/**
|
|
1747
|
-
* @public
|
|
1748
1747
|
* <p>The Amazon Resource Name (ARN) of the scheduled Lambda function.</p>
|
|
1748
|
+
* @public
|
|
1749
1749
|
*/
|
|
1750
1750
|
resource: string | undefined;
|
|
1751
1751
|
/**
|
|
1752
|
-
* @public
|
|
1753
1752
|
* <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>
|
|
1753
|
+
* @public
|
|
1754
1754
|
*/
|
|
1755
1755
|
input?: string;
|
|
1756
1756
|
/**
|
|
1757
|
-
* @public
|
|
1758
1757
|
* <p>Contains details about input for an execution history event.</p>
|
|
1758
|
+
* @public
|
|
1759
1759
|
*/
|
|
1760
1760
|
inputDetails?: HistoryEventExecutionDataDetails;
|
|
1761
1761
|
/**
|
|
1762
|
-
* @public
|
|
1763
1762
|
* <p>The maximum allowed duration of the Lambda function.</p>
|
|
1763
|
+
* @public
|
|
1764
1764
|
*/
|
|
1765
1765
|
timeoutInSeconds?: number;
|
|
1766
1766
|
/**
|
|
1767
|
-
* @public
|
|
1768
1767
|
* <p>The credentials that Step Functions uses for the task.</p>
|
|
1768
|
+
* @public
|
|
1769
1769
|
*/
|
|
1770
1770
|
taskCredentials?: TaskCredentials;
|
|
1771
1771
|
}
|
|
1772
1772
|
/**
|
|
1773
|
-
* @public
|
|
1774
1773
|
* <p>Contains details about a failed Lambda function schedule event that occurred during an
|
|
1775
1774
|
* execution.</p>
|
|
1775
|
+
* @public
|
|
1776
1776
|
*/
|
|
1777
1777
|
export interface LambdaFunctionScheduleFailedEventDetails {
|
|
1778
1778
|
/**
|
|
1779
|
-
* @public
|
|
1780
1779
|
* <p>The error code of the failure.</p>
|
|
1780
|
+
* @public
|
|
1781
1781
|
*/
|
|
1782
1782
|
error?: string;
|
|
1783
1783
|
/**
|
|
1784
|
-
* @public
|
|
1785
1784
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1785
|
+
* @public
|
|
1786
1786
|
*/
|
|
1787
1787
|
cause?: string;
|
|
1788
1788
|
}
|
|
1789
1789
|
/**
|
|
1790
|
-
* @public
|
|
1791
1790
|
* <p>Contains details about a lambda function that failed to start during an execution.</p>
|
|
1791
|
+
* @public
|
|
1792
1792
|
*/
|
|
1793
1793
|
export interface LambdaFunctionStartFailedEventDetails {
|
|
1794
1794
|
/**
|
|
1795
|
-
* @public
|
|
1796
1795
|
* <p>The error code of the failure.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
error?: string;
|
|
1799
1799
|
/**
|
|
1800
|
-
* @public
|
|
1801
1800
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1801
|
+
* @public
|
|
1802
1802
|
*/
|
|
1803
1803
|
cause?: string;
|
|
1804
1804
|
}
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>Contains details about a Lambda function that successfully terminated during an
|
|
1808
1807
|
* execution.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
export interface LambdaFunctionSucceededEventDetails {
|
|
1811
1811
|
/**
|
|
1812
|
-
* @public
|
|
1813
1812
|
* <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>
|
|
1813
|
+
* @public
|
|
1814
1814
|
*/
|
|
1815
1815
|
output?: string;
|
|
1816
1816
|
/**
|
|
1817
|
-
* @public
|
|
1818
1817
|
* <p>Contains details about the output of an execution history event.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
1821
1821
|
}
|
|
1822
1822
|
/**
|
|
1823
|
-
* @public
|
|
1824
1823
|
* <p>Contains details about a Lambda function timeout that occurred during an execution.</p>
|
|
1824
|
+
* @public
|
|
1825
1825
|
*/
|
|
1826
1826
|
export interface LambdaFunctionTimedOutEventDetails {
|
|
1827
1827
|
/**
|
|
1828
|
-
* @public
|
|
1829
1828
|
* <p>The error code of the failure.</p>
|
|
1829
|
+
* @public
|
|
1830
1830
|
*/
|
|
1831
1831
|
error?: string;
|
|
1832
1832
|
/**
|
|
1833
|
-
* @public
|
|
1834
1833
|
* <p>A more detailed explanation of the cause of the timeout.</p>
|
|
1834
|
+
* @public
|
|
1835
1835
|
*/
|
|
1836
1836
|
cause?: string;
|
|
1837
1837
|
}
|
|
1838
1838
|
/**
|
|
1839
|
-
* @public
|
|
1840
1839
|
* <p>Contains details about an iteration of a Map state.</p>
|
|
1840
|
+
* @public
|
|
1841
1841
|
*/
|
|
1842
1842
|
export interface MapIterationEventDetails {
|
|
1843
1843
|
/**
|
|
1844
|
-
* @public
|
|
1845
1844
|
* <p>The name of the iteration’s parent Map state.</p>
|
|
1845
|
+
* @public
|
|
1846
1846
|
*/
|
|
1847
1847
|
name?: string;
|
|
1848
1848
|
/**
|
|
1849
|
-
* @public
|
|
1850
1849
|
* <p>The index of the array belonging to the Map state iteration.</p>
|
|
1850
|
+
* @public
|
|
1851
1851
|
*/
|
|
1852
1852
|
index?: number;
|
|
1853
1853
|
}
|
|
1854
1854
|
/**
|
|
1855
|
-
* @public
|
|
1856
1855
|
* <p>Contains details about a Map Run failure event that occurred during a state machine execution.</p>
|
|
1856
|
+
* @public
|
|
1857
1857
|
*/
|
|
1858
1858
|
export interface MapRunFailedEventDetails {
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>The error code of the Map Run failure.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
error?: string;
|
|
1864
1864
|
/**
|
|
1865
|
-
* @public
|
|
1866
1865
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1866
|
+
* @public
|
|
1867
1867
|
*/
|
|
1868
1868
|
cause?: string;
|
|
1869
1869
|
}
|
|
1870
1870
|
/**
|
|
1871
|
-
* @public
|
|
1872
1871
|
* <p>Contains details about a Map Run that was redriven.</p>
|
|
1872
|
+
* @public
|
|
1873
1873
|
*/
|
|
1874
1874
|
export interface MapRunRedrivenEventDetails {
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>The Amazon Resource Name (ARN) of a Map Run that was redriven.</p>
|
|
1877
|
+
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
mapRunArn?: string;
|
|
1880
1880
|
/**
|
|
1881
|
-
* @public
|
|
1882
1881
|
* <p>The number of times the Map Run has been redriven at this point in the execution's history including this event. The redrive count for a redriven Map Run is always greater than 0.</p>
|
|
1882
|
+
* @public
|
|
1883
1883
|
*/
|
|
1884
1884
|
redriveCount?: number;
|
|
1885
1885
|
}
|
|
1886
1886
|
/**
|
|
1887
|
-
* @public
|
|
1888
1887
|
* <p>Contains details about a Map Run that was started during a state machine execution.</p>
|
|
1888
|
+
* @public
|
|
1889
1889
|
*/
|
|
1890
1890
|
export interface MapRunStartedEventDetails {
|
|
1891
1891
|
/**
|
|
1892
|
-
* @public
|
|
1893
1892
|
* <p>The Amazon Resource Name (ARN) of a Map Run that was started.</p>
|
|
1893
|
+
* @public
|
|
1894
1894
|
*/
|
|
1895
1895
|
mapRunArn?: string;
|
|
1896
1896
|
}
|
|
1897
1897
|
/**
|
|
1898
|
-
* @public
|
|
1899
1898
|
* <p>Details about a Map state that was started.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
export interface MapStateStartedEventDetails {
|
|
1902
1902
|
/**
|
|
1903
|
-
* @public
|
|
1904
1903
|
* <p>The size of the array for Map state iterations.</p>
|
|
1904
|
+
* @public
|
|
1905
1905
|
*/
|
|
1906
1906
|
length?: number;
|
|
1907
1907
|
}
|
|
1908
1908
|
/**
|
|
1909
|
-
* @public
|
|
1910
1909
|
* <p>Contains details about a state entered during an execution.</p>
|
|
1910
|
+
* @public
|
|
1911
1911
|
*/
|
|
1912
1912
|
export interface StateEnteredEventDetails {
|
|
1913
1913
|
/**
|
|
1914
|
-
* @public
|
|
1915
1914
|
* <p>The name of the state.</p>
|
|
1915
|
+
* @public
|
|
1916
1916
|
*/
|
|
1917
1917
|
name: string | undefined;
|
|
1918
1918
|
/**
|
|
1919
|
-
* @public
|
|
1920
1919
|
* <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>
|
|
1920
|
+
* @public
|
|
1921
1921
|
*/
|
|
1922
1922
|
input?: string;
|
|
1923
1923
|
/**
|
|
1924
|
-
* @public
|
|
1925
1924
|
* <p>Contains details about the input for an execution history event.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
inputDetails?: HistoryEventExecutionDataDetails;
|
|
1928
1928
|
}
|
|
1929
1929
|
/**
|
|
1930
|
-
* @public
|
|
1931
1930
|
* <p>Contains details about an exit from a state during an execution.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
export interface StateExitedEventDetails {
|
|
1934
1934
|
/**
|
|
1935
|
-
* @public
|
|
1936
1935
|
* <p>The name of the state.</p>
|
|
1937
1936
|
* <p>A name must <i>not</i> contain:</p>
|
|
1938
1937
|
* <ul>
|
|
@@ -1956,231 +1955,232 @@ export interface StateExitedEventDetails {
|
|
|
1956
1955
|
* </li>
|
|
1957
1956
|
* </ul>
|
|
1958
1957
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
1958
|
+
* @public
|
|
1959
1959
|
*/
|
|
1960
1960
|
name: string | undefined;
|
|
1961
1961
|
/**
|
|
1962
|
-
* @public
|
|
1963
1962
|
* <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>
|
|
1963
|
+
* @public
|
|
1964
1964
|
*/
|
|
1965
1965
|
output?: string;
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p>Contains details about the output of an execution history event.</p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
1971
1971
|
}
|
|
1972
1972
|
/**
|
|
1973
|
-
* @public
|
|
1974
1973
|
* <p>Contains details about a task failure event.</p>
|
|
1974
|
+
* @public
|
|
1975
1975
|
*/
|
|
1976
1976
|
export interface TaskFailedEventDetails {
|
|
1977
1977
|
/**
|
|
1978
|
-
* @public
|
|
1979
1978
|
* <p>The service name of the resource in a task state.</p>
|
|
1979
|
+
* @public
|
|
1980
1980
|
*/
|
|
1981
1981
|
resourceType: string | undefined;
|
|
1982
1982
|
/**
|
|
1983
|
-
* @public
|
|
1984
1983
|
* <p>The action of the resource called by a task state.</p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
resource: string | undefined;
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>The error code of the failure.</p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
error?: string;
|
|
1992
1992
|
/**
|
|
1993
|
-
* @public
|
|
1994
1993
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
cause?: string;
|
|
1997
1997
|
}
|
|
1998
1998
|
/**
|
|
1999
|
-
* @public
|
|
2000
1999
|
* <p>Contains details about a task scheduled during an execution.</p>
|
|
2000
|
+
* @public
|
|
2001
2001
|
*/
|
|
2002
2002
|
export interface TaskScheduledEventDetails {
|
|
2003
2003
|
/**
|
|
2004
|
-
* @public
|
|
2005
2004
|
* <p>The service name of the resource in a task state.</p>
|
|
2005
|
+
* @public
|
|
2006
2006
|
*/
|
|
2007
2007
|
resourceType: string | undefined;
|
|
2008
2008
|
/**
|
|
2009
|
-
* @public
|
|
2010
2009
|
* <p>The action of the resource called by a task state.</p>
|
|
2010
|
+
* @public
|
|
2011
2011
|
*/
|
|
2012
2012
|
resource: string | undefined;
|
|
2013
2013
|
/**
|
|
2014
|
-
* @public
|
|
2015
2014
|
* <p>The region of the scheduled task</p>
|
|
2015
|
+
* @public
|
|
2016
2016
|
*/
|
|
2017
2017
|
region: string | undefined;
|
|
2018
2018
|
/**
|
|
2019
|
-
* @public
|
|
2020
2019
|
* <p>The JSON data passed to the resource referenced in a task state.
|
|
2021
2020
|
* Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
2021
|
+
* @public
|
|
2022
2022
|
*/
|
|
2023
2023
|
parameters: string | undefined;
|
|
2024
2024
|
/**
|
|
2025
|
-
* @public
|
|
2026
2025
|
* <p>The maximum allowed duration of the task.</p>
|
|
2026
|
+
* @public
|
|
2027
2027
|
*/
|
|
2028
2028
|
timeoutInSeconds?: number;
|
|
2029
2029
|
/**
|
|
2030
|
-
* @public
|
|
2031
2030
|
* <p>The maximum allowed duration between two heartbeats for the task.</p>
|
|
2031
|
+
* @public
|
|
2032
2032
|
*/
|
|
2033
2033
|
heartbeatInSeconds?: number;
|
|
2034
2034
|
/**
|
|
2035
|
-
* @public
|
|
2036
2035
|
* <p>The credentials that Step Functions uses for the task.</p>
|
|
2036
|
+
* @public
|
|
2037
2037
|
*/
|
|
2038
2038
|
taskCredentials?: TaskCredentials;
|
|
2039
2039
|
}
|
|
2040
2040
|
/**
|
|
2041
|
-
* @public
|
|
2042
2041
|
* <p>Contains details about the start of a task during an execution.</p>
|
|
2042
|
+
* @public
|
|
2043
2043
|
*/
|
|
2044
2044
|
export interface TaskStartedEventDetails {
|
|
2045
2045
|
/**
|
|
2046
|
-
* @public
|
|
2047
2046
|
* <p>The service name of the resource in a task state.</p>
|
|
2047
|
+
* @public
|
|
2048
2048
|
*/
|
|
2049
2049
|
resourceType: string | undefined;
|
|
2050
2050
|
/**
|
|
2051
|
-
* @public
|
|
2052
2051
|
* <p>The action of the resource called by a task state.</p>
|
|
2052
|
+
* @public
|
|
2053
2053
|
*/
|
|
2054
2054
|
resource: string | undefined;
|
|
2055
2055
|
}
|
|
2056
2056
|
/**
|
|
2057
|
-
* @public
|
|
2058
2057
|
* <p>Contains details about a task that failed to start during an execution.</p>
|
|
2058
|
+
* @public
|
|
2059
2059
|
*/
|
|
2060
2060
|
export interface TaskStartFailedEventDetails {
|
|
2061
2061
|
/**
|
|
2062
|
-
* @public
|
|
2063
2062
|
* <p>The service name of the resource in a task state.</p>
|
|
2063
|
+
* @public
|
|
2064
2064
|
*/
|
|
2065
2065
|
resourceType: string | undefined;
|
|
2066
2066
|
/**
|
|
2067
|
-
* @public
|
|
2068
2067
|
* <p>The action of the resource called by a task state.</p>
|
|
2068
|
+
* @public
|
|
2069
2069
|
*/
|
|
2070
2070
|
resource: string | undefined;
|
|
2071
2071
|
/**
|
|
2072
|
-
* @public
|
|
2073
2072
|
* <p>The error code of the failure.</p>
|
|
2073
|
+
* @public
|
|
2074
2074
|
*/
|
|
2075
2075
|
error?: string;
|
|
2076
2076
|
/**
|
|
2077
|
-
* @public
|
|
2078
2077
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
2078
|
+
* @public
|
|
2079
2079
|
*/
|
|
2080
2080
|
cause?: string;
|
|
2081
2081
|
}
|
|
2082
2082
|
/**
|
|
2083
|
-
* @public
|
|
2084
2083
|
* <p>Contains details about a task that failed to submit during an execution.</p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
export interface TaskSubmitFailedEventDetails {
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>The service name of the resource in a task state.</p>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
resourceType: string | undefined;
|
|
2092
2092
|
/**
|
|
2093
|
-
* @public
|
|
2094
2093
|
* <p>The action of the resource called by a task state.</p>
|
|
2094
|
+
* @public
|
|
2095
2095
|
*/
|
|
2096
2096
|
resource: string | undefined;
|
|
2097
2097
|
/**
|
|
2098
|
-
* @public
|
|
2099
2098
|
* <p>The error code of the failure.</p>
|
|
2099
|
+
* @public
|
|
2100
2100
|
*/
|
|
2101
2101
|
error?: string;
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
cause?: string;
|
|
2107
2107
|
}
|
|
2108
2108
|
/**
|
|
2109
|
-
* @public
|
|
2110
2109
|
* <p>Contains details about a task submitted to a resource .</p>
|
|
2110
|
+
* @public
|
|
2111
2111
|
*/
|
|
2112
2112
|
export interface TaskSubmittedEventDetails {
|
|
2113
2113
|
/**
|
|
2114
|
-
* @public
|
|
2115
2114
|
* <p>The service name of the resource in a task state.</p>
|
|
2115
|
+
* @public
|
|
2116
2116
|
*/
|
|
2117
2117
|
resourceType: string | undefined;
|
|
2118
2118
|
/**
|
|
2119
|
-
* @public
|
|
2120
2119
|
* <p>The action of the resource called by a task state.</p>
|
|
2120
|
+
* @public
|
|
2121
2121
|
*/
|
|
2122
2122
|
resource: string | undefined;
|
|
2123
2123
|
/**
|
|
2124
|
-
* @public
|
|
2125
2124
|
* <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>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
output?: string;
|
|
2128
2128
|
/**
|
|
2129
|
-
* @public
|
|
2130
2129
|
* <p>Contains details about the output of an execution history event.</p>
|
|
2130
|
+
* @public
|
|
2131
2131
|
*/
|
|
2132
2132
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
2133
2133
|
}
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>Contains details about the successful completion of a task state.</p>
|
|
2136
|
+
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
export interface TaskSucceededEventDetails {
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>The service name of the resource in a task state.</p>
|
|
2141
|
+
* @public
|
|
2142
2142
|
*/
|
|
2143
2143
|
resourceType: string | undefined;
|
|
2144
2144
|
/**
|
|
2145
|
-
* @public
|
|
2146
2145
|
* <p>The action of the resource called by a task state.</p>
|
|
2146
|
+
* @public
|
|
2147
2147
|
*/
|
|
2148
2148
|
resource: string | undefined;
|
|
2149
2149
|
/**
|
|
2150
|
-
* @public
|
|
2151
2150
|
* <p>The full JSON response from a resource when a task has succeeded. This response becomes
|
|
2152
2151
|
* the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
2152
|
+
* @public
|
|
2153
2153
|
*/
|
|
2154
2154
|
output?: string;
|
|
2155
2155
|
/**
|
|
2156
|
-
* @public
|
|
2157
2156
|
* <p>Contains details about the output of an execution history event.</p>
|
|
2157
|
+
* @public
|
|
2158
2158
|
*/
|
|
2159
2159
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
2160
2160
|
}
|
|
2161
2161
|
/**
|
|
2162
|
-
* @public
|
|
2163
2162
|
* <p>Contains details about a resource timeout that occurred during an execution.</p>
|
|
2163
|
+
* @public
|
|
2164
2164
|
*/
|
|
2165
2165
|
export interface TaskTimedOutEventDetails {
|
|
2166
2166
|
/**
|
|
2167
|
-
* @public
|
|
2168
2167
|
* <p>The service name of the resource in a task state.</p>
|
|
2168
|
+
* @public
|
|
2169
2169
|
*/
|
|
2170
2170
|
resourceType: string | undefined;
|
|
2171
2171
|
/**
|
|
2172
|
-
* @public
|
|
2173
2172
|
* <p>The action of the resource called by a task state.</p>
|
|
2173
|
+
* @public
|
|
2174
2174
|
*/
|
|
2175
2175
|
resource: string | undefined;
|
|
2176
2176
|
/**
|
|
2177
|
-
* @public
|
|
2178
2177
|
* <p>The error code of the failure.</p>
|
|
2178
|
+
* @public
|
|
2179
2179
|
*/
|
|
2180
2180
|
error?: string;
|
|
2181
2181
|
/**
|
|
2182
|
-
* @public
|
|
2183
2182
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
2183
|
+
* @public
|
|
2184
2184
|
*/
|
|
2185
2185
|
cause?: string;
|
|
2186
2186
|
}
|
|
@@ -2256,211 +2256,211 @@ export declare const HistoryEventType: {
|
|
|
2256
2256
|
*/
|
|
2257
2257
|
export type HistoryEventType = (typeof HistoryEventType)[keyof typeof HistoryEventType];
|
|
2258
2258
|
/**
|
|
2259
|
-
* @public
|
|
2260
2259
|
* <p>Contains details about the events of an execution.</p>
|
|
2260
|
+
* @public
|
|
2261
2261
|
*/
|
|
2262
2262
|
export interface HistoryEvent {
|
|
2263
2263
|
/**
|
|
2264
|
-
* @public
|
|
2265
2264
|
* <p>The date and time the event occurred.</p>
|
|
2265
|
+
* @public
|
|
2266
2266
|
*/
|
|
2267
2267
|
timestamp: Date | undefined;
|
|
2268
2268
|
/**
|
|
2269
|
-
* @public
|
|
2270
2269
|
* <p>The type of the event.</p>
|
|
2270
|
+
* @public
|
|
2271
2271
|
*/
|
|
2272
2272
|
type: HistoryEventType | undefined;
|
|
2273
2273
|
/**
|
|
2274
|
-
* @public
|
|
2275
2274
|
* <p>The id of the event. Events are numbered sequentially, starting at one.</p>
|
|
2275
|
+
* @public
|
|
2276
2276
|
*/
|
|
2277
2277
|
id: number | undefined;
|
|
2278
2278
|
/**
|
|
2279
|
-
* @public
|
|
2280
2279
|
* <p>The id of the previous event.</p>
|
|
2280
|
+
* @public
|
|
2281
2281
|
*/
|
|
2282
2282
|
previousEventId?: number;
|
|
2283
2283
|
/**
|
|
2284
|
-
* @public
|
|
2285
2284
|
* <p>Contains details about an activity that failed during an execution.</p>
|
|
2285
|
+
* @public
|
|
2286
2286
|
*/
|
|
2287
2287
|
activityFailedEventDetails?: ActivityFailedEventDetails;
|
|
2288
2288
|
/**
|
|
2289
|
-
* @public
|
|
2290
2289
|
* <p>Contains details about an activity schedule event that failed during an execution.</p>
|
|
2290
|
+
* @public
|
|
2291
2291
|
*/
|
|
2292
2292
|
activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails;
|
|
2293
2293
|
/**
|
|
2294
|
-
* @public
|
|
2295
2294
|
* <p>Contains details about an activity scheduled during an execution.</p>
|
|
2295
|
+
* @public
|
|
2296
2296
|
*/
|
|
2297
2297
|
activityScheduledEventDetails?: ActivityScheduledEventDetails;
|
|
2298
2298
|
/**
|
|
2299
|
-
* @public
|
|
2300
2299
|
* <p>Contains details about the start of an activity during an execution.</p>
|
|
2300
|
+
* @public
|
|
2301
2301
|
*/
|
|
2302
2302
|
activityStartedEventDetails?: ActivityStartedEventDetails;
|
|
2303
2303
|
/**
|
|
2304
|
-
* @public
|
|
2305
2304
|
* <p>Contains details about an activity that successfully terminated during an
|
|
2306
2305
|
* execution.</p>
|
|
2306
|
+
* @public
|
|
2307
2307
|
*/
|
|
2308
2308
|
activitySucceededEventDetails?: ActivitySucceededEventDetails;
|
|
2309
2309
|
/**
|
|
2310
|
-
* @public
|
|
2311
2310
|
* <p>Contains details about an activity timeout that occurred during an execution.</p>
|
|
2311
|
+
* @public
|
|
2312
2312
|
*/
|
|
2313
2313
|
activityTimedOutEventDetails?: ActivityTimedOutEventDetails;
|
|
2314
2314
|
/**
|
|
2315
|
-
* @public
|
|
2316
2315
|
* <p>Contains details about the failure of a task.</p>
|
|
2316
|
+
* @public
|
|
2317
2317
|
*/
|
|
2318
2318
|
taskFailedEventDetails?: TaskFailedEventDetails;
|
|
2319
2319
|
/**
|
|
2320
|
-
* @public
|
|
2321
2320
|
* <p>Contains details about a task that was scheduled.</p>
|
|
2321
|
+
* @public
|
|
2322
2322
|
*/
|
|
2323
2323
|
taskScheduledEventDetails?: TaskScheduledEventDetails;
|
|
2324
2324
|
/**
|
|
2325
|
-
* @public
|
|
2326
2325
|
* <p>Contains details about a task that failed to start.</p>
|
|
2326
|
+
* @public
|
|
2327
2327
|
*/
|
|
2328
2328
|
taskStartFailedEventDetails?: TaskStartFailedEventDetails;
|
|
2329
2329
|
/**
|
|
2330
|
-
* @public
|
|
2331
2330
|
* <p>Contains details about a task that was started.</p>
|
|
2331
|
+
* @public
|
|
2332
2332
|
*/
|
|
2333
2333
|
taskStartedEventDetails?: TaskStartedEventDetails;
|
|
2334
2334
|
/**
|
|
2335
|
-
* @public
|
|
2336
2335
|
* <p>Contains details about a task that where the submit failed.</p>
|
|
2336
|
+
* @public
|
|
2337
2337
|
*/
|
|
2338
2338
|
taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails;
|
|
2339
2339
|
/**
|
|
2340
|
-
* @public
|
|
2341
2340
|
* <p>Contains details about a submitted task.</p>
|
|
2341
|
+
* @public
|
|
2342
2342
|
*/
|
|
2343
2343
|
taskSubmittedEventDetails?: TaskSubmittedEventDetails;
|
|
2344
2344
|
/**
|
|
2345
|
-
* @public
|
|
2346
2345
|
* <p>Contains details about a task that succeeded.</p>
|
|
2346
|
+
* @public
|
|
2347
2347
|
*/
|
|
2348
2348
|
taskSucceededEventDetails?: TaskSucceededEventDetails;
|
|
2349
2349
|
/**
|
|
2350
|
-
* @public
|
|
2351
2350
|
* <p>Contains details about a task that timed out.</p>
|
|
2351
|
+
* @public
|
|
2352
2352
|
*/
|
|
2353
2353
|
taskTimedOutEventDetails?: TaskTimedOutEventDetails;
|
|
2354
2354
|
/**
|
|
2355
|
-
* @public
|
|
2356
2355
|
* <p>Contains details about an execution failure event.</p>
|
|
2356
|
+
* @public
|
|
2357
2357
|
*/
|
|
2358
2358
|
executionFailedEventDetails?: ExecutionFailedEventDetails;
|
|
2359
2359
|
/**
|
|
2360
|
-
* @public
|
|
2361
2360
|
* <p>Contains details about the start of the execution.</p>
|
|
2361
|
+
* @public
|
|
2362
2362
|
*/
|
|
2363
2363
|
executionStartedEventDetails?: ExecutionStartedEventDetails;
|
|
2364
2364
|
/**
|
|
2365
|
-
* @public
|
|
2366
2365
|
* <p>Contains details about the successful termination of the execution.</p>
|
|
2366
|
+
* @public
|
|
2367
2367
|
*/
|
|
2368
2368
|
executionSucceededEventDetails?: ExecutionSucceededEventDetails;
|
|
2369
2369
|
/**
|
|
2370
|
-
* @public
|
|
2371
2370
|
* <p>Contains details about an abort of an execution.</p>
|
|
2371
|
+
* @public
|
|
2372
2372
|
*/
|
|
2373
2373
|
executionAbortedEventDetails?: ExecutionAbortedEventDetails;
|
|
2374
2374
|
/**
|
|
2375
|
-
* @public
|
|
2376
2375
|
* <p>Contains details about the execution timeout that occurred during the execution.</p>
|
|
2376
|
+
* @public
|
|
2377
2377
|
*/
|
|
2378
2378
|
executionTimedOutEventDetails?: ExecutionTimedOutEventDetails;
|
|
2379
2379
|
/**
|
|
2380
|
-
* @public
|
|
2381
2380
|
* <p>Contains details about the redrive attempt of an execution.</p>
|
|
2381
|
+
* @public
|
|
2382
2382
|
*/
|
|
2383
2383
|
executionRedrivenEventDetails?: ExecutionRedrivenEventDetails;
|
|
2384
2384
|
/**
|
|
2385
|
-
* @public
|
|
2386
2385
|
* <p>Contains details about Map state that was started.</p>
|
|
2386
|
+
* @public
|
|
2387
2387
|
*/
|
|
2388
2388
|
mapStateStartedEventDetails?: MapStateStartedEventDetails;
|
|
2389
2389
|
/**
|
|
2390
|
-
* @public
|
|
2391
2390
|
* <p>Contains details about an iteration of a Map state that was started.</p>
|
|
2391
|
+
* @public
|
|
2392
2392
|
*/
|
|
2393
2393
|
mapIterationStartedEventDetails?: MapIterationEventDetails;
|
|
2394
2394
|
/**
|
|
2395
|
-
* @public
|
|
2396
2395
|
* <p>Contains details about an iteration of a Map state that succeeded.</p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
mapIterationSucceededEventDetails?: MapIterationEventDetails;
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>Contains details about an iteration of a Map state that failed.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
mapIterationFailedEventDetails?: MapIterationEventDetails;
|
|
2404
2404
|
/**
|
|
2405
|
-
* @public
|
|
2406
2405
|
* <p>Contains details about an iteration of a Map state that was aborted.</p>
|
|
2406
|
+
* @public
|
|
2407
2407
|
*/
|
|
2408
2408
|
mapIterationAbortedEventDetails?: MapIterationEventDetails;
|
|
2409
2409
|
/**
|
|
2410
|
-
* @public
|
|
2411
2410
|
* <p>Contains details about a Lambda function that failed during an execution.</p>
|
|
2411
|
+
* @public
|
|
2412
2412
|
*/
|
|
2413
2413
|
lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails;
|
|
2414
2414
|
/**
|
|
2415
|
-
* @public
|
|
2416
2415
|
* <p>Contains details about a failed Lambda function schedule event that occurred during an
|
|
2417
2416
|
* execution.</p>
|
|
2417
|
+
* @public
|
|
2418
2418
|
*/
|
|
2419
2419
|
lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails;
|
|
2420
2420
|
/**
|
|
2421
|
-
* @public
|
|
2422
2421
|
* <p>Contains details about a Lambda function scheduled during an execution.</p>
|
|
2422
|
+
* @public
|
|
2423
2423
|
*/
|
|
2424
2424
|
lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails;
|
|
2425
2425
|
/**
|
|
2426
|
-
* @public
|
|
2427
2426
|
* <p>Contains details about a lambda function that failed to start during an execution.</p>
|
|
2427
|
+
* @public
|
|
2428
2428
|
*/
|
|
2429
2429
|
lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails;
|
|
2430
2430
|
/**
|
|
2431
|
-
* @public
|
|
2432
2431
|
* <p>Contains details about a Lambda function that terminated successfully during an
|
|
2433
2432
|
* execution.</p>
|
|
2433
|
+
* @public
|
|
2434
2434
|
*/
|
|
2435
2435
|
lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails;
|
|
2436
2436
|
/**
|
|
2437
|
-
* @public
|
|
2438
2437
|
* <p>Contains details about a Lambda function timeout that occurred during an execution.</p>
|
|
2438
|
+
* @public
|
|
2439
2439
|
*/
|
|
2440
2440
|
lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails;
|
|
2441
2441
|
/**
|
|
2442
|
-
* @public
|
|
2443
2442
|
* <p>Contains details about a state entered during an execution.</p>
|
|
2443
|
+
* @public
|
|
2444
2444
|
*/
|
|
2445
2445
|
stateEnteredEventDetails?: StateEnteredEventDetails;
|
|
2446
2446
|
/**
|
|
2447
|
-
* @public
|
|
2448
2447
|
* <p>Contains details about an exit from a state during an execution.</p>
|
|
2448
|
+
* @public
|
|
2449
2449
|
*/
|
|
2450
2450
|
stateExitedEventDetails?: StateExitedEventDetails;
|
|
2451
2451
|
/**
|
|
2452
|
-
* @public
|
|
2453
2452
|
* <p>Contains details, such as <code>mapRunArn</code>, and the start date and time of a Map Run. <code>mapRunArn</code> is the Amazon Resource Name (ARN) of the Map Run that was started.</p>
|
|
2453
|
+
* @public
|
|
2454
2454
|
*/
|
|
2455
2455
|
mapRunStartedEventDetails?: MapRunStartedEventDetails;
|
|
2456
2456
|
/**
|
|
2457
|
-
* @public
|
|
2458
2457
|
* <p>Contains error and cause details about a Map Run that failed.</p>
|
|
2458
|
+
* @public
|
|
2459
2459
|
*/
|
|
2460
2460
|
mapRunFailedEventDetails?: MapRunFailedEventDetails;
|
|
2461
2461
|
/**
|
|
2462
|
-
* @public
|
|
2463
2462
|
* <p>Contains details about the redrive attempt of a Map Run.</p>
|
|
2463
|
+
* @public
|
|
2464
2464
|
*/
|
|
2465
2465
|
mapRunRedrivenEventDetails?: MapRunRedrivenEventDetails;
|
|
2466
2466
|
}
|
|
@@ -2469,20 +2469,20 @@ export interface HistoryEvent {
|
|
|
2469
2469
|
*/
|
|
2470
2470
|
export interface GetExecutionHistoryOutput {
|
|
2471
2471
|
/**
|
|
2472
|
-
* @public
|
|
2473
2472
|
* <p>The list of events that occurred in the execution.</p>
|
|
2473
|
+
* @public
|
|
2474
2474
|
*/
|
|
2475
2475
|
events: HistoryEvent[] | undefined;
|
|
2476
2476
|
/**
|
|
2477
|
-
* @public
|
|
2478
2477
|
* <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.
|
|
2479
2478
|
* 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>
|
|
2479
|
+
* @public
|
|
2480
2480
|
*/
|
|
2481
2481
|
nextToken?: string;
|
|
2482
2482
|
}
|
|
2483
2483
|
/**
|
|
2484
|
-
* @public
|
|
2485
2484
|
* <p>The provided token is not valid.</p>
|
|
2485
|
+
* @public
|
|
2486
2486
|
*/
|
|
2487
2487
|
export declare class InvalidToken extends __BaseException {
|
|
2488
2488
|
readonly name: "InvalidToken";
|
|
@@ -2497,16 +2497,16 @@ export declare class InvalidToken extends __BaseException {
|
|
|
2497
2497
|
*/
|
|
2498
2498
|
export interface ListActivitiesInput {
|
|
2499
2499
|
/**
|
|
2500
|
-
* @public
|
|
2501
2500
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
2502
2501
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
2503
2502
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
2503
|
+
* @public
|
|
2504
2504
|
*/
|
|
2505
2505
|
maxResults?: number;
|
|
2506
2506
|
/**
|
|
2507
|
-
* @public
|
|
2508
2507
|
* <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.
|
|
2509
2508
|
* 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>
|
|
2509
|
+
* @public
|
|
2510
2510
|
*/
|
|
2511
2511
|
nextToken?: string;
|
|
2512
2512
|
}
|
|
@@ -2515,14 +2515,14 @@ export interface ListActivitiesInput {
|
|
|
2515
2515
|
*/
|
|
2516
2516
|
export interface ListActivitiesOutput {
|
|
2517
2517
|
/**
|
|
2518
|
-
* @public
|
|
2519
2518
|
* <p>The list of activities.</p>
|
|
2519
|
+
* @public
|
|
2520
2520
|
*/
|
|
2521
2521
|
activities: ActivityListItem[] | undefined;
|
|
2522
2522
|
/**
|
|
2523
|
-
* @public
|
|
2524
2523
|
* <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.
|
|
2525
2524
|
* 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>
|
|
2525
|
+
* @public
|
|
2526
2526
|
*/
|
|
2527
2527
|
nextToken?: string;
|
|
2528
2528
|
}
|
|
@@ -2543,63 +2543,62 @@ export type ExecutionRedriveFilter = (typeof ExecutionRedriveFilter)[keyof typeo
|
|
|
2543
2543
|
*/
|
|
2544
2544
|
export interface ListExecutionsInput {
|
|
2545
2545
|
/**
|
|
2546
|
-
* @public
|
|
2547
2546
|
* <p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p>
|
|
2548
2547
|
* <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
|
|
2549
2548
|
* <p>You can also return a list of executions associated with a specific <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, by specifying an alias ARN or a version ARN in the <code>stateMachineArn</code> parameter.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
stateMachineArn?: string;
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>If specified, only list the executions whose current execution status matches the given
|
|
2555
2554
|
* filter.</p>
|
|
2555
|
+
* @public
|
|
2556
2556
|
*/
|
|
2557
2557
|
statusFilter?: ExecutionStatus;
|
|
2558
2558
|
/**
|
|
2559
|
-
* @public
|
|
2560
2559
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
2561
2560
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
2562
2561
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
2562
|
+
* @public
|
|
2563
2563
|
*/
|
|
2564
2564
|
maxResults?: number;
|
|
2565
2565
|
/**
|
|
2566
|
-
* @public
|
|
2567
2566
|
* <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.
|
|
2568
2567
|
* 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>
|
|
2568
|
+
* @public
|
|
2569
2569
|
*/
|
|
2570
2570
|
nextToken?: string;
|
|
2571
2571
|
/**
|
|
2572
|
-
* @public
|
|
2573
2572
|
* <p>The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the <code>mapRunArn</code> field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
2574
2573
|
* <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
|
|
2574
|
+
* @public
|
|
2575
2575
|
*/
|
|
2576
2576
|
mapRunArn?: string;
|
|
2577
2577
|
/**
|
|
2578
|
-
* @public
|
|
2579
2578
|
* <p>Sets a filter to list executions based on whether or not they have been redriven.</p>
|
|
2580
2579
|
* <p>For a Distributed Map, <code>redriveFilter</code> sets a filter to list child workflow executions based on whether or not they have been redriven.</p>
|
|
2581
2580
|
* <p>If you do not provide a <code>redriveFilter</code>, Step Functions returns a list of both redriven and non-redriven executions.</p>
|
|
2582
2581
|
* <p>If you provide a state machine ARN in <code>redriveFilter</code>, the API returns a validation exception.</p>
|
|
2582
|
+
* @public
|
|
2583
2583
|
*/
|
|
2584
2584
|
redriveFilter?: ExecutionRedriveFilter;
|
|
2585
2585
|
}
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>Contains details about an execution.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
export interface ExecutionListItem {
|
|
2591
2591
|
/**
|
|
2592
|
-
* @public
|
|
2593
2592
|
* <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
|
|
2593
|
+
* @public
|
|
2594
2594
|
*/
|
|
2595
2595
|
executionArn: string | undefined;
|
|
2596
2596
|
/**
|
|
2597
|
-
* @public
|
|
2598
2597
|
* <p>The Amazon Resource Name (ARN) of the state machine that ran the execution.</p>
|
|
2598
|
+
* @public
|
|
2599
2599
|
*/
|
|
2600
2600
|
stateMachineArn: string | undefined;
|
|
2601
2601
|
/**
|
|
2602
|
-
* @public
|
|
2603
2602
|
* <p>The name of the execution.</p>
|
|
2604
2603
|
* <p>A name must <i>not</i> contain:</p>
|
|
2605
2604
|
* <ul>
|
|
@@ -2623,54 +2622,55 @@ export interface ExecutionListItem {
|
|
|
2623
2622
|
* </li>
|
|
2624
2623
|
* </ul>
|
|
2625
2624
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
2625
|
+
* @public
|
|
2626
2626
|
*/
|
|
2627
2627
|
name: string | undefined;
|
|
2628
2628
|
/**
|
|
2629
|
-
* @public
|
|
2630
2629
|
* <p>The current status of the execution.</p>
|
|
2630
|
+
* @public
|
|
2631
2631
|
*/
|
|
2632
2632
|
status: ExecutionStatus | undefined;
|
|
2633
2633
|
/**
|
|
2634
|
-
* @public
|
|
2635
2634
|
* <p>The date the execution started.</p>
|
|
2635
|
+
* @public
|
|
2636
2636
|
*/
|
|
2637
2637
|
startDate: Date | undefined;
|
|
2638
2638
|
/**
|
|
2639
|
-
* @public
|
|
2640
2639
|
* <p>If the execution already ended, the date the execution stopped.</p>
|
|
2640
|
+
* @public
|
|
2641
2641
|
*/
|
|
2642
2642
|
stopDate?: Date;
|
|
2643
2643
|
/**
|
|
2644
|
-
* @public
|
|
2645
2644
|
* <p>The Amazon Resource Name (ARN) of a Map Run. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>mapRunArn</code> isn't returned.</p>
|
|
2645
|
+
* @public
|
|
2646
2646
|
*/
|
|
2647
2647
|
mapRunArn?: string;
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p>The total number of items processed in a child workflow execution. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>itemCount</code> field isn't returned.</p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
itemCount?: number;
|
|
2653
2653
|
/**
|
|
2654
|
-
* @public
|
|
2655
2654
|
* <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p>
|
|
2656
2655
|
* <p>If the state machine execution was started with an unqualified ARN, it returns null.</p>
|
|
2657
2656
|
* <p>If the execution was started using a <code>stateMachineAliasArn</code>, both the <code>stateMachineAliasArn</code> and <code>stateMachineVersionArn</code> parameters contain the respective values.</p>
|
|
2657
|
+
* @public
|
|
2658
2658
|
*/
|
|
2659
2659
|
stateMachineVersionArn?: string;
|
|
2660
2660
|
/**
|
|
2661
|
-
* @public
|
|
2662
2661
|
* <p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p>
|
|
2663
2662
|
* <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>
|
|
2663
|
+
* @public
|
|
2664
2664
|
*/
|
|
2665
2665
|
stateMachineAliasArn?: string;
|
|
2666
2666
|
/**
|
|
2667
|
-
* @public
|
|
2668
2667
|
* <p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is only updated when you successfully redrive an execution.</p>
|
|
2668
|
+
* @public
|
|
2669
2669
|
*/
|
|
2670
2670
|
redriveCount?: number;
|
|
2671
2671
|
/**
|
|
2672
|
-
* @public
|
|
2673
2672
|
* <p>The date the execution was last redriven.</p>
|
|
2673
|
+
* @public
|
|
2674
2674
|
*/
|
|
2675
2675
|
redriveDate?: Date;
|
|
2676
2676
|
}
|
|
@@ -2679,14 +2679,14 @@ export interface ExecutionListItem {
|
|
|
2679
2679
|
*/
|
|
2680
2680
|
export interface ListExecutionsOutput {
|
|
2681
2681
|
/**
|
|
2682
|
-
* @public
|
|
2683
2682
|
* <p>The list of matching executions.</p>
|
|
2683
|
+
* @public
|
|
2684
2684
|
*/
|
|
2685
2685
|
executions: ExecutionListItem[] | undefined;
|
|
2686
2686
|
/**
|
|
2687
|
-
* @public
|
|
2688
2687
|
* <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.
|
|
2689
2688
|
* 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>
|
|
2689
|
+
* @public
|
|
2690
2690
|
*/
|
|
2691
2691
|
nextToken?: string;
|
|
2692
2692
|
}
|
|
@@ -2695,52 +2695,52 @@ export interface ListExecutionsOutput {
|
|
|
2695
2695
|
*/
|
|
2696
2696
|
export interface ListMapRunsInput {
|
|
2697
2697
|
/**
|
|
2698
|
-
* @public
|
|
2699
2698
|
* <p>The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.</p>
|
|
2699
|
+
* @public
|
|
2700
2700
|
*/
|
|
2701
2701
|
executionArn: string | undefined;
|
|
2702
2702
|
/**
|
|
2703
|
-
* @public
|
|
2704
2703
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
2705
2704
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
2706
2705
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
2706
|
+
* @public
|
|
2707
2707
|
*/
|
|
2708
2708
|
maxResults?: number;
|
|
2709
2709
|
/**
|
|
2710
|
-
* @public
|
|
2711
2710
|
* <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.
|
|
2712
2711
|
* 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>
|
|
2712
|
+
* @public
|
|
2713
2713
|
*/
|
|
2714
2714
|
nextToken?: string;
|
|
2715
2715
|
}
|
|
2716
2716
|
/**
|
|
2717
|
-
* @public
|
|
2718
2717
|
* <p>Contains details about a specific Map Run.</p>
|
|
2718
|
+
* @public
|
|
2719
2719
|
*/
|
|
2720
2720
|
export interface MapRunListItem {
|
|
2721
2721
|
/**
|
|
2722
|
-
* @public
|
|
2723
2722
|
* <p>The <code>executionArn</code> of the execution from which the Map Run was started.</p>
|
|
2723
|
+
* @public
|
|
2724
2724
|
*/
|
|
2725
2725
|
executionArn: string | undefined;
|
|
2726
2726
|
/**
|
|
2727
|
-
* @public
|
|
2728
2727
|
* <p>The Amazon Resource Name (ARN) of the Map Run.</p>
|
|
2728
|
+
* @public
|
|
2729
2729
|
*/
|
|
2730
2730
|
mapRunArn: string | undefined;
|
|
2731
2731
|
/**
|
|
2732
|
-
* @public
|
|
2733
2732
|
* <p>The Amazon Resource Name (ARN) of the executed state machine.</p>
|
|
2733
|
+
* @public
|
|
2734
2734
|
*/
|
|
2735
2735
|
stateMachineArn: string | undefined;
|
|
2736
2736
|
/**
|
|
2737
|
-
* @public
|
|
2738
2737
|
* <p>The date on which the Map Run started.</p>
|
|
2738
|
+
* @public
|
|
2739
2739
|
*/
|
|
2740
2740
|
startDate: Date | undefined;
|
|
2741
2741
|
/**
|
|
2742
|
-
* @public
|
|
2743
2742
|
* <p>The date on which the Map Run stopped.</p>
|
|
2743
|
+
* @public
|
|
2744
2744
|
*/
|
|
2745
2745
|
stopDate?: Date;
|
|
2746
2746
|
}
|
|
@@ -2749,14 +2749,14 @@ export interface MapRunListItem {
|
|
|
2749
2749
|
*/
|
|
2750
2750
|
export interface ListMapRunsOutput {
|
|
2751
2751
|
/**
|
|
2752
|
-
* @public
|
|
2753
2752
|
* <p>An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.</p>
|
|
2753
|
+
* @public
|
|
2754
2754
|
*/
|
|
2755
2755
|
mapRuns: MapRunListItem[] | undefined;
|
|
2756
2756
|
/**
|
|
2757
|
-
* @public
|
|
2758
2757
|
* <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.
|
|
2759
2758
|
* 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>
|
|
2759
|
+
* @public
|
|
2760
2760
|
*/
|
|
2761
2761
|
nextToken?: string;
|
|
2762
2762
|
}
|
|
@@ -2765,38 +2765,38 @@ export interface ListMapRunsOutput {
|
|
|
2765
2765
|
*/
|
|
2766
2766
|
export interface ListStateMachineAliasesInput {
|
|
2767
2767
|
/**
|
|
2768
|
-
* @public
|
|
2769
2768
|
* <p>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</p>
|
|
2770
2769
|
* <p>If you specify a state machine version ARN, this API returns a list of aliases for that version.</p>
|
|
2770
|
+
* @public
|
|
2771
2771
|
*/
|
|
2772
2772
|
stateMachineArn: string | undefined;
|
|
2773
2773
|
/**
|
|
2774
|
-
* @public
|
|
2775
2774
|
* <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.
|
|
2776
2775
|
* 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>
|
|
2776
|
+
* @public
|
|
2777
2777
|
*/
|
|
2778
2778
|
nextToken?: string;
|
|
2779
2779
|
/**
|
|
2780
|
-
* @public
|
|
2781
2780
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
2782
2781
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
2783
2782
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
2783
|
+
* @public
|
|
2784
2784
|
*/
|
|
2785
2785
|
maxResults?: number;
|
|
2786
2786
|
}
|
|
2787
2787
|
/**
|
|
2788
|
-
* @public
|
|
2789
2788
|
* <p>Contains details about a specific state machine alias.</p>
|
|
2789
|
+
* @public
|
|
2790
2790
|
*/
|
|
2791
2791
|
export interface StateMachineAliasListItem {
|
|
2792
2792
|
/**
|
|
2793
|
-
* @public
|
|
2794
2793
|
* <p>The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, <code>stateMachineARN:PROD</code>.</p>
|
|
2794
|
+
* @public
|
|
2795
2795
|
*/
|
|
2796
2796
|
stateMachineAliasArn: string | undefined;
|
|
2797
2797
|
/**
|
|
2798
|
-
* @public
|
|
2799
2798
|
* <p>The creation date of a state machine alias.</p>
|
|
2799
|
+
* @public
|
|
2800
2800
|
*/
|
|
2801
2801
|
creationDate: Date | undefined;
|
|
2802
2802
|
}
|
|
@@ -2805,14 +2805,14 @@ export interface StateMachineAliasListItem {
|
|
|
2805
2805
|
*/
|
|
2806
2806
|
export interface ListStateMachineAliasesOutput {
|
|
2807
2807
|
/**
|
|
2808
|
-
* @public
|
|
2809
2808
|
* <p>Aliases for the state machine.</p>
|
|
2809
|
+
* @public
|
|
2810
2810
|
*/
|
|
2811
2811
|
stateMachineAliases: StateMachineAliasListItem[] | undefined;
|
|
2812
2812
|
/**
|
|
2813
|
-
* @public
|
|
2814
2813
|
* <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.
|
|
2815
2814
|
* 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>
|
|
2815
|
+
* @public
|
|
2816
2816
|
*/
|
|
2817
2817
|
nextToken?: string;
|
|
2818
2818
|
}
|
|
@@ -2821,31 +2821,30 @@ export interface ListStateMachineAliasesOutput {
|
|
|
2821
2821
|
*/
|
|
2822
2822
|
export interface ListStateMachinesInput {
|
|
2823
2823
|
/**
|
|
2824
|
-
* @public
|
|
2825
2824
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
2826
2825
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
2827
2826
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
2827
|
+
* @public
|
|
2828
2828
|
*/
|
|
2829
2829
|
maxResults?: number;
|
|
2830
2830
|
/**
|
|
2831
|
-
* @public
|
|
2832
2831
|
* <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.
|
|
2833
2832
|
* 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>
|
|
2833
|
+
* @public
|
|
2834
2834
|
*/
|
|
2835
2835
|
nextToken?: string;
|
|
2836
2836
|
}
|
|
2837
2837
|
/**
|
|
2838
|
-
* @public
|
|
2839
2838
|
* <p>Contains details about the state machine.</p>
|
|
2839
|
+
* @public
|
|
2840
2840
|
*/
|
|
2841
2841
|
export interface StateMachineListItem {
|
|
2842
2842
|
/**
|
|
2843
|
-
* @public
|
|
2844
2843
|
* <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
|
|
2844
|
+
* @public
|
|
2845
2845
|
*/
|
|
2846
2846
|
stateMachineArn: string | undefined;
|
|
2847
2847
|
/**
|
|
2848
|
-
* @public
|
|
2849
2848
|
* <p>The name of the state machine.</p>
|
|
2850
2849
|
* <p>A name must <i>not</i> contain:</p>
|
|
2851
2850
|
* <ul>
|
|
@@ -2869,16 +2868,17 @@ export interface StateMachineListItem {
|
|
|
2869
2868
|
* </li>
|
|
2870
2869
|
* </ul>
|
|
2871
2870
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
2871
|
+
* @public
|
|
2872
2872
|
*/
|
|
2873
2873
|
name: string | undefined;
|
|
2874
2874
|
/**
|
|
2875
|
-
* @public
|
|
2876
2875
|
* <p></p>
|
|
2876
|
+
* @public
|
|
2877
2877
|
*/
|
|
2878
2878
|
type: StateMachineType | undefined;
|
|
2879
2879
|
/**
|
|
2880
|
-
* @public
|
|
2881
2880
|
* <p>The date the state machine is created.</p>
|
|
2881
|
+
* @public
|
|
2882
2882
|
*/
|
|
2883
2883
|
creationDate: Date | undefined;
|
|
2884
2884
|
}
|
|
@@ -2888,9 +2888,9 @@ export interface StateMachineListItem {
|
|
|
2888
2888
|
export interface ListStateMachinesOutput {
|
|
2889
2889
|
stateMachines: StateMachineListItem[] | undefined;
|
|
2890
2890
|
/**
|
|
2891
|
-
* @public
|
|
2892
2891
|
* <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.
|
|
2893
2892
|
* 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>
|
|
2893
|
+
* @public
|
|
2894
2894
|
*/
|
|
2895
2895
|
nextToken?: string;
|
|
2896
2896
|
}
|
|
@@ -2899,37 +2899,37 @@ export interface ListStateMachinesOutput {
|
|
|
2899
2899
|
*/
|
|
2900
2900
|
export interface ListStateMachineVersionsInput {
|
|
2901
2901
|
/**
|
|
2902
|
-
* @public
|
|
2903
2902
|
* <p>The Amazon Resource Name (ARN) of the state machine.</p>
|
|
2903
|
+
* @public
|
|
2904
2904
|
*/
|
|
2905
2905
|
stateMachineArn: string | undefined;
|
|
2906
2906
|
/**
|
|
2907
|
-
* @public
|
|
2908
2907
|
* <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.
|
|
2909
2908
|
* 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>
|
|
2909
|
+
* @public
|
|
2910
2910
|
*/
|
|
2911
2911
|
nextToken?: string;
|
|
2912
2912
|
/**
|
|
2913
|
-
* @public
|
|
2914
2913
|
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.
|
|
2915
2914
|
* The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p>
|
|
2916
2915
|
* <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
|
|
2916
|
+
* @public
|
|
2917
2917
|
*/
|
|
2918
2918
|
maxResults?: number;
|
|
2919
2919
|
}
|
|
2920
2920
|
/**
|
|
2921
|
-
* @public
|
|
2922
2921
|
* <p>Contains details about a specific state machine version.</p>
|
|
2922
|
+
* @public
|
|
2923
2923
|
*/
|
|
2924
2924
|
export interface StateMachineVersionListItem {
|
|
2925
2925
|
/**
|
|
2926
|
-
* @public
|
|
2927
2926
|
* <p>The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p>
|
|
2927
|
+
* @public
|
|
2928
2928
|
*/
|
|
2929
2929
|
stateMachineVersionArn: string | undefined;
|
|
2930
2930
|
/**
|
|
2931
|
-
* @public
|
|
2932
2931
|
* <p>The creation date of a state machine version.</p>
|
|
2932
|
+
* @public
|
|
2933
2933
|
*/
|
|
2934
2934
|
creationDate: Date | undefined;
|
|
2935
2935
|
}
|
|
@@ -2938,14 +2938,14 @@ export interface StateMachineVersionListItem {
|
|
|
2938
2938
|
*/
|
|
2939
2939
|
export interface ListStateMachineVersionsOutput {
|
|
2940
2940
|
/**
|
|
2941
|
-
* @public
|
|
2942
2941
|
* <p>Versions for the state machine.</p>
|
|
2942
|
+
* @public
|
|
2943
2943
|
*/
|
|
2944
2944
|
stateMachineVersions: StateMachineVersionListItem[] | undefined;
|
|
2945
2945
|
/**
|
|
2946
|
-
* @public
|
|
2947
2946
|
* <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.
|
|
2948
2947
|
* 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>
|
|
2948
|
+
* @public
|
|
2949
2949
|
*/
|
|
2950
2950
|
nextToken?: string;
|
|
2951
2951
|
}
|
|
@@ -2954,8 +2954,8 @@ export interface ListStateMachineVersionsOutput {
|
|
|
2954
2954
|
*/
|
|
2955
2955
|
export interface ListTagsForResourceInput {
|
|
2956
2956
|
/**
|
|
2957
|
-
* @public
|
|
2958
2957
|
* <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
|
|
2958
|
+
* @public
|
|
2959
2959
|
*/
|
|
2960
2960
|
resourceArn: string | undefined;
|
|
2961
2961
|
}
|
|
@@ -2964,8 +2964,8 @@ export interface ListTagsForResourceInput {
|
|
|
2964
2964
|
*/
|
|
2965
2965
|
export interface ListTagsForResourceOutput {
|
|
2966
2966
|
/**
|
|
2967
|
-
* @public
|
|
2968
2967
|
* <p>An array of tags associated with the resource.</p>
|
|
2968
|
+
* @public
|
|
2969
2969
|
*/
|
|
2970
2970
|
tags?: Tag[];
|
|
2971
2971
|
}
|
|
@@ -2974,12 +2974,11 @@ export interface ListTagsForResourceOutput {
|
|
|
2974
2974
|
*/
|
|
2975
2975
|
export interface PublishStateMachineVersionInput {
|
|
2976
2976
|
/**
|
|
2977
|
-
* @public
|
|
2978
2977
|
* <p>The Amazon Resource Name (ARN) of the state machine.</p>
|
|
2978
|
+
* @public
|
|
2979
2979
|
*/
|
|
2980
2980
|
stateMachineArn: string | undefined;
|
|
2981
2981
|
/**
|
|
2982
|
-
* @public
|
|
2983
2982
|
* <p>Only publish the state machine version if the current state machine's revision ID matches the specified ID.</p>
|
|
2984
2983
|
* <p>Use this option to avoid publishing a version if the state machine changed since you last
|
|
2985
2984
|
* updated it. If the specified revision ID doesn't match the state machine's current revision
|
|
@@ -2990,11 +2989,12 @@ export interface PublishStateMachineVersionInput {
|
|
|
2990
2989
|
* example, you can specify a <code>revisionID</code> of <code>INITIAL</code> when you create a
|
|
2991
2990
|
* state machine using the <a>CreateStateMachine</a> API action.</p>
|
|
2992
2991
|
* </note>
|
|
2992
|
+
* @public
|
|
2993
2993
|
*/
|
|
2994
2994
|
revisionId?: string;
|
|
2995
2995
|
/**
|
|
2996
|
-
* @public
|
|
2997
2996
|
* <p>An optional description of the state machine version.</p>
|
|
2997
|
+
* @public
|
|
2998
2998
|
*/
|
|
2999
2999
|
description?: string;
|
|
3000
3000
|
}
|
|
@@ -3003,20 +3003,20 @@ export interface PublishStateMachineVersionInput {
|
|
|
3003
3003
|
*/
|
|
3004
3004
|
export interface PublishStateMachineVersionOutput {
|
|
3005
3005
|
/**
|
|
3006
|
-
* @public
|
|
3007
3006
|
* <p>The date the version was created.</p>
|
|
3007
|
+
* @public
|
|
3008
3008
|
*/
|
|
3009
3009
|
creationDate: Date | undefined;
|
|
3010
3010
|
/**
|
|
3011
|
-
* @public
|
|
3012
3011
|
* <p>The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.</p>
|
|
3012
|
+
* @public
|
|
3013
3013
|
*/
|
|
3014
3014
|
stateMachineVersionArn: string | undefined;
|
|
3015
3015
|
}
|
|
3016
3016
|
/**
|
|
3017
|
-
* @public
|
|
3018
3017
|
* <p>The maximum number of running executions has been reached. Running executions must end or
|
|
3019
3018
|
* be stopped before a new execution can be started.</p>
|
|
3019
|
+
* @public
|
|
3020
3020
|
*/
|
|
3021
3021
|
export declare class ExecutionLimitExceeded extends __BaseException {
|
|
3022
3022
|
readonly name: "ExecutionLimitExceeded";
|
|
@@ -3027,8 +3027,8 @@ export declare class ExecutionLimitExceeded extends __BaseException {
|
|
|
3027
3027
|
constructor(opts: __ExceptionOptionType<ExecutionLimitExceeded, __BaseException>);
|
|
3028
3028
|
}
|
|
3029
3029
|
/**
|
|
3030
|
-
* @public
|
|
3031
3030
|
* <p>The execution Amazon Resource Name (ARN) that you specified for <code>executionArn</code> cannot be redriven.</p>
|
|
3031
|
+
* @public
|
|
3032
3032
|
*/
|
|
3033
3033
|
export declare class ExecutionNotRedrivable extends __BaseException {
|
|
3034
3034
|
readonly name: "ExecutionNotRedrivable";
|
|
@@ -3043,13 +3043,13 @@ export declare class ExecutionNotRedrivable extends __BaseException {
|
|
|
3043
3043
|
*/
|
|
3044
3044
|
export interface RedriveExecutionInput {
|
|
3045
3045
|
/**
|
|
3046
|
-
* @public
|
|
3047
3046
|
* <p>The Amazon Resource Name (ARN) of the execution to be redriven.</p>
|
|
3047
|
+
* @public
|
|
3048
3048
|
*/
|
|
3049
3049
|
executionArn: string | undefined;
|
|
3050
3050
|
/**
|
|
3051
|
-
* @public
|
|
3052
3051
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.</p>
|
|
3052
|
+
* @public
|
|
3053
3053
|
*/
|
|
3054
3054
|
clientToken?: string;
|
|
3055
3055
|
}
|
|
@@ -3058,8 +3058,8 @@ export interface RedriveExecutionInput {
|
|
|
3058
3058
|
*/
|
|
3059
3059
|
export interface RedriveExecutionOutput {
|
|
3060
3060
|
/**
|
|
3061
|
-
* @public
|
|
3062
3061
|
* <p>The date the execution was last redriven.</p>
|
|
3062
|
+
* @public
|
|
3063
3063
|
*/
|
|
3064
3064
|
redriveDate: Date | undefined;
|
|
3065
3065
|
}
|
|
@@ -3068,20 +3068,20 @@ export interface RedriveExecutionOutput {
|
|
|
3068
3068
|
*/
|
|
3069
3069
|
export interface SendTaskFailureInput {
|
|
3070
3070
|
/**
|
|
3071
|
-
* @public
|
|
3072
3071
|
* <p>The token that represents this task. Task tokens are generated by Step Functions when
|
|
3073
3072
|
* 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
|
|
3074
3073
|
* workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
|
|
3074
|
+
* @public
|
|
3075
3075
|
*/
|
|
3076
3076
|
taskToken: string | undefined;
|
|
3077
3077
|
/**
|
|
3078
|
-
* @public
|
|
3079
3078
|
* <p>The error code of the failure.</p>
|
|
3079
|
+
* @public
|
|
3080
3080
|
*/
|
|
3081
3081
|
error?: string;
|
|
3082
3082
|
/**
|
|
3083
|
-
* @public
|
|
3084
3083
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
3084
|
+
* @public
|
|
3085
3085
|
*/
|
|
3086
3086
|
cause?: string;
|
|
3087
3087
|
}
|
|
@@ -3091,8 +3091,8 @@ export interface SendTaskFailureInput {
|
|
|
3091
3091
|
export interface SendTaskFailureOutput {
|
|
3092
3092
|
}
|
|
3093
3093
|
/**
|
|
3094
|
-
* @public
|
|
3095
3094
|
* <p>The activity does not exist.</p>
|
|
3095
|
+
* @public
|
|
3096
3096
|
*/
|
|
3097
3097
|
export declare class TaskDoesNotExist extends __BaseException {
|
|
3098
3098
|
readonly name: "TaskDoesNotExist";
|
|
@@ -3103,8 +3103,8 @@ export declare class TaskDoesNotExist extends __BaseException {
|
|
|
3103
3103
|
constructor(opts: __ExceptionOptionType<TaskDoesNotExist, __BaseException>);
|
|
3104
3104
|
}
|
|
3105
3105
|
/**
|
|
3106
|
-
* @public
|
|
3107
3106
|
* <p>The task token has either expired or the task associated with the token has already been closed.</p>
|
|
3107
|
+
* @public
|
|
3108
3108
|
*/
|
|
3109
3109
|
export declare class TaskTimedOut extends __BaseException {
|
|
3110
3110
|
readonly name: "TaskTimedOut";
|
|
@@ -3119,10 +3119,10 @@ export declare class TaskTimedOut extends __BaseException {
|
|
|
3119
3119
|
*/
|
|
3120
3120
|
export interface SendTaskHeartbeatInput {
|
|
3121
3121
|
/**
|
|
3122
|
-
* @public
|
|
3123
3122
|
* <p>The token that represents this task. Task tokens are generated by Step Functions when
|
|
3124
3123
|
* 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
|
|
3125
3124
|
* workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
|
|
3125
|
+
* @public
|
|
3126
3126
|
*/
|
|
3127
3127
|
taskToken: string | undefined;
|
|
3128
3128
|
}
|
|
@@ -3132,8 +3132,8 @@ export interface SendTaskHeartbeatInput {
|
|
|
3132
3132
|
export interface SendTaskHeartbeatOutput {
|
|
3133
3133
|
}
|
|
3134
3134
|
/**
|
|
3135
|
-
* @public
|
|
3136
3135
|
* <p>The provided JSON output data is not valid.</p>
|
|
3136
|
+
* @public
|
|
3137
3137
|
*/
|
|
3138
3138
|
export declare class InvalidOutput extends __BaseException {
|
|
3139
3139
|
readonly name: "InvalidOutput";
|
|
@@ -3148,15 +3148,15 @@ export declare class InvalidOutput extends __BaseException {
|
|
|
3148
3148
|
*/
|
|
3149
3149
|
export interface SendTaskSuccessInput {
|
|
3150
3150
|
/**
|
|
3151
|
-
* @public
|
|
3152
3151
|
* <p>The token that represents this task. Task tokens are generated by Step Functions when
|
|
3153
3152
|
* 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
|
|
3154
3153
|
* workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>
|
|
3154
|
+
* @public
|
|
3155
3155
|
*/
|
|
3156
3156
|
taskToken: string | undefined;
|
|
3157
3157
|
/**
|
|
3158
|
-
* @public
|
|
3159
3158
|
* <p>The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
3159
|
+
* @public
|
|
3160
3160
|
*/
|
|
3161
3161
|
output: string | undefined;
|
|
3162
3162
|
}
|
|
@@ -3166,13 +3166,13 @@ export interface SendTaskSuccessInput {
|
|
|
3166
3166
|
export interface SendTaskSuccessOutput {
|
|
3167
3167
|
}
|
|
3168
3168
|
/**
|
|
3169
|
-
* @public
|
|
3170
3169
|
* <p>The execution has the same <code>name</code> as another execution (but a different
|
|
3171
3170
|
* <code>input</code>).</p>
|
|
3172
3171
|
* <note>
|
|
3173
3172
|
* <p>Executions with the same <code>name</code> and <code>input</code> are considered
|
|
3174
3173
|
* idempotent.</p>
|
|
3175
3174
|
* </note>
|
|
3175
|
+
* @public
|
|
3176
3176
|
*/
|
|
3177
3177
|
export declare class ExecutionAlreadyExists extends __BaseException {
|
|
3178
3178
|
readonly name: "ExecutionAlreadyExists";
|
|
@@ -3183,8 +3183,8 @@ export declare class ExecutionAlreadyExists extends __BaseException {
|
|
|
3183
3183
|
constructor(opts: __ExceptionOptionType<ExecutionAlreadyExists, __BaseException>);
|
|
3184
3184
|
}
|
|
3185
3185
|
/**
|
|
3186
|
-
* @public
|
|
3187
3186
|
* <p>The provided JSON input data is not valid.</p>
|
|
3187
|
+
* @public
|
|
3188
3188
|
*/
|
|
3189
3189
|
export declare class InvalidExecutionInput extends __BaseException {
|
|
3190
3190
|
readonly name: "InvalidExecutionInput";
|
|
@@ -3199,7 +3199,6 @@ export declare class InvalidExecutionInput extends __BaseException {
|
|
|
3199
3199
|
*/
|
|
3200
3200
|
export interface StartExecutionInput {
|
|
3201
3201
|
/**
|
|
3202
|
-
* @public
|
|
3203
3202
|
* <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
|
|
3204
3203
|
* <p>The <code>stateMachineArn</code> parameter accepts one of the following inputs:</p>
|
|
3205
3204
|
* <ul>
|
|
@@ -3230,10 +3229,10 @@ export interface StartExecutionInput {
|
|
|
3230
3229
|
* that execution.</p>
|
|
3231
3230
|
* </li>
|
|
3232
3231
|
* </ul>
|
|
3232
|
+
* @public
|
|
3233
3233
|
*/
|
|
3234
3234
|
stateMachineArn: string | undefined;
|
|
3235
3235
|
/**
|
|
3236
|
-
* @public
|
|
3237
3236
|
* <p>Optional name of the execution.
|
|
3238
3237
|
* This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,
|
|
3239
3238
|
* see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
|
|
@@ -3261,10 +3260,10 @@ export interface StartExecutionInput {
|
|
|
3261
3260
|
* </li>
|
|
3262
3261
|
* </ul>
|
|
3263
3262
|
* <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
|
|
3263
|
+
* @public
|
|
3264
3264
|
*/
|
|
3265
3265
|
name?: string;
|
|
3266
3266
|
/**
|
|
3267
|
-
* @public
|
|
3268
3267
|
* <p>The string that contains the JSON input data for the execution, for example:</p>
|
|
3269
3268
|
* <p>
|
|
3270
3269
|
* <code>"input": "\{\"first_name\" : \"test\"\}"</code>
|
|
@@ -3275,12 +3274,13 @@ export interface StartExecutionInput {
|
|
|
3275
3274
|
* </p>
|
|
3276
3275
|
* </note>
|
|
3277
3276
|
* <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
3277
|
+
* @public
|
|
3278
3278
|
*/
|
|
3279
3279
|
input?: string;
|
|
3280
3280
|
/**
|
|
3281
|
-
* @public
|
|
3282
3281
|
* <p>Passes the X-Ray trace header. The trace header can also be passed in the request
|
|
3283
3282
|
* payload.</p>
|
|
3283
|
+
* @public
|
|
3284
3284
|
*/
|
|
3285
3285
|
traceHeader?: string;
|
|
3286
3286
|
}
|
|
@@ -3289,13 +3289,13 @@ export interface StartExecutionInput {
|
|
|
3289
3289
|
*/
|
|
3290
3290
|
export interface StartExecutionOutput {
|
|
3291
3291
|
/**
|
|
3292
|
-
* @public
|
|
3293
3292
|
* <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
|
|
3293
|
+
* @public
|
|
3294
3294
|
*/
|
|
3295
3295
|
executionArn: string | undefined;
|
|
3296
3296
|
/**
|
|
3297
|
-
* @public
|
|
3298
3297
|
* <p>The date the execution is started.</p>
|
|
3298
|
+
* @public
|
|
3299
3299
|
*/
|
|
3300
3300
|
startDate: Date | undefined;
|
|
3301
3301
|
}
|
|
@@ -3304,17 +3304,16 @@ export interface StartExecutionOutput {
|
|
|
3304
3304
|
*/
|
|
3305
3305
|
export interface StartSyncExecutionInput {
|
|
3306
3306
|
/**
|
|
3307
|
-
* @public
|
|
3308
3307
|
* <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
|
|
3308
|
+
* @public
|
|
3309
3309
|
*/
|
|
3310
3310
|
stateMachineArn: string | undefined;
|
|
3311
3311
|
/**
|
|
3312
|
-
* @public
|
|
3313
3312
|
* <p>The name of the execution.</p>
|
|
3313
|
+
* @public
|
|
3314
3314
|
*/
|
|
3315
3315
|
name?: string;
|
|
3316
3316
|
/**
|
|
3317
|
-
* @public
|
|
3318
3317
|
* <p>The string that contains the JSON input data for the execution, for example:</p>
|
|
3319
3318
|
* <p>
|
|
3320
3319
|
* <code>"input": "\{\"first_name\" : \"test\"\}"</code>
|
|
@@ -3325,28 +3324,29 @@ export interface StartSyncExecutionInput {
|
|
|
3325
3324
|
* </p>
|
|
3326
3325
|
* </note>
|
|
3327
3326
|
* <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
3327
|
+
* @public
|
|
3328
3328
|
*/
|
|
3329
3329
|
input?: string;
|
|
3330
3330
|
/**
|
|
3331
|
-
* @public
|
|
3332
3331
|
* <p>Passes the X-Ray trace header. The trace header can also be passed in the request
|
|
3333
3332
|
* payload.</p>
|
|
3333
|
+
* @public
|
|
3334
3334
|
*/
|
|
3335
3335
|
traceHeader?: string;
|
|
3336
3336
|
}
|
|
3337
3337
|
/**
|
|
3338
|
-
* @public
|
|
3339
3338
|
* <p>An object that describes workflow billing details.</p>
|
|
3339
|
+
* @public
|
|
3340
3340
|
*/
|
|
3341
3341
|
export interface BillingDetails {
|
|
3342
3342
|
/**
|
|
3343
|
-
* @public
|
|
3344
3343
|
* <p>Billed memory consumption of your workflow, in MB.</p>
|
|
3344
|
+
* @public
|
|
3345
3345
|
*/
|
|
3346
3346
|
billedMemoryUsedInMB?: number;
|
|
3347
3347
|
/**
|
|
3348
|
-
* @public
|
|
3349
3348
|
* <p>Billed duration of your workflow, in milliseconds.</p>
|
|
3349
|
+
* @public
|
|
3350
3350
|
*/
|
|
3351
3351
|
billedDurationInMilliseconds?: number;
|
|
3352
3352
|
}
|
|
@@ -3368,78 +3368,78 @@ export type SyncExecutionStatus = (typeof SyncExecutionStatus)[keyof typeof Sync
|
|
|
3368
3368
|
*/
|
|
3369
3369
|
export interface StartSyncExecutionOutput {
|
|
3370
3370
|
/**
|
|
3371
|
-
* @public
|
|
3372
3371
|
* <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
|
|
3372
|
+
* @public
|
|
3373
3373
|
*/
|
|
3374
3374
|
executionArn: string | undefined;
|
|
3375
3375
|
/**
|
|
3376
|
-
* @public
|
|
3377
3376
|
* <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
|
|
3377
|
+
* @public
|
|
3378
3378
|
*/
|
|
3379
3379
|
stateMachineArn?: string;
|
|
3380
3380
|
/**
|
|
3381
|
-
* @public
|
|
3382
3381
|
* <p>The name of the execution.</p>
|
|
3382
|
+
* @public
|
|
3383
3383
|
*/
|
|
3384
3384
|
name?: string;
|
|
3385
3385
|
/**
|
|
3386
|
-
* @public
|
|
3387
3386
|
* <p>The date the execution is started.</p>
|
|
3387
|
+
* @public
|
|
3388
3388
|
*/
|
|
3389
3389
|
startDate: Date | undefined;
|
|
3390
3390
|
/**
|
|
3391
|
-
* @public
|
|
3392
3391
|
* <p>If the execution has already ended, the date the execution stopped.</p>
|
|
3392
|
+
* @public
|
|
3393
3393
|
*/
|
|
3394
3394
|
stopDate: Date | undefined;
|
|
3395
3395
|
/**
|
|
3396
|
-
* @public
|
|
3397
3396
|
* <p>The current status of the execution.</p>
|
|
3397
|
+
* @public
|
|
3398
3398
|
*/
|
|
3399
3399
|
status: SyncExecutionStatus | undefined;
|
|
3400
3400
|
/**
|
|
3401
|
-
* @public
|
|
3402
3401
|
* <p>The error code of the failure.</p>
|
|
3402
|
+
* @public
|
|
3403
3403
|
*/
|
|
3404
3404
|
error?: string;
|
|
3405
3405
|
/**
|
|
3406
|
-
* @public
|
|
3407
3406
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
3407
|
+
* @public
|
|
3408
3408
|
*/
|
|
3409
3409
|
cause?: string;
|
|
3410
3410
|
/**
|
|
3411
|
-
* @public
|
|
3412
3411
|
* <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>
|
|
3412
|
+
* @public
|
|
3413
3413
|
*/
|
|
3414
3414
|
input?: string;
|
|
3415
3415
|
/**
|
|
3416
|
-
* @public
|
|
3417
3416
|
* <p>Provides details about execution input or output.</p>
|
|
3417
|
+
* @public
|
|
3418
3418
|
*/
|
|
3419
3419
|
inputDetails?: CloudWatchEventsExecutionDataDetails;
|
|
3420
3420
|
/**
|
|
3421
|
-
* @public
|
|
3422
3421
|
* <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>
|
|
3423
3422
|
* <note>
|
|
3424
3423
|
* <p>This field is set only if the execution succeeds. If the execution fails, this field is
|
|
3425
3424
|
* null.</p>
|
|
3426
3425
|
* </note>
|
|
3426
|
+
* @public
|
|
3427
3427
|
*/
|
|
3428
3428
|
output?: string;
|
|
3429
3429
|
/**
|
|
3430
|
-
* @public
|
|
3431
3430
|
* <p>Provides details about execution input or output.</p>
|
|
3431
|
+
* @public
|
|
3432
3432
|
*/
|
|
3433
3433
|
outputDetails?: CloudWatchEventsExecutionDataDetails;
|
|
3434
3434
|
/**
|
|
3435
|
-
* @public
|
|
3436
3435
|
* <p>The X-Ray trace header that was passed to the execution.</p>
|
|
3436
|
+
* @public
|
|
3437
3437
|
*/
|
|
3438
3438
|
traceHeader?: string;
|
|
3439
3439
|
/**
|
|
3440
|
-
* @public
|
|
3441
3440
|
* <p>An object that describes workflow billing details, including billed duration and memory
|
|
3442
3441
|
* use.</p>
|
|
3442
|
+
* @public
|
|
3443
3443
|
*/
|
|
3444
3444
|
billingDetails?: BillingDetails;
|
|
3445
3445
|
}
|
|
@@ -3448,18 +3448,18 @@ export interface StartSyncExecutionOutput {
|
|
|
3448
3448
|
*/
|
|
3449
3449
|
export interface StopExecutionInput {
|
|
3450
3450
|
/**
|
|
3451
|
-
* @public
|
|
3452
3451
|
* <p>The Amazon Resource Name (ARN) of the execution to stop.</p>
|
|
3452
|
+
* @public
|
|
3453
3453
|
*/
|
|
3454
3454
|
executionArn: string | undefined;
|
|
3455
3455
|
/**
|
|
3456
|
-
* @public
|
|
3457
3456
|
* <p>The error code of the failure.</p>
|
|
3457
|
+
* @public
|
|
3458
3458
|
*/
|
|
3459
3459
|
error?: string;
|
|
3460
3460
|
/**
|
|
3461
|
-
* @public
|
|
3462
3461
|
* <p>A more detailed explanation of the cause of the failure.</p>
|
|
3462
|
+
* @public
|
|
3463
3463
|
*/
|
|
3464
3464
|
cause?: string;
|
|
3465
3465
|
}
|
|
@@ -3468,8 +3468,8 @@ export interface StopExecutionInput {
|
|
|
3468
3468
|
*/
|
|
3469
3469
|
export interface StopExecutionOutput {
|
|
3470
3470
|
/**
|
|
3471
|
-
* @public
|
|
3472
3471
|
* <p>The date the execution is stopped.</p>
|
|
3472
|
+
* @public
|
|
3473
3473
|
*/
|
|
3474
3474
|
stopDate: Date | undefined;
|
|
3475
3475
|
}
|
|
@@ -3478,14 +3478,14 @@ export interface StopExecutionOutput {
|
|
|
3478
3478
|
*/
|
|
3479
3479
|
export interface TagResourceInput {
|
|
3480
3480
|
/**
|
|
3481
|
-
* @public
|
|
3482
3481
|
* <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
|
|
3482
|
+
* @public
|
|
3483
3483
|
*/
|
|
3484
3484
|
resourceArn: string | undefined;
|
|
3485
3485
|
/**
|
|
3486
|
-
* @public
|
|
3487
3486
|
* <p>The list of tags to add to a resource.</p>
|
|
3488
3487
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
3488
|
+
* @public
|
|
3489
3489
|
*/
|
|
3490
3490
|
tags: Tag[] | undefined;
|
|
3491
3491
|
}
|
|
@@ -3512,22 +3512,21 @@ export type InspectionLevel = (typeof InspectionLevel)[keyof typeof InspectionLe
|
|
|
3512
3512
|
*/
|
|
3513
3513
|
export interface TestStateInput {
|
|
3514
3514
|
/**
|
|
3515
|
-
* @public
|
|
3516
3515
|
* <p>The <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> (ASL) definition of the state.</p>
|
|
3516
|
+
* @public
|
|
3517
3517
|
*/
|
|
3518
3518
|
definition: string | undefined;
|
|
3519
3519
|
/**
|
|
3520
|
-
* @public
|
|
3521
3520
|
* <p>The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.</p>
|
|
3521
|
+
* @public
|
|
3522
3522
|
*/
|
|
3523
3523
|
roleArn: string | undefined;
|
|
3524
3524
|
/**
|
|
3525
|
-
* @public
|
|
3526
3525
|
* <p>A string that contains the JSON input data for the state.</p>
|
|
3526
|
+
* @public
|
|
3527
3527
|
*/
|
|
3528
3528
|
input?: string;
|
|
3529
3529
|
/**
|
|
3530
|
-
* @public
|
|
3531
3530
|
* <p>Determines the values to return when a state is tested. You can specify one of the following types:</p>
|
|
3532
3531
|
* <ul>
|
|
3533
3532
|
* <li>
|
|
@@ -3544,121 +3543,122 @@ export interface TestStateInput {
|
|
|
3544
3543
|
* </li>
|
|
3545
3544
|
* </ul>
|
|
3546
3545
|
* <p>Each of these levels also provide information about the status of the state execution and the next state to transition to.</p>
|
|
3546
|
+
* @public
|
|
3547
3547
|
*/
|
|
3548
3548
|
inspectionLevel?: InspectionLevel;
|
|
3549
3549
|
/**
|
|
3550
|
-
* @public
|
|
3551
3550
|
* <p>Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.</p>
|
|
3552
3551
|
* <p>If you set <code>revealSecrets</code> to <code>true</code>, you must make sure that the IAM user that calls the <code>TestState</code> API has permission for the <code>states:RevealSecrets</code> action. For an example of IAM policy that sets the <code>states:RevealSecrets</code> permission, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions">IAM permissions to test a state</a>. Without this permission, Step Functions throws an access denied error.</p>
|
|
3553
3552
|
* <p>By default, <code>revealSecrets</code> is set to <code>false</code>.</p>
|
|
3553
|
+
* @public
|
|
3554
3554
|
*/
|
|
3555
3555
|
revealSecrets?: boolean;
|
|
3556
3556
|
}
|
|
3557
3557
|
/**
|
|
3558
|
-
* @public
|
|
3559
3558
|
* <p>Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request information.</p>
|
|
3559
|
+
* @public
|
|
3560
3560
|
*/
|
|
3561
3561
|
export interface InspectionDataRequest {
|
|
3562
3562
|
/**
|
|
3563
|
-
* @public
|
|
3564
3563
|
* <p>The protocol used to make the HTTP request.</p>
|
|
3564
|
+
* @public
|
|
3565
3565
|
*/
|
|
3566
3566
|
protocol?: string;
|
|
3567
3567
|
/**
|
|
3568
|
-
* @public
|
|
3569
3568
|
* <p>The HTTP method used for the HTTP request.</p>
|
|
3569
|
+
* @public
|
|
3570
3570
|
*/
|
|
3571
3571
|
method?: string;
|
|
3572
3572
|
/**
|
|
3573
|
-
* @public
|
|
3574
3573
|
* <p>The API endpoint used for the HTTP request.</p>
|
|
3574
|
+
* @public
|
|
3575
3575
|
*/
|
|
3576
3576
|
url?: string;
|
|
3577
3577
|
/**
|
|
3578
|
-
* @public
|
|
3579
3578
|
* <p>The request headers associated with the HTTP request.</p>
|
|
3579
|
+
* @public
|
|
3580
3580
|
*/
|
|
3581
3581
|
headers?: string;
|
|
3582
3582
|
/**
|
|
3583
|
-
* @public
|
|
3584
3583
|
* <p>The request body for the HTTP request.</p>
|
|
3584
|
+
* @public
|
|
3585
3585
|
*/
|
|
3586
3586
|
body?: string;
|
|
3587
3587
|
}
|
|
3588
3588
|
/**
|
|
3589
|
-
* @public
|
|
3590
3589
|
* <p>Contains additional details about the state's execution, including its input and output data processing flow, and HTTP response information. The <code>inspectionLevel</code> request parameter specifies which details are returned.</p>
|
|
3590
|
+
* @public
|
|
3591
3591
|
*/
|
|
3592
3592
|
export interface InspectionDataResponse {
|
|
3593
3593
|
/**
|
|
3594
|
-
* @public
|
|
3595
3594
|
* <p>The protocol used to return the HTTP response.</p>
|
|
3595
|
+
* @public
|
|
3596
3596
|
*/
|
|
3597
3597
|
protocol?: string;
|
|
3598
3598
|
/**
|
|
3599
|
-
* @public
|
|
3600
3599
|
* <p>The HTTP response status code for the HTTP response.</p>
|
|
3600
|
+
* @public
|
|
3601
3601
|
*/
|
|
3602
3602
|
statusCode?: string;
|
|
3603
3603
|
/**
|
|
3604
|
-
* @public
|
|
3605
3604
|
* <p>The message associated with the HTTP status code.</p>
|
|
3605
|
+
* @public
|
|
3606
3606
|
*/
|
|
3607
3607
|
statusMessage?: string;
|
|
3608
3608
|
/**
|
|
3609
|
-
* @public
|
|
3610
3609
|
* <p>The response headers associated with the HTTP response.</p>
|
|
3610
|
+
* @public
|
|
3611
3611
|
*/
|
|
3612
3612
|
headers?: string;
|
|
3613
3613
|
/**
|
|
3614
|
-
* @public
|
|
3615
3614
|
* <p>The HTTP response returned.</p>
|
|
3615
|
+
* @public
|
|
3616
3616
|
*/
|
|
3617
3617
|
body?: string;
|
|
3618
3618
|
}
|
|
3619
3619
|
/**
|
|
3620
|
-
* @public
|
|
3621
3620
|
* <p>Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information.</p>
|
|
3621
|
+
* @public
|
|
3622
3622
|
*/
|
|
3623
3623
|
export interface InspectionData {
|
|
3624
3624
|
/**
|
|
3625
|
-
* @public
|
|
3626
3625
|
* <p>The raw state input.</p>
|
|
3626
|
+
* @public
|
|
3627
3627
|
*/
|
|
3628
3628
|
input?: string;
|
|
3629
3629
|
/**
|
|
3630
|
-
* @public
|
|
3631
3630
|
* <p>The input after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-inputpath">InputPath</a> filter.</p>
|
|
3631
|
+
* @public
|
|
3632
3632
|
*/
|
|
3633
3633
|
afterInputPath?: string;
|
|
3634
3634
|
/**
|
|
3635
|
-
* @public
|
|
3636
3635
|
* <p>The effective input after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters">Parameters</a> filter.</p>
|
|
3636
|
+
* @public
|
|
3637
3637
|
*/
|
|
3638
3638
|
afterParameters?: string;
|
|
3639
3639
|
/**
|
|
3640
|
-
* @public
|
|
3641
3640
|
* <p>The state's raw result.</p>
|
|
3641
|
+
* @public
|
|
3642
3642
|
*/
|
|
3643
3643
|
result?: string;
|
|
3644
3644
|
/**
|
|
3645
|
-
* @public
|
|
3646
3645
|
* <p>The effective result after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector">ResultSelector</a> filter.</p>
|
|
3646
|
+
* @public
|
|
3647
3647
|
*/
|
|
3648
3648
|
afterResultSelector?: string;
|
|
3649
3649
|
/**
|
|
3650
|
-
* @public
|
|
3651
3650
|
* <p>The effective result combined with the raw state input after Step Functions applies the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultpath.html">ResultPath</a> filter.</p>
|
|
3651
|
+
* @public
|
|
3652
3652
|
*/
|
|
3653
3653
|
afterResultPath?: string;
|
|
3654
3654
|
/**
|
|
3655
|
-
* @public
|
|
3656
3655
|
* <p>The raw HTTP request that is sent when you test an HTTP Task.</p>
|
|
3656
|
+
* @public
|
|
3657
3657
|
*/
|
|
3658
3658
|
request?: InspectionDataRequest;
|
|
3659
3659
|
/**
|
|
3660
|
-
* @public
|
|
3661
3660
|
* <p>The raw HTTP response that is returned when you test an HTTP Task.</p>
|
|
3661
|
+
* @public
|
|
3662
3662
|
*/
|
|
3663
3663
|
response?: InspectionDataResponse;
|
|
3664
3664
|
}
|
|
@@ -3681,33 +3681,33 @@ export type TestExecutionStatus = (typeof TestExecutionStatus)[keyof typeof Test
|
|
|
3681
3681
|
*/
|
|
3682
3682
|
export interface TestStateOutput {
|
|
3683
3683
|
/**
|
|
3684
|
-
* @public
|
|
3685
3684
|
* <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>
|
|
3685
|
+
* @public
|
|
3686
3686
|
*/
|
|
3687
3687
|
output?: string;
|
|
3688
3688
|
/**
|
|
3689
|
-
* @public
|
|
3690
3689
|
* <p>The error returned when the execution of a state fails.</p>
|
|
3690
|
+
* @public
|
|
3691
3691
|
*/
|
|
3692
3692
|
error?: string;
|
|
3693
3693
|
/**
|
|
3694
|
-
* @public
|
|
3695
3694
|
* <p>A detailed explanation of the cause for the error when the execution of a state fails.</p>
|
|
3695
|
+
* @public
|
|
3696
3696
|
*/
|
|
3697
3697
|
cause?: string;
|
|
3698
3698
|
/**
|
|
3699
|
-
* @public
|
|
3700
3699
|
* <p>Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The <code>inspectionLevel</code> request parameter specifies which details are returned.</p>
|
|
3700
|
+
* @public
|
|
3701
3701
|
*/
|
|
3702
3702
|
inspectionData?: InspectionData;
|
|
3703
3703
|
/**
|
|
3704
|
-
* @public
|
|
3705
3704
|
* <p>The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.</p>
|
|
3705
|
+
* @public
|
|
3706
3706
|
*/
|
|
3707
3707
|
nextState?: string;
|
|
3708
3708
|
/**
|
|
3709
|
-
* @public
|
|
3710
3709
|
* <p>The execution status of the state.</p>
|
|
3710
|
+
* @public
|
|
3711
3711
|
*/
|
|
3712
3712
|
status?: TestExecutionStatus;
|
|
3713
3713
|
}
|
|
@@ -3716,13 +3716,13 @@ export interface TestStateOutput {
|
|
|
3716
3716
|
*/
|
|
3717
3717
|
export interface UntagResourceInput {
|
|
3718
3718
|
/**
|
|
3719
|
-
* @public
|
|
3720
3719
|
* <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
|
|
3720
|
+
* @public
|
|
3721
3721
|
*/
|
|
3722
3722
|
resourceArn: string | undefined;
|
|
3723
3723
|
/**
|
|
3724
|
-
* @public
|
|
3725
3724
|
* <p>The list of tags to remove from the resource.</p>
|
|
3725
|
+
* @public
|
|
3726
3726
|
*/
|
|
3727
3727
|
tagKeys: string[] | undefined;
|
|
3728
3728
|
}
|
|
@@ -3736,23 +3736,23 @@ export interface UntagResourceOutput {
|
|
|
3736
3736
|
*/
|
|
3737
3737
|
export interface UpdateMapRunInput {
|
|
3738
3738
|
/**
|
|
3739
|
-
* @public
|
|
3740
3739
|
* <p>The Amazon Resource Name (ARN) of a Map Run.</p>
|
|
3740
|
+
* @public
|
|
3741
3741
|
*/
|
|
3742
3742
|
mapRunArn: string | undefined;
|
|
3743
3743
|
/**
|
|
3744
|
-
* @public
|
|
3745
3744
|
* <p>The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.</p>
|
|
3745
|
+
* @public
|
|
3746
3746
|
*/
|
|
3747
3747
|
maxConcurrency?: number;
|
|
3748
3748
|
/**
|
|
3749
|
-
* @public
|
|
3750
3749
|
* <p>The maximum percentage of failed items before the Map Run fails.</p>
|
|
3750
|
+
* @public
|
|
3751
3751
|
*/
|
|
3752
3752
|
toleratedFailurePercentage?: number;
|
|
3753
3753
|
/**
|
|
3754
|
-
* @public
|
|
3755
3754
|
* <p>The maximum number of failed items before the Map Run fails.</p>
|
|
3755
|
+
* @public
|
|
3756
3756
|
*/
|
|
3757
3757
|
toleratedFailureCount?: number;
|
|
3758
3758
|
}
|
|
@@ -3762,9 +3762,9 @@ export interface UpdateMapRunInput {
|
|
|
3762
3762
|
export interface UpdateMapRunOutput {
|
|
3763
3763
|
}
|
|
3764
3764
|
/**
|
|
3765
|
-
* @public
|
|
3766
3765
|
* <p>Request is missing a required parameter. This error occurs if both <code>definition</code>
|
|
3767
3766
|
* and <code>roleArn</code> are not specified.</p>
|
|
3767
|
+
* @public
|
|
3768
3768
|
*/
|
|
3769
3769
|
export declare class MissingRequiredParameter extends __BaseException {
|
|
3770
3770
|
readonly name: "MissingRequiredParameter";
|
|
@@ -3779,42 +3779,42 @@ export declare class MissingRequiredParameter extends __BaseException {
|
|
|
3779
3779
|
*/
|
|
3780
3780
|
export interface UpdateStateMachineInput {
|
|
3781
3781
|
/**
|
|
3782
|
-
* @public
|
|
3783
3782
|
* <p>The Amazon Resource Name (ARN) of the state machine.</p>
|
|
3783
|
+
* @public
|
|
3784
3784
|
*/
|
|
3785
3785
|
stateMachineArn: string | undefined;
|
|
3786
3786
|
/**
|
|
3787
|
-
* @public
|
|
3788
3787
|
* <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>
|
|
3788
|
+
* @public
|
|
3789
3789
|
*/
|
|
3790
3790
|
definition?: string;
|
|
3791
3791
|
/**
|
|
3792
|
-
* @public
|
|
3793
3792
|
* <p>The Amazon Resource Name (ARN) of the IAM role of the state machine.</p>
|
|
3793
|
+
* @public
|
|
3794
3794
|
*/
|
|
3795
3795
|
roleArn?: string;
|
|
3796
3796
|
/**
|
|
3797
|
-
* @public
|
|
3798
3797
|
* <p>Use the <code>LoggingConfiguration</code> data type to set CloudWatch Logs
|
|
3799
3798
|
* options.</p>
|
|
3799
|
+
* @public
|
|
3800
3800
|
*/
|
|
3801
3801
|
loggingConfiguration?: LoggingConfiguration;
|
|
3802
3802
|
/**
|
|
3803
|
-
* @public
|
|
3804
3803
|
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
3804
|
+
* @public
|
|
3805
3805
|
*/
|
|
3806
3806
|
tracingConfiguration?: TracingConfiguration;
|
|
3807
3807
|
/**
|
|
3808
|
-
* @public
|
|
3809
3808
|
* <p>Specifies whether the state machine version is published. The default is
|
|
3810
3809
|
* <code>false</code>. To publish a version after updating the state machine, set
|
|
3811
3810
|
* <code>publish</code> to <code>true</code>.</p>
|
|
3811
|
+
* @public
|
|
3812
3812
|
*/
|
|
3813
3813
|
publish?: boolean;
|
|
3814
3814
|
/**
|
|
3815
|
-
* @public
|
|
3816
3815
|
* <p>An optional description of the state machine version to publish.</p>
|
|
3817
3816
|
* <p>You can only specify the <code>versionDescription</code> parameter if you've set <code>publish</code> to <code>true</code>.</p>
|
|
3817
|
+
* @public
|
|
3818
3818
|
*/
|
|
3819
3819
|
versionDescription?: string;
|
|
3820
3820
|
}
|
|
@@ -3823,19 +3823,19 @@ export interface UpdateStateMachineInput {
|
|
|
3823
3823
|
*/
|
|
3824
3824
|
export interface UpdateStateMachineOutput {
|
|
3825
3825
|
/**
|
|
3826
|
-
* @public
|
|
3827
3826
|
* <p>The date and time the state machine was updated.</p>
|
|
3827
|
+
* @public
|
|
3828
3828
|
*/
|
|
3829
3829
|
updateDate: Date | undefined;
|
|
3830
3830
|
/**
|
|
3831
|
-
* @public
|
|
3832
3831
|
* <p>The revision identifier for the updated state machine.</p>
|
|
3832
|
+
* @public
|
|
3833
3833
|
*/
|
|
3834
3834
|
revisionId?: string;
|
|
3835
3835
|
/**
|
|
3836
|
-
* @public
|
|
3837
3836
|
* <p>The Amazon Resource Name (ARN) of the published state machine version.</p>
|
|
3838
3837
|
* <p>If the <code>publish</code> parameter isn't set to <code>true</code>, this field returns null.</p>
|
|
3838
|
+
* @public
|
|
3839
3839
|
*/
|
|
3840
3840
|
stateMachineVersionArn?: string;
|
|
3841
3841
|
}
|
|
@@ -3844,19 +3844,19 @@ export interface UpdateStateMachineOutput {
|
|
|
3844
3844
|
*/
|
|
3845
3845
|
export interface UpdateStateMachineAliasInput {
|
|
3846
3846
|
/**
|
|
3847
|
-
* @public
|
|
3848
3847
|
* <p>The Amazon Resource Name (ARN) of the state machine alias.</p>
|
|
3848
|
+
* @public
|
|
3849
3849
|
*/
|
|
3850
3850
|
stateMachineAliasArn: string | undefined;
|
|
3851
3851
|
/**
|
|
3852
|
-
* @public
|
|
3853
3852
|
* <p>A description of the state machine alias.</p>
|
|
3853
|
+
* @public
|
|
3854
3854
|
*/
|
|
3855
3855
|
description?: string;
|
|
3856
3856
|
/**
|
|
3857
|
-
* @public
|
|
3858
3857
|
* <p>The routing configuration of the state machine alias.</p>
|
|
3859
3858
|
* <p>An array of <code>RoutingConfig</code> objects that specifies up to two state machine versions that the alias starts executions for.</p>
|
|
3859
|
+
* @public
|
|
3860
3860
|
*/
|
|
3861
3861
|
routingConfiguration?: RoutingConfigurationListItem[];
|
|
3862
3862
|
}
|
|
@@ -3865,8 +3865,8 @@ export interface UpdateStateMachineAliasInput {
|
|
|
3865
3865
|
*/
|
|
3866
3866
|
export interface UpdateStateMachineAliasOutput {
|
|
3867
3867
|
/**
|
|
3868
|
-
* @public
|
|
3869
3868
|
* <p>The date and time the state machine alias was updated.</p>
|
|
3869
|
+
* @public
|
|
3870
3870
|
*/
|
|
3871
3871
|
updateDate: Date | undefined;
|
|
3872
3872
|
}
|