Skip to content

delete_deployment_config

delete_deployment_config(
    deployment_config_name: DeploymentConfigName,
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> None

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

Parameters:

  • deployment_config_name (DeploymentConfigName) –

    The name of a deployment configuration associated with the user or Amazon Web Services account.

Raises:

Source code in docs_src/capo_codedeploy/_services/code_deploy.py
def delete_deployment_config(
    self,
    deployment_config_name: "capo_codedeploy.types.deployment_config_name.DeploymentConfigName",
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> None:
    """<p>Deletes a deployment configuration.</p> <note> <p>A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.</p> </note>

    Args:
        deployment_config_name: <p>The name of a deployment configuration associated with the user or Amazon Web Services account.</p>

    Raises:
        capo_codedeploy.errors.deployment_config_in_use_exception.DeploymentConfigInUseException: <p>The deployment configuration is still in use.</p>
        capo_codedeploy.errors.deployment_config_name_required_exception.DeploymentConfigNameRequiredException: <p>The deployment configuration name was not specified.</p>
        capo_codedeploy.errors.invalid_deployment_config_name_exception.InvalidDeploymentConfigNameException: <p>The deployment configuration name was specified in an invalid format.</p>
        capo_codedeploy.errors.invalid_operation_exception.InvalidOperationException: <p>An invalid operation was detected.</p>
        capo_codedeploy.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codedeploy.types.delete_deployment_config_input.DeleteDeploymentConfigInput]",
    ) -> OperationResponse[None]:
        import capo_codedeploy._operations.code_deploy_20141006.delete_deployment_config

        output, http_response = (
            capo_codedeploy._operations.code_deploy_20141006.delete_deployment_config.delete_deployment_config(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDeploymentConfig")
    )
    input_: capo_codedeploy.types.delete_deployment_config_input.DeleteDeploymentConfigInput = {
        "deployment_config_name": deployment_config_name
    }

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