delete_environment_configuration ¶

delete_environment_configuration(
    application_name: ApplicationName,
    environment_name: EnvironmentName,
    *,
    config_overrides: Optional[ElasticBeanstalkClientConfig] = None,
) -> None

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

Parameters:

application_name (ApplicationName) –

The name of the application the environment is associated with.
environment_name (EnvironmentName) –

The name of the environment to delete the draft configuration from.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a draft configuration The following operation deletes a draft configuration for an environment named my-env:

>>> client.delete_environment_configuration(application_name='my-app', environment_name='my-env')

Source code in docs_src/capo_elastic_beanstalk/_services/elastic_beanstalk.py

def delete_environment_configuration(
    self,
    application_name: "capo_elastic_beanstalk.types.application_name.ApplicationName",
    environment_name: "capo_elastic_beanstalk.types.environment_name.EnvironmentName",
    *,
    config_overrides: Optional[ElasticBeanstalkClientConfig] = None,
) -> None:
    """<p>Deletes the draft configuration associated with the running environment.</p> <p>Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.</p>

    Args:
        application_name: <p>The name of the application the environment is associated with.</p>
        environment_name: <p>The name of the environment to delete the draft configuration from.</p>

    Raises:
        capo_elastic_beanstalk.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a draft configuration
        The following operation deletes a draft configuration for an environment named my-env:

        >>> client.delete_environment_configuration(application_name='my-app', environment_name='my-env')
    """

    def _handler(
        req: "OperationRequest[capo_elastic_beanstalk.types.delete_environment_configuration_message.DeleteEnvironmentConfigurationMessage]",
    ) -> OperationResponse[None]:
        import capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.delete_environment_configuration

        output, http_response = (
            capo_elastic_beanstalk._operations.aws_elastic_beanstalk_service.delete_environment_configuration.delete_environment_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteEnvironmentConfiguration")
    )
    input_: capo_elastic_beanstalk.types.delete_environment_configuration_message.DeleteEnvironmentConfigurationMessage = {
        "application_name": application_name,
        "environment_name": environment_name,
    }

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