Backend appId Api backendEnvironmentName GetModels - AWS 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

Gets a model introspection schema for an existing backend API resource.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

Responses
Status codeResponse modelDescription
200GetBackendAPIModelsResponse

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

backendEnvironmentNameStringTrue

The name of the backend environment.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "resourceName": "string" }

Response bodies

{ "models": "string", "modelIntrospectionSchema": "string", "status": enum }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BackendAPICodegenReqObj

The request object for this operation.

PropertyTypeRequiredDescription
resourceName

string

True

The name of this resource.

BadRequestException

An error returned if a request is not formed properly.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

GetBackendAPIModelsResponse

The response object for this operation.

PropertyTypeRequiredDescription
modelIntrospectionSchema

string

False

Stringified JSON of the model introspection schema for an existing backend API resource.

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.

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:

GetBackendAPIModels