@aws-sdk/client-mwaa 3.687.0 → 3.692.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +126 -126
- package/dist-types/ts3.4/models/models_0.d.ts +126 -126
- package/package.json +35 -35
|
@@ -8,7 +8,7 @@ import { MWAAServiceException as __BaseException } from "./MWAAServiceException"
|
|
|
8
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
10
10
|
readonly $fault: "client";
|
|
11
|
-
Message?: string;
|
|
11
|
+
Message?: string | undefined;
|
|
12
12
|
/**
|
|
13
13
|
* @internal
|
|
14
14
|
*/
|
|
@@ -32,12 +32,12 @@ export interface CreateCliTokenResponse {
|
|
|
32
32
|
* <p>An Airflow CLI login token.</p>
|
|
33
33
|
* @public
|
|
34
34
|
*/
|
|
35
|
-
CliToken?: string;
|
|
35
|
+
CliToken?: string | undefined;
|
|
36
36
|
/**
|
|
37
37
|
* <p>The Airflow web server hostname for the environment.</p>
|
|
38
38
|
* @public
|
|
39
39
|
*/
|
|
40
|
-
WebServerHostname?: string;
|
|
40
|
+
WebServerHostname?: string | undefined;
|
|
41
41
|
}
|
|
42
42
|
/**
|
|
43
43
|
* <p>ResourceNotFoundException: The resource is not available.</p>
|
|
@@ -103,27 +103,27 @@ export interface LoggingConfigurationInput {
|
|
|
103
103
|
* <p>Publishes Airflow DAG processing logs to CloudWatch Logs.</p>
|
|
104
104
|
* @public
|
|
105
105
|
*/
|
|
106
|
-
DagProcessingLogs?: ModuleLoggingConfigurationInput;
|
|
106
|
+
DagProcessingLogs?: ModuleLoggingConfigurationInput | undefined;
|
|
107
107
|
/**
|
|
108
108
|
* <p>Publishes Airflow scheduler logs to CloudWatch Logs.</p>
|
|
109
109
|
* @public
|
|
110
110
|
*/
|
|
111
|
-
SchedulerLogs?: ModuleLoggingConfigurationInput;
|
|
111
|
+
SchedulerLogs?: ModuleLoggingConfigurationInput | undefined;
|
|
112
112
|
/**
|
|
113
113
|
* <p>Publishes Airflow web server logs to CloudWatch Logs.</p>
|
|
114
114
|
* @public
|
|
115
115
|
*/
|
|
116
|
-
WebserverLogs?: ModuleLoggingConfigurationInput;
|
|
116
|
+
WebserverLogs?: ModuleLoggingConfigurationInput | undefined;
|
|
117
117
|
/**
|
|
118
118
|
* <p>Publishes Airflow worker logs to CloudWatch Logs.</p>
|
|
119
119
|
* @public
|
|
120
120
|
*/
|
|
121
|
-
WorkerLogs?: ModuleLoggingConfigurationInput;
|
|
121
|
+
WorkerLogs?: ModuleLoggingConfigurationInput | undefined;
|
|
122
122
|
/**
|
|
123
123
|
* <p>Publishes Airflow task logs to CloudWatch Logs.</p>
|
|
124
124
|
* @public
|
|
125
125
|
*/
|
|
126
|
-
TaskLogs?: ModuleLoggingConfigurationInput;
|
|
126
|
+
TaskLogs?: ModuleLoggingConfigurationInput | undefined;
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
129
|
* <p>Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
@@ -134,12 +134,12 @@ export interface NetworkConfiguration {
|
|
|
134
134
|
* <p>A list of subnet IDs. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
135
135
|
* @public
|
|
136
136
|
*/
|
|
137
|
-
SubnetIds?: string[];
|
|
137
|
+
SubnetIds?: string[] | undefined;
|
|
138
138
|
/**
|
|
139
139
|
* <p>A list of security group IDs. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html">Security in your VPC on Amazon MWAA</a>.</p>
|
|
140
140
|
* @public
|
|
141
141
|
*/
|
|
142
|
-
SecurityGroupIds?: string[];
|
|
142
|
+
SecurityGroupIds?: string[] | undefined;
|
|
143
143
|
}
|
|
144
144
|
/**
|
|
145
145
|
* @public
|
|
@@ -187,22 +187,22 @@ export interface CreateEnvironmentInput {
|
|
|
187
187
|
* <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the <code>plugins.zip</code> version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
188
188
|
* @public
|
|
189
189
|
*/
|
|
190
|
-
PluginsS3Path?: string;
|
|
190
|
+
PluginsS3Path?: string | undefined;
|
|
191
191
|
/**
|
|
192
192
|
* <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
193
193
|
* @public
|
|
194
194
|
*/
|
|
195
|
-
PluginsS3ObjectVersion?: string;
|
|
195
|
+
PluginsS3ObjectVersion?: string | undefined;
|
|
196
196
|
/**
|
|
197
197
|
* <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
198
198
|
* @public
|
|
199
199
|
*/
|
|
200
|
-
RequirementsS3Path?: string;
|
|
200
|
+
RequirementsS3Path?: string | undefined;
|
|
201
201
|
/**
|
|
202
202
|
* <p>The version of the <code>requirements.txt</code> file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
203
203
|
* @public
|
|
204
204
|
*/
|
|
205
|
-
RequirementsS3ObjectVersion?: string;
|
|
205
|
+
RequirementsS3ObjectVersion?: string | undefined;
|
|
206
206
|
/**
|
|
207
207
|
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>
|
|
208
208
|
* <p>
|
|
@@ -212,7 +212,7 @@ export interface CreateEnvironmentInput {
|
|
|
212
212
|
* </p>
|
|
213
213
|
* @public
|
|
214
214
|
*/
|
|
215
|
-
StartupScriptS3Path?: string;
|
|
215
|
+
StartupScriptS3Path?: string | undefined;
|
|
216
216
|
/**
|
|
217
217
|
* <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file
|
|
218
218
|
* every time you update the script.
|
|
@@ -228,27 +228,27 @@ export interface CreateEnvironmentInput {
|
|
|
228
228
|
* </p>
|
|
229
229
|
* @public
|
|
230
230
|
*/
|
|
231
|
-
StartupScriptS3ObjectVersion?: string;
|
|
231
|
+
StartupScriptS3ObjectVersion?: string | undefined;
|
|
232
232
|
/**
|
|
233
233
|
* <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
|
|
234
234
|
* @public
|
|
235
235
|
*/
|
|
236
|
-
AirflowConfigurationOptions?: Record<string, string
|
|
236
|
+
AirflowConfigurationOptions?: Record<string, string> | undefined;
|
|
237
237
|
/**
|
|
238
238
|
* <p>The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
|
|
239
239
|
* @public
|
|
240
240
|
*/
|
|
241
|
-
EnvironmentClass?: string;
|
|
241
|
+
EnvironmentClass?: string | undefined;
|
|
242
242
|
/**
|
|
243
243
|
* <p>The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. For example, <code>20</code>. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in <code>MinWorkers</code>.</p>
|
|
244
244
|
* @public
|
|
245
245
|
*/
|
|
246
|
-
MaxWorkers?: number;
|
|
246
|
+
MaxWorkers?: number | undefined;
|
|
247
247
|
/**
|
|
248
248
|
* <p>The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html">Create an Amazon MWAA environment</a>.</p>
|
|
249
249
|
* @public
|
|
250
250
|
*/
|
|
251
|
-
KmsKey?: string;
|
|
251
|
+
KmsKey?: string | undefined;
|
|
252
252
|
/**
|
|
253
253
|
* <p>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version.
|
|
254
254
|
* For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA)</a>.</p>
|
|
@@ -257,32 +257,32 @@ export interface CreateEnvironmentInput {
|
|
|
257
257
|
* <code>2.8.1</code>, <code>2.9.2</code>, and <code>2.10.1</code>.</p>
|
|
258
258
|
* @public
|
|
259
259
|
*/
|
|
260
|
-
AirflowVersion?: string;
|
|
260
|
+
AirflowVersion?: string | undefined;
|
|
261
261
|
/**
|
|
262
262
|
* <p>Defines the Apache Airflow logs to send to CloudWatch Logs.</p>
|
|
263
263
|
* @public
|
|
264
264
|
*/
|
|
265
|
-
LoggingConfiguration?: LoggingConfigurationInput;
|
|
265
|
+
LoggingConfiguration?: LoggingConfigurationInput | undefined;
|
|
266
266
|
/**
|
|
267
267
|
* <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only.</p>
|
|
268
268
|
* @public
|
|
269
269
|
*/
|
|
270
|
-
WeeklyMaintenanceWindowStart?: string;
|
|
270
|
+
WeeklyMaintenanceWindowStart?: string | undefined;
|
|
271
271
|
/**
|
|
272
272
|
* <p>The key-value tag pairs you want to associate to your environment. For example, <code>"Environment": "Staging"</code>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
273
273
|
* @public
|
|
274
274
|
*/
|
|
275
|
-
Tags?: Record<string, string
|
|
275
|
+
Tags?: Record<string, string> | undefined;
|
|
276
276
|
/**
|
|
277
277
|
* <p>Defines the access mode for the Apache Airflow <i>web server</i>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
|
|
278
278
|
* @public
|
|
279
279
|
*/
|
|
280
|
-
WebserverAccessMode?: WebserverAccessMode;
|
|
280
|
+
WebserverAccessMode?: WebserverAccessMode | undefined;
|
|
281
281
|
/**
|
|
282
282
|
* <p>The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the <code>MinWorkers</code> field. For example, <code>2</code>.</p>
|
|
283
283
|
* @public
|
|
284
284
|
*/
|
|
285
|
-
MinWorkers?: number;
|
|
285
|
+
MinWorkers?: number | undefined;
|
|
286
286
|
/**
|
|
287
287
|
* <p>The number of Apache Airflow schedulers to run in your environment. Valid values:</p>
|
|
288
288
|
* <ul>
|
|
@@ -295,7 +295,7 @@ export interface CreateEnvironmentInput {
|
|
|
295
295
|
* </ul>
|
|
296
296
|
* @public
|
|
297
297
|
*/
|
|
298
|
-
Schedulers?: number;
|
|
298
|
+
Schedulers?: number | undefined;
|
|
299
299
|
/**
|
|
300
300
|
* <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in
|
|
301
301
|
* your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to <code>CUSTOMER</code>.
|
|
@@ -303,7 +303,7 @@ export interface CreateEnvironmentInput {
|
|
|
303
303
|
* create the endpoints within 72 hours, the status will change to <code>CREATE_FAILED</code>. You can delete the failed environment and create a new one.</p>
|
|
304
304
|
* @public
|
|
305
305
|
*/
|
|
306
|
-
EndpointManagement?: EndpointManagement;
|
|
306
|
+
EndpointManagement?: EndpointManagement | undefined;
|
|
307
307
|
/**
|
|
308
308
|
* <p>
|
|
309
309
|
* The minimum number of web servers that you want to run in your environment.
|
|
@@ -315,7 +315,7 @@ export interface CreateEnvironmentInput {
|
|
|
315
315
|
* <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>
|
|
316
316
|
* @public
|
|
317
317
|
*/
|
|
318
|
-
MinWebservers?: number;
|
|
318
|
+
MinWebservers?: number | undefined;
|
|
319
319
|
/**
|
|
320
320
|
* <p>
|
|
321
321
|
* The maximum number of web servers that you want to run in your environment.
|
|
@@ -328,7 +328,7 @@ export interface CreateEnvironmentInput {
|
|
|
328
328
|
* <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>
|
|
329
329
|
* @public
|
|
330
330
|
*/
|
|
331
|
-
MaxWebservers?: number;
|
|
331
|
+
MaxWebservers?: number | undefined;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
334
|
* @public
|
|
@@ -338,7 +338,7 @@ export interface CreateEnvironmentOutput {
|
|
|
338
338
|
* <p>The Amazon Resource Name (ARN) returned in the response for the environment.</p>
|
|
339
339
|
* @public
|
|
340
340
|
*/
|
|
341
|
-
Arn?: string;
|
|
341
|
+
Arn?: string | undefined;
|
|
342
342
|
}
|
|
343
343
|
/**
|
|
344
344
|
* <p>InternalServerException: An internal error has occurred.</p>
|
|
@@ -382,22 +382,22 @@ export interface CreateWebLoginTokenResponse {
|
|
|
382
382
|
* <p>An Airflow web server login token.</p>
|
|
383
383
|
* @public
|
|
384
384
|
*/
|
|
385
|
-
WebToken?: string;
|
|
385
|
+
WebToken?: string | undefined;
|
|
386
386
|
/**
|
|
387
387
|
* <p>The Airflow web server hostname for the environment.</p>
|
|
388
388
|
* @public
|
|
389
389
|
*/
|
|
390
|
-
WebServerHostname?: string;
|
|
390
|
+
WebServerHostname?: string | undefined;
|
|
391
391
|
/**
|
|
392
392
|
* <p>The name of the IAM identity creating the web login token. This might be an IAM user, or an assumed or federated identity. For example, <code>assumed-role/Admin/your-name</code>.</p>
|
|
393
393
|
* @public
|
|
394
394
|
*/
|
|
395
|
-
IamIdentity?: string;
|
|
395
|
+
IamIdentity?: string | undefined;
|
|
396
396
|
/**
|
|
397
397
|
* <p>The user name of the Apache Airflow identity creating the web login token.</p>
|
|
398
398
|
* @public
|
|
399
399
|
*/
|
|
400
|
-
AirflowIdentity?: string;
|
|
400
|
+
AirflowIdentity?: string | undefined;
|
|
401
401
|
}
|
|
402
402
|
/**
|
|
403
403
|
* @public
|
|
@@ -433,12 +433,12 @@ export interface UpdateError {
|
|
|
433
433
|
* <p>The error code that corresponds to the error with the last update.</p>
|
|
434
434
|
* @public
|
|
435
435
|
*/
|
|
436
|
-
ErrorCode?: string;
|
|
436
|
+
ErrorCode?: string | undefined;
|
|
437
437
|
/**
|
|
438
438
|
* <p>The error message that corresponds to the error code.</p>
|
|
439
439
|
* @public
|
|
440
440
|
*/
|
|
441
|
-
ErrorMessage?: string;
|
|
441
|
+
ErrorMessage?: string | undefined;
|
|
442
442
|
}
|
|
443
443
|
/**
|
|
444
444
|
* @public
|
|
@@ -462,22 +462,22 @@ export interface LastUpdate {
|
|
|
462
462
|
* <p>The status of the last update on the environment.</p>
|
|
463
463
|
* @public
|
|
464
464
|
*/
|
|
465
|
-
Status?: UpdateStatus;
|
|
465
|
+
Status?: UpdateStatus | undefined;
|
|
466
466
|
/**
|
|
467
467
|
* <p>The day and time of the last update on the environment.</p>
|
|
468
468
|
* @public
|
|
469
469
|
*/
|
|
470
|
-
CreatedAt?: Date;
|
|
470
|
+
CreatedAt?: Date | undefined;
|
|
471
471
|
/**
|
|
472
472
|
* <p>The error that was encountered during the last update of the environment.</p>
|
|
473
473
|
* @public
|
|
474
474
|
*/
|
|
475
|
-
Error?: UpdateError;
|
|
475
|
+
Error?: UpdateError | undefined;
|
|
476
476
|
/**
|
|
477
477
|
* <p>The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.</p>
|
|
478
478
|
* @public
|
|
479
479
|
*/
|
|
480
|
-
Source?: string;
|
|
480
|
+
Source?: string | undefined;
|
|
481
481
|
}
|
|
482
482
|
/**
|
|
483
483
|
* <p>Describes the Apache Airflow log details for the log type (e.g. <code>DagProcessingLogs</code>).</p>
|
|
@@ -488,17 +488,17 @@ export interface ModuleLoggingConfiguration {
|
|
|
488
488
|
* <p>Indicates whether the Apache Airflow log type (e.g. <code>DagProcessingLogs</code>) is enabled.</p>
|
|
489
489
|
* @public
|
|
490
490
|
*/
|
|
491
|
-
Enabled?: boolean;
|
|
491
|
+
Enabled?: boolean | undefined;
|
|
492
492
|
/**
|
|
493
493
|
* <p>The Apache Airflow log level for the log type (e.g. <code>DagProcessingLogs</code>). </p>
|
|
494
494
|
* @public
|
|
495
495
|
*/
|
|
496
|
-
LogLevel?: LoggingLevel;
|
|
496
|
+
LogLevel?: LoggingLevel | undefined;
|
|
497
497
|
/**
|
|
498
498
|
* <p>The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. <code>DagProcessingLogs</code>) is published. For example, <code>arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*</code>.</p>
|
|
499
499
|
* @public
|
|
500
500
|
*/
|
|
501
|
-
CloudWatchLogGroupArn?: string;
|
|
501
|
+
CloudWatchLogGroupArn?: string | undefined;
|
|
502
502
|
}
|
|
503
503
|
/**
|
|
504
504
|
* <p>Describes the Apache Airflow log types that are published to CloudWatch Logs.</p>
|
|
@@ -509,27 +509,27 @@ export interface LoggingConfiguration {
|
|
|
509
509
|
* <p>The Airflow DAG processing logs published to CloudWatch Logs and the log level.</p>
|
|
510
510
|
* @public
|
|
511
511
|
*/
|
|
512
|
-
DagProcessingLogs?: ModuleLoggingConfiguration;
|
|
512
|
+
DagProcessingLogs?: ModuleLoggingConfiguration | undefined;
|
|
513
513
|
/**
|
|
514
514
|
* <p>The Airflow scheduler logs published to CloudWatch Logs and the log level.</p>
|
|
515
515
|
* @public
|
|
516
516
|
*/
|
|
517
|
-
SchedulerLogs?: ModuleLoggingConfiguration;
|
|
517
|
+
SchedulerLogs?: ModuleLoggingConfiguration | undefined;
|
|
518
518
|
/**
|
|
519
519
|
* <p>The Airflow web server logs published to CloudWatch Logs and the log level.</p>
|
|
520
520
|
* @public
|
|
521
521
|
*/
|
|
522
|
-
WebserverLogs?: ModuleLoggingConfiguration;
|
|
522
|
+
WebserverLogs?: ModuleLoggingConfiguration | undefined;
|
|
523
523
|
/**
|
|
524
524
|
* <p>The Airflow worker logs published to CloudWatch Logs and the log level.</p>
|
|
525
525
|
* @public
|
|
526
526
|
*/
|
|
527
|
-
WorkerLogs?: ModuleLoggingConfiguration;
|
|
527
|
+
WorkerLogs?: ModuleLoggingConfiguration | undefined;
|
|
528
528
|
/**
|
|
529
529
|
* <p>The Airflow task logs published to CloudWatch Logs and the log level.</p>
|
|
530
530
|
* @public
|
|
531
531
|
*/
|
|
532
|
-
TaskLogs?: ModuleLoggingConfiguration;
|
|
532
|
+
TaskLogs?: ModuleLoggingConfiguration | undefined;
|
|
533
533
|
}
|
|
534
534
|
/**
|
|
535
535
|
* @public
|
|
@@ -562,7 +562,7 @@ export interface Environment {
|
|
|
562
562
|
* <p>The name of the Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>
|
|
563
563
|
* @public
|
|
564
564
|
*/
|
|
565
|
-
Name?: string;
|
|
565
|
+
Name?: string | undefined;
|
|
566
566
|
/**
|
|
567
567
|
* <p>The status of the Amazon MWAA environment.</p>
|
|
568
568
|
* <p>Valid values:</p>
|
|
@@ -624,37 +624,37 @@ export interface Environment {
|
|
|
624
624
|
* <p>We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html">Amazon MWAA troubleshooting</a>.</p>
|
|
625
625
|
* @public
|
|
626
626
|
*/
|
|
627
|
-
Status?: EnvironmentStatus;
|
|
627
|
+
Status?: EnvironmentStatus | undefined;
|
|
628
628
|
/**
|
|
629
629
|
* <p>The Amazon Resource Name (ARN) of the Amazon MWAA environment.</p>
|
|
630
630
|
* @public
|
|
631
631
|
*/
|
|
632
|
-
Arn?: string;
|
|
632
|
+
Arn?: string | undefined;
|
|
633
633
|
/**
|
|
634
634
|
* <p>The day and time the environment was created.</p>
|
|
635
635
|
* @public
|
|
636
636
|
*/
|
|
637
|
-
CreatedAt?: Date;
|
|
637
|
+
CreatedAt?: Date | undefined;
|
|
638
638
|
/**
|
|
639
639
|
* <p>The Apache Airflow <i>web server</i> host name for the Amazon MWAA environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html">Accessing the Apache Airflow UI</a>.</p>
|
|
640
640
|
* @public
|
|
641
641
|
*/
|
|
642
|
-
WebserverUrl?: string;
|
|
642
|
+
WebserverUrl?: string | undefined;
|
|
643
643
|
/**
|
|
644
644
|
* <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
|
|
645
645
|
* @public
|
|
646
646
|
*/
|
|
647
|
-
ExecutionRoleArn?: string;
|
|
647
|
+
ExecutionRoleArn?: string | undefined;
|
|
648
648
|
/**
|
|
649
649
|
* <p>The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html">Amazon MWAA Service-linked role</a>.</p>
|
|
650
650
|
* @public
|
|
651
651
|
*/
|
|
652
|
-
ServiceRoleArn?: string;
|
|
652
|
+
ServiceRoleArn?: string | undefined;
|
|
653
653
|
/**
|
|
654
654
|
* <p>The KMS encryption key used to encrypt the data in your environment.</p>
|
|
655
655
|
* @public
|
|
656
656
|
*/
|
|
657
|
-
KmsKey?: string;
|
|
657
|
+
KmsKey?: string | undefined;
|
|
658
658
|
/**
|
|
659
659
|
* <p>The Apache Airflow version on your environment.</p>
|
|
660
660
|
* <p>Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>,
|
|
@@ -662,22 +662,22 @@ export interface Environment {
|
|
|
662
662
|
* <code>2.8.1</code>, <code>2.9.2</code>, and <code>2.10.1</code>.</p>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
AirflowVersion?: string;
|
|
665
|
+
AirflowVersion?: string | undefined;
|
|
666
666
|
/**
|
|
667
667
|
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
|
|
668
668
|
* @public
|
|
669
669
|
*/
|
|
670
|
-
SourceBucketArn?: string;
|
|
670
|
+
SourceBucketArn?: string | undefined;
|
|
671
671
|
/**
|
|
672
672
|
* <p>The relative path to the DAGs folder in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/dags</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
|
|
673
673
|
* @public
|
|
674
674
|
*/
|
|
675
|
-
DagS3Path?: string;
|
|
675
|
+
DagS3Path?: string | undefined;
|
|
676
676
|
/**
|
|
677
677
|
* <p>The relative path to the file in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/plugins.zip</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
678
678
|
* @public
|
|
679
679
|
*/
|
|
680
|
-
PluginsS3Path?: string;
|
|
680
|
+
PluginsS3Path?: string | undefined;
|
|
681
681
|
/**
|
|
682
682
|
* <p>The version of the <code>plugins.zip</code> file in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p>
|
|
683
683
|
* <p>
|
|
@@ -689,13 +689,13 @@ export interface Environment {
|
|
|
689
689
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
690
690
|
* @public
|
|
691
691
|
*/
|
|
692
|
-
PluginsS3ObjectVersion?: string;
|
|
692
|
+
PluginsS3ObjectVersion?: string | undefined;
|
|
693
693
|
/**
|
|
694
694
|
* <p>The relative path to the <code>requirements.txt</code> file in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/requirements.txt</code>. For more information, see
|
|
695
695
|
* <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
696
696
|
* @public
|
|
697
697
|
*/
|
|
698
|
-
RequirementsS3Path?: string;
|
|
698
|
+
RequirementsS3Path?: string | undefined;
|
|
699
699
|
/**
|
|
700
700
|
* <p>The version of the <code>requirements.txt </code> file on your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p>
|
|
701
701
|
* <p>
|
|
@@ -709,7 +709,7 @@ export interface Environment {
|
|
|
709
709
|
* </p>
|
|
710
710
|
* @public
|
|
711
711
|
*/
|
|
712
|
-
RequirementsS3ObjectVersion?: string;
|
|
712
|
+
RequirementsS3ObjectVersion?: string | undefined;
|
|
713
713
|
/**
|
|
714
714
|
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>
|
|
715
715
|
* <p>
|
|
@@ -719,7 +719,7 @@ export interface Environment {
|
|
|
719
719
|
* </p>
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
722
|
-
StartupScriptS3Path?: string;
|
|
722
|
+
StartupScriptS3Path?: string | undefined;
|
|
723
723
|
/**
|
|
724
724
|
* <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file.</p>
|
|
725
725
|
* <p>
|
|
@@ -733,84 +733,84 @@ export interface Environment {
|
|
|
733
733
|
* </p>
|
|
734
734
|
* @public
|
|
735
735
|
*/
|
|
736
|
-
StartupScriptS3ObjectVersion?: string;
|
|
736
|
+
StartupScriptS3ObjectVersion?: string | undefined;
|
|
737
737
|
/**
|
|
738
738
|
* <p>A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
|
|
739
739
|
* @public
|
|
740
740
|
*/
|
|
741
|
-
AirflowConfigurationOptions?: Record<string, string
|
|
741
|
+
AirflowConfigurationOptions?: Record<string, string> | undefined;
|
|
742
742
|
/**
|
|
743
743
|
* <p>The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
EnvironmentClass?: string;
|
|
746
|
+
EnvironmentClass?: string | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>The maximum number of workers that run in your environment. For example, <code>20</code>.</p>
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
MaxWorkers?: number;
|
|
751
|
+
MaxWorkers?: number | undefined;
|
|
752
752
|
/**
|
|
753
753
|
* <p>Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
754
754
|
* @public
|
|
755
755
|
*/
|
|
756
|
-
NetworkConfiguration?: NetworkConfiguration;
|
|
756
|
+
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
757
757
|
/**
|
|
758
758
|
* <p>The Apache Airflow logs published to CloudWatch Logs.</p>
|
|
759
759
|
* @public
|
|
760
760
|
*/
|
|
761
|
-
LoggingConfiguration?: LoggingConfiguration;
|
|
761
|
+
LoggingConfiguration?: LoggingConfiguration | undefined;
|
|
762
762
|
/**
|
|
763
763
|
* <p>The status of the last update on the environment.</p>
|
|
764
764
|
* @public
|
|
765
765
|
*/
|
|
766
|
-
LastUpdate?: LastUpdate;
|
|
766
|
+
LastUpdate?: LastUpdate | undefined;
|
|
767
767
|
/**
|
|
768
768
|
* <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: <code>TUE:03:30</code>.</p>
|
|
769
769
|
* @public
|
|
770
770
|
*/
|
|
771
|
-
WeeklyMaintenanceWindowStart?: string;
|
|
771
|
+
WeeklyMaintenanceWindowStart?: string | undefined;
|
|
772
772
|
/**
|
|
773
773
|
* <p>The key-value tag pairs associated to your environment. For example, <code>"Environment": "Staging"</code>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
774
774
|
* @public
|
|
775
775
|
*/
|
|
776
|
-
Tags?: Record<string, string
|
|
776
|
+
Tags?: Record<string, string> | undefined;
|
|
777
777
|
/**
|
|
778
778
|
* <p>The Apache Airflow <i>web server</i> access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
|
|
779
779
|
* @public
|
|
780
780
|
*/
|
|
781
|
-
WebserverAccessMode?: WebserverAccessMode;
|
|
781
|
+
WebserverAccessMode?: WebserverAccessMode | undefined;
|
|
782
782
|
/**
|
|
783
783
|
* <p>The minimum number of workers that run in your environment. For example, <code>2</code>.</p>
|
|
784
784
|
* @public
|
|
785
785
|
*/
|
|
786
|
-
MinWorkers?: number;
|
|
786
|
+
MinWorkers?: number | undefined;
|
|
787
787
|
/**
|
|
788
788
|
* <p>The number of Apache Airflow schedulers that run in your Amazon MWAA environment.</p>
|
|
789
789
|
* @public
|
|
790
790
|
*/
|
|
791
|
-
Schedulers?: number;
|
|
791
|
+
Schedulers?: number | undefined;
|
|
792
792
|
/**
|
|
793
793
|
* <p>The VPC endpoint for the environment's web server.</p>
|
|
794
794
|
* @public
|
|
795
795
|
*/
|
|
796
|
-
WebserverVpcEndpointService?: string;
|
|
796
|
+
WebserverVpcEndpointService?: string | undefined;
|
|
797
797
|
/**
|
|
798
798
|
* <p>The VPC endpoint for the environment's Amazon RDS database.</p>
|
|
799
799
|
* @public
|
|
800
800
|
*/
|
|
801
|
-
DatabaseVpcEndpointService?: string;
|
|
801
|
+
DatabaseVpcEndpointService?: string | undefined;
|
|
802
802
|
/**
|
|
803
803
|
* <p>The queue ARN for the environment's <a href="https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html">Celery Executor</a>. Amazon MWAA uses a Celery Executor
|
|
804
804
|
* to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.</p>
|
|
805
805
|
* @public
|
|
806
806
|
*/
|
|
807
|
-
CeleryExecutorQueue?: string;
|
|
807
|
+
CeleryExecutorQueue?: string | undefined;
|
|
808
808
|
/**
|
|
809
809
|
* <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in
|
|
810
810
|
* your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints in your VPC.</p>
|
|
811
811
|
* @public
|
|
812
812
|
*/
|
|
813
|
-
EndpointManagement?: EndpointManagement;
|
|
813
|
+
EndpointManagement?: EndpointManagement | undefined;
|
|
814
814
|
/**
|
|
815
815
|
* <p>
|
|
816
816
|
* The minimum number of web servers that you want to run in your environment.
|
|
@@ -822,7 +822,7 @@ export interface Environment {
|
|
|
822
822
|
* <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>
|
|
823
823
|
* @public
|
|
824
824
|
*/
|
|
825
|
-
MinWebservers?: number;
|
|
825
|
+
MinWebservers?: number | undefined;
|
|
826
826
|
/**
|
|
827
827
|
* <p>
|
|
828
828
|
* The maximum number of web servers that you want to run in your environment.
|
|
@@ -835,7 +835,7 @@ export interface Environment {
|
|
|
835
835
|
* <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>
|
|
836
836
|
* @public
|
|
837
837
|
*/
|
|
838
|
-
MaxWebservers?: number;
|
|
838
|
+
MaxWebservers?: number | undefined;
|
|
839
839
|
}
|
|
840
840
|
/**
|
|
841
841
|
* @public
|
|
@@ -845,7 +845,7 @@ export interface GetEnvironmentOutput {
|
|
|
845
845
|
* <p>An object containing all available details about the environment.</p>
|
|
846
846
|
* @public
|
|
847
847
|
*/
|
|
848
|
-
Environment?: Environment;
|
|
848
|
+
Environment?: Environment | undefined;
|
|
849
849
|
}
|
|
850
850
|
/**
|
|
851
851
|
* @public
|
|
@@ -889,13 +889,13 @@ export interface InvokeRestApiRequest {
|
|
|
889
889
|
* JSON object. </p>
|
|
890
890
|
* @public
|
|
891
891
|
*/
|
|
892
|
-
QueryParameters?: __DocumentType;
|
|
892
|
+
QueryParameters?: __DocumentType | undefined;
|
|
893
893
|
/**
|
|
894
894
|
* <p>The request body for the Apache Airflow REST API call, provided as a JSON
|
|
895
895
|
* object.</p>
|
|
896
896
|
* @public
|
|
897
897
|
*/
|
|
898
|
-
Body?: __DocumentType;
|
|
898
|
+
Body?: __DocumentType | undefined;
|
|
899
899
|
}
|
|
900
900
|
/**
|
|
901
901
|
* @public
|
|
@@ -905,13 +905,13 @@ export interface InvokeRestApiResponse {
|
|
|
905
905
|
* <p>The HTTP status code returned by the Apache Airflow REST API call.</p>
|
|
906
906
|
* @public
|
|
907
907
|
*/
|
|
908
|
-
RestApiStatusCode?: number;
|
|
908
|
+
RestApiStatusCode?: number | undefined;
|
|
909
909
|
/**
|
|
910
910
|
* <p>The response data from the Apache Airflow REST API call, provided as a JSON
|
|
911
911
|
* object.</p>
|
|
912
912
|
* @public
|
|
913
913
|
*/
|
|
914
|
-
RestApiResponse?: __DocumentType;
|
|
914
|
+
RestApiResponse?: __DocumentType | undefined;
|
|
915
915
|
}
|
|
916
916
|
/**
|
|
917
917
|
* <p>An exception indicating that a client-side error occurred during the Apache Airflow
|
|
@@ -925,13 +925,13 @@ export declare class RestApiClientException extends __BaseException {
|
|
|
925
925
|
* <p>The HTTP status code returned by the Apache Airflow REST API call.</p>
|
|
926
926
|
* @public
|
|
927
927
|
*/
|
|
928
|
-
RestApiStatusCode?: number;
|
|
928
|
+
RestApiStatusCode?: number | undefined;
|
|
929
929
|
/**
|
|
930
930
|
* <p>The error response data from the Apache Airflow REST API call, provided as a JSON
|
|
931
931
|
* object.</p>
|
|
932
932
|
* @public
|
|
933
933
|
*/
|
|
934
|
-
RestApiResponse?: __DocumentType;
|
|
934
|
+
RestApiResponse?: __DocumentType | undefined;
|
|
935
935
|
/**
|
|
936
936
|
* @internal
|
|
937
937
|
*/
|
|
@@ -949,13 +949,13 @@ export declare class RestApiServerException extends __BaseException {
|
|
|
949
949
|
* <p>The HTTP status code returned by the Apache Airflow REST API call.</p>
|
|
950
950
|
* @public
|
|
951
951
|
*/
|
|
952
|
-
RestApiStatusCode?: number;
|
|
952
|
+
RestApiStatusCode?: number | undefined;
|
|
953
953
|
/**
|
|
954
954
|
* <p>The error response data from the Apache Airflow REST API call, provided as a JSON
|
|
955
955
|
* object.</p>
|
|
956
956
|
* @public
|
|
957
957
|
*/
|
|
958
|
-
RestApiResponse?: __DocumentType;
|
|
958
|
+
RestApiResponse?: __DocumentType | undefined;
|
|
959
959
|
/**
|
|
960
960
|
* @internal
|
|
961
961
|
*/
|
|
@@ -969,12 +969,12 @@ export interface ListEnvironmentsInput {
|
|
|
969
969
|
* <p>Retrieves the next page of the results.</p>
|
|
970
970
|
* @public
|
|
971
971
|
*/
|
|
972
|
-
NextToken?: string;
|
|
972
|
+
NextToken?: string | undefined;
|
|
973
973
|
/**
|
|
974
974
|
* <p>The maximum number of results to retrieve per page. For example, <code>5</code> environments per page.</p>
|
|
975
975
|
* @public
|
|
976
976
|
*/
|
|
977
|
-
MaxResults?: number;
|
|
977
|
+
MaxResults?: number | undefined;
|
|
978
978
|
}
|
|
979
979
|
/**
|
|
980
980
|
* @public
|
|
@@ -989,7 +989,7 @@ export interface ListEnvironmentsOutput {
|
|
|
989
989
|
* <p>Retrieves the next page of the results.</p>
|
|
990
990
|
* @public
|
|
991
991
|
*/
|
|
992
|
-
NextToken?: string;
|
|
992
|
+
NextToken?: string | undefined;
|
|
993
993
|
}
|
|
994
994
|
/**
|
|
995
995
|
* @public
|
|
@@ -1009,7 +1009,7 @@ export interface ListTagsForResourceOutput {
|
|
|
1009
1009
|
* <p>The key-value tag pairs associated to your environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
|
1010
1010
|
* @public
|
|
1011
1011
|
*/
|
|
1012
|
-
Tags?: Record<string, string
|
|
1012
|
+
Tags?: Record<string, string> | undefined;
|
|
1013
1013
|
}
|
|
1014
1014
|
/**
|
|
1015
1015
|
* <p>
|
|
@@ -1045,25 +1045,25 @@ export interface StatisticSet {
|
|
|
1045
1045
|
* <b>Internal only</b>. The number of samples used for the statistic set.</p>
|
|
1046
1046
|
* @public
|
|
1047
1047
|
*/
|
|
1048
|
-
SampleCount?: number;
|
|
1048
|
+
SampleCount?: number | undefined;
|
|
1049
1049
|
/**
|
|
1050
1050
|
* <p>
|
|
1051
1051
|
* <b>Internal only</b>. The sum of values for the sample set.</p>
|
|
1052
1052
|
* @public
|
|
1053
1053
|
*/
|
|
1054
|
-
Sum?: number;
|
|
1054
|
+
Sum?: number | undefined;
|
|
1055
1055
|
/**
|
|
1056
1056
|
* <p>
|
|
1057
1057
|
* <b>Internal only</b>. The minimum value of the sample set.</p>
|
|
1058
1058
|
* @public
|
|
1059
1059
|
*/
|
|
1060
|
-
Minimum?: number;
|
|
1060
|
+
Minimum?: number | undefined;
|
|
1061
1061
|
/**
|
|
1062
1062
|
* <p>
|
|
1063
1063
|
* <b>Internal only</b>. The maximum value of the sample set.</p>
|
|
1064
1064
|
* @public
|
|
1065
1065
|
*/
|
|
1066
|
-
Maximum?: number;
|
|
1066
|
+
Maximum?: number | undefined;
|
|
1067
1067
|
}
|
|
1068
1068
|
/**
|
|
1069
1069
|
* @public
|
|
@@ -1129,19 +1129,19 @@ export interface MetricDatum {
|
|
|
1129
1129
|
* <b>Internal only</b>. The dimensions associated with the metric.</p>
|
|
1130
1130
|
* @public
|
|
1131
1131
|
*/
|
|
1132
|
-
Dimensions?: Dimension[];
|
|
1132
|
+
Dimensions?: Dimension[] | undefined;
|
|
1133
1133
|
/**
|
|
1134
1134
|
* <p>
|
|
1135
1135
|
* <b>Internal only</b>. The value for the metric.</p>
|
|
1136
1136
|
* @public
|
|
1137
1137
|
*/
|
|
1138
|
-
Value?: number;
|
|
1138
|
+
Value?: number | undefined;
|
|
1139
1139
|
/**
|
|
1140
1140
|
* <p>
|
|
1141
1141
|
* <b>Internal only</b>. The unit used to store the metric.</p>
|
|
1142
1142
|
* @public
|
|
1143
1143
|
*/
|
|
1144
|
-
Unit?: Unit;
|
|
1144
|
+
Unit?: Unit | undefined;
|
|
1145
1145
|
/**
|
|
1146
1146
|
* @deprecated
|
|
1147
1147
|
*
|
|
@@ -1149,7 +1149,7 @@ export interface MetricDatum {
|
|
|
1149
1149
|
* <b>Internal only</b>. The statistical values for the metric.</p>
|
|
1150
1150
|
* @public
|
|
1151
1151
|
*/
|
|
1152
|
-
StatisticValues?: StatisticSet;
|
|
1152
|
+
StatisticValues?: StatisticSet | undefined;
|
|
1153
1153
|
}
|
|
1154
1154
|
/**
|
|
1155
1155
|
* @public
|
|
@@ -1239,7 +1239,7 @@ export interface UpdateEnvironmentInput {
|
|
|
1239
1239
|
* <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
|
|
1240
1240
|
* @public
|
|
1241
1241
|
*/
|
|
1242
|
-
ExecutionRoleArn?: string;
|
|
1242
|
+
ExecutionRoleArn?: string | undefined;
|
|
1243
1243
|
/**
|
|
1244
1244
|
* <p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.</p>
|
|
1245
1245
|
* <p>Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating
|
|
@@ -1249,37 +1249,37 @@ export interface UpdateEnvironmentInput {
|
|
|
1249
1249
|
* <code>2.8.1</code>, <code>2.9.2</code>, and <code>2.10.1</code>.</p>
|
|
1250
1250
|
* @public
|
|
1251
1251
|
*/
|
|
1252
|
-
AirflowVersion?: string;
|
|
1252
|
+
AirflowVersion?: string | undefined;
|
|
1253
1253
|
/**
|
|
1254
1254
|
* <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
|
|
1255
1255
|
* @public
|
|
1256
1256
|
*/
|
|
1257
|
-
SourceBucketArn?: string;
|
|
1257
|
+
SourceBucketArn?: string | undefined;
|
|
1258
1258
|
/**
|
|
1259
1259
|
* <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
|
|
1260
1260
|
* @public
|
|
1261
1261
|
*/
|
|
1262
|
-
DagS3Path?: string;
|
|
1262
|
+
DagS3Path?: string | undefined;
|
|
1263
1263
|
/**
|
|
1264
1264
|
* <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
|
|
1265
1265
|
* @public
|
|
1266
1266
|
*/
|
|
1267
|
-
PluginsS3Path?: string;
|
|
1267
|
+
PluginsS3Path?: string | undefined;
|
|
1268
1268
|
/**
|
|
1269
1269
|
* <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <code>plugins.zip</code> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
1270
1270
|
* @public
|
|
1271
1271
|
*/
|
|
1272
|
-
PluginsS3ObjectVersion?: string;
|
|
1272
|
+
PluginsS3ObjectVersion?: string | undefined;
|
|
1273
1273
|
/**
|
|
1274
1274
|
* <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
|
|
1275
1275
|
* @public
|
|
1276
1276
|
*/
|
|
1277
|
-
RequirementsS3Path?: string;
|
|
1277
|
+
RequirementsS3Path?: string | undefined;
|
|
1278
1278
|
/**
|
|
1279
1279
|
* <p>The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <code>requirements.txt</code> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
|
|
1280
1280
|
* @public
|
|
1281
1281
|
*/
|
|
1282
|
-
RequirementsS3ObjectVersion?: string;
|
|
1282
|
+
RequirementsS3ObjectVersion?: string | undefined;
|
|
1283
1283
|
/**
|
|
1284
1284
|
* <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p>
|
|
1285
1285
|
* <p>
|
|
@@ -1289,7 +1289,7 @@ export interface UpdateEnvironmentInput {
|
|
|
1289
1289
|
* </p>
|
|
1290
1290
|
* @public
|
|
1291
1291
|
*/
|
|
1292
|
-
StartupScriptS3Path?: string;
|
|
1292
|
+
StartupScriptS3Path?: string | undefined;
|
|
1293
1293
|
/**
|
|
1294
1294
|
* <p>
|
|
1295
1295
|
* The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file
|
|
@@ -1306,52 +1306,52 @@ export interface UpdateEnvironmentInput {
|
|
|
1306
1306
|
* </p>
|
|
1307
1307
|
* @public
|
|
1308
1308
|
*/
|
|
1309
|
-
StartupScriptS3ObjectVersion?: string;
|
|
1309
|
+
StartupScriptS3ObjectVersion?: string | undefined;
|
|
1310
1310
|
/**
|
|
1311
1311
|
* <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
|
|
1312
1312
|
* @public
|
|
1313
1313
|
*/
|
|
1314
|
-
AirflowConfigurationOptions?: Record<string, string
|
|
1314
|
+
AirflowConfigurationOptions?: Record<string, string> | undefined;
|
|
1315
1315
|
/**
|
|
1316
1316
|
* <p>The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
|
|
1317
1317
|
* @public
|
|
1318
1318
|
*/
|
|
1319
|
-
EnvironmentClass?: string;
|
|
1319
|
+
EnvironmentClass?: string | undefined;
|
|
1320
1320
|
/**
|
|
1321
1321
|
* <p>The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. For example, <code>20</code>. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in <code>MinWorkers</code>.</p>
|
|
1322
1322
|
* @public
|
|
1323
1323
|
*/
|
|
1324
|
-
MaxWorkers?: number;
|
|
1324
|
+
MaxWorkers?: number | undefined;
|
|
1325
1325
|
/**
|
|
1326
1326
|
* <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
|
|
1327
1327
|
* @public
|
|
1328
1328
|
*/
|
|
1329
|
-
NetworkConfiguration?: UpdateNetworkConfigurationInput;
|
|
1329
|
+
NetworkConfiguration?: UpdateNetworkConfigurationInput | undefined;
|
|
1330
1330
|
/**
|
|
1331
1331
|
* <p>The Apache Airflow log types to send to CloudWatch Logs.</p>
|
|
1332
1332
|
* @public
|
|
1333
1333
|
*/
|
|
1334
|
-
LoggingConfiguration?: LoggingConfigurationInput;
|
|
1334
|
+
LoggingConfiguration?: LoggingConfigurationInput | undefined;
|
|
1335
1335
|
/**
|
|
1336
1336
|
* <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only.</p>
|
|
1337
1337
|
* @public
|
|
1338
1338
|
*/
|
|
1339
|
-
WeeklyMaintenanceWindowStart?: string;
|
|
1339
|
+
WeeklyMaintenanceWindowStart?: string | undefined;
|
|
1340
1340
|
/**
|
|
1341
1341
|
* <p>The Apache Airflow <i>Web server</i> access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p>
|
|
1342
1342
|
* @public
|
|
1343
1343
|
*/
|
|
1344
|
-
WebserverAccessMode?: WebserverAccessMode;
|
|
1344
|
+
WebserverAccessMode?: WebserverAccessMode | undefined;
|
|
1345
1345
|
/**
|
|
1346
1346
|
* <p>The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the <code>MinWorkers</code> field. For example, <code>2</code>.</p>
|
|
1347
1347
|
* @public
|
|
1348
1348
|
*/
|
|
1349
|
-
MinWorkers?: number;
|
|
1349
|
+
MinWorkers?: number | undefined;
|
|
1350
1350
|
/**
|
|
1351
1351
|
* <p>The number of Apache Airflow schedulers to run in your Amazon MWAA environment.</p>
|
|
1352
1352
|
* @public
|
|
1353
1353
|
*/
|
|
1354
|
-
Schedulers?: number;
|
|
1354
|
+
Schedulers?: number | undefined;
|
|
1355
1355
|
/**
|
|
1356
1356
|
* <p>
|
|
1357
1357
|
* The minimum number of web servers that you want to run in your environment.
|
|
@@ -1363,7 +1363,7 @@ export interface UpdateEnvironmentInput {
|
|
|
1363
1363
|
* <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>
|
|
1364
1364
|
* @public
|
|
1365
1365
|
*/
|
|
1366
|
-
MinWebservers?: number;
|
|
1366
|
+
MinWebservers?: number | undefined;
|
|
1367
1367
|
/**
|
|
1368
1368
|
* <p>
|
|
1369
1369
|
* The maximum number of web servers that you want to run in your environment.
|
|
@@ -1376,7 +1376,7 @@ export interface UpdateEnvironmentInput {
|
|
|
1376
1376
|
* <p>Valid values: Accepts between <code>2</code> and <code>5</code>. Defaults to <code>2</code>.</p>
|
|
1377
1377
|
* @public
|
|
1378
1378
|
*/
|
|
1379
|
-
MaxWebservers?: number;
|
|
1379
|
+
MaxWebservers?: number | undefined;
|
|
1380
1380
|
}
|
|
1381
1381
|
/**
|
|
1382
1382
|
* @public
|
|
@@ -1386,7 +1386,7 @@ export interface UpdateEnvironmentOutput {
|
|
|
1386
1386
|
* <p>The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, <code>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</code>.</p>
|
|
1387
1387
|
* @public
|
|
1388
1388
|
*/
|
|
1389
|
-
Arn?: string;
|
|
1389
|
+
Arn?: string | undefined;
|
|
1390
1390
|
}
|
|
1391
1391
|
/**
|
|
1392
1392
|
* @internal
|