Skip to content

delete_deployment

delete_deployment(
    id: DeploymentId, *, config_overrides: Optional[ProtonClientConfig] = None
) -> DeleteDeploymentOutput

Delete the deployment.

Parameters:

Raises:

Source code in docs_src/capo_proton/_services/proton.py
def delete_deployment(
    self,
    id: "capo_proton.types.deployment_id.DeploymentId",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
) -> "capo_proton.types.delete_deployment_output.DeleteDeploymentOutput":
    """<p>Delete the deployment.</p>

    Args:
        id: <p>The ID of the deployment to delete.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.delete_deployment_input.DeleteDeploymentInput]",
    ) -> OperationResponse[
        "capo_proton.types.delete_deployment_output.DeleteDeploymentOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.delete_deployment

        output, http_response = (
            capo_proton._operations.aws_proton20200720.delete_deployment.delete_deployment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_proton.types.delete_deployment_output.DeleteDeploymentOutput",
    ) -> dict[str, Any]:
        import capo_proton.types.delete_deployment_output

        return capo_proton.types.delete_deployment_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteDeployment", redact_output=_redact_output),
    )
    input_: capo_proton.types.delete_deployment_input.DeleteDeploymentInput = {
        "id": id
    }

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