Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListCodegenJobs

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

Request Syntax


GET /app/appId/environment/environmentName/codegen-jobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for the Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Required: Yes

environmentName

The name of the backend environment that is a part of the Amplify app.

Required: Yes

maxResults

The maximum number of jobs to retrieve.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to request the next page of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "entities": [ 
      { 
         "appId": "string",
         "createdAt": "string",
         "environmentName": "string",
         "id": "string",
         "modifiedAt": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

entities

The list of code generation jobs for the Amplify app.

Type: Array of CodegenJobSummary objects

nextToken

The pagination token that's included if more results are available.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

InvalidParameterException

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429