StopJob - Amplify


Stops a job that is in progress for a branch of an Amplify app.

Request Syntax

DELETE /apps/appId/branches/branchName/jobs/jobId/stop HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The unique ID for an Amplify app.

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

Pattern: d[a-z0-9]+

Required: Yes


The name of the branch to use for the stop job request.

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

Pattern: (?s).+

Required: Yes


The unique id for the job.

Length Constraints: Maximum length of 255.

Pattern: [0-9]+

Required: Yes

Request Body

The request does not have a request body.

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", "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.


The summary for the job.

Type: JobSummary object


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


A request contains unexpected data.

HTTP Status Code: 400


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

HTTP Status Code: 500


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

HTTP Status Code: 429


An entity was not found during an operation.

HTTP Status Code: 404


An operation failed due to a lack of access.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: