Skip to content

remove_all_backends

remove_all_backends(
    app_id: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    clean_amplify_app: Optional[__boolean] = None,
) -> RemoveAllBackendsResponse

Removes all backend environments from your Amplify project.

Parameters:

  • app_id (__string) –

    The app ID.

  • 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/amplify_backend.py
def remove_all_backends(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = 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.
    """

    def _handler(
        req: "OperationRequest[capo_amplifybackend.types.remove_all_backends_request.RemoveAllBackendsRequest]",
    ) -> OperationResponse[
        "capo_amplifybackend.types.remove_all_backends_response.RemoveAllBackendsResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.remove_all_backends

        output, http_response = (
            capo_amplifybackend._operations.amplify_backend.remove_all_backends.remove_all_backends(
                req.options, req.input
            )
        )
        return OperationResponse(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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output