# Backend appId Job backendEnvironmentName


Jobs perform backend API actions on your behalf based on your choices in the Amplify Admin UI. The actions that the jobs perform depend on the underlying API request sent from the Amplify Admin UI.

This resource is associated with the `ListBackendJobs` operation.

## URI


`/prod/backend/appId/job/backendEnvironmentName`

## HTTP methods


### POST


**Operation ID:** `ListBackendJobs`

Lists the jobs for the backend of an Amplify app.


**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 | ListBackendJobRespObj | 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

```
{
  "jobId": "string",
  "nextToken": "string",
  "maxResults": integer,
  "operation": "string",
  "status": "string"
}
```

### Response bodies


#### ListBackendJobRespObj schema
ListBackendJobRespObj

```
{
  "nextToken": "string",
  "jobs": [
    {
      "jobId": "string",
      "createTime": "string",
      "appId": "string",
      "updateTime": "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


### BackendJobRespObj


The response object for this operation.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| appId | string | True | The app ID. | 
| backendEnvironmentName | string | True | The name of the backend environment. | 
| createTime | string | False | The time when the job was created. | 
| 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. | 
| updateTime | string | False | The time when the job was last updated. | 

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

### ListBackendJobReqObj


The request object for this operation.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| jobId | string | False | The ID for the job. | 
| maxResults | integerFormat: int32Minimum: 1Maximum: 25 | False | The maximum number of results that you want in the response. | 
| nextToken | string | False | The token for the next set of results. | 
| operation | string | False | Filters the list of response objects to include only those with the specified operation name. | 
| status | string | False | Filters the list of response objects to include only those with the specified status. | 

### ListBackendJobRespObj


The returned list of backend jobs.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| jobs | Array of type [BackendJobRespObj](#backend-appid-job-backendenvironmentname-model-backendjobrespobj) | False | An array of jobs and their properties. | 
| nextToken | string | False | The token for the next set of results. | 

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

### ListBackendJobs

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