Removes all backend environments from your Amplify project.
Parameters:
-
app_id
(__string)
–
-
clean_amplify_app
(Optional[__boolean], default:
None
)
–
Cleans up the Amplify Console app if this value is set to true.
Raises:
Source code in docs_src/capo_amplifybackend/_services/async_amplify_backend.py
| async def remove_all_backends(
self,
app_id: "capo_amplifybackend.types.__string.__string",
*,
config_overrides: Optional[AsyncAmplifyBackendClientConfig] = None,
clean_amplify_app: Optional[
"capo_amplifybackend.types.__boolean.__boolean"
] = None,
) -> "capo_amplifybackend.types.remove_all_backends_response.RemoveAllBackendsResponse":
"""<p>Removes all backend environments from your Amplify project.</p>
Args:
app_id: <p>The app ID.</p>
clean_amplify_app: <p>Cleans up the Amplify Console app if this value is set to true.</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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_amplifybackend.types.remove_all_backends_request.RemoveAllBackendsRequest]",
) -> AsyncOperationResponse[
"capo_amplifybackend.types.remove_all_backends_response.RemoveAllBackendsResponse"
]:
import capo_amplifybackend._operations.amplify_backend.remove_all_backends
(
output,
http_response,
) = await capo_amplifybackend._operations.amplify_backend.remove_all_backends.async_remove_all_backends(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("RemoveAllBackends")
)
input_: capo_amplifybackend.types.remove_all_backends_request.RemoveAllBackendsRequest = {
"app_id": app_id
}
if clean_amplify_app is not None:
input_["clean_amplify_app"] = clean_amplify_app
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|