MWAA
Service object for interacting with AWS MWAA service.
public struct MWAA: AWSService
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.
Endpoints
-
api.airflow.{region}.amazonaws.com
- This endpoint is used for environment management. -
env.airflow.{region}.amazonaws.com
- This endpoint is used to operate the Airflow environment. -
ops.airflow.{region}.amazonaws.com
- This endpoint is used to push environment metrics that track environment health.
Regions
For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the MWAA client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: MWAA, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
createCliToken(_:logger:on:)
public func createCliToken(_ input: CreateCliTokenRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateCliTokenResponse>
Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.
createEnvironment(_:logger:on:)
public func createEnvironment(_ input: CreateEnvironmentInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateEnvironmentOutput>
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
createWebLoginToken(_:logger:on:)
public func createWebLoginToken(_ input: CreateWebLoginTokenRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateWebLoginTokenResponse>
Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.
deleteEnvironment(_:logger:on:)
public func deleteEnvironment(_ input: DeleteEnvironmentInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEnvironmentOutput>
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
getEnvironment(_:logger:on:)
public func getEnvironment(_ input: GetEnvironmentInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetEnvironmentOutput>
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
listEnvironments(_:logger:on:)
public func listEnvironments(_ input: ListEnvironmentsInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListEnvironmentsOutput>
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceOutput>
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging"
.
publishMetrics(_:logger:on:)
public func publishMetrics(_ input: PublishMetricsInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PublishMetricsOutput>
Internal only. Publishes environment health metrics to Amazon CloudWatch.
tagResource(_:logger:on:)
public func tagResource(_ input: TagResourceInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceOutput>
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
untagResource(_:logger:on:)
public func untagResource(_ input: UntagResourceInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceOutput>
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging"
.
updateEnvironment(_:logger:on:)
public func updateEnvironment(_ input: UpdateEnvironmentInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateEnvironmentOutput>
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
listEnvironmentsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listEnvironmentsPaginator( _ input: ListEnvironmentsInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListEnvironmentsInput, ListEnvironmentsOutput>
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listEnvironmentsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listEnvironmentsPaginator<Result>(
_ input: ListEnvironmentsInput,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListEnvironmentsOutput, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listEnvironmentsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listEnvironmentsPaginator(
_ input: ListEnvironmentsInput,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListEnvironmentsOutput, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.