Backend appId Api backendEnvironmentName GetModels - Amplify Admin UI

Backend appId Api backendEnvironmentName GetModels

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

URI

/prod/backend/appId/api/backendEnvironmentName/getModels

HTTP methods

POST

Operation ID: GetBackendAPIModels

Generates a model schema for 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 GetBackendAPICodegenRespObj

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

{ "models": "string", "status": enum }
{ "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.

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.

GetBackendAPICodegenRespObj

The response object for this operation.

Property Type Required Description
models

string

False

Stringified JSON of the datastore model.

status

string

Values: LATEST | STALE

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
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.

See also

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

GetBackendAPIModels