# 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


#### POST schema
POST

```
{
  "resourceName": "string"
}
```

### Response bodies


#### BackendAPICodegenRespObj schema
BackendAPICodegenRespObj

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

#### BadRequestException schema
BadRequestException

```
{
  "message": "string"
}
```

#### NotFoundException schema
NotFoundException

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

#### LimitExceededException schema
LimitExceededException

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

#### InternalServiceException schema
InternalServiceException

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

### 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 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:

### GenerateBackendAPIModels

+ [AWS Command Line Interface V2](/goto/cli2/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for Python](/goto/boto3/amplifybackend-2020-08-11/GenerateBackendAPIModels)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/amplifybackend-2020-08-11/GenerateBackendAPIModels)