mwaa/aws.sdk.kotlin.services.mwaa/MwaaClient

MwaaClient

Amazon Managed Workflows for Apache Airflow

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.

Regions

For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.

Types

Builder

class Builder : AbstractSdkClientBuilder<MwaaClient.Config, MwaaClient.Config.Builder, MwaaClient>

Companion

object Companion : AbstractAwsSdkClientFactory<MwaaClient.Config, MwaaClient.Config.Builder, MwaaClient, MwaaClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: MwaaClient.Config

MwaaClient's configuration

Functions

createCliToken

abstract suspend fun createCliToken(input: CreateCliTokenRequest): CreateCliTokenResponse

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

createEnvironment

abstract suspend fun createEnvironment(input: CreateEnvironmentRequest): CreateEnvironmentResponse

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

createWebLoginToken

abstract suspend fun createWebLoginToken(input: CreateWebLoginTokenRequest): CreateWebLoginTokenResponse

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

deleteEnvironment

abstract suspend fun deleteEnvironment(input: DeleteEnvironmentRequest): DeleteEnvironmentResponse

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

getEnvironment

abstract suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

listEnvironments

abstract suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest { }): ListEnvironmentsResponse

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

publishMetrics

abstract suspend fun ~~publishMetrics~~(input: PublishMetricsRequest): PublishMetricsResponse

Internal only. Publishes environment health metrics to Amazon CloudWatch.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

updateEnvironment

abstract suspend fun updateEnvironment(input: UpdateEnvironmentRequest): UpdateEnvironmentResponse

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Inherited functions

expect abstract fun close()

createCliToken

inline suspend fun MwaaClient.createCliToken(crossinline block: CreateCliTokenRequest.Builder.() -> Unit): CreateCliTokenResponse

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

createEnvironment

inline suspend fun MwaaClient.createEnvironment(crossinline block: CreateEnvironmentRequest.Builder.() -> Unit): CreateEnvironmentResponse

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

createWebLoginToken

inline suspend fun MwaaClient.createWebLoginToken(crossinline block: CreateWebLoginTokenRequest.Builder.() -> Unit): CreateWebLoginTokenResponse

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

deleteEnvironment

inline suspend fun MwaaClient.deleteEnvironment(crossinline block: DeleteEnvironmentRequest.Builder.() -> Unit): DeleteEnvironmentResponse

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

getEnvironment

inline suspend fun MwaaClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

listEnvironments

inline suspend fun MwaaClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

listEnvironmentsPaginated

fun MwaaClient.listEnvironmentsPaginated(initialRequest: ListEnvironmentsRequest = ListEnvironmentsRequest { }): Flow<ListEnvironmentsResponse>

fun MwaaClient.listEnvironmentsPaginated(block: ListEnvironmentsRequest.Builder.() -> Unit): Flow<ListEnvironmentsResponse>

Paginate over ListEnvironmentsResponse results.

listTagsForResource

inline suspend fun MwaaClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

publishMetrics

inline suspend fun MwaaClient.~~publishMetrics~~(crossinline block: PublishMetricsRequest.Builder.() -> Unit): PublishMetricsResponse

Internal only. Publishes environment health metrics to Amazon CloudWatch.

tagResource

inline suspend fun MwaaClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

untagResource

inline suspend fun MwaaClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

updateEnvironment

inline suspend fun MwaaClient.updateEnvironment(crossinline block: UpdateEnvironmentRequest.Builder.() -> Unit): UpdateEnvironmentResponse

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

withConfig

fun MwaaClient.withConfig(block: MwaaClient.Config.Builder.() -> Unit): MwaaClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.