Backend appId Remove - Amplify Admin UI

Backend appId Remove

All Amplify apps have a backend. The backend has settings and configurations for data storage, security, and other important logic that your app's users don't see. The easiest way to manage your Amplify app backend is by using the Amplify Admin UI for your app.

URI

/prod/backend/appId/remove

HTTP methods

POST

Operation ID: RemoveAllBackends

Removes all backend environments from your Amplify project.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

Responses
Status codeResponse modelDescription
200RemoveAllBackendsRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "cleanAmplifyApp": boolean }

Response bodies

{ "jobId": "string", "appId": "string", "error": "string", "operation": "string", "status": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BadRequestException

An error returned if a request is not formed properly.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

InternalServiceException

An error returned if there's a temporary issue with the service.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

LimitExceededException

An error that is returned when a limit of a specific type has been exceeded.

PropertyTypeRequiredDescription
limitType

string

False

The type of limit that was exceeded.

message

string

False

An error message to inform that the request has failed.

NotFoundException

An error returned when a specific resource type is not found.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request has failed.

resourceType

string

False

The type of resource that is not found.

RemoveAllBackendsReqObj

The request object for this operation.

PropertyTypeRequiredDescription
cleanAmplifyApp

boolean

False

Cleans up the Amplify Console app if this value is set to true.

RemoveAllBackendsRespObj

The response object for this operation.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

error

string

False

If the request fails, this error is returned.

jobId

string

False

The ID for the job.

operation

string

False

The name of the operation.

status

string

False

The current status of the request.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

RemoveAllBackends