MWAA / Client / create_web_login_token

create_web_login_token#

MWAA.Client.create_web_login_token(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_web_login_token(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Return type:

dict

Returns:

Response Syntax

{
    'AirflowIdentity': 'string',
    'IamIdentity': 'string',
    'WebServerHostname': 'string',
    'WebToken': 'string'
}

Response Structure

(dict) –
- AirflowIdentity (string) –
  
  The user name of the Apache Airflow identity creating the web login token.
- IamIdentity (string) –
  
  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, assumed-role/Admin/your-name.
- WebServerHostname (string) –
  
  The Airflow web server hostname for the environment.
- WebToken (string) –
  
  An Airflow web server login token.

Exceptions

MWAA.Client.exceptions.AccessDeniedException
MWAA.Client.exceptions.ResourceNotFoundException
MWAA.Client.exceptions.ValidationException
MWAA.Client.exceptions.InternalServerException