update_environment ¶

def update_environment(
    self,
    application_id: "capo_appconfig.types.name.Name",
    environment_id: "capo_appconfig.types.name.Name",
    *,
    config_overrides: Optional[AppConfigClientConfig] = None,
    name: Optional["capo_appconfig.types.name.Name"] = None,
    description: Optional["capo_appconfig.types.description.Description"] = None,
    monitors: Optional["capo_appconfig.types.monitor_list.MonitorList"] = None,
) -> "capo_appconfig.types.environment.Environment":
    """<p>Updates an environment.</p>

    Args:
        application_id: <p>The application ID.</p>
        environment_id: <p>The environment ID.</p>
        name: <p>The name of the environment.</p>
        description: <p>A description of the environment.</p>
        monitors: <p>Amazon CloudWatch alarms to monitor during the deployment process.</p>

    Raises:
        capo_appconfig.errors.bad_request_exception.BadRequestException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_appconfig.errors.internal_server_exception.InternalServerException: <p>There was an internal failure in the AppConfig service.</p>
        capo_appconfig.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_appconfig.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update an environment
        The following update-environment example updates an environment's description.

        >>> client.update_environment(application_id='339ohji', environment_id='54j1r29', description='An environment for examples.')
    """

    def _handler(
        req: "OperationRequest[capo_appconfig.types.update_environment_request.UpdateEnvironmentRequest]",
    ) -> OperationResponse["capo_appconfig.types.environment.Environment"]:
        import capo_appconfig._operations.amazon_app_config.update_environment

        output, http_response = (
            capo_appconfig._operations.amazon_app_config.update_environment.update_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEnvironment")
    )
    input_: capo_appconfig.types.update_environment_request.UpdateEnvironmentRequest = {
        "application_id": application_id,
        "environment_id": environment_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if monitors is not None:
        input_["monitors"] = monitors

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