Backend appId Config Remove
A configuration object that contains the authentication resources required for a user to access the Amplify Admin UI.
URI
/prod/backend/appId/config/remove
HTTP methods
POST
Operation ID: RemoveBackendConfig
Removes the AWS resources required to access the Amplify Admin UI.
| Name | Type | Required | Description | 
|---|---|---|---|
| appId | String | True | The app ID. | 
| Status code | Response model | Description | 
|---|---|---|
| 200 | RemoveBackendConfigRespObj | 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.
| Name | Type | Required | Description | 
|---|---|---|---|
| appId | String | True | The app ID. | 
| Status code | Response model | Description | 
|---|---|---|
| 200 | None | 200 response | 
Schemas
Response bodies
{ "error": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "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 has been exceeded.
| Property | Type | Required | Description | 
|---|---|---|---|
| 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.
| Property | Type | Required | Description | 
|---|---|---|---|
| message | string | False | An error message to inform that the request has failed. | 
| resourceType | string | False | The type of resource that is not found. | 
RemoveBackendConfigRespObj
The response object for this operation.
| Property | Type | Required | Description | 
|---|---|---|---|
| error | string | False | If the request fails, this error is returned. | 
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: