Backend appId Remove - AWS 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. We recommend managing your Amplify app backend using the Amplify Admin UI.

URI

/prod/backend/appId/remove

HTTP methods

POST

Operation ID: RemoveAllBackends

Removes all backend environments from your Amplify project.

Path parameters
Name Type Required Description
appId String True

The app ID.

Responses
Status code Response model Description
200 RemoveAllBackendsRespObj

200 response

400 BadRequestException

400 response

404 NotFoundException

404 response

429 LimitExceededException

429 response

504 InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
Name Type Required Description
appId String True

The app ID.

Responses
Status code Response model Description
200 None

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.

Property Type Required Description
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.

Property Type Required Description
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 is exceeded.

Property Type Required Description
message

string

False

An error message to inform that the request failed.

limitType

string

False

The type of limit that was exceeded.

NotFoundException

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

Property Type Required Description
message

string

False

An error message to inform that the request failed.

resourceType

string

False

The type of resource that wasn't found.

RemoveAllBackendsReqObj

The request object for this operation.

Property Type Required Description
cleanAmplifyApp

boolean

False

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

RemoveAllBackendsRespObj

The response object for this operation.

Property Type Required Description
jobId

string

False

The ID for the job.

appId

string

True

The app ID.

error

string

False

If the request failed, this is the returned error.

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