DeleteBranch - Amplify


Deletes a branch for an Amplify app.

Request Syntax

DELETE /apps/appId/branches/branchName 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.

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

Pattern: (?s).+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "branch": { "activeJobId": "string", "associatedResources": [ "string" ], "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string", "branchName": "string", "buildSpec": "string", "createTime": number, "customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "sourceBranch": "string", "stage": "string", "tags": { "string" : "string" }, "thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string", "updateTime": number } }

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 branch for an Amplify app, which maps to a third-party repository branch.

Type: Branch object


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


A request contains unexpected data.

HTTP Status Code: 400


An operation failed because a dependent service threw an exception.

HTTP Status Code: 503


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

HTTP Status Code: 500


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: