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 codeResponse modelDescription
200CreateBackendRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Responses
Status codeResponse modelDescription
200None

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.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

CreateBackendReqObj

The request object for this operation.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

appName

string

True

The name of the app.

backendEnvironmentName

string

True

The name of the backend environment.

resourceConfig

object

False

The resource configuration for creating a backend.

resourceName

string

False

The name of the resource.

CreateBackendRespObj

The response object sent when a backend is created.

PropertyTypeRequiredDescription
appId

string

True

The app ID.

backendEnvironmentName

string

True

The name of the backend environment.

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.

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.

See also

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

CreateBackend