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

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

Servers

https://amplify.{region}.amazonaws.com
https://amplify.{region}.amazonaws.com.cn

Path parameters

Name	Type	Required	Description
`branchName`	String	Yes	The branch name for the job.
`appId`	String	Yes	The unique ID for an Amplify app.

Request headers

Name	Type	Required	Description
`X-Amz-Content-Sha256`	String	No
`X-Amz-Credential`	String	No
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`X-Amz-Date`	String	No
`X-Amz-Algorithm`	String	No
`X-Amz-SignedHeaders`	String	No
`X-Amz-Security-Token`	String	No
`X-Amz-Signature`	String	No

Request body fields

Name	Type	Required	Description
`commitMessage`	String	No	The commit message from a third-party repository provider for the job.
`jobReason`	String	No	A descriptive reason for starting this job.
`jobId`	String	No	The unique ID for an existing job. This is required if the value of `jobType` is `RETRY`.
`jobType`	String	Yes	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. Valid values: `"WEB_HOOK"` `"RETRY"` `"RELEASE"` `"MANUAL"`
`commitTime`	String	No	The commit date and time for the job.
`commitId`	String	No	The commit ID from a third-party repository provider for the job.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.