aws-sdk-mwaaserverless 1.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-mwaaserverless/client.rb +1427 -0
- data/lib/aws-sdk-mwaaserverless/client_api.rb +694 -0
- data/lib/aws-sdk-mwaaserverless/customizations.rb +0 -0
- data/lib/aws-sdk-mwaaserverless/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-mwaaserverless/endpoint_provider.rb +32 -0
- data/lib/aws-sdk-mwaaserverless/endpoints.rb +20 -0
- data/lib/aws-sdk-mwaaserverless/errors.rb +248 -0
- data/lib/aws-sdk-mwaaserverless/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-mwaaserverless/resource.rb +26 -0
- data/lib/aws-sdk-mwaaserverless/types.rb +1613 -0
- data/lib/aws-sdk-mwaaserverless/waiters.rb +15 -0
- data/lib/aws-sdk-mwaaserverless.rb +62 -0
- data/sig/client.rbs +344 -0
- data/sig/errors.rbs +54 -0
- data/sig/resource.rbs +86 -0
- data/sig/types.rbs +404 -0
- data/sig/waiters.rbs +13 -0
- metadata +97 -0
|
@@ -0,0 +1,1613 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
module Aws::MWAAServerless
|
|
11
|
+
module Types
|
|
12
|
+
|
|
13
|
+
# You do not have sufficient permission to perform this action.
|
|
14
|
+
#
|
|
15
|
+
# @!attribute [rw] message
|
|
16
|
+
# @return [String]
|
|
17
|
+
#
|
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/AccessDeniedException AWS API Documentation
|
|
19
|
+
#
|
|
20
|
+
class AccessDeniedException < Struct.new(
|
|
21
|
+
:message)
|
|
22
|
+
SENSITIVE = []
|
|
23
|
+
include Aws::Structure
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# You cannot create a resource that already exists, or the resource is
|
|
27
|
+
# in a state that prevents the requested operation.
|
|
28
|
+
#
|
|
29
|
+
# @!attribute [rw] message
|
|
30
|
+
# @return [String]
|
|
31
|
+
#
|
|
32
|
+
# @!attribute [rw] resource_id
|
|
33
|
+
# The unique identifier of the resource.
|
|
34
|
+
# @return [String]
|
|
35
|
+
#
|
|
36
|
+
# @!attribute [rw] resource_type
|
|
37
|
+
# The type of the resource.
|
|
38
|
+
# @return [String]
|
|
39
|
+
#
|
|
40
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ConflictException AWS API Documentation
|
|
41
|
+
#
|
|
42
|
+
class ConflictException < Struct.new(
|
|
43
|
+
:message,
|
|
44
|
+
:resource_id,
|
|
45
|
+
:resource_type)
|
|
46
|
+
SENSITIVE = []
|
|
47
|
+
include Aws::Structure
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# @!attribute [rw] name
|
|
51
|
+
# The name of the workflow. You must use unique workflow names within
|
|
52
|
+
# your Amazon Web Services account. The service generates a unique
|
|
53
|
+
# identifier that is appended to ensure temporal uniqueness across the
|
|
54
|
+
# account lifecycle.
|
|
55
|
+
# @return [String]
|
|
56
|
+
#
|
|
57
|
+
# @!attribute [rw] client_token
|
|
58
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
59
|
+
# idempotency of the request. This token prevents duplicate workflow
|
|
60
|
+
# creation requests.
|
|
61
|
+
#
|
|
62
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
63
|
+
# not need to pass this option.
|
|
64
|
+
# @return [String]
|
|
65
|
+
#
|
|
66
|
+
# @!attribute [rw] definition_s3_location
|
|
67
|
+
# The Amazon S3 location where the workflow definition file is stored.
|
|
68
|
+
# This must point to a valid YAML file that defines the workflow
|
|
69
|
+
# structure using supported Amazon Web Services operators and tasks.
|
|
70
|
+
# Amazon Managed Workflows for Apache Airflow Serverless takes a
|
|
71
|
+
# snapshot of the definition at creation time, so subsequent changes
|
|
72
|
+
# to the Amazon S3 object will not affect the workflow unless you
|
|
73
|
+
# create a new version. In your YAML definition, include task
|
|
74
|
+
# dependencies, scheduling information, and operator configurations
|
|
75
|
+
# that are compatible with the Amazon Managed Workflows for Apache
|
|
76
|
+
# Airflow Serverless execution environment.
|
|
77
|
+
# @return [Types::DefinitionS3Location]
|
|
78
|
+
#
|
|
79
|
+
# @!attribute [rw] role_arn
|
|
80
|
+
# The Amazon Resource Name (ARN) of the IAM role that Amazon Managed
|
|
81
|
+
# Workflows for Apache Airflow Serverless assumes when executing the
|
|
82
|
+
# workflow. This role must have the necessary permissions to access
|
|
83
|
+
# the required Amazon Web Services services and resources that your
|
|
84
|
+
# workflow tasks will interact with. The role is used for task
|
|
85
|
+
# execution in the isolated, multi-tenant environment and should
|
|
86
|
+
# follow the principle of least privilege. Amazon Managed Workflows
|
|
87
|
+
# for Apache Airflow Serverless validates role access during workflow
|
|
88
|
+
# creation but runtime permission checks are performed by the target
|
|
89
|
+
# services.
|
|
90
|
+
# @return [String]
|
|
91
|
+
#
|
|
92
|
+
# @!attribute [rw] description
|
|
93
|
+
# An optional description of the workflow that you can use to provide
|
|
94
|
+
# additional context about the workflow's purpose and functionality.
|
|
95
|
+
# @return [String]
|
|
96
|
+
#
|
|
97
|
+
# @!attribute [rw] encryption_configuration
|
|
98
|
+
# The configuration for encrypting workflow data at rest and in
|
|
99
|
+
# transit. Specifies the encryption type and optional KMS key for
|
|
100
|
+
# customer-managed encryption.
|
|
101
|
+
# @return [Types::EncryptionConfiguration]
|
|
102
|
+
#
|
|
103
|
+
# @!attribute [rw] logging_configuration
|
|
104
|
+
# The configuration for workflow logging. Specifies the CloudWatch log
|
|
105
|
+
# group where workflow execution logs are stored. Amazon Managed
|
|
106
|
+
# Workflows for Apache Airflow Serverless automatically exports worker
|
|
107
|
+
# logs and task-level information to the specified log group in your
|
|
108
|
+
# account using remote logging functionality. This provides
|
|
109
|
+
# comprehensive observability for debugging and monitoring workflow
|
|
110
|
+
# execution across the distributed, serverless environment.
|
|
111
|
+
# @return [Types::LoggingConfiguration]
|
|
112
|
+
#
|
|
113
|
+
# @!attribute [rw] engine_version
|
|
114
|
+
# The version of the Amazon Managed Workflows for Apache Airflow
|
|
115
|
+
# Serverless engine that you want to use for this workflow. This
|
|
116
|
+
# determines the feature set, supported operators, and execution
|
|
117
|
+
# environment capabilities available to your workflow. Amazon Managed
|
|
118
|
+
# Workflows for Apache Airflow Serverless maintains backward
|
|
119
|
+
# compatibility across versions while introducing new features and
|
|
120
|
+
# improvements. Currently supports version 1 with plans for additional
|
|
121
|
+
# versions as the service evolves.
|
|
122
|
+
# @return [Integer]
|
|
123
|
+
#
|
|
124
|
+
# @!attribute [rw] network_configuration
|
|
125
|
+
# Network configuration for the workflow execution environment,
|
|
126
|
+
# including VPC security groups and subnets for secure network access.
|
|
127
|
+
# When specified, Amazon Managed Workflows for Apache Airflow
|
|
128
|
+
# Serverless deploys ECS worker tasks in your customer VPC to provide
|
|
129
|
+
# secure connectivity to your resources. If not specified, tasks run
|
|
130
|
+
# in the service's default worker VPC with network isolation from
|
|
131
|
+
# other customers. This configuration enables secure access to
|
|
132
|
+
# VPC-only resources like RDS databases or private endpoints.
|
|
133
|
+
# @return [Types::NetworkConfiguration]
|
|
134
|
+
#
|
|
135
|
+
# @!attribute [rw] tags
|
|
136
|
+
# A map of tags to assign to the workflow resource. Tags are key-value
|
|
137
|
+
# pairs that are used for resource organization and cost allocation.
|
|
138
|
+
# @return [Hash<String,String>]
|
|
139
|
+
#
|
|
140
|
+
# @!attribute [rw] trigger_mode
|
|
141
|
+
# The trigger mode for the workflow execution.
|
|
142
|
+
# @return [String]
|
|
143
|
+
#
|
|
144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/CreateWorkflowRequest AWS API Documentation
|
|
145
|
+
#
|
|
146
|
+
class CreateWorkflowRequest < Struct.new(
|
|
147
|
+
:name,
|
|
148
|
+
:client_token,
|
|
149
|
+
:definition_s3_location,
|
|
150
|
+
:role_arn,
|
|
151
|
+
:description,
|
|
152
|
+
:encryption_configuration,
|
|
153
|
+
:logging_configuration,
|
|
154
|
+
:engine_version,
|
|
155
|
+
:network_configuration,
|
|
156
|
+
:tags,
|
|
157
|
+
:trigger_mode)
|
|
158
|
+
SENSITIVE = []
|
|
159
|
+
include Aws::Structure
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# @!attribute [rw] workflow_arn
|
|
163
|
+
# The Amazon Resource Name (ARN) of the newly created workflow. This
|
|
164
|
+
# ARN uniquely identifies the workflow resource.
|
|
165
|
+
# @return [String]
|
|
166
|
+
#
|
|
167
|
+
# @!attribute [rw] created_at
|
|
168
|
+
# The timestamp when the workflow was created, in ISO 8601 date-time
|
|
169
|
+
# format.
|
|
170
|
+
# @return [Time]
|
|
171
|
+
#
|
|
172
|
+
# @!attribute [rw] revision_id
|
|
173
|
+
# A unique identifier for this revision of the workflow configuration.
|
|
174
|
+
# This ID changes when the workflow is updated and you can use it for
|
|
175
|
+
# optimistic concurrency control in update operations. The revision ID
|
|
176
|
+
# helps prevent conflicting updates and ensures that updates are
|
|
177
|
+
# applied to the expected version of the workflow configuration.
|
|
178
|
+
# @return [String]
|
|
179
|
+
#
|
|
180
|
+
# @!attribute [rw] workflow_status
|
|
181
|
+
# The current status of the workflow. Possible values are `READY`
|
|
182
|
+
# (workflow is ready to run) and `DELETING` (workflow is being
|
|
183
|
+
# deleted).
|
|
184
|
+
# @return [String]
|
|
185
|
+
#
|
|
186
|
+
# @!attribute [rw] workflow_version
|
|
187
|
+
# The version identifier of the workflow. This is a service-generated
|
|
188
|
+
# alphanumeric string that uniquely identifies this version of the
|
|
189
|
+
# workflow. Amazon Managed Workflows for Apache Airflow Serverless
|
|
190
|
+
# uses a version-first approach where each workflow can have multiple
|
|
191
|
+
# immutable versions, which allows you to maintain different
|
|
192
|
+
# configurations and roll back to previous versions as needed. The
|
|
193
|
+
# version identifier is used in ARNs and API operations to reference
|
|
194
|
+
# specific workflow versions.
|
|
195
|
+
# @return [String]
|
|
196
|
+
#
|
|
197
|
+
# @!attribute [rw] is_latest_version
|
|
198
|
+
# A Boolean flag that indicates whether this workflow version is the
|
|
199
|
+
# latest version of the workflow.
|
|
200
|
+
# @return [Boolean]
|
|
201
|
+
#
|
|
202
|
+
# @!attribute [rw] warnings
|
|
203
|
+
# Warning messages generated during workflow creation.
|
|
204
|
+
# @return [Array<String>]
|
|
205
|
+
#
|
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/CreateWorkflowResponse AWS API Documentation
|
|
207
|
+
#
|
|
208
|
+
class CreateWorkflowResponse < Struct.new(
|
|
209
|
+
:workflow_arn,
|
|
210
|
+
:created_at,
|
|
211
|
+
:revision_id,
|
|
212
|
+
:workflow_status,
|
|
213
|
+
:workflow_version,
|
|
214
|
+
:is_latest_version,
|
|
215
|
+
:warnings)
|
|
216
|
+
SENSITIVE = []
|
|
217
|
+
include Aws::Structure
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Specifies the Amazon S3 location of a workflow definition file. This
|
|
221
|
+
# structure contains the bucket name, object key, and optional version
|
|
222
|
+
# ID for the workflow definition. Amazon Managed Workflows for Apache
|
|
223
|
+
# Airflow Serverless takes a snapshot of the definition file at the time
|
|
224
|
+
# of workflow creation or update, ensuring that the workflow behavior
|
|
225
|
+
# remains consistent even if the source file is modified. The definition
|
|
226
|
+
# must be a valid YAML file that uses supported Amazon Web Services
|
|
227
|
+
# operators and Amazon Managed Workflows for Apache Airflow Serverless
|
|
228
|
+
# syntax.
|
|
229
|
+
#
|
|
230
|
+
# @!attribute [rw] bucket
|
|
231
|
+
# The name of the Amazon S3 bucket that contains the workflow
|
|
232
|
+
# definition file.
|
|
233
|
+
# @return [String]
|
|
234
|
+
#
|
|
235
|
+
# @!attribute [rw] object_key
|
|
236
|
+
# The key (name) of the workflow definition file within the S3 bucket.
|
|
237
|
+
# @return [String]
|
|
238
|
+
#
|
|
239
|
+
# @!attribute [rw] version_id
|
|
240
|
+
# Optional. The version ID of the workflow definition file in Amazon
|
|
241
|
+
# S3. If not specified, the latest version is used.
|
|
242
|
+
# @return [String]
|
|
243
|
+
#
|
|
244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/DefinitionS3Location AWS API Documentation
|
|
245
|
+
#
|
|
246
|
+
class DefinitionS3Location < Struct.new(
|
|
247
|
+
:bucket,
|
|
248
|
+
:object_key,
|
|
249
|
+
:version_id)
|
|
250
|
+
SENSITIVE = []
|
|
251
|
+
include Aws::Structure
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# @!attribute [rw] workflow_arn
|
|
255
|
+
# The Amazon Resource Name (ARN) of the workflow you want to delete.
|
|
256
|
+
# @return [String]
|
|
257
|
+
#
|
|
258
|
+
# @!attribute [rw] workflow_version
|
|
259
|
+
# Optional. The specific version of the workflow to delete. If not
|
|
260
|
+
# specified, all versions of the workflow are deleted.
|
|
261
|
+
# @return [String]
|
|
262
|
+
#
|
|
263
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/DeleteWorkflowRequest AWS API Documentation
|
|
264
|
+
#
|
|
265
|
+
class DeleteWorkflowRequest < Struct.new(
|
|
266
|
+
:workflow_arn,
|
|
267
|
+
:workflow_version)
|
|
268
|
+
SENSITIVE = []
|
|
269
|
+
include Aws::Structure
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
# @!attribute [rw] workflow_arn
|
|
273
|
+
# The Amazon Resource Name (ARN) of the deleted workflow.
|
|
274
|
+
# @return [String]
|
|
275
|
+
#
|
|
276
|
+
# @!attribute [rw] workflow_version
|
|
277
|
+
# The version of the workflow that was deleted.
|
|
278
|
+
# @return [String]
|
|
279
|
+
#
|
|
280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/DeleteWorkflowResponse AWS API Documentation
|
|
281
|
+
#
|
|
282
|
+
class DeleteWorkflowResponse < Struct.new(
|
|
283
|
+
:workflow_arn,
|
|
284
|
+
:workflow_version)
|
|
285
|
+
SENSITIVE = []
|
|
286
|
+
include Aws::Structure
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Configuration for encrypting workflow data at rest and in transit.
|
|
290
|
+
# Amazon Managed Workflows for Apache Airflow Serverless provides
|
|
291
|
+
# comprehensive encryption capabilities to protect sensitive workflow
|
|
292
|
+
# data, parameters, and execution logs. When using customer-managed
|
|
293
|
+
# keys, the service integrates with Amazon Web Services KMS to provide
|
|
294
|
+
# fine-grained access control and audit capabilities. Encryption is
|
|
295
|
+
# applied consistently across the distributed execution environment
|
|
296
|
+
# including task containers, metadata storage, and log streams.
|
|
297
|
+
#
|
|
298
|
+
# @!attribute [rw] type
|
|
299
|
+
# The type of encryption to use. Values are `AWS_MANAGED_KEY` (Amazon
|
|
300
|
+
# Web Services manages the encryption key) or `CUSTOMER_MANAGED_KEY`
|
|
301
|
+
# (you provide a KMS key).
|
|
302
|
+
# @return [String]
|
|
303
|
+
#
|
|
304
|
+
# @!attribute [rw] kms_key_id
|
|
305
|
+
# The ID or ARN of the Amazon Web Services KMS key to use for
|
|
306
|
+
# encryption. Required when `Type` is `CUSTOMER_MANAGED_KEY`.
|
|
307
|
+
# @return [String]
|
|
308
|
+
#
|
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/EncryptionConfiguration AWS API Documentation
|
|
310
|
+
#
|
|
311
|
+
class EncryptionConfiguration < Struct.new(
|
|
312
|
+
:type,
|
|
313
|
+
:kms_key_id)
|
|
314
|
+
SENSITIVE = []
|
|
315
|
+
include Aws::Structure
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
# @!attribute [rw] workflow_arn
|
|
319
|
+
# The Amazon Resource Name (ARN) of the workflow that contains the
|
|
320
|
+
# task instance.
|
|
321
|
+
# @return [String]
|
|
322
|
+
#
|
|
323
|
+
# @!attribute [rw] task_instance_id
|
|
324
|
+
# The unique identifier of the task instance to retrieve.
|
|
325
|
+
# @return [String]
|
|
326
|
+
#
|
|
327
|
+
# @!attribute [rw] run_id
|
|
328
|
+
# The unique identifier of the workflow run that contains the task
|
|
329
|
+
# instance.
|
|
330
|
+
# @return [String]
|
|
331
|
+
#
|
|
332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetTaskInstanceRequest AWS API Documentation
|
|
333
|
+
#
|
|
334
|
+
class GetTaskInstanceRequest < Struct.new(
|
|
335
|
+
:workflow_arn,
|
|
336
|
+
:task_instance_id,
|
|
337
|
+
:run_id)
|
|
338
|
+
SENSITIVE = []
|
|
339
|
+
include Aws::Structure
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
# @!attribute [rw] workflow_arn
|
|
343
|
+
# The Amazon Resource Name (ARN) of the workflow that contains this
|
|
344
|
+
# task instance.
|
|
345
|
+
# @return [String]
|
|
346
|
+
#
|
|
347
|
+
# @!attribute [rw] run_id
|
|
348
|
+
# The unique identifier of the workflow run that contains this task
|
|
349
|
+
# instance.
|
|
350
|
+
# @return [String]
|
|
351
|
+
#
|
|
352
|
+
# @!attribute [rw] task_instance_id
|
|
353
|
+
# The unique identifier of this task instance.
|
|
354
|
+
# @return [String]
|
|
355
|
+
#
|
|
356
|
+
# @!attribute [rw] workflow_version
|
|
357
|
+
# The version of the workflow that contains this task instance.
|
|
358
|
+
# @return [String]
|
|
359
|
+
#
|
|
360
|
+
# @!attribute [rw] status
|
|
361
|
+
# The current status of the task instance.
|
|
362
|
+
# @return [String]
|
|
363
|
+
#
|
|
364
|
+
# @!attribute [rw] duration_in_seconds
|
|
365
|
+
# The duration of the task instance execution in seconds. This value
|
|
366
|
+
# is null if the task is not complete.
|
|
367
|
+
# @return [Integer]
|
|
368
|
+
#
|
|
369
|
+
# @!attribute [rw] operator_name
|
|
370
|
+
# The name of the Apache Airflow operator used for this task instance.
|
|
371
|
+
# @return [String]
|
|
372
|
+
#
|
|
373
|
+
# @!attribute [rw] modified_at
|
|
374
|
+
# The timestamp when the task instance was last modified, in ISO 8601
|
|
375
|
+
# date-time format.
|
|
376
|
+
# @return [Time]
|
|
377
|
+
#
|
|
378
|
+
# @!attribute [rw] ended_at
|
|
379
|
+
# The timestamp when the task instance completed execution, in ISO
|
|
380
|
+
# 8601 date-time format. This value is null if the task is not
|
|
381
|
+
# complete.
|
|
382
|
+
# @return [Time]
|
|
383
|
+
#
|
|
384
|
+
# @!attribute [rw] started_at
|
|
385
|
+
# The timestamp when the task instance started execution, in ISO 8601
|
|
386
|
+
# date-time format. This value is null if the task has not started.
|
|
387
|
+
# @return [Time]
|
|
388
|
+
#
|
|
389
|
+
# @!attribute [rw] attempt_number
|
|
390
|
+
# The attempt number for this task instance.
|
|
391
|
+
# @return [Integer]
|
|
392
|
+
#
|
|
393
|
+
# @!attribute [rw] error_message
|
|
394
|
+
# The error message if the task instance failed. This value is null if
|
|
395
|
+
# the task completed successfully.
|
|
396
|
+
# @return [String]
|
|
397
|
+
#
|
|
398
|
+
# @!attribute [rw] task_id
|
|
399
|
+
# The unique identifier of the task definition within the workflow.
|
|
400
|
+
# @return [String]
|
|
401
|
+
#
|
|
402
|
+
# @!attribute [rw] log_stream
|
|
403
|
+
# The CloudWatch log stream name for this task instance execution.
|
|
404
|
+
# @return [String]
|
|
405
|
+
#
|
|
406
|
+
# @!attribute [rw] xcom
|
|
407
|
+
# Cross-communication data exchanged between tasks in the workflow
|
|
408
|
+
# execution.
|
|
409
|
+
# @return [Hash<String,String>]
|
|
410
|
+
#
|
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetTaskInstanceResponse AWS API Documentation
|
|
412
|
+
#
|
|
413
|
+
class GetTaskInstanceResponse < Struct.new(
|
|
414
|
+
:workflow_arn,
|
|
415
|
+
:run_id,
|
|
416
|
+
:task_instance_id,
|
|
417
|
+
:workflow_version,
|
|
418
|
+
:status,
|
|
419
|
+
:duration_in_seconds,
|
|
420
|
+
:operator_name,
|
|
421
|
+
:modified_at,
|
|
422
|
+
:ended_at,
|
|
423
|
+
:started_at,
|
|
424
|
+
:attempt_number,
|
|
425
|
+
:error_message,
|
|
426
|
+
:task_id,
|
|
427
|
+
:log_stream,
|
|
428
|
+
:xcom)
|
|
429
|
+
SENSITIVE = []
|
|
430
|
+
include Aws::Structure
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
# @!attribute [rw] workflow_arn
|
|
434
|
+
# The Amazon Resource Name (ARN) of the workflow you want to retrieve.
|
|
435
|
+
# @return [String]
|
|
436
|
+
#
|
|
437
|
+
# @!attribute [rw] workflow_version
|
|
438
|
+
# Optional. The specific version of the workflow to retrieve. If not
|
|
439
|
+
# specified, the latest version is returned.
|
|
440
|
+
# @return [String]
|
|
441
|
+
#
|
|
442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetWorkflowRequest AWS API Documentation
|
|
443
|
+
#
|
|
444
|
+
class GetWorkflowRequest < Struct.new(
|
|
445
|
+
:workflow_arn,
|
|
446
|
+
:workflow_version)
|
|
447
|
+
SENSITIVE = []
|
|
448
|
+
include Aws::Structure
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# @!attribute [rw] workflow_arn
|
|
452
|
+
# The Amazon Resource Name (ARN) of the workflow.
|
|
453
|
+
# @return [String]
|
|
454
|
+
#
|
|
455
|
+
# @!attribute [rw] workflow_version
|
|
456
|
+
# The version identifier of the workflow.
|
|
457
|
+
# @return [String]
|
|
458
|
+
#
|
|
459
|
+
# @!attribute [rw] name
|
|
460
|
+
# The name of the workflow.
|
|
461
|
+
# @return [String]
|
|
462
|
+
#
|
|
463
|
+
# @!attribute [rw] description
|
|
464
|
+
# The description of the workflow.
|
|
465
|
+
# @return [String]
|
|
466
|
+
#
|
|
467
|
+
# @!attribute [rw] created_at
|
|
468
|
+
# The timestamp when the workflow was created, in ISO 8601 date-time
|
|
469
|
+
# format.
|
|
470
|
+
# @return [Time]
|
|
471
|
+
#
|
|
472
|
+
# @!attribute [rw] modified_at
|
|
473
|
+
# The timestamp when the workflow was last modified, in ISO 8601
|
|
474
|
+
# date-time format.
|
|
475
|
+
# @return [Time]
|
|
476
|
+
#
|
|
477
|
+
# @!attribute [rw] encryption_configuration
|
|
478
|
+
# The encryption configuration for the workflow.
|
|
479
|
+
# @return [Types::EncryptionConfiguration]
|
|
480
|
+
#
|
|
481
|
+
# @!attribute [rw] logging_configuration
|
|
482
|
+
# The logging configuration for the workflow.
|
|
483
|
+
# @return [Types::LoggingConfiguration]
|
|
484
|
+
#
|
|
485
|
+
# @!attribute [rw] engine_version
|
|
486
|
+
# The version of the Amazon Managed Workflows for Apache Airflow
|
|
487
|
+
# Serverless engine that this workflow uses.
|
|
488
|
+
# @return [Integer]
|
|
489
|
+
#
|
|
490
|
+
# @!attribute [rw] workflow_status
|
|
491
|
+
# The current status of the workflow.
|
|
492
|
+
# @return [String]
|
|
493
|
+
#
|
|
494
|
+
# @!attribute [rw] definition_s3_location
|
|
495
|
+
# The Amazon S3 location of the workflow definition file.
|
|
496
|
+
# @return [Types::DefinitionS3Location]
|
|
497
|
+
#
|
|
498
|
+
# @!attribute [rw] schedule_configuration
|
|
499
|
+
# The schedule configuration for the workflow, including cron
|
|
500
|
+
# expressions for automated execution. Amazon Managed Workflows for
|
|
501
|
+
# Apache Airflow Serverless uses EventBridge Scheduler for
|
|
502
|
+
# cost-effective, timezone-aware scheduling. When a workflow includes
|
|
503
|
+
# schedule information in its YAML definition, the service
|
|
504
|
+
# automatically configures the appropriate triggers for automated
|
|
505
|
+
# execution. Only one version of a workflow can have an active
|
|
506
|
+
# schedule at any given time.
|
|
507
|
+
# @return [Types::ScheduleConfiguration]
|
|
508
|
+
#
|
|
509
|
+
# @!attribute [rw] role_arn
|
|
510
|
+
# The Amazon Resource Name (ARN) of the IAM role used for workflow
|
|
511
|
+
# execution.
|
|
512
|
+
# @return [String]
|
|
513
|
+
#
|
|
514
|
+
# @!attribute [rw] network_configuration
|
|
515
|
+
# The network configuration for the workflow execution environment.
|
|
516
|
+
# @return [Types::NetworkConfiguration]
|
|
517
|
+
#
|
|
518
|
+
# @!attribute [rw] trigger_mode
|
|
519
|
+
# The trigger mode for the workflow execution.
|
|
520
|
+
# @return [String]
|
|
521
|
+
#
|
|
522
|
+
# @!attribute [rw] workflow_definition
|
|
523
|
+
# The workflow definition content.
|
|
524
|
+
# @return [String]
|
|
525
|
+
#
|
|
526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetWorkflowResponse AWS API Documentation
|
|
527
|
+
#
|
|
528
|
+
class GetWorkflowResponse < Struct.new(
|
|
529
|
+
:workflow_arn,
|
|
530
|
+
:workflow_version,
|
|
531
|
+
:name,
|
|
532
|
+
:description,
|
|
533
|
+
:created_at,
|
|
534
|
+
:modified_at,
|
|
535
|
+
:encryption_configuration,
|
|
536
|
+
:logging_configuration,
|
|
537
|
+
:engine_version,
|
|
538
|
+
:workflow_status,
|
|
539
|
+
:definition_s3_location,
|
|
540
|
+
:schedule_configuration,
|
|
541
|
+
:role_arn,
|
|
542
|
+
:network_configuration,
|
|
543
|
+
:trigger_mode,
|
|
544
|
+
:workflow_definition)
|
|
545
|
+
SENSITIVE = []
|
|
546
|
+
include Aws::Structure
|
|
547
|
+
end
|
|
548
|
+
|
|
549
|
+
# @!attribute [rw] workflow_arn
|
|
550
|
+
# The Amazon Resource Name (ARN) of the workflow that contains the
|
|
551
|
+
# run.
|
|
552
|
+
# @return [String]
|
|
553
|
+
#
|
|
554
|
+
# @!attribute [rw] run_id
|
|
555
|
+
# The unique identifier of the workflow run to retrieve.
|
|
556
|
+
# @return [String]
|
|
557
|
+
#
|
|
558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetWorkflowRunRequest AWS API Documentation
|
|
559
|
+
#
|
|
560
|
+
class GetWorkflowRunRequest < Struct.new(
|
|
561
|
+
:workflow_arn,
|
|
562
|
+
:run_id)
|
|
563
|
+
SENSITIVE = []
|
|
564
|
+
include Aws::Structure
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
# @!attribute [rw] workflow_arn
|
|
568
|
+
# The Amazon Resource Name (ARN) of the workflow that contains this
|
|
569
|
+
# run.
|
|
570
|
+
# @return [String]
|
|
571
|
+
#
|
|
572
|
+
# @!attribute [rw] workflow_version
|
|
573
|
+
# The version of the workflow that is used for this run.
|
|
574
|
+
# @return [String]
|
|
575
|
+
#
|
|
576
|
+
# @!attribute [rw] run_id
|
|
577
|
+
# The unique identifier of this workflow run.
|
|
578
|
+
# @return [String]
|
|
579
|
+
#
|
|
580
|
+
# @!attribute [rw] run_type
|
|
581
|
+
# The type of workflow run. Values are `ON_DEMAND` (manually
|
|
582
|
+
# triggered) or `SCHEDULED` (automatically triggered by schedule).
|
|
583
|
+
# @return [String]
|
|
584
|
+
#
|
|
585
|
+
# @!attribute [rw] override_parameters
|
|
586
|
+
# Parameters that were overridden for this specific workflow run.
|
|
587
|
+
# @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
|
|
588
|
+
#
|
|
589
|
+
# @!attribute [rw] run_detail
|
|
590
|
+
# Detailed information about the workflow run execution, including
|
|
591
|
+
# timing, status, and task instances.
|
|
592
|
+
# @return [Types::WorkflowRunDetail]
|
|
593
|
+
#
|
|
594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetWorkflowRunResponse AWS API Documentation
|
|
595
|
+
#
|
|
596
|
+
class GetWorkflowRunResponse < Struct.new(
|
|
597
|
+
:workflow_arn,
|
|
598
|
+
:workflow_version,
|
|
599
|
+
:run_id,
|
|
600
|
+
:run_type,
|
|
601
|
+
:override_parameters,
|
|
602
|
+
:run_detail)
|
|
603
|
+
SENSITIVE = [:override_parameters]
|
|
604
|
+
include Aws::Structure
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
# An unexpected server-side error occurred during request processing.
|
|
608
|
+
#
|
|
609
|
+
# @!attribute [rw] message
|
|
610
|
+
# @return [String]
|
|
611
|
+
#
|
|
612
|
+
# @!attribute [rw] retry_after_seconds
|
|
613
|
+
# The number of seconds to wait before retrying the operation.
|
|
614
|
+
# @return [Integer]
|
|
615
|
+
#
|
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/InternalServerException AWS API Documentation
|
|
617
|
+
#
|
|
618
|
+
class InternalServerException < Struct.new(
|
|
619
|
+
:message,
|
|
620
|
+
:retry_after_seconds)
|
|
621
|
+
SENSITIVE = []
|
|
622
|
+
include Aws::Structure
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
# @!attribute [rw] resource_arn
|
|
626
|
+
# The Amazon Resource Name (ARN) of the resource for which to list
|
|
627
|
+
# tags.
|
|
628
|
+
# @return [String]
|
|
629
|
+
#
|
|
630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListTagsForResourceRequest AWS API Documentation
|
|
631
|
+
#
|
|
632
|
+
class ListTagsForResourceRequest < Struct.new(
|
|
633
|
+
:resource_arn)
|
|
634
|
+
SENSITIVE = []
|
|
635
|
+
include Aws::Structure
|
|
636
|
+
end
|
|
637
|
+
|
|
638
|
+
# @!attribute [rw] tags
|
|
639
|
+
# A map of tags that are associated with the resource, where each tag
|
|
640
|
+
# consists of a key-value pair.
|
|
641
|
+
# @return [Hash<String,String>]
|
|
642
|
+
#
|
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListTagsForResourceResponse AWS API Documentation
|
|
644
|
+
#
|
|
645
|
+
class ListTagsForResourceResponse < Struct.new(
|
|
646
|
+
:tags)
|
|
647
|
+
SENSITIVE = []
|
|
648
|
+
include Aws::Structure
|
|
649
|
+
end
|
|
650
|
+
|
|
651
|
+
# @!attribute [rw] workflow_arn
|
|
652
|
+
# The Amazon Resource Name (ARN) of the workflow that contains the
|
|
653
|
+
# run.
|
|
654
|
+
# @return [String]
|
|
655
|
+
#
|
|
656
|
+
# @!attribute [rw] run_id
|
|
657
|
+
# The unique identifier of the workflow run for which you want a list
|
|
658
|
+
# of task instances.
|
|
659
|
+
# @return [String]
|
|
660
|
+
#
|
|
661
|
+
# @!attribute [rw] max_results
|
|
662
|
+
# The maximum number of task instances to return in a single response.
|
|
663
|
+
# @return [Integer]
|
|
664
|
+
#
|
|
665
|
+
# @!attribute [rw] next_token
|
|
666
|
+
# The pagination token you need to use to retrieve the next set of
|
|
667
|
+
# results. This value is returned from a previous call to
|
|
668
|
+
# `ListTaskInstances`.
|
|
669
|
+
# @return [String]
|
|
670
|
+
#
|
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListTaskInstancesRequest AWS API Documentation
|
|
672
|
+
#
|
|
673
|
+
class ListTaskInstancesRequest < Struct.new(
|
|
674
|
+
:workflow_arn,
|
|
675
|
+
:run_id,
|
|
676
|
+
:max_results,
|
|
677
|
+
:next_token)
|
|
678
|
+
SENSITIVE = []
|
|
679
|
+
include Aws::Structure
|
|
680
|
+
end
|
|
681
|
+
|
|
682
|
+
# @!attribute [rw] task_instances
|
|
683
|
+
# A list of task instance summaries for the specified workflow run.
|
|
684
|
+
# @return [Array<Types::TaskInstanceSummary>]
|
|
685
|
+
#
|
|
686
|
+
# @!attribute [rw] next_token
|
|
687
|
+
# The pagination token you need to use to retrieve the next set of
|
|
688
|
+
# results. This value is null if there are no more results.
|
|
689
|
+
# @return [String]
|
|
690
|
+
#
|
|
691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListTaskInstancesResponse AWS API Documentation
|
|
692
|
+
#
|
|
693
|
+
class ListTaskInstancesResponse < Struct.new(
|
|
694
|
+
:task_instances,
|
|
695
|
+
:next_token)
|
|
696
|
+
SENSITIVE = []
|
|
697
|
+
include Aws::Structure
|
|
698
|
+
end
|
|
699
|
+
|
|
700
|
+
# @!attribute [rw] max_results
|
|
701
|
+
# The maximum number of workflow runs to return in a single response.
|
|
702
|
+
# @return [Integer]
|
|
703
|
+
#
|
|
704
|
+
# @!attribute [rw] next_token
|
|
705
|
+
# The pagination token you need to use to retrieve the next set of
|
|
706
|
+
# results. This value is returned from a previous call to
|
|
707
|
+
# `ListWorkflowRuns`.
|
|
708
|
+
# @return [String]
|
|
709
|
+
#
|
|
710
|
+
# @!attribute [rw] workflow_arn
|
|
711
|
+
# The Amazon Resource Name (ARN) of the workflow for which you want a
|
|
712
|
+
# list of runs.
|
|
713
|
+
# @return [String]
|
|
714
|
+
#
|
|
715
|
+
# @!attribute [rw] workflow_version
|
|
716
|
+
# Optional. The specific version of the workflow for which you want a
|
|
717
|
+
# list of runs. If not specified, runs for all versions are returned.
|
|
718
|
+
# @return [String]
|
|
719
|
+
#
|
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowRunsRequest AWS API Documentation
|
|
721
|
+
#
|
|
722
|
+
class ListWorkflowRunsRequest < Struct.new(
|
|
723
|
+
:max_results,
|
|
724
|
+
:next_token,
|
|
725
|
+
:workflow_arn,
|
|
726
|
+
:workflow_version)
|
|
727
|
+
SENSITIVE = []
|
|
728
|
+
include Aws::Structure
|
|
729
|
+
end
|
|
730
|
+
|
|
731
|
+
# @!attribute [rw] workflow_runs
|
|
732
|
+
# A list of workflow run summaries for the specified workflow.
|
|
733
|
+
# @return [Array<Types::WorkflowRunSummary>]
|
|
734
|
+
#
|
|
735
|
+
# @!attribute [rw] next_token
|
|
736
|
+
# The pagination token you need to use to retrieve the next set of
|
|
737
|
+
# results. This value is null if there are no more results.
|
|
738
|
+
# @return [String]
|
|
739
|
+
#
|
|
740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowRunsResponse AWS API Documentation
|
|
741
|
+
#
|
|
742
|
+
class ListWorkflowRunsResponse < Struct.new(
|
|
743
|
+
:workflow_runs,
|
|
744
|
+
:next_token)
|
|
745
|
+
SENSITIVE = []
|
|
746
|
+
include Aws::Structure
|
|
747
|
+
end
|
|
748
|
+
|
|
749
|
+
# @!attribute [rw] max_results
|
|
750
|
+
# The maximum number of workflow versions to return in a single
|
|
751
|
+
# response.
|
|
752
|
+
# @return [Integer]
|
|
753
|
+
#
|
|
754
|
+
# @!attribute [rw] next_token
|
|
755
|
+
# The pagination token you need to use to retrieve the next set of
|
|
756
|
+
# results. This value is returned from a previous call to
|
|
757
|
+
# `ListWorkflowVersions`.
|
|
758
|
+
# @return [String]
|
|
759
|
+
#
|
|
760
|
+
# @!attribute [rw] workflow_arn
|
|
761
|
+
# The Amazon Resource Name (ARN) of the workflow for which you want to
|
|
762
|
+
# list versions.
|
|
763
|
+
# @return [String]
|
|
764
|
+
#
|
|
765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowVersionsRequest AWS API Documentation
|
|
766
|
+
#
|
|
767
|
+
class ListWorkflowVersionsRequest < Struct.new(
|
|
768
|
+
:max_results,
|
|
769
|
+
:next_token,
|
|
770
|
+
:workflow_arn)
|
|
771
|
+
SENSITIVE = []
|
|
772
|
+
include Aws::Structure
|
|
773
|
+
end
|
|
774
|
+
|
|
775
|
+
# @!attribute [rw] workflow_versions
|
|
776
|
+
# A list of workflow version summaries for the specified workflow.
|
|
777
|
+
# @return [Array<Types::WorkflowVersionSummary>]
|
|
778
|
+
#
|
|
779
|
+
# @!attribute [rw] next_token
|
|
780
|
+
# The pagination token you need to use to retrieve the next set of
|
|
781
|
+
# results. This value is null if there are no more results.
|
|
782
|
+
# @return [String]
|
|
783
|
+
#
|
|
784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowVersionsResponse AWS API Documentation
|
|
785
|
+
#
|
|
786
|
+
class ListWorkflowVersionsResponse < Struct.new(
|
|
787
|
+
:workflow_versions,
|
|
788
|
+
:next_token)
|
|
789
|
+
SENSITIVE = []
|
|
790
|
+
include Aws::Structure
|
|
791
|
+
end
|
|
792
|
+
|
|
793
|
+
# @!attribute [rw] max_results
|
|
794
|
+
# The maximum number of workflows you want to return in a single
|
|
795
|
+
# response.
|
|
796
|
+
# @return [Integer]
|
|
797
|
+
#
|
|
798
|
+
# @!attribute [rw] next_token
|
|
799
|
+
# The pagination token you need to use to retrieve the next set of
|
|
800
|
+
# results. This value is returned from a previous call to
|
|
801
|
+
# `ListWorkflows`.
|
|
802
|
+
# @return [String]
|
|
803
|
+
#
|
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowsRequest AWS API Documentation
|
|
805
|
+
#
|
|
806
|
+
class ListWorkflowsRequest < Struct.new(
|
|
807
|
+
:max_results,
|
|
808
|
+
:next_token)
|
|
809
|
+
SENSITIVE = []
|
|
810
|
+
include Aws::Structure
|
|
811
|
+
end
|
|
812
|
+
|
|
813
|
+
# @!attribute [rw] workflows
|
|
814
|
+
# A list of workflow summaries for all workflows in your account.
|
|
815
|
+
# @return [Array<Types::WorkflowSummary>]
|
|
816
|
+
#
|
|
817
|
+
# @!attribute [rw] next_token
|
|
818
|
+
# The pagination token you need to use to retrieve the next set of
|
|
819
|
+
# results. This value is null if there are no more results.
|
|
820
|
+
# @return [String]
|
|
821
|
+
#
|
|
822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowsResponse AWS API Documentation
|
|
823
|
+
#
|
|
824
|
+
class ListWorkflowsResponse < Struct.new(
|
|
825
|
+
:workflows,
|
|
826
|
+
:next_token)
|
|
827
|
+
SENSITIVE = []
|
|
828
|
+
include Aws::Structure
|
|
829
|
+
end
|
|
830
|
+
|
|
831
|
+
# Configuration for workflow logging that specifies where you should
|
|
832
|
+
# store your workflow execution logs. Amazon Managed Workflows for
|
|
833
|
+
# Apache Airflow Serverless provides comprehensive logging capabilities
|
|
834
|
+
# that capture workflow execution details, task-level information, and
|
|
835
|
+
# system events. Logs are automatically exported to your specified
|
|
836
|
+
# CloudWatch log group using remote logging functionality, providing
|
|
837
|
+
# centralized observability across the distributed, multi-tenant
|
|
838
|
+
# execution environment. This enables effective debugging, monitoring,
|
|
839
|
+
# and compliance auditing of workflow executions.
|
|
840
|
+
#
|
|
841
|
+
# @!attribute [rw] log_group_name
|
|
842
|
+
# The name of the CloudWatch log group where workflow execution logs
|
|
843
|
+
# are stored.
|
|
844
|
+
# @return [String]
|
|
845
|
+
#
|
|
846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/LoggingConfiguration AWS API Documentation
|
|
847
|
+
#
|
|
848
|
+
class LoggingConfiguration < Struct.new(
|
|
849
|
+
:log_group_name)
|
|
850
|
+
SENSITIVE = []
|
|
851
|
+
include Aws::Structure
|
|
852
|
+
end
|
|
853
|
+
|
|
854
|
+
# Network configuration for workflow execution. Specifies VPC security
|
|
855
|
+
# groups and subnets for secure network access. When provided, Amazon
|
|
856
|
+
# Managed Workflows for Apache Airflow Serverless deploys ECS worker
|
|
857
|
+
# tasks in your specified VPC configuration, enabling secure access to
|
|
858
|
+
# VPC-only resources. The service uses a proxy API container
|
|
859
|
+
# architecture where one container handles external communication while
|
|
860
|
+
# the worker container connects to your VPC for task execution. This
|
|
861
|
+
# design provides both security isolation and connectivity flexibility.
|
|
862
|
+
#
|
|
863
|
+
# @!attribute [rw] security_group_ids
|
|
864
|
+
# A list of VPC security group IDs to associate with the workflow
|
|
865
|
+
# execution environment.
|
|
866
|
+
# @return [Array<String>]
|
|
867
|
+
#
|
|
868
|
+
# @!attribute [rw] subnet_ids
|
|
869
|
+
# A list of VPC subnet IDs where the workflow execution environment is
|
|
870
|
+
# deployed.
|
|
871
|
+
# @return [Array<String>]
|
|
872
|
+
#
|
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/NetworkConfiguration AWS API Documentation
|
|
874
|
+
#
|
|
875
|
+
class NetworkConfiguration < Struct.new(
|
|
876
|
+
:security_group_ids,
|
|
877
|
+
:subnet_ids)
|
|
878
|
+
SENSITIVE = []
|
|
879
|
+
include Aws::Structure
|
|
880
|
+
end
|
|
881
|
+
|
|
882
|
+
# The operation timed out.
|
|
883
|
+
#
|
|
884
|
+
# @!attribute [rw] message
|
|
885
|
+
# @return [String]
|
|
886
|
+
#
|
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/OperationTimeoutException AWS API Documentation
|
|
888
|
+
#
|
|
889
|
+
class OperationTimeoutException < Struct.new(
|
|
890
|
+
:message)
|
|
891
|
+
SENSITIVE = []
|
|
892
|
+
include Aws::Structure
|
|
893
|
+
end
|
|
894
|
+
|
|
895
|
+
# The specified resource was not found. You can only access or modify a
|
|
896
|
+
# resource that already exists.
|
|
897
|
+
#
|
|
898
|
+
# @!attribute [rw] message
|
|
899
|
+
# @return [String]
|
|
900
|
+
#
|
|
901
|
+
# @!attribute [rw] resource_id
|
|
902
|
+
# The unique identifier of the resource.
|
|
903
|
+
# @return [String]
|
|
904
|
+
#
|
|
905
|
+
# @!attribute [rw] resource_type
|
|
906
|
+
# The type of the resource.
|
|
907
|
+
# @return [String]
|
|
908
|
+
#
|
|
909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ResourceNotFoundException AWS API Documentation
|
|
910
|
+
#
|
|
911
|
+
class ResourceNotFoundException < Struct.new(
|
|
912
|
+
:message,
|
|
913
|
+
:resource_id,
|
|
914
|
+
:resource_type)
|
|
915
|
+
SENSITIVE = []
|
|
916
|
+
include Aws::Structure
|
|
917
|
+
end
|
|
918
|
+
|
|
919
|
+
# Summary information about a workflow run's execution details,
|
|
920
|
+
# including status and timing information.
|
|
921
|
+
#
|
|
922
|
+
# @!attribute [rw] status
|
|
923
|
+
# The current status of the workflow run.
|
|
924
|
+
# @return [String]
|
|
925
|
+
#
|
|
926
|
+
# @!attribute [rw] created_on
|
|
927
|
+
# The timestamp when the workflow run was created, in ISO 8601
|
|
928
|
+
# date-time format.
|
|
929
|
+
# @return [Time]
|
|
930
|
+
#
|
|
931
|
+
# @!attribute [rw] started_at
|
|
932
|
+
# The timestamp when the workflow run started execution, in ISO 8601
|
|
933
|
+
# date-time format.
|
|
934
|
+
# @return [Time]
|
|
935
|
+
#
|
|
936
|
+
# @!attribute [rw] ended_at
|
|
937
|
+
# The timestamp when the workflow run completed execution, in ISO 8601
|
|
938
|
+
# date-time format. This value is null if the run is not complete.
|
|
939
|
+
# @return [Time]
|
|
940
|
+
#
|
|
941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/RunDetailSummary AWS API Documentation
|
|
942
|
+
#
|
|
943
|
+
class RunDetailSummary < Struct.new(
|
|
944
|
+
:status,
|
|
945
|
+
:created_on,
|
|
946
|
+
:started_at,
|
|
947
|
+
:ended_at)
|
|
948
|
+
SENSITIVE = []
|
|
949
|
+
include Aws::Structure
|
|
950
|
+
end
|
|
951
|
+
|
|
952
|
+
# The configuration to use to schedule automated workflow execution
|
|
953
|
+
# using cron expressions. Amazon Managed Workflows for Apache Airflow
|
|
954
|
+
# Serverless integrates with EventBridge Scheduler to provide
|
|
955
|
+
# cost-effective, timezone-aware scheduling capabilities. The service
|
|
956
|
+
# supports both time-based and event-based scheduling (event-based
|
|
957
|
+
# scheduling available post-GA). When a workflow definition includes
|
|
958
|
+
# scheduling information, Amazon Managed Workflows for Apache Airflow
|
|
959
|
+
# Serverless automatically configures the appropriate triggers and
|
|
960
|
+
# ensures only one version of a workflow has an active schedule at any
|
|
961
|
+
# time.
|
|
962
|
+
#
|
|
963
|
+
# @!attribute [rw] cron_expression
|
|
964
|
+
# A cron expression that defines when the workflow is automatically
|
|
965
|
+
# executed. Uses standard cron syntax.
|
|
966
|
+
# @return [String]
|
|
967
|
+
#
|
|
968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ScheduleConfiguration AWS API Documentation
|
|
969
|
+
#
|
|
970
|
+
class ScheduleConfiguration < Struct.new(
|
|
971
|
+
:cron_expression)
|
|
972
|
+
SENSITIVE = []
|
|
973
|
+
include Aws::Structure
|
|
974
|
+
end
|
|
975
|
+
|
|
976
|
+
# The request exceeds the service quota for Amazon Managed Workflows for
|
|
977
|
+
# Apache Airflow Serverless resources. This can occur when you attempt
|
|
978
|
+
# to create more workflows than allowed, exceed concurrent workflow run
|
|
979
|
+
# limits, or surpass task execution limits. Amazon Managed Workflows for
|
|
980
|
+
# Apache Airflow Serverless implements admission control using
|
|
981
|
+
# DynamoDB-based counters to manage resource utilization across the
|
|
982
|
+
# multi-tenant environment. Contact Amazon Web Services Support to
|
|
983
|
+
# request quota increases if you need higher limits for your use case.
|
|
984
|
+
#
|
|
985
|
+
# @!attribute [rw] message
|
|
986
|
+
# @return [String]
|
|
987
|
+
#
|
|
988
|
+
# @!attribute [rw] resource_id
|
|
989
|
+
# The unique identifier of the resource.
|
|
990
|
+
# @return [String]
|
|
991
|
+
#
|
|
992
|
+
# @!attribute [rw] resource_type
|
|
993
|
+
# The type of resource affected.
|
|
994
|
+
# @return [String]
|
|
995
|
+
#
|
|
996
|
+
# @!attribute [rw] service_code
|
|
997
|
+
# The code for the service.
|
|
998
|
+
# @return [String]
|
|
999
|
+
#
|
|
1000
|
+
# @!attribute [rw] quota_code
|
|
1001
|
+
# The code of the quota.
|
|
1002
|
+
# @return [String]
|
|
1003
|
+
#
|
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ServiceQuotaExceededException AWS API Documentation
|
|
1005
|
+
#
|
|
1006
|
+
class ServiceQuotaExceededException < Struct.new(
|
|
1007
|
+
:message,
|
|
1008
|
+
:resource_id,
|
|
1009
|
+
:resource_type,
|
|
1010
|
+
:service_code,
|
|
1011
|
+
:quota_code)
|
|
1012
|
+
SENSITIVE = []
|
|
1013
|
+
include Aws::Structure
|
|
1014
|
+
end
|
|
1015
|
+
|
|
1016
|
+
# @!attribute [rw] workflow_arn
|
|
1017
|
+
# The Amazon Resource Name (ARN) of the workflow you want to run.
|
|
1018
|
+
# @return [String]
|
|
1019
|
+
#
|
|
1020
|
+
# @!attribute [rw] client_token
|
|
1021
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
1022
|
+
# idempotency of the request. This token prevents duplicate workflow
|
|
1023
|
+
# run requests.
|
|
1024
|
+
#
|
|
1025
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1026
|
+
# not need to pass this option.
|
|
1027
|
+
# @return [String]
|
|
1028
|
+
#
|
|
1029
|
+
# @!attribute [rw] override_parameters
|
|
1030
|
+
# Optional parameters to override default workflow parameters for this
|
|
1031
|
+
# specific run. These parameters are passed to the workflow during
|
|
1032
|
+
# execution and can be used to customize behavior without modifying
|
|
1033
|
+
# the workflow definition. Parameters are made available as
|
|
1034
|
+
# environment variables to tasks and you can reference them within the
|
|
1035
|
+
# YAML workflow definition using standard parameter substitution
|
|
1036
|
+
# syntax.
|
|
1037
|
+
# @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
|
|
1038
|
+
#
|
|
1039
|
+
# @!attribute [rw] workflow_version
|
|
1040
|
+
# Optional. The specific version of the workflow to execute. If not
|
|
1041
|
+
# specified, the latest version is used.
|
|
1042
|
+
# @return [String]
|
|
1043
|
+
#
|
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/StartWorkflowRunRequest AWS API Documentation
|
|
1045
|
+
#
|
|
1046
|
+
class StartWorkflowRunRequest < Struct.new(
|
|
1047
|
+
:workflow_arn,
|
|
1048
|
+
:client_token,
|
|
1049
|
+
:override_parameters,
|
|
1050
|
+
:workflow_version)
|
|
1051
|
+
SENSITIVE = [:override_parameters]
|
|
1052
|
+
include Aws::Structure
|
|
1053
|
+
end
|
|
1054
|
+
|
|
1055
|
+
# @!attribute [rw] run_id
|
|
1056
|
+
# The unique identifier of the newly started workflow run.
|
|
1057
|
+
# @return [String]
|
|
1058
|
+
#
|
|
1059
|
+
# @!attribute [rw] status
|
|
1060
|
+
# The initial status of the workflow run. This is typically `STARTING`
|
|
1061
|
+
# when you first create the run.
|
|
1062
|
+
# @return [String]
|
|
1063
|
+
#
|
|
1064
|
+
# @!attribute [rw] started_at
|
|
1065
|
+
# The timestamp when the workflow run was started, in ISO 8601
|
|
1066
|
+
# date-time format.
|
|
1067
|
+
# @return [Time]
|
|
1068
|
+
#
|
|
1069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/StartWorkflowRunResponse AWS API Documentation
|
|
1070
|
+
#
|
|
1071
|
+
class StartWorkflowRunResponse < Struct.new(
|
|
1072
|
+
:run_id,
|
|
1073
|
+
:status,
|
|
1074
|
+
:started_at)
|
|
1075
|
+
SENSITIVE = []
|
|
1076
|
+
include Aws::Structure
|
|
1077
|
+
end
|
|
1078
|
+
|
|
1079
|
+
# @!attribute [rw] workflow_arn
|
|
1080
|
+
# The Amazon Resource Name (ARN) of the workflow that contains the run
|
|
1081
|
+
# you want to stop.
|
|
1082
|
+
# @return [String]
|
|
1083
|
+
#
|
|
1084
|
+
# @!attribute [rw] run_id
|
|
1085
|
+
# The unique identifier of the workflow run to stop.
|
|
1086
|
+
# @return [String]
|
|
1087
|
+
#
|
|
1088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/StopWorkflowRunRequest AWS API Documentation
|
|
1089
|
+
#
|
|
1090
|
+
class StopWorkflowRunRequest < Struct.new(
|
|
1091
|
+
:workflow_arn,
|
|
1092
|
+
:run_id)
|
|
1093
|
+
SENSITIVE = []
|
|
1094
|
+
include Aws::Structure
|
|
1095
|
+
end
|
|
1096
|
+
|
|
1097
|
+
# @!attribute [rw] workflow_arn
|
|
1098
|
+
# The Amazon Resource Name (ARN) of the workflow that contains the
|
|
1099
|
+
# stopped run.
|
|
1100
|
+
# @return [String]
|
|
1101
|
+
#
|
|
1102
|
+
# @!attribute [rw] workflow_version
|
|
1103
|
+
# The version of the workflow that was stopped.
|
|
1104
|
+
# @return [String]
|
|
1105
|
+
#
|
|
1106
|
+
# @!attribute [rw] run_id
|
|
1107
|
+
# The unique identifier of the stopped workflow run.
|
|
1108
|
+
# @return [String]
|
|
1109
|
+
#
|
|
1110
|
+
# @!attribute [rw] status
|
|
1111
|
+
# The status of the workflow run after the stop operation. This is
|
|
1112
|
+
# typically `STOPPING` or `STOPPED`.
|
|
1113
|
+
# @return [String]
|
|
1114
|
+
#
|
|
1115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/StopWorkflowRunResponse AWS API Documentation
|
|
1116
|
+
#
|
|
1117
|
+
class StopWorkflowRunResponse < Struct.new(
|
|
1118
|
+
:workflow_arn,
|
|
1119
|
+
:workflow_version,
|
|
1120
|
+
:run_id,
|
|
1121
|
+
:status)
|
|
1122
|
+
SENSITIVE = []
|
|
1123
|
+
include Aws::Structure
|
|
1124
|
+
end
|
|
1125
|
+
|
|
1126
|
+
# @!attribute [rw] resource_arn
|
|
1127
|
+
# The Amazon Resource Name (ARN) of the resource to which to add tags.
|
|
1128
|
+
# @return [String]
|
|
1129
|
+
#
|
|
1130
|
+
# @!attribute [rw] tags
|
|
1131
|
+
# A map of tags to add to the resource. Each tag consists of a
|
|
1132
|
+
# key-value pair.
|
|
1133
|
+
# @return [Hash<String,String>]
|
|
1134
|
+
#
|
|
1135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/TagResourceRequest AWS API Documentation
|
|
1136
|
+
#
|
|
1137
|
+
class TagResourceRequest < Struct.new(
|
|
1138
|
+
:resource_arn,
|
|
1139
|
+
:tags)
|
|
1140
|
+
SENSITIVE = []
|
|
1141
|
+
include Aws::Structure
|
|
1142
|
+
end
|
|
1143
|
+
|
|
1144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/TagResourceResponse AWS API Documentation
|
|
1145
|
+
#
|
|
1146
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
|
1147
|
+
|
|
1148
|
+
# Summary information about a task instance within a workflow run,
|
|
1149
|
+
# including its status and execution details.
|
|
1150
|
+
#
|
|
1151
|
+
# @!attribute [rw] workflow_arn
|
|
1152
|
+
# The Amazon Resource Name (ARN) of the workflow that contains this
|
|
1153
|
+
# task instance.
|
|
1154
|
+
# @return [String]
|
|
1155
|
+
#
|
|
1156
|
+
# @!attribute [rw] workflow_version
|
|
1157
|
+
# The version of the workflow that contains this task instance.
|
|
1158
|
+
# @return [String]
|
|
1159
|
+
#
|
|
1160
|
+
# @!attribute [rw] run_id
|
|
1161
|
+
# The unique identifier of the workflow run that contains this task
|
|
1162
|
+
# instance.
|
|
1163
|
+
# @return [String]
|
|
1164
|
+
#
|
|
1165
|
+
# @!attribute [rw] task_instance_id
|
|
1166
|
+
# The unique identifier of this task instance.
|
|
1167
|
+
# @return [String]
|
|
1168
|
+
#
|
|
1169
|
+
# @!attribute [rw] status
|
|
1170
|
+
# The current status of the task instance.
|
|
1171
|
+
# @return [String]
|
|
1172
|
+
#
|
|
1173
|
+
# @!attribute [rw] duration_in_seconds
|
|
1174
|
+
# The duration of the task instance execution in seconds. This value
|
|
1175
|
+
# is null if the task is not complete.
|
|
1176
|
+
# @return [Integer]
|
|
1177
|
+
#
|
|
1178
|
+
# @!attribute [rw] operator_name
|
|
1179
|
+
# The name of the Apache Airflow operator used for this task instance.
|
|
1180
|
+
# @return [String]
|
|
1181
|
+
#
|
|
1182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/TaskInstanceSummary AWS API Documentation
|
|
1183
|
+
#
|
|
1184
|
+
class TaskInstanceSummary < Struct.new(
|
|
1185
|
+
:workflow_arn,
|
|
1186
|
+
:workflow_version,
|
|
1187
|
+
:run_id,
|
|
1188
|
+
:task_instance_id,
|
|
1189
|
+
:status,
|
|
1190
|
+
:duration_in_seconds,
|
|
1191
|
+
:operator_name)
|
|
1192
|
+
SENSITIVE = []
|
|
1193
|
+
include Aws::Structure
|
|
1194
|
+
end
|
|
1195
|
+
|
|
1196
|
+
# The request was denied because too many requests were made in a short
|
|
1197
|
+
# period, exceeding the service rate limits. Amazon Managed Workflows
|
|
1198
|
+
# for Apache Airflow Serverless implements throttling controls to ensure
|
|
1199
|
+
# fair resource allocation across all customers in the multi-tenant
|
|
1200
|
+
# environment. This helps maintain service stability and performance. If
|
|
1201
|
+
# you encounter throttling, implement exponential backoff and retry
|
|
1202
|
+
# logic in your applications, or consider distributing your API calls
|
|
1203
|
+
# over a longer time period.
|
|
1204
|
+
#
|
|
1205
|
+
# @!attribute [rw] message
|
|
1206
|
+
# @return [String]
|
|
1207
|
+
#
|
|
1208
|
+
# @!attribute [rw] service_code
|
|
1209
|
+
# The code for the service.
|
|
1210
|
+
# @return [String]
|
|
1211
|
+
#
|
|
1212
|
+
# @!attribute [rw] quota_code
|
|
1213
|
+
# The code of the quota.
|
|
1214
|
+
# @return [String]
|
|
1215
|
+
#
|
|
1216
|
+
# @!attribute [rw] retry_after_seconds
|
|
1217
|
+
# The number of seconds to wait before retrying the operation.
|
|
1218
|
+
# @return [Integer]
|
|
1219
|
+
#
|
|
1220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ThrottlingException AWS API Documentation
|
|
1221
|
+
#
|
|
1222
|
+
class ThrottlingException < Struct.new(
|
|
1223
|
+
:message,
|
|
1224
|
+
:service_code,
|
|
1225
|
+
:quota_code,
|
|
1226
|
+
:retry_after_seconds)
|
|
1227
|
+
SENSITIVE = []
|
|
1228
|
+
include Aws::Structure
|
|
1229
|
+
end
|
|
1230
|
+
|
|
1231
|
+
# @!attribute [rw] resource_arn
|
|
1232
|
+
# The Amazon Resource Name (ARN) of the resource from which to remove
|
|
1233
|
+
# tags.
|
|
1234
|
+
# @return [String]
|
|
1235
|
+
#
|
|
1236
|
+
# @!attribute [rw] tag_keys
|
|
1237
|
+
# A list of tag keys to remove from the resource. Only the keys are
|
|
1238
|
+
# required; the values are ignored.
|
|
1239
|
+
# @return [Array<String>]
|
|
1240
|
+
#
|
|
1241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/UntagResourceRequest AWS API Documentation
|
|
1242
|
+
#
|
|
1243
|
+
class UntagResourceRequest < Struct.new(
|
|
1244
|
+
:resource_arn,
|
|
1245
|
+
:tag_keys)
|
|
1246
|
+
SENSITIVE = []
|
|
1247
|
+
include Aws::Structure
|
|
1248
|
+
end
|
|
1249
|
+
|
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/UntagResourceResponse AWS API Documentation
|
|
1251
|
+
#
|
|
1252
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
|
1253
|
+
|
|
1254
|
+
# @!attribute [rw] workflow_arn
|
|
1255
|
+
# The Amazon Resource Name (ARN) of the workflow you want to update.
|
|
1256
|
+
# @return [String]
|
|
1257
|
+
#
|
|
1258
|
+
# @!attribute [rw] definition_s3_location
|
|
1259
|
+
# The Amazon S3 location where the updated workflow definition file is
|
|
1260
|
+
# stored.
|
|
1261
|
+
# @return [Types::DefinitionS3Location]
|
|
1262
|
+
#
|
|
1263
|
+
# @!attribute [rw] role_arn
|
|
1264
|
+
# The Amazon Resource Name (ARN) of the IAM role that Amazon Managed
|
|
1265
|
+
# Workflows for Apache Airflow Serverless assumes when it executes the
|
|
1266
|
+
# updated workflow.
|
|
1267
|
+
# @return [String]
|
|
1268
|
+
#
|
|
1269
|
+
# @!attribute [rw] description
|
|
1270
|
+
# An updated description for the workflow.
|
|
1271
|
+
# @return [String]
|
|
1272
|
+
#
|
|
1273
|
+
# @!attribute [rw] logging_configuration
|
|
1274
|
+
# Updated logging configuration for the workflow.
|
|
1275
|
+
# @return [Types::LoggingConfiguration]
|
|
1276
|
+
#
|
|
1277
|
+
# @!attribute [rw] engine_version
|
|
1278
|
+
# The version of the Amazon Managed Workflows for Apache Airflow
|
|
1279
|
+
# Serverless engine that you want to use for the updated workflow.
|
|
1280
|
+
# @return [Integer]
|
|
1281
|
+
#
|
|
1282
|
+
# @!attribute [rw] network_configuration
|
|
1283
|
+
# Updated network configuration for the workflow execution
|
|
1284
|
+
# environment.
|
|
1285
|
+
# @return [Types::NetworkConfiguration]
|
|
1286
|
+
#
|
|
1287
|
+
# @!attribute [rw] trigger_mode
|
|
1288
|
+
# The trigger mode for the workflow execution.
|
|
1289
|
+
# @return [String]
|
|
1290
|
+
#
|
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/UpdateWorkflowRequest AWS API Documentation
|
|
1292
|
+
#
|
|
1293
|
+
class UpdateWorkflowRequest < Struct.new(
|
|
1294
|
+
:workflow_arn,
|
|
1295
|
+
:definition_s3_location,
|
|
1296
|
+
:role_arn,
|
|
1297
|
+
:description,
|
|
1298
|
+
:logging_configuration,
|
|
1299
|
+
:engine_version,
|
|
1300
|
+
:network_configuration,
|
|
1301
|
+
:trigger_mode)
|
|
1302
|
+
SENSITIVE = []
|
|
1303
|
+
include Aws::Structure
|
|
1304
|
+
end
|
|
1305
|
+
|
|
1306
|
+
# @!attribute [rw] workflow_arn
|
|
1307
|
+
# The Amazon Resource Name (ARN) of the updated workflow.
|
|
1308
|
+
# @return [String]
|
|
1309
|
+
#
|
|
1310
|
+
# @!attribute [rw] modified_at
|
|
1311
|
+
# The timestamp when the workflow was last modified, in ISO 8601
|
|
1312
|
+
# date-time format.
|
|
1313
|
+
# @return [Time]
|
|
1314
|
+
#
|
|
1315
|
+
# @!attribute [rw] workflow_version
|
|
1316
|
+
# The version identifier of the updated workflow.
|
|
1317
|
+
# @return [String]
|
|
1318
|
+
#
|
|
1319
|
+
# @!attribute [rw] warnings
|
|
1320
|
+
# Warning messages generated during workflow update.
|
|
1321
|
+
# @return [Array<String>]
|
|
1322
|
+
#
|
|
1323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/UpdateWorkflowResponse AWS API Documentation
|
|
1324
|
+
#
|
|
1325
|
+
class UpdateWorkflowResponse < Struct.new(
|
|
1326
|
+
:workflow_arn,
|
|
1327
|
+
:modified_at,
|
|
1328
|
+
:workflow_version,
|
|
1329
|
+
:warnings)
|
|
1330
|
+
SENSITIVE = []
|
|
1331
|
+
include Aws::Structure
|
|
1332
|
+
end
|
|
1333
|
+
|
|
1334
|
+
# The specified request parameters are invalid, missing, or inconsistent
|
|
1335
|
+
# with Amazon Managed Workflows for Apache Airflow Serverless service
|
|
1336
|
+
# requirements. This can occur when workflow definitions contain
|
|
1337
|
+
# unsupported operators, when required IAM permissions are missing, when
|
|
1338
|
+
# S3 locations are inaccessible, or when network configurations are
|
|
1339
|
+
# invalid. The service validates workflow definitions, execution roles,
|
|
1340
|
+
# and resource configurations to ensure compatibility with the managed
|
|
1341
|
+
# Airflow environment and security requirements.
|
|
1342
|
+
#
|
|
1343
|
+
# @!attribute [rw] message
|
|
1344
|
+
# @return [String]
|
|
1345
|
+
#
|
|
1346
|
+
# @!attribute [rw] reason
|
|
1347
|
+
# The reason the request failed validation.
|
|
1348
|
+
# @return [String]
|
|
1349
|
+
#
|
|
1350
|
+
# @!attribute [rw] field_list
|
|
1351
|
+
# The fields that failed validation.
|
|
1352
|
+
# @return [Array<Types::ValidationExceptionField>]
|
|
1353
|
+
#
|
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ValidationException AWS API Documentation
|
|
1355
|
+
#
|
|
1356
|
+
class ValidationException < Struct.new(
|
|
1357
|
+
:message,
|
|
1358
|
+
:reason,
|
|
1359
|
+
:field_list)
|
|
1360
|
+
SENSITIVE = []
|
|
1361
|
+
include Aws::Structure
|
|
1362
|
+
end
|
|
1363
|
+
|
|
1364
|
+
# Contains information about a field that failed validation, including
|
|
1365
|
+
# the field name and a descriptive error message.
|
|
1366
|
+
#
|
|
1367
|
+
# @!attribute [rw] name
|
|
1368
|
+
# The name of the field that failed validation.
|
|
1369
|
+
# @return [String]
|
|
1370
|
+
#
|
|
1371
|
+
# @!attribute [rw] message
|
|
1372
|
+
# A message that describes why the field failed validation.
|
|
1373
|
+
# @return [String]
|
|
1374
|
+
#
|
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ValidationExceptionField AWS API Documentation
|
|
1376
|
+
#
|
|
1377
|
+
class ValidationExceptionField < Struct.new(
|
|
1378
|
+
:name,
|
|
1379
|
+
:message)
|
|
1380
|
+
SENSITIVE = []
|
|
1381
|
+
include Aws::Structure
|
|
1382
|
+
end
|
|
1383
|
+
|
|
1384
|
+
# Detailed information about a workflow run execution, including timing,
|
|
1385
|
+
# status, error information, and associated task instances. This
|
|
1386
|
+
# structure provides comprehensive visibility into the workflow
|
|
1387
|
+
# execution lifecycle within the Amazon Managed Workflows for Apache
|
|
1388
|
+
# Airflow Serverless serverless environment. The service tracks
|
|
1389
|
+
# execution across distributed ECS worker tasks and provides detailed
|
|
1390
|
+
# timing information, error diagnostics, and task instance relationships
|
|
1391
|
+
# to support effective monitoring and troubleshooting of complex
|
|
1392
|
+
# workflow executions.
|
|
1393
|
+
#
|
|
1394
|
+
# @!attribute [rw] workflow_arn
|
|
1395
|
+
# The Amazon Resource Name (ARN) of the workflow that contains this
|
|
1396
|
+
# run.
|
|
1397
|
+
# @return [String]
|
|
1398
|
+
#
|
|
1399
|
+
# @!attribute [rw] workflow_version
|
|
1400
|
+
# The version of the workflow used for this run.
|
|
1401
|
+
# @return [String]
|
|
1402
|
+
#
|
|
1403
|
+
# @!attribute [rw] run_id
|
|
1404
|
+
# The unique identifier of this workflow run.
|
|
1405
|
+
# @return [String]
|
|
1406
|
+
#
|
|
1407
|
+
# @!attribute [rw] run_type
|
|
1408
|
+
# The type of workflow run.
|
|
1409
|
+
# @return [String]
|
|
1410
|
+
#
|
|
1411
|
+
# @!attribute [rw] started_on
|
|
1412
|
+
# The timestamp when the workflow run started execution, in ISO 8601
|
|
1413
|
+
# date-time format.
|
|
1414
|
+
# @return [Time]
|
|
1415
|
+
#
|
|
1416
|
+
# @!attribute [rw] created_at
|
|
1417
|
+
# The timestamp when the workflow run was created, in ISO 8601
|
|
1418
|
+
# date-time format.
|
|
1419
|
+
# @return [Time]
|
|
1420
|
+
#
|
|
1421
|
+
# @!attribute [rw] completed_on
|
|
1422
|
+
# The timestamp when the workflow run completed execution, in ISO 8601
|
|
1423
|
+
# date-time format. This value is null if the run is not complete.
|
|
1424
|
+
# @return [Time]
|
|
1425
|
+
#
|
|
1426
|
+
# @!attribute [rw] modified_at
|
|
1427
|
+
# The timestamp when the workflow run was last modified, in ISO 8601
|
|
1428
|
+
# date-time format.
|
|
1429
|
+
# @return [Time]
|
|
1430
|
+
#
|
|
1431
|
+
# @!attribute [rw] duration
|
|
1432
|
+
# The total duration of the workflow run execution in seconds. This
|
|
1433
|
+
# value is null if the run is not complete.
|
|
1434
|
+
# @return [Integer]
|
|
1435
|
+
#
|
|
1436
|
+
# @!attribute [rw] error_message
|
|
1437
|
+
# The error message if the workflow run failed. This value is null if
|
|
1438
|
+
# the run completed successfully.
|
|
1439
|
+
# @return [String]
|
|
1440
|
+
#
|
|
1441
|
+
# @!attribute [rw] task_instances
|
|
1442
|
+
# A list of task instance IDs that are part of this workflow run.
|
|
1443
|
+
# @return [Array<String>]
|
|
1444
|
+
#
|
|
1445
|
+
# @!attribute [rw] run_state
|
|
1446
|
+
# The current execution state of the workflow run.
|
|
1447
|
+
# @return [String]
|
|
1448
|
+
#
|
|
1449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/WorkflowRunDetail AWS API Documentation
|
|
1450
|
+
#
|
|
1451
|
+
class WorkflowRunDetail < Struct.new(
|
|
1452
|
+
:workflow_arn,
|
|
1453
|
+
:workflow_version,
|
|
1454
|
+
:run_id,
|
|
1455
|
+
:run_type,
|
|
1456
|
+
:started_on,
|
|
1457
|
+
:created_at,
|
|
1458
|
+
:completed_on,
|
|
1459
|
+
:modified_at,
|
|
1460
|
+
:duration,
|
|
1461
|
+
:error_message,
|
|
1462
|
+
:task_instances,
|
|
1463
|
+
:run_state)
|
|
1464
|
+
SENSITIVE = []
|
|
1465
|
+
include Aws::Structure
|
|
1466
|
+
end
|
|
1467
|
+
|
|
1468
|
+
# Summary information about a workflow run, including basic
|
|
1469
|
+
# identification and status information.
|
|
1470
|
+
#
|
|
1471
|
+
# @!attribute [rw] run_id
|
|
1472
|
+
# The unique identifier of the workflow run.
|
|
1473
|
+
# @return [String]
|
|
1474
|
+
#
|
|
1475
|
+
# @!attribute [rw] workflow_arn
|
|
1476
|
+
# The Amazon Resource Name (ARN) of the workflow that contains this
|
|
1477
|
+
# run.
|
|
1478
|
+
# @return [String]
|
|
1479
|
+
#
|
|
1480
|
+
# @!attribute [rw] workflow_version
|
|
1481
|
+
# The version of the workflow used for this run.
|
|
1482
|
+
# @return [String]
|
|
1483
|
+
#
|
|
1484
|
+
# @!attribute [rw] run_type
|
|
1485
|
+
# The type of workflow run.
|
|
1486
|
+
# @return [String]
|
|
1487
|
+
#
|
|
1488
|
+
# @!attribute [rw] run_detail_summary
|
|
1489
|
+
# Summary details about the workflow run execution.
|
|
1490
|
+
# @return [Types::RunDetailSummary]
|
|
1491
|
+
#
|
|
1492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/WorkflowRunSummary AWS API Documentation
|
|
1493
|
+
#
|
|
1494
|
+
class WorkflowRunSummary < Struct.new(
|
|
1495
|
+
:run_id,
|
|
1496
|
+
:workflow_arn,
|
|
1497
|
+
:workflow_version,
|
|
1498
|
+
:run_type,
|
|
1499
|
+
:run_detail_summary)
|
|
1500
|
+
SENSITIVE = []
|
|
1501
|
+
include Aws::Structure
|
|
1502
|
+
end
|
|
1503
|
+
|
|
1504
|
+
# Summary information about a workflow, including basic identification
|
|
1505
|
+
# and metadata.
|
|
1506
|
+
#
|
|
1507
|
+
# @!attribute [rw] workflow_arn
|
|
1508
|
+
# The Amazon Resource Name (ARN) of the workflow.
|
|
1509
|
+
# @return [String]
|
|
1510
|
+
#
|
|
1511
|
+
# @!attribute [rw] workflow_version
|
|
1512
|
+
# The version identifier of the workflow.
|
|
1513
|
+
# @return [String]
|
|
1514
|
+
#
|
|
1515
|
+
# @!attribute [rw] name
|
|
1516
|
+
# The name of the workflow.
|
|
1517
|
+
# @return [String]
|
|
1518
|
+
#
|
|
1519
|
+
# @!attribute [rw] description
|
|
1520
|
+
# The description of the workflow.
|
|
1521
|
+
# @return [String]
|
|
1522
|
+
#
|
|
1523
|
+
# @!attribute [rw] created_at
|
|
1524
|
+
# The timestamp when the workflow was created, in ISO 8601 date-time
|
|
1525
|
+
# format.
|
|
1526
|
+
# @return [Time]
|
|
1527
|
+
#
|
|
1528
|
+
# @!attribute [rw] modified_at
|
|
1529
|
+
# The timestamp when the workflow was last modified, in ISO 8601
|
|
1530
|
+
# date-time format.
|
|
1531
|
+
# @return [Time]
|
|
1532
|
+
#
|
|
1533
|
+
# @!attribute [rw] workflow_status
|
|
1534
|
+
# The current status of the workflow.
|
|
1535
|
+
# @return [String]
|
|
1536
|
+
#
|
|
1537
|
+
# @!attribute [rw] trigger_mode
|
|
1538
|
+
# The trigger mode for the workflow execution.
|
|
1539
|
+
# @return [String]
|
|
1540
|
+
#
|
|
1541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/WorkflowSummary AWS API Documentation
|
|
1542
|
+
#
|
|
1543
|
+
class WorkflowSummary < Struct.new(
|
|
1544
|
+
:workflow_arn,
|
|
1545
|
+
:workflow_version,
|
|
1546
|
+
:name,
|
|
1547
|
+
:description,
|
|
1548
|
+
:created_at,
|
|
1549
|
+
:modified_at,
|
|
1550
|
+
:workflow_status,
|
|
1551
|
+
:trigger_mode)
|
|
1552
|
+
SENSITIVE = []
|
|
1553
|
+
include Aws::Structure
|
|
1554
|
+
end
|
|
1555
|
+
|
|
1556
|
+
# Summary information about a workflow version, including identification
|
|
1557
|
+
# and configuration details.
|
|
1558
|
+
#
|
|
1559
|
+
# @!attribute [rw] workflow_version
|
|
1560
|
+
# The version identifier of the workflow version.
|
|
1561
|
+
# @return [String]
|
|
1562
|
+
#
|
|
1563
|
+
# @!attribute [rw] workflow_arn
|
|
1564
|
+
# The Amazon Resource Name (ARN) of the workflow that contains this
|
|
1565
|
+
# version.
|
|
1566
|
+
# @return [String]
|
|
1567
|
+
#
|
|
1568
|
+
# @!attribute [rw] is_latest_version
|
|
1569
|
+
# Boolean flag that indicates whether this is the latest version of
|
|
1570
|
+
# the workflow.
|
|
1571
|
+
# @return [Boolean]
|
|
1572
|
+
#
|
|
1573
|
+
# @!attribute [rw] created_at
|
|
1574
|
+
# The timestamp when the workflow version was created, in ISO 8601
|
|
1575
|
+
# date-time format.
|
|
1576
|
+
# @return [Time]
|
|
1577
|
+
#
|
|
1578
|
+
# @!attribute [rw] modified_at
|
|
1579
|
+
# The timestamp when the workflow version was last modified, in ISO
|
|
1580
|
+
# 8601 date-time format.
|
|
1581
|
+
# @return [Time]
|
|
1582
|
+
#
|
|
1583
|
+
# @!attribute [rw] definition_s3_location
|
|
1584
|
+
# The Amazon S3 location of the workflow definition file for this
|
|
1585
|
+
# version.
|
|
1586
|
+
# @return [Types::DefinitionS3Location]
|
|
1587
|
+
#
|
|
1588
|
+
# @!attribute [rw] schedule_configuration
|
|
1589
|
+
# The schedule configuration for this workflow version.
|
|
1590
|
+
# @return [Types::ScheduleConfiguration]
|
|
1591
|
+
#
|
|
1592
|
+
# @!attribute [rw] trigger_mode
|
|
1593
|
+
# The trigger mode for the workflow execution.
|
|
1594
|
+
# @return [String]
|
|
1595
|
+
#
|
|
1596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/WorkflowVersionSummary AWS API Documentation
|
|
1597
|
+
#
|
|
1598
|
+
class WorkflowVersionSummary < Struct.new(
|
|
1599
|
+
:workflow_version,
|
|
1600
|
+
:workflow_arn,
|
|
1601
|
+
:is_latest_version,
|
|
1602
|
+
:created_at,
|
|
1603
|
+
:modified_at,
|
|
1604
|
+
:definition_s3_location,
|
|
1605
|
+
:schedule_configuration,
|
|
1606
|
+
:trigger_mode)
|
|
1607
|
+
SENSITIVE = []
|
|
1608
|
+
include Aws::Structure
|
|
1609
|
+
end
|
|
1610
|
+
|
|
1611
|
+
end
|
|
1612
|
+
end
|
|
1613
|
+
|