Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437207152.4 KB

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

post/apps/{appId}/branches/{branchName}/jobs

Path parameters

appIdstring required

The unique ID for an Amplify app.

branchNamestring required

The branch name for the job.

Request body

jobIdstring

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

jobType'RELEASE' | 'RETRY' | 'MANUAL' | 'WEB_HOOK' required

Describes the type for the job. The job type <code>RELEASE</code> 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 <code>RETRY</code> retries an existing job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also required.

jobReasonstring

A descriptive reason for starting this job.

commitIdstring

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

commitMessagestring

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

commitTimestring date-time

The commit date and time for the job.

Response

Success