CreateCliToken - Amazon Managed Workflows for Apache Airflow

CreateCliToken

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

Request Syntax

POST /clitoken/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 { "CliToken": "string", "WebServerHostname": "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.

CliToken

An Airflow CLI login token.

Type: String

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])$

Errors

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

ResourceNotFoundException

ResourceNotFoundException: The resource is not available.

HTTP Status Code: 404

See Also

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