Backend - Amplify Admin UI

Backend

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 using the Amplify Admin UI for your app.

URI

/prod/backend

HTTP methods

POST

Operation ID: CreateBackend

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Responses
Status code Response model Description
200 CreateBackendRespObj

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.

Responses
Status code Response model Description
200 None

200 response

Schemas

Request bodies

{ "resourceConfig": { }, "appName": "string", "appId": "string", "resourceName": "string", "backendEnvironmentName": "string" }

Response bodies

{ "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "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.

CreateBackendReqObj

The request object for this operation.

Property Type Required Description
resourceConfig

object

False

The resource configuration for the create backend request.

appName

string

True

The name of the app.

appId

string

True

The app ID.

resourceName

string

False

The name of the resource.

backendEnvironmentName

string

True

The name of the backend environment.

CreateBackendRespObj

The response object sent when a backend is created.

Property Type Required Description
jobId

string

False

The ID for the job.

appId

string

True

The app ID.

error

string

False

If the request fails, this error is returned.

operation

string

False

The name of the operation.

backendEnvironmentName

string

True

The name of the backend environment.

status

string

False

The current status of the request.

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
message

string

False

An error message to inform that the request has 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 has failed.

resourceType

string

False

The type of resource that is not found.

See also

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

CreateBackend