CreateWebLoginToken - Amazon Managed Workflows for Apache Airflow

CreateWebLoginToken

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

Request Syntax

POST /webtoken/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Name

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

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: ^[a-zA-Z][0-9a-zA-Z-_]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "WebServerHostname": "string", "WebToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

WebServerHostname

The Airflow web server hostname for the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$

WebToken

An Airflow web server login token.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

HTTP Status Code: 403

InternalServerException

InternalServerException: An internal error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

ResourceNotFoundException: The resource is not available.

HTTP Status Code: 404

ValidationException

ValidationException: The provided input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: