Deletes a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
Parameters:
-
app_id
(AppId)
–
The unique ID of an Amplify app.
-
environment_name
(EnvironmentName)
–
The name of a backend environment of an Amplify app.
Raises:
Source code in docs_src/capo_amplify/_services/async_amplify.py
| async def delete_backend_environment(
self,
app_id: "capo_amplify.types.app_id.AppId",
environment_name: "capo_amplify.types.environment_name.EnvironmentName",
*,
config_overrides: Optional[AsyncAmplifyClientConfig] = None,
) -> "capo_amplify.types.delete_backend_environment_result.DeleteBackendEnvironmentResult":
"""<p>Deletes a backend environment for an Amplify app. </p> <p>This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>
Args:
app_id: <p>The unique ID of an Amplify app. </p>
environment_name: <p>The name of a backend environment of an Amplify app. </p>
Raises:
capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
capo_amplify.errors.dependent_service_failure_exception.DependentServiceFailureException: <p>An operation failed because a dependent service threw an exception. </p>
capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
capo_amplify.errors.not_found_exception.NotFoundException: <p>An entity was not found during an operation. </p>
capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_amplify.types.delete_backend_environment_request.DeleteBackendEnvironmentRequest]",
) -> AsyncOperationResponse[
"capo_amplify.types.delete_backend_environment_result.DeleteBackendEnvironmentResult"
]:
import capo_amplify._operations.amplify.delete_backend_environment
(
output,
http_response,
) = await capo_amplify._operations.amplify.delete_backend_environment.async_delete_backend_environment(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteBackendEnvironment")
)
input_: capo_amplify.types.delete_backend_environment_request.DeleteBackendEnvironmentRequest = {
"app_id": app_id,
"environment_name": environment_name,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|