update_environment async ¶

async def update_environment(
    self,
    name: "capo_mwaa.types.environment_name.EnvironmentName",
    *,
    config_overrides: Optional[AsyncMWAAClientConfig] = None,
    execution_role_arn: Optional["capo_mwaa.types.iam_role_arn.IamRoleArn"] = None,
    airflow_configuration_options: Optional[
        "capo_mwaa.types.airflow_configuration_options.AirflowConfigurationOptions"
    ] = None,
    airflow_version: Optional[
        "capo_mwaa.types.airflow_version.AirflowVersion"
    ] = None,
    dag_s3_path: Optional["capo_mwaa.types.relative_path.RelativePath"] = None,
    environment_class: Optional[
        "capo_mwaa.types.environment_class.EnvironmentClass"
    ] = None,
    logging_configuration: Optional[
        "capo_mwaa.types.logging_configuration_input.LoggingConfigurationInput"
    ] = None,
    max_workers: Optional["capo_mwaa.types.max_workers.MaxWorkers"] = None,
    min_workers: Optional["capo_mwaa.types.min_workers.MinWorkers"] = None,
    max_webservers: Optional["capo_mwaa.types.max_webservers.MaxWebservers"] = None,
    min_webservers: Optional["capo_mwaa.types.min_webservers.MinWebservers"] = None,
    worker_replacement_strategy: Optional[
        "capo_mwaa.types.worker_replacement_strategy.WorkerReplacementStrategy"
    ] = None,
    network_configuration: Optional[
        "capo_mwaa.types.update_network_configuration_input.UpdateNetworkConfigurationInput"
    ] = None,
    plugins_s3_path: Optional["capo_mwaa.types.relative_path.RelativePath"] = None,
    plugins_s3_object_version: Optional[
        "capo_mwaa.types.s3_object_version.S3ObjectVersion"
    ] = None,
    requirements_s3_path: Optional[
        "capo_mwaa.types.relative_path.RelativePath"
    ] = None,
    requirements_s3_object_version: Optional[
        "capo_mwaa.types.s3_object_version.S3ObjectVersion"
    ] = None,
    schedulers: Optional["capo_mwaa.types.schedulers.Schedulers"] = None,
    source_bucket_arn: Optional["capo_mwaa.types.s3_bucket_arn.S3BucketArn"] = None,
    startup_script_s3_path: Optional[
        "capo_mwaa.types.relative_path.RelativePath"
    ] = None,
    startup_script_s3_object_version: Optional[
        "capo_mwaa.types.s3_object_version.S3ObjectVersion"
    ] = None,
    webserver_access_mode: Optional[
        "capo_mwaa.types.webserver_access_mode.WebserverAccessMode"
    ] = None,
    weekly_maintenance_window_start: Optional[
        "capo_mwaa.types.weekly_maintenance_window_start.WeeklyMaintenanceWindowStart"
    ] = None,
) -> "capo_mwaa.types.update_environment_output.UpdateEnvironmentOutput":
    """<p>Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.</p>

    Args:
        name: <p>The name of your Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>
        execution_role_arn: <p>The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
        airflow_configuration_options: <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
        airflow_version: <p>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA. To downgrade your environment, specify an older version of Apache Airflow supported by Amazon MWAA.</p> <p>Before you upgrade or downgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html">Upgrading and downgrading an Amazon MWAA environment</a>.</p> <p>Valid values: <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, <code>2.10.3</code>, <code>2.11.0</code>, and <code>3.0.6</code>.</p>
        dag_s3_path: <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
        environment_class: <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>. </p>
        logging_configuration: <p>The Apache Airflow log types to send to CloudWatch Logs.</p>
        max_workers: <p>The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. For example, <code>20</code>. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in <code>MinWorkers</code>.</p>
        min_workers: <p>The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the <code>MinWorkers</code> field. For example, <code>2</code>.</p>
        max_webservers: <p> The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in <code>MaxWebserers</code>. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
        min_webservers: <p> The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
        worker_replacement_strategy: <p>The worker replacement strategy to use when updating the environment.</p> <p>You can select one of the following strategies:</p> <ul> <li> <p> <b>Forced -</b> Stops and replaces Apache Airflow workers without waiting for tasks to complete before an update.</p> </li> <li> <p> <b>Graceful -</b> Allows Apache Airflow workers to complete running tasks for up to 12 hours during an update before they're stopped and replaced.</p> </li> </ul>
        network_configuration: <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
        plugins_s3_path: <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
        plugins_s3_object_version: <p>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <code>plugins.zip</code> file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
        requirements_s3_path: <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
        requirements_s3_object_version: <p>The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <code>requirements.txt</code> file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
        schedulers: <p>The number of Apache Airflow schedulers to run in your Amazon MWAA environment.</p>
        source_bucket_arn: <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
        startup_script_s3_path: <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p> <p> Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
        startup_script_s3_object_version: <p> The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </p> <p> Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p> For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
        webserver_access_mode: <p>The Apache Airflow <i>Web server</i> access mode. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p> <p>If set to <code>PUBLIC_AND_PRIVATE</code>, creates both a public network load balancer (NLB) for browser access and a private VPC endpoint (VPCE) for worker-to-webserver communication. This mode is only available for Apache Airflow version 3.2 and later.</p>
        weekly_maintenance_window_start: <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only.</p>

    Raises:
        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.service_unavailable_exception.ServiceUnavailableException: <p>ServiceUnavailableException: The service is currently unavailable.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mwaa.types.update_environment_input.UpdateEnvironmentInput]",
    ) -> AsyncOperationResponse[
        "capo_mwaa.types.update_environment_output.UpdateEnvironmentOutput"
    ]:
        import capo_mwaa._operations.amazon_mwaa.update_environment

        (
            output,
            http_response,
        ) = await capo_mwaa._operations.amazon_mwaa.update_environment.async_update_environment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mwaa.types.update_environment_input.UpdateEnvironmentInput",
    ) -> dict[str, Any]:
        import capo_mwaa.types.update_environment_input

        return capo_mwaa.types.update_environment_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateEnvironment", redact_input=_redact_input),
    )
    input_: capo_mwaa.types.update_environment_input.UpdateEnvironmentInput = {
        "name": name
    }
    if execution_role_arn is not None:
        input_["execution_role_arn"] = execution_role_arn
    if airflow_configuration_options is not None:
        input_["airflow_configuration_options"] = airflow_configuration_options
    if airflow_version is not None:
        input_["airflow_version"] = airflow_version
    if dag_s3_path is not None:
        input_["dag_s3_path"] = dag_s3_path
    if environment_class is not None:
        input_["environment_class"] = environment_class
    if logging_configuration is not None:
        input_["logging_configuration"] = logging_configuration
    if max_workers is not None:
        input_["max_workers"] = max_workers
    if min_workers is not None:
        input_["min_workers"] = min_workers
    if max_webservers is not None:
        input_["max_webservers"] = max_webservers
    if min_webservers is not None:
        input_["min_webservers"] = min_webservers
    if worker_replacement_strategy is not None:
        input_["worker_replacement_strategy"] = worker_replacement_strategy
    if network_configuration is not None:
        input_["network_configuration"] = network_configuration
    if plugins_s3_path is not None:
        input_["plugins_s3_path"] = plugins_s3_path
    if plugins_s3_object_version is not None:
        input_["plugins_s3_object_version"] = plugins_s3_object_version
    if requirements_s3_path is not None:
        input_["requirements_s3_path"] = requirements_s3_path
    if requirements_s3_object_version is not None:
        input_["requirements_s3_object_version"] = requirements_s3_object_version
    if schedulers is not None:
        input_["schedulers"] = schedulers
    if source_bucket_arn is not None:
        input_["source_bucket_arn"] = source_bucket_arn
    if startup_script_s3_path is not None:
        input_["startup_script_s3_path"] = startup_script_s3_path
    if startup_script_s3_object_version is not None:
        input_["startup_script_s3_object_version"] = (
            startup_script_s3_object_version
        )
    if webserver_access_mode is not None:
        input_["webserver_access_mode"] = webserver_access_mode
    if weekly_maintenance_window_start is not None:
        input_["weekly_maintenance_window_start"] = weekly_maintenance_window_start

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output