URI HTTP methods Schemas Properties See also

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 resourceConfig": {
  },
  "appName appName": "string",
  "appId appId": "string",
  "resourceName resourceName": "string",
  "backendEnvironmentName backendEnvironmentName": "string"
}

Response bodies


{
  "jobId jobId": "string",
  "appId appId": "string",
  "error error": "string",
  "operation operation": "string",
  "backendEnvironmentName backendEnvironmentName": "string",
  "status status": "string"
}


{
  "message message": "string"
}


{
  "message message": "string",
  "resourceType resourceType": "string"
}


{
  "message message": "string",
  "limitType limitType": "string"
}


{
  "message 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.

message

An error message to inform that the request failed.

Type: string
Required: False

CreateBackendReqObj

The request object for this operation.

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

resourceConfig

The resource configuration for creating a backend.

Type: object
Required: False

appName

The name of the app.

Type: string
Required: True

appId

The app ID.

Type: string
Required: True

resourceName

The name of the resource.

Type: string
Required: False

backendEnvironmentName

The name of the backend environment.

Type: string
Required: True

CreateBackendRespObj

The response object sent when a backend is created.

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

jobId

The ID for the job.

Type: string
Required: False

appId

The app ID.

Type: string
Required: True

error

If the request fails, this error is returned.

Type: string
Required: False

operation

The name of the operation.

Type: string
Required: False

backendEnvironmentName

The name of the backend environment.

Type: string
Required: True

status

The current status of the request.

Type: string
Required: False

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.

message

An error message to inform that the request failed.

Type: string
Required: False

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.

message

An error message to inform that the request has failed.

Type: string
Required: False

limitType

The type of limit that was exceeded.

Type: string
Required: False

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.

message

An error message to inform that the request has failed.

Type: string
Required: False

resourceType

The type of resource that is not found.

Type: string
Required: False