Backend appId Api backendEnvironmentName GenerateModels - AWS Amplify Admin UI

Backend appId Api backendEnvironmentName GenerateModels

The generated DataStore models for your Amplify app. Web clients can consume these to use the DataStore.

URI

/prod/backend/appId/api/backendEnvironmentName/generateModels

HTTP methods

POST

Operation ID: GenerateBackendAPIModels

Generates a model schema for an existing backend API resource.

Path parameters
Name Type Required Description
appId String True

The app ID.

backendEnvironmentName String True

The name of the backend environment.

Responses
Status code Response model Description
200 BackendAPICodegenRespObj

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.

backendEnvironmentName String True

The name of the backend environment.

Responses
Status code Response model Description
200 None

200 response

Schemas

Request bodies

{ "resourceName": "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

BackendAPICodegenReqObj

The request object for this operation.

Property Type Required Description
resourceName

string

True

The name of this resource.

BackendAPICodegenRespObj

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 failed, this is the returned error.

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.

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.

See also

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

GenerateBackendAPIModels