File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (430 lines) | stat: -rw-r--r-- 17,598 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Internal only. Represents the dimensions of a metric. To learn more about the
// metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in
// Amazon CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html)
// .
type Dimension struct {

	// Internal only. The name of the dimension.
	//
	// This member is required.
	Name *string

	// Internal only. The value of the dimension.
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

// Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
type Environment struct {

	// A list of key-value pairs containing the Apache Airflow configuration options
	// attached to your environment. For more information, see Apache Airflow
	// configuration options (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html)
	// .
	AirflowConfigurationOptions map[string]string

	// The Apache Airflow version on your environment. Valid values: 1.10.12 , 2.0.2 ,
	// 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 .
	AirflowVersion *string

	// The Amazon Resource Name (ARN) of the Amazon MWAA environment.
	Arn *string

	// The queue ARN for the environment's Celery Executor (https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html)
	// . Amazon MWAA uses a Celery Executor 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.
	CeleryExecutorQueue *string

	// The day and time the environment was created.
	CreatedAt *time.Time

	// The relative path to the DAGs folder in your Amazon S3 bucket. For example,
	// s3://mwaa-environment/dags . For more information, see Adding or updating DAGs (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html)
	// .
	DagS3Path *string

	// The VPC endpoint for the environment's Amazon RDS database.
	DatabaseVpcEndpointService *string

	// Defines whether the VPC endpoints configured for the environment are created,
	// and managed, by the customer or by Amazon MWAA. If set to SERVICE , Amazon MWAA
	// will create and manage the required VPC endpoints in your VPC. If set to
	// CUSTOMER , you must create, and manage, the VPC endpoints in your VPC.
	EndpointManagement EndpointManagement

	// The environment class type. Valid values: mw1.small , mw1.medium , mw1.large .
	// For more information, see Amazon MWAA environment class (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html)
	// .
	EnvironmentClass *string

	// 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,
	// arn:aws:iam::123456789:role/my-execution-role . For more information, see
	// Amazon MWAA Execution role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html)
	// .
	ExecutionRoleArn *string

	// The Amazon Web Services Key Management Service (KMS) encryption key used to
	// encrypt the data in your environment.
	KmsKey *string

	// The status of the last update on the environment.
	LastUpdate *LastUpdate

	// The Apache Airflow logs published to CloudWatch Logs.
	LoggingConfiguration *LoggingConfiguration

	// The maximum number of workers that run in your environment. For example, 20 .
	MaxWorkers *int32

	// The minimum number of workers that run in your environment. For example, 2 .
	MinWorkers *int32

	// The name of the Amazon MWAA environment. For example, MyMWAAEnvironment .
	Name *string

	// 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 About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html)
	// .
	NetworkConfiguration *NetworkConfiguration

	// The version of the plugins.zip file in your Amazon S3 bucket. You must specify
	// the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html)
	// that Amazon S3 assigns to the file. Version IDs are Unicode, UTF-8 encoded,
	// URL-ready, opaque strings that are no more than 1,024 bytes long. The following
	// is an example: 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
	// For more information, see Installing custom plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html)
	// .
	PluginsS3ObjectVersion *string

	// The relative path to the file in your Amazon S3 bucket. For example,
	// s3://mwaa-environment/plugins.zip . For more information, see Installing custom
	// plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html)
	// .
	PluginsS3Path *string

	// The version of the requirements.txt  file on your Amazon S3 bucket. You must
	// specify the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html)
	// that Amazon S3 assigns to the file. Version IDs are Unicode, UTF-8 encoded,
	// URL-ready, opaque strings that are no more than 1,024 bytes long. The following
	// is an example: 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
	// For more information, see Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html)
	// .
	RequirementsS3ObjectVersion *string

	// The relative path to the requirements.txt file in your Amazon S3 bucket. For
	// example, s3://mwaa-environment/requirements.txt . For more information, see
	// Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html)
	// .
	RequirementsS3Path *string

	// The number of Apache Airflow schedulers that run in your Amazon MWAA
	// environment.
	Schedulers *int32

	// The Amazon Resource Name (ARN) for the service-linked role of the environment.
	// For more information, see Amazon MWAA Service-linked role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html)
	// .
	ServiceRoleArn *string

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and
	// supporting files are stored. For example,
	// arn:aws:s3:::my-airflow-bucket-unique-name . For more information, see Create
	// an Amazon S3 bucket for Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html)
	// .
	SourceBucketArn *string

	// The version of the startup shell script in your Amazon S3 bucket. You must
	// specify the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html)
	// that Amazon S3 assigns to the file. Version IDs are Unicode, UTF-8 encoded,
	// URL-ready, opaque strings that are no more than 1,024 bytes long. The following
	// is an example: 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
	// For more information, see Using a startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html)
	// .
	StartupScriptS3ObjectVersion *string

	// The relative path to the startup shell script in your Amazon S3 bucket. For
	// example, s3://mwaa-environment/startup.sh . Amazon MWAA runs the script as your
	// environment starts, and before running the Apache Airflow process. You can use
	// this script to install dependencies, modify Apache Airflow configuration
	// options, and set environment variables. For more information, see Using a
	// startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html)
	// .
	StartupScriptS3Path *string

	// The status of the Amazon MWAA environment. Valid values:
	//   - CREATING - Indicates the request to create the environment is in progress.
	//   - CREATING_SNAPSHOT - Indicates the request to update environment details, or
	//   upgrade the environment version, is in progress and Amazon MWAA is creating a
	//   storage volume snapshot of the Amazon RDS database cluster associated with the
	//   environment. A database snapshot is a backup created at a specific point in
	//   time. Amazon MWAA uses snapshots to recover environment metadata if the process
	//   to update or upgrade an environment fails.
	//   - CREATE_FAILED - Indicates the request to create the environment failed, and
	//   the environment could not be created.
	//   - AVAILABLE - Indicates the request was successful and the environment is
	//   ready to use.
	//   - PENDING - Indicates the request was successful, but the process to create
	//   the environment is paused until you create the required VPC endpoints in your
	//   VPC. After you create the VPC endpoints, the process resumes.
	//   - UPDATING - Indicates the request to update the environment is in progress.
	//   - ROLLING_BACK - Indicates the request to update environment details, or
	//   upgrade the environment version, failed and Amazon MWAA is restoring the
	//   environment using the latest storage volume snapshot.
	//   - DELETING - Indicates the request to delete the environment is in progress.
	//   - DELETED - Indicates the request to delete the environment is complete, and
	//   the environment has been deleted.
	//   - UNAVAILABLE - Indicates the request failed, but the environment was unable
	//   to rollback and is not in a stable state.
	//   - UPDATE_FAILED - Indicates the request to update the environment failed, and
	//   the environment has rolled back successfully and is ready to use.
	// We recommend reviewing our troubleshooting guide for a list of common errors
	// and their solutions. For more information, see Amazon MWAA troubleshooting (https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html)
	// .
	Status EnvironmentStatus

	// The key-value tag pairs associated to your environment. For example,
	// "Environment": "Staging" . For more information, see Tagging Amazon Web
	// Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags map[string]string

	// The Apache Airflow web server access mode. For more information, see Apache
	// Airflow access modes (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html)
	// .
	WebserverAccessMode WebserverAccessMode

	// The Apache Airflow Web server host name for the Amazon MWAA environment. For
	// more information, see Accessing the Apache Airflow UI (https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html)
	// .
	WebserverUrl *string

	// The VPC endpoint for the environment's web server.
	WebserverVpcEndpointService *string

	// The day and time of the week in Coordinated Universal Time (UTC) 24-hour
	// standard time that weekly maintenance updates are scheduled. For example:
	// TUE:03:30 .
	WeeklyMaintenanceWindowStart *string

	noSmithyDocumentSerde
}

// Describes the status of the last update on the environment, and any errors that
// were encountered.
type LastUpdate struct {

	// The day and time of the last update on the environment.
	CreatedAt *time.Time

	// The error that was encountered during the last update of the environment.
	Error *UpdateError

	// The source of the last update to the environment. Includes internal processes
	// by Amazon MWAA, such as an environment maintenance update.
	Source *string

	// The status of the last update on the environment.
	Status UpdateStatus

	noSmithyDocumentSerde
}

// Describes the Apache Airflow log types that are published to CloudWatch Logs.
type LoggingConfiguration struct {

	// The Airflow DAG processing logs published to CloudWatch Logs and the log level.
	DagProcessingLogs *ModuleLoggingConfiguration

	// The Airflow scheduler logs published to CloudWatch Logs and the log level.
	SchedulerLogs *ModuleLoggingConfiguration

	// The Airflow task logs published to CloudWatch Logs and the log level.
	TaskLogs *ModuleLoggingConfiguration

	// The Airflow web server logs published to CloudWatch Logs and the log level.
	WebserverLogs *ModuleLoggingConfiguration

	// The Airflow worker logs published to CloudWatch Logs and the log level.
	WorkerLogs *ModuleLoggingConfiguration

	noSmithyDocumentSerde
}

// Defines the Apache Airflow log types to send to CloudWatch Logs.
type LoggingConfigurationInput struct {

	// Publishes Airflow DAG processing logs to CloudWatch Logs.
	DagProcessingLogs *ModuleLoggingConfigurationInput

	// Publishes Airflow scheduler logs to CloudWatch Logs.
	SchedulerLogs *ModuleLoggingConfigurationInput

	// Publishes Airflow task logs to CloudWatch Logs.
	TaskLogs *ModuleLoggingConfigurationInput

	// Publishes Airflow web server logs to CloudWatch Logs.
	WebserverLogs *ModuleLoggingConfigurationInput

	// Publishes Airflow worker logs to CloudWatch Logs.
	WorkerLogs *ModuleLoggingConfigurationInput

	noSmithyDocumentSerde
}

// Internal only. Collects Apache Airflow metrics. To learn more about the metrics
// published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon
// CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html) .
type MetricDatum struct {

	// Internal only. The name of the metric.
	//
	// This member is required.
	MetricName *string

	// Internal only. The time the metric data was received.
	//
	// This member is required.
	Timestamp *time.Time

	// Internal only. The dimensions associated with the metric.
	//
	// Deprecated: This type is for internal use and not meant for public use. Data
	// set for this type will be ignored.
	Dimensions []Dimension

	// Internal only. The statistical values for the metric.
	//
	// Deprecated: This type is for internal use and not meant for public use. Data
	// set for this type will be ignored.
	StatisticValues *StatisticSet

	// Internal only. The unit used to store the metric.
	Unit Unit

	// Internal only. The value for the metric.
	Value *float64

	noSmithyDocumentSerde
}

// Describes the Apache Airflow log details for the log type (e.g.
// DagProcessingLogs ).
type ModuleLoggingConfiguration struct {

	// The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache
	// Airflow log type (e.g. DagProcessingLogs ) is published. For example,
	// arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*
	// .
	CloudWatchLogGroupArn *string

	// Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is
	// enabled.
	Enabled *bool

	// The Apache Airflow log level for the log type (e.g. DagProcessingLogs ).
	LogLevel LoggingLevel

	noSmithyDocumentSerde
}

// Enables the Apache Airflow log type (e.g. DagProcessingLogs ) and defines the
// log level to send to CloudWatch Logs (e.g. INFO ).
type ModuleLoggingConfigurationInput struct {

	// Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs
	// ).
	//
	// This member is required.
	Enabled *bool

	// Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs.
	//
	// This member is required.
	LogLevel LoggingLevel

	noSmithyDocumentSerde
}

// 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 About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html)
// .
type NetworkConfiguration struct {

	// A list of security group IDs. For more information, see Security in your VPC on
	// Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html)
	// .
	SecurityGroupIds []string

	// A list of subnet IDs. For more information, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html)
	// .
	SubnetIds []string

	noSmithyDocumentSerde
}

// Internal only. Represents a set of statistics that describe a specific metric.
// To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA
// performance metrics in Amazon CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html)
// .
type StatisticSet struct {

	// Internal only. The maximum value of the sample set.
	Maximum *float64

	// Internal only. The minimum value of the sample set.
	Minimum *float64

	// Internal only. The number of samples used for the statistic set.
	SampleCount *int32

	// Internal only. The sum of values for the sample set.
	Sum *float64

	noSmithyDocumentSerde
}

// Describes the error(s) encountered with the last update of the environment.
type UpdateError struct {

	// The error code that corresponds to the error with the last update.
	ErrorCode *string

	// The error message that corresponds to the error code.
	ErrorMessage *string

	noSmithyDocumentSerde
}

// Defines the VPC networking components used to secure and enable network traffic
// between the Amazon Web Services resources for your environment. For more
// information, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html)
// .
type UpdateNetworkConfigurationInput struct {

	// A list of security group IDs. A security group must be attached to the same VPC
	// as the subnets. For more information, see Security in your VPC on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html)
	// .
	//
	// This member is required.
	SecurityGroupIds []string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde