ListBranches - AWS Amplify

ListBranches

Lists the branches of an Amplify app.

Request Syntax

GET /apps/appId/branches?maxResults=maxResults&nextToken=nextToken HTTP/1.1

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

maxResults

The maximum number of records to list in a single response.

Valid Range: Minimum value of 0. Maximum value of 100.

nextToken

A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "branches": [ { "activeJobId": "string", "associatedResources": [ "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 } ], "nextToken": "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.

branches

A list of branches for an Amplify app.

Type: Array of Branch objects

Array Members: Maximum number of 255 items.

nextToken

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Type: String

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

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

UnauthorizedException

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: