@aws-sdk/client-mwaa-serverless 3.933.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/LICENSE +201 -0
- package/README.md +325 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +1324 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +56 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-es/MWAAServerless.js +37 -0
- package/dist-es/MWAAServerlessClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateWorkflowCommand.js +16 -0
- package/dist-es/commands/DeleteWorkflowCommand.js +16 -0
- package/dist-es/commands/GetTaskInstanceCommand.js +16 -0
- package/dist-es/commands/GetWorkflowCommand.js +16 -0
- package/dist-es/commands/GetWorkflowRunCommand.js +16 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
- package/dist-es/commands/ListTaskInstancesCommand.js +16 -0
- package/dist-es/commands/ListWorkflowRunsCommand.js +16 -0
- package/dist-es/commands/ListWorkflowVersionsCommand.js +16 -0
- package/dist-es/commands/ListWorkflowsCommand.js +16 -0
- package/dist-es/commands/StartWorkflowRunCommand.js +16 -0
- package/dist-es/commands/StopWorkflowRunCommand.js +16 -0
- package/dist-es/commands/TagResourceCommand.js +16 -0
- package/dist-es/commands/UntagResourceCommand.js +16 -0
- package/dist-es/commands/UpdateWorkflowCommand.js +16 -0
- package/dist-es/commands/index.js +15 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/MWAAServerlessServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +193 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListTaskInstancesPaginator.js +4 -0
- package/dist-es/pagination/ListWorkflowRunsPaginator.js +4 -0
- package/dist-es/pagination/ListWorkflowVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListWorkflowsPaginator.js +4 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +51 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +771 -0
- package/dist-types/MWAAServerless.d.ts +116 -0
- package/dist-types/MWAAServerlessClient.d.ts +211 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/CreateWorkflowCommand.d.ts +131 -0
- package/dist-types/commands/DeleteWorkflowCommand.d.ts +94 -0
- package/dist-types/commands/GetTaskInstanceCommand.d.ts +110 -0
- package/dist-types/commands/GetWorkflowCommand.d.ts +126 -0
- package/dist-types/commands/GetWorkflowRunCommand.d.ts +115 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +94 -0
- package/dist-types/commands/ListTaskInstancesCommand.d.ts +103 -0
- package/dist-types/commands/ListWorkflowRunsCommand.d.ts +106 -0
- package/dist-types/commands/ListWorkflowVersionsCommand.d.ts +109 -0
- package/dist-types/commands/ListWorkflowsCommand.d.ts +102 -0
- package/dist-types/commands/StartWorkflowRunCommand.d.ts +105 -0
- package/dist-types/commands/StopWorkflowRunCommand.d.ts +96 -0
- package/dist-types/commands/TagResourceCommand.d.ts +93 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +93 -0
- package/dist-types/commands/UpdateWorkflowCommand.d.ts +123 -0
- package/dist-types/commands/index.d.ts +15 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/MWAAServerlessServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1363 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListTaskInstancesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowRunsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkflowsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/runtimeConfig.browser.d.ts +51 -0
- package/dist-types/runtimeConfig.d.ts +51 -0
- package/dist-types/runtimeConfig.native.d.ts +50 -0
- package/dist-types/runtimeConfig.shared.d.ts +22 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +81 -0
- package/dist-types/ts3.4/MWAAServerless.d.ts +263 -0
- package/dist-types/ts3.4/MWAAServerlessClient.d.ts +214 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateWorkflowCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteWorkflowCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetTaskInstanceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetWorkflowCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetWorkflowRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTaskInstancesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListWorkflowRunsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListWorkflowVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartWorkflowRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StopWorkflowRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateWorkflowCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +15 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/MWAAServerlessServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +396 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListTaskInstancesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowRunsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWorkflowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +25 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +87 -0
- package/package.json +99 -0
|
@@ -0,0 +1,1363 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
+
import { MWAAServerlessServiceException as __BaseException } from "./MWAAServerlessServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* <p>You do not have sufficient permission to perform this action.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
9
|
+
readonly name: "AccessDeniedException";
|
|
10
|
+
readonly $fault: "client";
|
|
11
|
+
Message: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* @internal
|
|
14
|
+
*/
|
|
15
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* <p>An unexpected server-side error occurred during request processing.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
export declare class InternalServerException extends __BaseException {
|
|
22
|
+
readonly name: "InternalServerException";
|
|
23
|
+
readonly $fault: "server";
|
|
24
|
+
$retryable: {};
|
|
25
|
+
Message: string | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>The number of seconds to wait before retrying the operation.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
RetryAfterSeconds?: number | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export interface ListTagsForResourceRequest {
|
|
40
|
+
/**
|
|
41
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
ResourceArn: string | undefined;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
export interface ListTagsForResourceResponse {
|
|
50
|
+
/**
|
|
51
|
+
* <p>A map of tags that are associated with the resource, where each tag consists of a key-value pair.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
Tags?: Record<string, string> | undefined;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* <p>The operation timed out.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
export declare class OperationTimeoutException extends __BaseException {
|
|
61
|
+
readonly name: "OperationTimeoutException";
|
|
62
|
+
readonly $fault: "server";
|
|
63
|
+
Message?: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
constructor(opts: __ExceptionOptionType<OperationTimeoutException, __BaseException>);
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* <p>The specified resource was not found. You can only access or modify a resource that already exists.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
74
|
+
readonly name: "ResourceNotFoundException";
|
|
75
|
+
readonly $fault: "client";
|
|
76
|
+
Message: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The unique identifier of the resource.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
ResourceId: string | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>The type of the resource.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
ResourceType: string | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* <p>The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class ThrottlingException extends __BaseException {
|
|
97
|
+
readonly name: "ThrottlingException";
|
|
98
|
+
readonly $fault: "client";
|
|
99
|
+
$retryable: {
|
|
100
|
+
throttling: boolean;
|
|
101
|
+
};
|
|
102
|
+
Message: string | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>The code for the service.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
ServiceCode: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The code of the quota.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
QuotaCode: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The number of seconds to wait before retrying the operation.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
RetryAfterSeconds?: number | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
121
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* <p>Contains information about a field that failed validation, including the field name and a descriptive error message.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
export interface ValidationExceptionField {
|
|
128
|
+
/**
|
|
129
|
+
* <p>The name of the field that failed validation.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
Name: string | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* <p>A message that describes why the field failed validation.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
Message: string | undefined;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
* @enum
|
|
142
|
+
*/
|
|
143
|
+
export declare const ValidationExceptionReason: {
|
|
144
|
+
readonly CANNOT_PARSE: "cannotParse";
|
|
145
|
+
readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed";
|
|
146
|
+
readonly OTHER: "other";
|
|
147
|
+
readonly UNKNOWN_OPERATION: "unknownOperation";
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
153
|
+
/**
|
|
154
|
+
* <p>The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.</p>
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export declare class ValidationException extends __BaseException {
|
|
158
|
+
readonly name: "ValidationException";
|
|
159
|
+
readonly $fault: "client";
|
|
160
|
+
Message: string | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>The reason the request failed validation.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
Reason: ValidationExceptionReason | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <p>The fields that failed validation.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
FieldList?: ValidationExceptionField[] | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* @internal
|
|
173
|
+
*/
|
|
174
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
export interface TagResourceRequest {
|
|
180
|
+
/**
|
|
181
|
+
* <p>The Amazon Resource Name (ARN) of the resource to which to add tags.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
ResourceArn: string | undefined;
|
|
185
|
+
/**
|
|
186
|
+
* <p>A map of tags to add to the resource. Each tag consists of a key-value pair.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
Tags: Record<string, string> | undefined;
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
export interface TagResourceResponse {
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
export interface GetTaskInstanceRequest {
|
|
200
|
+
/**
|
|
201
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains the task instance.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
WorkflowArn: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* <p>The unique identifier of the task instance to retrieve.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
TaskInstanceId: string | undefined;
|
|
210
|
+
/**
|
|
211
|
+
* <p>The unique identifier of the workflow run that contains the task instance.</p>
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
RunId: string | undefined;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
* @enum
|
|
219
|
+
*/
|
|
220
|
+
export declare const TaskInstanceStatus: {
|
|
221
|
+
readonly CANCELLED: "CANCELLED";
|
|
222
|
+
readonly DEFERRED: "DEFERRED";
|
|
223
|
+
readonly FAILED: "FAILED";
|
|
224
|
+
readonly NONE: "NONE";
|
|
225
|
+
readonly QUEUED: "QUEUED";
|
|
226
|
+
readonly REMOVED: "REMOVED";
|
|
227
|
+
readonly RESTARTING: "RESTARTING";
|
|
228
|
+
readonly RUNNING: "RUNNING";
|
|
229
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
230
|
+
readonly SUCCESS: "SUCCESS";
|
|
231
|
+
readonly TIMEOUT: "TIMEOUT";
|
|
232
|
+
readonly UPSTREAM_FAILED: "UPSTREAM_FAILED";
|
|
233
|
+
readonly UP_FOR_RESCHEDULE: "UP_FOR_RESCHEDULE";
|
|
234
|
+
readonly UP_FOR_RETRY: "UP_FOR_RETRY";
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export type TaskInstanceStatus = (typeof TaskInstanceStatus)[keyof typeof TaskInstanceStatus];
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export interface GetTaskInstanceResponse {
|
|
244
|
+
/**
|
|
245
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains this task instance.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
WorkflowArn: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>The unique identifier of the workflow run that contains this task instance.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
RunId: string | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>The unique identifier of this task instance.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
TaskInstanceId: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The version of the workflow that contains this task instance.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
WorkflowVersion?: string | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The current status of the task instance.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
Status?: TaskInstanceStatus | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The duration of the task instance execution in seconds. This value is null if the task is not complete.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
DurationInSeconds?: number | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* <p>The name of the Apache Airflow operator used for this task instance.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
OperatorName?: string | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* <p>The timestamp when the task instance was last modified, in ISO 8601 date-time format.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
ModifiedAt?: Date | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* <p>The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
EndedAt?: Date | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
StartedAt?: Date | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>The attempt number for this task instance.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
AttemptNumber?: number | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* <p>The error message if the task instance failed. This value is null if the task completed successfully.</p>
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
ErrorMessage?: string | undefined;
|
|
304
|
+
/**
|
|
305
|
+
* <p>The unique identifier of the task definition within the workflow.</p>
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
TaskId?: string | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* <p>The CloudWatch log stream name for this task instance execution.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
LogStream?: string | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* <p>Cross-communication data exchanged between tasks in the workflow execution.</p>
|
|
316
|
+
* @public
|
|
317
|
+
*/
|
|
318
|
+
Xcom?: Record<string, string> | undefined;
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
export interface ListTaskInstancesRequest {
|
|
324
|
+
/**
|
|
325
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains the run.</p>
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
WorkflowArn: string | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* <p>The unique identifier of the workflow run for which you want a list of task instances.</p>
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
RunId: string | undefined;
|
|
334
|
+
/**
|
|
335
|
+
* <p>The maximum number of task instances to return in a single response.</p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
MaxResults?: number | undefined;
|
|
339
|
+
/**
|
|
340
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to <code>ListTaskInstances</code>.</p>
|
|
341
|
+
* @public
|
|
342
|
+
*/
|
|
343
|
+
NextToken?: string | undefined;
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* <p>Summary information about a task instance within a workflow run, including its status and execution details.</p>
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
export interface TaskInstanceSummary {
|
|
350
|
+
/**
|
|
351
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains this task instance.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
WorkflowArn?: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The version of the workflow that contains this task instance.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
WorkflowVersion?: string | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* <p>The unique identifier of the workflow run that contains this task instance.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
RunId?: string | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>The unique identifier of this task instance.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
TaskInstanceId?: string | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The current status of the task instance.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
Status?: TaskInstanceStatus | undefined;
|
|
375
|
+
/**
|
|
376
|
+
* <p>The duration of the task instance execution in seconds. This value is null if the task is not complete.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
DurationInSeconds?: number | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>The name of the Apache Airflow operator used for this task instance.</p>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
OperatorName?: string | undefined;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
export interface ListTaskInstancesResponse {
|
|
390
|
+
/**
|
|
391
|
+
* <p>A list of task instance summaries for the specified workflow run.</p>
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
TaskInstances?: TaskInstanceSummary[] | undefined;
|
|
395
|
+
/**
|
|
396
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.</p>
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
NextToken?: string | undefined;
|
|
400
|
+
}
|
|
401
|
+
/**
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
export interface UntagResourceRequest {
|
|
405
|
+
/**
|
|
406
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
ResourceArn: string | undefined;
|
|
410
|
+
/**
|
|
411
|
+
* <p>A list of tag keys to remove from the resource. Only the keys are required; the values are ignored.</p>
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
TagKeys: string[] | undefined;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
export interface UntagResourceResponse {
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* <p>You cannot create a resource that already exists, or the resource is in a state that prevents the requested operation.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
export declare class ConflictException extends __BaseException {
|
|
426
|
+
readonly name: "ConflictException";
|
|
427
|
+
readonly $fault: "client";
|
|
428
|
+
Message: string | undefined;
|
|
429
|
+
/**
|
|
430
|
+
* <p>The unique identifier of the resource.</p>
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
ResourceId: string | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>The type of the resource.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
ResourceType: string | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* @internal
|
|
441
|
+
*/
|
|
442
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* <p>Specifies the Amazon S3 location of a workflow definition file. This structure contains the bucket name, object key, and optional version ID for the workflow definition. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition file at the time of workflow creation or update, ensuring that the workflow behavior remains consistent even if the source file is modified. The definition must be a valid YAML file that uses supported Amazon Web Services operators and Amazon Managed Workflows for Apache Airflow Serverless syntax.</p>
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
export interface DefinitionS3Location {
|
|
449
|
+
/**
|
|
450
|
+
* <p>The name of the Amazon S3 bucket that contains the workflow definition file.</p>
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
Bucket: string | undefined;
|
|
454
|
+
/**
|
|
455
|
+
* <p>The key (name) of the workflow definition file within the S3 bucket.</p>
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
ObjectKey: string | undefined;
|
|
459
|
+
/**
|
|
460
|
+
* <p>Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
VersionId?: string | undefined;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* @public
|
|
467
|
+
* @enum
|
|
468
|
+
*/
|
|
469
|
+
export declare const EncryptionType: {
|
|
470
|
+
readonly AWS_MANAGED_KEY: "AWS_MANAGED_KEY";
|
|
471
|
+
readonly CUSTOMER_MANAGED_KEY: "CUSTOMER_MANAGED_KEY";
|
|
472
|
+
};
|
|
473
|
+
/**
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
|
|
477
|
+
/**
|
|
478
|
+
* <p>Configuration for encrypting workflow data at rest and in transit. Amazon Managed Workflows for Apache Airflow Serverless provides comprehensive encryption capabilities to protect sensitive workflow data, parameters, and execution logs. When using customer-managed keys, the service integrates with Amazon Web Services KMS to provide fine-grained access control and audit capabilities. Encryption is applied consistently across the distributed execution environment including task containers, metadata storage, and log streams.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
export interface EncryptionConfiguration {
|
|
482
|
+
/**
|
|
483
|
+
* <p>The type of encryption to use. Values are <code>AWS_MANAGED_KEY</code> (Amazon Web Services manages the encryption key) or <code>CUSTOMER_MANAGED_KEY</code> (you provide a KMS key).</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
Type: EncryptionType | undefined;
|
|
487
|
+
/**
|
|
488
|
+
* <p>The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when <code>Type</code> is <code>CUSTOMER_MANAGED_KEY</code>.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
KmsKeyId?: string | undefined;
|
|
492
|
+
}
|
|
493
|
+
export declare enum EngineVersion {
|
|
494
|
+
ONE = 1
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* <p>Configuration for workflow logging that specifies where you should store your workflow execution logs. Amazon Managed Workflows for Apache Airflow Serverless provides comprehensive logging capabilities that capture workflow execution details, task-level information, and system events. Logs are automatically exported to your specified CloudWatch log group using remote logging functionality, providing centralized observability across the distributed, multi-tenant execution environment. This enables effective debugging, monitoring, and compliance auditing of workflow executions.</p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
export interface LoggingConfiguration {
|
|
501
|
+
/**
|
|
502
|
+
* <p>The name of the CloudWatch log group where workflow execution logs are stored.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
LogGroupName: string | undefined;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* <p>Network configuration for workflow execution. Specifies VPC security groups and subnets for secure network access. When provided, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your specified VPC configuration, enabling secure access to VPC-only resources. The service uses a proxy API container architecture where one container handles external communication while the worker container connects to your VPC for task execution. This design provides both security isolation and connectivity flexibility.</p>
|
|
509
|
+
* @public
|
|
510
|
+
*/
|
|
511
|
+
export interface NetworkConfiguration {
|
|
512
|
+
/**
|
|
513
|
+
* <p>A list of VPC security group IDs to associate with the workflow execution environment.</p>
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
SecurityGroupIds?: string[] | undefined;
|
|
517
|
+
/**
|
|
518
|
+
* <p>A list of VPC subnet IDs where the workflow execution environment is deployed.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
SubnetIds?: string[] | undefined;
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
export interface CreateWorkflowRequest {
|
|
527
|
+
/**
|
|
528
|
+
* <p>The name of the workflow. You must use unique workflow names within your Amazon Web Services account. The service generates a unique identifier that is appended to ensure temporal uniqueness across the account lifecycle.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
Name: string | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow creation requests.</p>
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
ClientToken?: string | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
DefinitionS3Location: DefinitionS3Location | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services.</p>
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
RoleArn: string | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* <p>An optional description of the workflow that you can use to provide additional context about the workflow's purpose and functionality.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
Description?: string | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* <p>The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.</p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
EncryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The configuration for workflow logging. Specifies the CloudWatch log group where workflow execution logs are stored. Amazon Managed Workflows for Apache Airflow Serverless automatically exports worker logs and task-level information to the specified log group in your account using remote logging functionality. This provides comprehensive observability for debugging and monitoring workflow execution across the distributed, serverless environment.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
LoggingConfiguration?: LoggingConfiguration | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for this workflow. This determines the feature set, supported operators, and execution environment capabilities available to your workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains backward compatibility across versions while introducing new features and improvements. Currently supports version 1 with plans for additional versions as the service evolves.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
EngineVersion?: EngineVersion | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* <p>Network configuration for the workflow execution environment, including VPC security groups and subnets for secure network access. When specified, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your customer VPC to provide secure connectivity to your resources. If not specified, tasks run in the service's default worker VPC with network isolation from other customers. This configuration enables secure access to VPC-only resources like RDS databases or private endpoints.</p>
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* <p>A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation.</p>
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
Tags?: Record<string, string> | undefined;
|
|
577
|
+
/**
|
|
578
|
+
* <p>The trigger mode for the workflow execution.</p>
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
TriggerMode?: string | undefined;
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
* @public
|
|
585
|
+
* @enum
|
|
586
|
+
*/
|
|
587
|
+
export declare const WorkflowStatus: {
|
|
588
|
+
readonly DELETING: "DELETING";
|
|
589
|
+
readonly READY: "READY";
|
|
590
|
+
};
|
|
591
|
+
/**
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];
|
|
595
|
+
/**
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
export interface CreateWorkflowResponse {
|
|
599
|
+
/**
|
|
600
|
+
* <p>The Amazon Resource Name (ARN) of the newly created workflow. This ARN uniquely identifies the workflow resource.</p>
|
|
601
|
+
* @public
|
|
602
|
+
*/
|
|
603
|
+
WorkflowArn: string | undefined;
|
|
604
|
+
/**
|
|
605
|
+
* <p>The timestamp when the workflow was created, in ISO 8601 date-time format.</p>
|
|
606
|
+
* @public
|
|
607
|
+
*/
|
|
608
|
+
CreatedAt?: Date | undefined;
|
|
609
|
+
/**
|
|
610
|
+
* <p>A unique identifier for this revision of the workflow configuration. This ID changes when the workflow is updated and you can use it for optimistic concurrency control in update operations. The revision ID helps prevent conflicting updates and ensures that updates are applied to the expected version of the workflow configuration.</p>
|
|
611
|
+
* @public
|
|
612
|
+
*/
|
|
613
|
+
RevisionId?: string | undefined;
|
|
614
|
+
/**
|
|
615
|
+
* <p>The current status of the workflow. Possible values are <code>READY</code> (workflow is ready to run) and <code>DELETING</code> (workflow is being deleted).</p>
|
|
616
|
+
* @public
|
|
617
|
+
*/
|
|
618
|
+
WorkflowStatus?: WorkflowStatus | undefined;
|
|
619
|
+
/**
|
|
620
|
+
* <p>The version identifier of the workflow. This is a service-generated alphanumeric string that uniquely identifies this version of the workflow. Amazon Managed Workflows for Apache Airflow Serverless uses a version-first approach where each workflow can have multiple immutable versions, which allows you to maintain different configurations and roll back to previous versions as needed. The version identifier is used in ARNs and API operations to reference specific workflow versions.</p>
|
|
621
|
+
* @public
|
|
622
|
+
*/
|
|
623
|
+
WorkflowVersion?: string | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* <p>A Boolean flag that indicates whether this workflow version is the latest version of the workflow.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
IsLatestVersion?: boolean | undefined;
|
|
629
|
+
/**
|
|
630
|
+
* <p>Warning messages generated during workflow creation.</p>
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
Warnings?: string[] | undefined;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* <p>The request exceeds the service quota for Amazon Managed Workflows for Apache Airflow Serverless resources. This can occur when you attempt to create more workflows than allowed, exceed concurrent workflow run limits, or surpass task execution limits. Amazon Managed Workflows for Apache Airflow Serverless implements admission control using DynamoDB-based counters to manage resource utilization across the multi-tenant environment. Contact Amazon Web Services Support to request quota increases if you need higher limits for your use case.</p>
|
|
637
|
+
* @public
|
|
638
|
+
*/
|
|
639
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
640
|
+
readonly name: "ServiceQuotaExceededException";
|
|
641
|
+
readonly $fault: "client";
|
|
642
|
+
Message: string | undefined;
|
|
643
|
+
/**
|
|
644
|
+
* <p>The unique identifier of the resource.</p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
ResourceId: string | undefined;
|
|
648
|
+
/**
|
|
649
|
+
* <p>The type of resource affected.</p>
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
ResourceType: string | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* <p>The code for the service.</p>
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
ServiceCode: string | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* <p>The code of the quota.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
QuotaCode: string | undefined;
|
|
663
|
+
/**
|
|
664
|
+
* @internal
|
|
665
|
+
*/
|
|
666
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
667
|
+
}
|
|
668
|
+
/**
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
export interface DeleteWorkflowRequest {
|
|
672
|
+
/**
|
|
673
|
+
* <p>The Amazon Resource Name (ARN) of the workflow you want to delete.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
WorkflowArn: string | undefined;
|
|
677
|
+
/**
|
|
678
|
+
* <p>Optional. The specific version of the workflow to delete. If not specified, all versions of the workflow are deleted.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
WorkflowVersion?: string | undefined;
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
export interface DeleteWorkflowResponse {
|
|
687
|
+
/**
|
|
688
|
+
* <p>The Amazon Resource Name (ARN) of the deleted workflow.</p>
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
WorkflowArn: string | undefined;
|
|
692
|
+
/**
|
|
693
|
+
* <p>The version of the workflow that was deleted.</p>
|
|
694
|
+
* @public
|
|
695
|
+
*/
|
|
696
|
+
WorkflowVersion?: string | undefined;
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* @public
|
|
700
|
+
*/
|
|
701
|
+
export interface GetWorkflowRequest {
|
|
702
|
+
/**
|
|
703
|
+
* <p>The Amazon Resource Name (ARN) of the workflow you want to retrieve.</p>
|
|
704
|
+
* @public
|
|
705
|
+
*/
|
|
706
|
+
WorkflowArn: string | undefined;
|
|
707
|
+
/**
|
|
708
|
+
* <p>Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.</p>
|
|
709
|
+
* @public
|
|
710
|
+
*/
|
|
711
|
+
WorkflowVersion?: string | undefined;
|
|
712
|
+
}
|
|
713
|
+
/**
|
|
714
|
+
* <p>The configuration to use to schedule automated workflow execution using cron expressions. Amazon Managed Workflows for Apache Airflow Serverless integrates with EventBridge Scheduler to provide cost-effective, timezone-aware scheduling capabilities. The service supports both time-based and event-based scheduling (event-based scheduling available post-GA). When a workflow definition includes scheduling information, Amazon Managed Workflows for Apache Airflow Serverless automatically configures the appropriate triggers and ensures only one version of a workflow has an active schedule at any time.</p>
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
export interface ScheduleConfiguration {
|
|
718
|
+
/**
|
|
719
|
+
* <p>A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.</p>
|
|
720
|
+
* @public
|
|
721
|
+
*/
|
|
722
|
+
CronExpression?: string | undefined;
|
|
723
|
+
}
|
|
724
|
+
/**
|
|
725
|
+
* @public
|
|
726
|
+
*/
|
|
727
|
+
export interface GetWorkflowResponse {
|
|
728
|
+
/**
|
|
729
|
+
* <p>The Amazon Resource Name (ARN) of the workflow.</p>
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
WorkflowArn: string | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* <p>The version identifier of the workflow.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
WorkflowVersion?: string | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* <p>The name of the workflow.</p>
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
Name?: string | undefined;
|
|
743
|
+
/**
|
|
744
|
+
* <p>The description of the workflow.</p>
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
Description?: string | undefined;
|
|
748
|
+
/**
|
|
749
|
+
* <p>The timestamp when the workflow was created, in ISO 8601 date-time format.</p>
|
|
750
|
+
* @public
|
|
751
|
+
*/
|
|
752
|
+
CreatedAt?: Date | undefined;
|
|
753
|
+
/**
|
|
754
|
+
* <p>The timestamp when the workflow was last modified, in ISO 8601 date-time format.</p>
|
|
755
|
+
* @public
|
|
756
|
+
*/
|
|
757
|
+
ModifiedAt?: Date | undefined;
|
|
758
|
+
/**
|
|
759
|
+
* <p>The encryption configuration for the workflow.</p>
|
|
760
|
+
* @public
|
|
761
|
+
*/
|
|
762
|
+
EncryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
763
|
+
/**
|
|
764
|
+
* <p>The logging configuration for the workflow.</p>
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
LoggingConfiguration?: LoggingConfiguration | undefined;
|
|
768
|
+
/**
|
|
769
|
+
* <p>The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.</p>
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
EngineVersion?: EngineVersion | undefined;
|
|
773
|
+
/**
|
|
774
|
+
* <p>The current status of the workflow.</p>
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
WorkflowStatus?: WorkflowStatus | undefined;
|
|
778
|
+
/**
|
|
779
|
+
* <p>The Amazon S3 location of the workflow definition file.</p>
|
|
780
|
+
* @public
|
|
781
|
+
*/
|
|
782
|
+
DefinitionS3Location?: DefinitionS3Location | undefined;
|
|
783
|
+
/**
|
|
784
|
+
* <p>The schedule configuration for the workflow, including cron expressions for automated execution. Amazon Managed Workflows for Apache Airflow Serverless uses EventBridge Scheduler for cost-effective, timezone-aware scheduling. When a workflow includes schedule information in its YAML definition, the service automatically configures the appropriate triggers for automated execution. Only one version of a workflow can have an active schedule at any given time.</p>
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
ScheduleConfiguration?: ScheduleConfiguration | undefined;
|
|
788
|
+
/**
|
|
789
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role used for workflow execution.</p>
|
|
790
|
+
* @public
|
|
791
|
+
*/
|
|
792
|
+
RoleArn?: string | undefined;
|
|
793
|
+
/**
|
|
794
|
+
* <p>The network configuration for the workflow execution environment.</p>
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
798
|
+
/**
|
|
799
|
+
* <p>The trigger mode for the workflow execution.</p>
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
TriggerMode?: string | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* <p>The workflow definition content.</p>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
WorkflowDefinition?: string | undefined;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
812
|
+
export interface ListWorkflowsRequest {
|
|
813
|
+
/**
|
|
814
|
+
* <p>The maximum number of workflows you want to return in a single response.</p>
|
|
815
|
+
* @public
|
|
816
|
+
*/
|
|
817
|
+
MaxResults?: number | undefined;
|
|
818
|
+
/**
|
|
819
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to <code>ListWorkflows</code>.</p>
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
822
|
+
NextToken?: string | undefined;
|
|
823
|
+
}
|
|
824
|
+
/**
|
|
825
|
+
* <p>Summary information about a workflow, including basic identification and metadata.</p>
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
export interface WorkflowSummary {
|
|
829
|
+
/**
|
|
830
|
+
* <p>The Amazon Resource Name (ARN) of the workflow.</p>
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
WorkflowArn: string | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* <p>The version identifier of the workflow.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
WorkflowVersion?: string | undefined;
|
|
839
|
+
/**
|
|
840
|
+
* <p>The name of the workflow.</p>
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
Name?: string | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* <p>The description of the workflow.</p>
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
Description?: string | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* <p>The timestamp when the workflow was created, in ISO 8601 date-time format.</p>
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
CreatedAt?: Date | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* <p>The timestamp when the workflow was last modified, in ISO 8601 date-time format.</p>
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
ModifiedAt?: Date | undefined;
|
|
859
|
+
/**
|
|
860
|
+
* <p>The current status of the workflow.</p>
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
863
|
+
WorkflowStatus?: WorkflowStatus | undefined;
|
|
864
|
+
/**
|
|
865
|
+
* <p>The trigger mode for the workflow execution.</p>
|
|
866
|
+
* @public
|
|
867
|
+
*/
|
|
868
|
+
TriggerMode?: string | undefined;
|
|
869
|
+
}
|
|
870
|
+
/**
|
|
871
|
+
* @public
|
|
872
|
+
*/
|
|
873
|
+
export interface ListWorkflowsResponse {
|
|
874
|
+
/**
|
|
875
|
+
* <p>A list of workflow summaries for all workflows in your account.</p>
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
Workflows: WorkflowSummary[] | undefined;
|
|
879
|
+
/**
|
|
880
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.</p>
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
NextToken?: string | undefined;
|
|
884
|
+
}
|
|
885
|
+
/**
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
export interface UpdateWorkflowRequest {
|
|
889
|
+
/**
|
|
890
|
+
* <p>The Amazon Resource Name (ARN) of the workflow you want to update.</p>
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
WorkflowArn: string | undefined;
|
|
894
|
+
/**
|
|
895
|
+
* <p>The Amazon S3 location where the updated workflow definition file is stored.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
DefinitionS3Location: DefinitionS3Location | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when it executes the updated workflow.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
RoleArn: string | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>An updated description for the workflow.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
Description?: string | undefined;
|
|
909
|
+
/**
|
|
910
|
+
* <p>Updated logging configuration for the workflow.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
LoggingConfiguration?: LoggingConfiguration | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for the updated workflow.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
EngineVersion?: EngineVersion | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* <p>Updated network configuration for the workflow execution environment.</p>
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
924
|
+
/**
|
|
925
|
+
* <p>The trigger mode for the workflow execution.</p>
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
TriggerMode?: string | undefined;
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
export interface UpdateWorkflowResponse {
|
|
934
|
+
/**
|
|
935
|
+
* <p>The Amazon Resource Name (ARN) of the updated workflow.</p>
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
WorkflowArn: string | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* <p>The timestamp when the workflow was last modified, in ISO 8601 date-time format.</p>
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
ModifiedAt?: Date | undefined;
|
|
944
|
+
/**
|
|
945
|
+
* <p>The version identifier of the updated workflow.</p>
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
WorkflowVersion?: string | undefined;
|
|
949
|
+
/**
|
|
950
|
+
* <p>Warning messages generated during workflow update.</p>
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
Warnings?: string[] | undefined;
|
|
954
|
+
}
|
|
955
|
+
/**
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
export interface GetWorkflowRunRequest {
|
|
959
|
+
/**
|
|
960
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains the run.</p>
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
WorkflowArn: string | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* <p>The unique identifier of the workflow run to retrieve.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
RunId: string | undefined;
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* @public
|
|
972
|
+
* @enum
|
|
973
|
+
*/
|
|
974
|
+
export declare const WorkflowRunStatus: {
|
|
975
|
+
readonly FAILED: "FAILED";
|
|
976
|
+
readonly QUEUED: "QUEUED";
|
|
977
|
+
readonly RUNNING: "RUNNING";
|
|
978
|
+
readonly STARTING: "STARTING";
|
|
979
|
+
readonly STOPPED: "STOPPED";
|
|
980
|
+
readonly STOPPING: "STOPPING";
|
|
981
|
+
readonly SUCCESS: "SUCCESS";
|
|
982
|
+
readonly TIMEOUT: "TIMEOUT";
|
|
983
|
+
};
|
|
984
|
+
/**
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
export type WorkflowRunStatus = (typeof WorkflowRunStatus)[keyof typeof WorkflowRunStatus];
|
|
988
|
+
/**
|
|
989
|
+
* @public
|
|
990
|
+
* @enum
|
|
991
|
+
*/
|
|
992
|
+
export declare const RunType: {
|
|
993
|
+
readonly ON_DEMAND: "ON_DEMAND";
|
|
994
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
995
|
+
};
|
|
996
|
+
/**
|
|
997
|
+
* @public
|
|
998
|
+
*/
|
|
999
|
+
export type RunType = (typeof RunType)[keyof typeof RunType];
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>Detailed information about a workflow run execution, including timing, status, error information, and associated task instances. This structure provides comprehensive visibility into the workflow execution lifecycle within the Amazon Managed Workflows for Apache Airflow Serverless serverless environment. The service tracks execution across distributed ECS worker tasks and provides detailed timing information, error diagnostics, and task instance relationships to support effective monitoring and troubleshooting of complex workflow executions.</p>
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
export interface WorkflowRunDetail {
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains this run.</p>
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
WorkflowArn?: string | undefined;
|
|
1010
|
+
/**
|
|
1011
|
+
* <p>The version of the workflow used for this run.</p>
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
WorkflowVersion?: string | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* <p>The unique identifier of this workflow run.</p>
|
|
1017
|
+
* @public
|
|
1018
|
+
*/
|
|
1019
|
+
RunId?: string | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>The type of workflow run.</p>
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
RunType?: RunType | undefined;
|
|
1025
|
+
/**
|
|
1026
|
+
* <p>The timestamp when the workflow run started execution, in ISO 8601 date-time format.</p>
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
StartedOn?: Date | undefined;
|
|
1030
|
+
/**
|
|
1031
|
+
* <p>The timestamp when the workflow run was created, in ISO 8601 date-time format.</p>
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
CreatedAt?: Date | undefined;
|
|
1035
|
+
/**
|
|
1036
|
+
* <p>The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.</p>
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
CompletedOn?: Date | undefined;
|
|
1040
|
+
/**
|
|
1041
|
+
* <p>The timestamp when the workflow run was last modified, in ISO 8601 date-time format.</p>
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
1044
|
+
ModifiedAt?: Date | undefined;
|
|
1045
|
+
/**
|
|
1046
|
+
* <p>The total duration of the workflow run execution in seconds. This value is null if the run is not complete.</p>
|
|
1047
|
+
* @public
|
|
1048
|
+
*/
|
|
1049
|
+
Duration?: number | undefined;
|
|
1050
|
+
/**
|
|
1051
|
+
* <p>The error message if the workflow run failed. This value is null if the run completed successfully.</p>
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
1054
|
+
ErrorMessage?: string | undefined;
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>A list of task instance IDs that are part of this workflow run.</p>
|
|
1057
|
+
* @public
|
|
1058
|
+
*/
|
|
1059
|
+
TaskInstances?: string[] | undefined;
|
|
1060
|
+
/**
|
|
1061
|
+
* <p>The current execution state of the workflow run.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
RunState?: WorkflowRunStatus | undefined;
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
export interface GetWorkflowRunResponse {
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains this run.</p>
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
WorkflowArn?: string | undefined;
|
|
1075
|
+
/**
|
|
1076
|
+
* <p>The version of the workflow that is used for this run.</p>
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
WorkflowVersion?: string | undefined;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The unique identifier of this workflow run.</p>
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
RunId?: string | undefined;
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>The type of workflow run. Values are <code>ON_DEMAND</code> (manually triggered) or <code>SCHEDULED</code> (automatically triggered by schedule).</p>
|
|
1087
|
+
* @public
|
|
1088
|
+
*/
|
|
1089
|
+
RunType?: RunType | undefined;
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>Parameters that were overridden for this specific workflow run.</p>
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
OverrideParameters?: Record<string, __DocumentType> | undefined;
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>Detailed information about the workflow run execution, including timing, status, and task instances.</p>
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
RunDetail?: WorkflowRunDetail | undefined;
|
|
1100
|
+
}
|
|
1101
|
+
/**
|
|
1102
|
+
* @public
|
|
1103
|
+
*/
|
|
1104
|
+
export interface ListWorkflowRunsRequest {
|
|
1105
|
+
/**
|
|
1106
|
+
* <p>The maximum number of workflow runs to return in a single response.</p>
|
|
1107
|
+
* @public
|
|
1108
|
+
*/
|
|
1109
|
+
MaxResults?: number | undefined;
|
|
1110
|
+
/**
|
|
1111
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to <code>ListWorkflowRuns</code>.</p>
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
NextToken?: string | undefined;
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.</p>
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
WorkflowArn: string | undefined;
|
|
1120
|
+
/**
|
|
1121
|
+
* <p>Optional. The specific version of the workflow for which you want a list of runs. If not specified, runs for all versions are returned.</p>
|
|
1122
|
+
* @public
|
|
1123
|
+
*/
|
|
1124
|
+
WorkflowVersion?: string | undefined;
|
|
1125
|
+
}
|
|
1126
|
+
/**
|
|
1127
|
+
* <p>Summary information about a workflow run's execution details, including status and timing information.</p>
|
|
1128
|
+
* @public
|
|
1129
|
+
*/
|
|
1130
|
+
export interface RunDetailSummary {
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The current status of the workflow run.</p>
|
|
1133
|
+
* @public
|
|
1134
|
+
*/
|
|
1135
|
+
Status?: WorkflowRunStatus | undefined;
|
|
1136
|
+
/**
|
|
1137
|
+
* <p>The timestamp when the workflow run was created, in ISO 8601 date-time format.</p>
|
|
1138
|
+
* @public
|
|
1139
|
+
*/
|
|
1140
|
+
CreatedOn?: Date | undefined;
|
|
1141
|
+
/**
|
|
1142
|
+
* <p>The timestamp when the workflow run started execution, in ISO 8601 date-time format.</p>
|
|
1143
|
+
* @public
|
|
1144
|
+
*/
|
|
1145
|
+
StartedAt?: Date | undefined;
|
|
1146
|
+
/**
|
|
1147
|
+
* <p>The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.</p>
|
|
1148
|
+
* @public
|
|
1149
|
+
*/
|
|
1150
|
+
EndedAt?: Date | undefined;
|
|
1151
|
+
}
|
|
1152
|
+
/**
|
|
1153
|
+
* <p>Summary information about a workflow run, including basic identification and status information.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
export interface WorkflowRunSummary {
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>The unique identifier of the workflow run.</p>
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
RunId?: string | undefined;
|
|
1162
|
+
/**
|
|
1163
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains this run.</p>
|
|
1164
|
+
* @public
|
|
1165
|
+
*/
|
|
1166
|
+
WorkflowArn?: string | undefined;
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The version of the workflow used for this run.</p>
|
|
1169
|
+
* @public
|
|
1170
|
+
*/
|
|
1171
|
+
WorkflowVersion?: string | undefined;
|
|
1172
|
+
/**
|
|
1173
|
+
* <p>The type of workflow run.</p>
|
|
1174
|
+
* @public
|
|
1175
|
+
*/
|
|
1176
|
+
RunType?: RunType | undefined;
|
|
1177
|
+
/**
|
|
1178
|
+
* <p>Summary details about the workflow run execution.</p>
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
RunDetailSummary?: RunDetailSummary | undefined;
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
export interface ListWorkflowRunsResponse {
|
|
1187
|
+
/**
|
|
1188
|
+
* <p>A list of workflow run summaries for the specified workflow.</p>
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
WorkflowRuns?: WorkflowRunSummary[] | undefined;
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.</p>
|
|
1194
|
+
* @public
|
|
1195
|
+
*/
|
|
1196
|
+
NextToken?: string | undefined;
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
export interface StartWorkflowRunRequest {
|
|
1202
|
+
/**
|
|
1203
|
+
* <p>The Amazon Resource Name (ARN) of the workflow you want to run.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
WorkflowArn: string | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
ClientToken?: string | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* <p>Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
OverrideParameters?: Record<string, __DocumentType> | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>Optional. The specific version of the workflow to execute. If not specified, the latest version is used.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
WorkflowVersion?: string | undefined;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
export interface StartWorkflowRunResponse {
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>The unique identifier of the newly started workflow run.</p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
RunId?: string | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The initial status of the workflow run. This is typically <code>STARTING</code> when you first create the run.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
Status?: WorkflowRunStatus | undefined;
|
|
1237
|
+
/**
|
|
1238
|
+
* <p>The timestamp when the workflow run was started, in ISO 8601 date-time format.</p>
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
StartedAt?: Date | undefined;
|
|
1242
|
+
}
|
|
1243
|
+
/**
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
export interface StopWorkflowRunRequest {
|
|
1247
|
+
/**
|
|
1248
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains the run you want to stop.</p>
|
|
1249
|
+
* @public
|
|
1250
|
+
*/
|
|
1251
|
+
WorkflowArn: string | undefined;
|
|
1252
|
+
/**
|
|
1253
|
+
* <p>The unique identifier of the workflow run to stop.</p>
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
RunId: string | undefined;
|
|
1257
|
+
}
|
|
1258
|
+
/**
|
|
1259
|
+
* @public
|
|
1260
|
+
*/
|
|
1261
|
+
export interface StopWorkflowRunResponse {
|
|
1262
|
+
/**
|
|
1263
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains the stopped run.</p>
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
WorkflowArn?: string | undefined;
|
|
1267
|
+
/**
|
|
1268
|
+
* <p>The version of the workflow that was stopped.</p>
|
|
1269
|
+
* @public
|
|
1270
|
+
*/
|
|
1271
|
+
WorkflowVersion?: string | undefined;
|
|
1272
|
+
/**
|
|
1273
|
+
* <p>The unique identifier of the stopped workflow run.</p>
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
RunId?: string | undefined;
|
|
1277
|
+
/**
|
|
1278
|
+
* <p>The status of the workflow run after the stop operation. This is typically <code>STOPPING</code> or <code>STOPPED</code>.</p>
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
Status?: WorkflowRunStatus | undefined;
|
|
1282
|
+
}
|
|
1283
|
+
/**
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
export interface ListWorkflowVersionsRequest {
|
|
1287
|
+
/**
|
|
1288
|
+
* <p>The maximum number of workflow versions to return in a single response.</p>
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
MaxResults?: number | undefined;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to <code>ListWorkflowVersions</code>.</p>
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
NextToken?: string | undefined;
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>The Amazon Resource Name (ARN) of the workflow for which you want to list versions.</p>
|
|
1299
|
+
* @public
|
|
1300
|
+
*/
|
|
1301
|
+
WorkflowArn: string | undefined;
|
|
1302
|
+
}
|
|
1303
|
+
/**
|
|
1304
|
+
* <p>Summary information about a workflow version, including identification and configuration details.</p>
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
export interface WorkflowVersionSummary {
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The version identifier of the workflow version.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
WorkflowVersion: string | undefined;
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>The Amazon Resource Name (ARN) of the workflow that contains this version.</p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
WorkflowArn: string | undefined;
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>Boolean flag that indicates whether this is the latest version of the workflow.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
IsLatestVersion?: boolean | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The timestamp when the workflow version was created, in ISO 8601 date-time format.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
CreatedAt?: Date | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The timestamp when the workflow version was last modified, in ISO 8601 date-time format.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
ModifiedAt?: Date | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The Amazon S3 location of the workflow definition file for this version.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
DefinitionS3Location?: DefinitionS3Location | undefined;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The schedule configuration for this workflow version.</p>
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
ScheduleConfiguration?: ScheduleConfiguration | undefined;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The trigger mode for the workflow execution.</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
TriggerMode?: string | undefined;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
export interface ListWorkflowVersionsResponse {
|
|
1353
|
+
/**
|
|
1354
|
+
* <p>A list of workflow version summaries for the specified workflow.</p>
|
|
1355
|
+
* @public
|
|
1356
|
+
*/
|
|
1357
|
+
WorkflowVersions?: WorkflowVersionSummary[] | undefined;
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.</p>
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
NextToken?: string | undefined;
|
|
1363
|
+
}
|