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

StartJob

Starts a new job for a branch of an Amplify app.

Request Syntax


POST /apps/appId/branches/branchName/jobs HTTP/1.1
Content-type: application/json

{
   "commitId": "string",
   "commitMessage": "string",
   "commitTime": number,
   "jobId": "string",
   "jobReason": "string",
   "jobType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for an Amplify app.

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

Pattern: d[a-z0-9]+

Required: Yes

branchName

The name of the branch to use for the job.

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

Pattern: (?s).+

Required: Yes

Request Body

The request accepts the following data in JSON format.

commitId

The commit ID from a third-party repository provider for the job.

Type: String

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: No

commitMessage

The commit message from a third-party repository provider for the job.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

commitTime

The commit date and time for the job.

Type: Timestamp

Required: No

jobId

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Type: String

Length Constraints: Maximum length of 255.

Pattern: [0-9]+

Required: No

jobReason

A descriptive reason for starting the job.

Type: String

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: No

jobType

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Type: String

Length Constraints: Maximum length of 10.

Valid Values: RELEASE | RETRY | MANUAL | WEB_HOOK

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobSummary": { 
      "commitId": "string",
      "commitMessage": "string",
      "commitTime": number,
      "endTime": number,
      "jobArn": "string",
      "jobId": "string",
      "jobType": "string",
      "sourceUrl": "string",
      "sourceUrlType": "string",
      "startTime": number,
      "status": "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.

jobSummary

The summary for the job.

Type: JobSummary object

Errors

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

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

LimitExceededException

A resource could not be created because service quotas were exceeded.

HTTP Status Code: 429

NotFoundException

An entity was not found during an operation.

HTTP Status Code: 404

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401