Client

mwaa	R Documentation

AmazonMWAA¶

Description¶

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.
- create_environment
- delete_environment
- get_environment
- list_environments
- list_tags_for_resource
- tag_resource
- untag_resource
- update_environment
⁠env.airflow.{region}.amazonaws.com⁠ - This endpoint is used to operate the Airflow environment.
- create_cli_token
- create_web_login_token

Regions

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

Usage¶

mwaa(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- mwaa(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_cli_token: Creates a CLI token for the Airflow CLI
create_environment: Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment
create_web_login_token: Creates a web login token for the Airflow Web UI
delete_environment: Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment
get_environment: Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment
list_environments: Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments
list_tags_for_resource: Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment
publish_metrics: Internal only
tag_resource: Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment
untag_resource: Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment
update_environment: Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment

Examples¶

## Not run: 
svc <- mwaa()
svc$create_cli_token(
  Foo = 123
)

## End(Not run)