Skip to content

create_web_login_token

create_web_login_token(
    name: EnvironmentName, *, config_overrides: Optional[MWAAClientConfig] = None
) -> CreateWebLoginTokenResponse

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

Parameters:

  • name (EnvironmentName) –

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

Raises:

Source code in docs_src/capo_mwaa/_services/mwaa.py
def create_web_login_token(
    self,
    name: "capo_mwaa.types.environment_name.EnvironmentName",
    *,
    config_overrides: Optional[MWAAClientConfig] = None,
) -> "capo_mwaa.types.create_web_login_token_response.CreateWebLoginTokenResponse":
    """<p>Creates a web login token for the Airflow Web UI. To learn more, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-web.html">Creating an Apache Airflow web login token</a>.</p>

    Args:
        name: <p>The name of the Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>

    Raises:
        capo_mwaa.errors.access_denied_exception.AccessDeniedException: <p>Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/access-policies.html">Accessing an Amazon MWAA environment</a>.</p>
        capo_mwaa.errors.internal_server_exception.InternalServerException: <p>InternalServerException: An internal error has occurred.</p>
        capo_mwaa.errors.resource_not_found_exception.ResourceNotFoundException: <p>ResourceNotFoundException: The resource is not available.</p>
        capo_mwaa.errors.validation_exception.ValidationException: <p>ValidationException: The provided input is not valid.</p>
        capo_mwaa.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mwaa.types.create_web_login_token_request.CreateWebLoginTokenRequest]",
    ) -> OperationResponse[
        "capo_mwaa.types.create_web_login_token_response.CreateWebLoginTokenResponse"
    ]:
        import capo_mwaa._operations.amazon_mwaa.create_web_login_token

        output, http_response = (
            capo_mwaa._operations.amazon_mwaa.create_web_login_token.create_web_login_token(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_mwaa.types.create_web_login_token_response.CreateWebLoginTokenResponse",
    ) -> dict[str, Any]:
        import capo_mwaa.types.create_web_login_token_response

        return capo_mwaa.types.create_web_login_token_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateWebLoginToken", redact_output=_redact_output),
    )
    input_: capo_mwaa.types.create_web_login_token_request.CreateWebLoginTokenRequest = {
        "name": name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output