Removes an existing environment from your Amplify project.
Parameters:
-
app_id
(__string)
–
-
backend_environment_name
(__string)
–
The name of the backend environment.
Raises:
Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py
| def delete_backend(
self,
app_id: "capo_amplifybackend.types.__string.__string",
backend_environment_name: "capo_amplifybackend.types.__string.__string",
*,
config_overrides: Optional[AmplifyBackendClientConfig] = None,
) -> "capo_amplifybackend.types.delete_backend_response.DeleteBackendResponse":
"""<p>Removes an existing environment from your Amplify project.</p>
Args:
app_id: <p>The app ID.</p>
backend_environment_name: <p>The name of the backend environment.</p>
Raises:
capo_amplifybackend.errors.bad_request_exception.BadRequestException: <p>An error returned if a request is not formed properly.</p>
capo_amplifybackend.errors.gateway_timeout_exception.GatewayTimeoutException: <p>An error returned if there's a temporary issue with the service.</p>
capo_amplifybackend.errors.not_found_exception.NotFoundException: <p>An error returned when a specific resource type is not found.</p>
capo_amplifybackend.errors.too_many_requests_exception.TooManyRequestsException: <p>An error that is returned when a limit of a specific type has been exceeded.</p>
capo_amplifybackend.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_amplifybackend.types.delete_backend_request.DeleteBackendRequest]",
) -> OperationResponse[
"capo_amplifybackend.types.delete_backend_response.DeleteBackendResponse"
]:
import capo_amplifybackend._operations.amplify_backend.delete_backend
output, http_response = (
capo_amplifybackend._operations.amplify_backend.delete_backend.delete_backend(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteBackend")
)
input_: capo_amplifybackend.types.delete_backend_request.DeleteBackendRequest = {
"app_id": app_id,
"backend_environment_name": backend_environment_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|