POST /apps/{appId}/branches
Creates a new branch for an Amplify app.
Servers
- https://amplify.{region}.amazonaws.com
- https://amplify.{region}.amazonaws.com.cn
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
buildSpec |
String | No |
The build specification (build spec) file for an Amplify app build. |
ttl |
String | No |
The content Time to Live (TTL) for the website in seconds. |
pullRequestEnvironmentName |
String | No |
The Amplify environment name for the pull request. |
description |
String | No |
The description for the branch. |
branchName |
String | Yes |
The name for the branch. |
enableAutoBuild |
Boolean | No |
Enables auto building for the branch. |
displayName |
String | No |
The display name for a branch. This is used as the default domain prefix. |
environmentVariables |
Object | No |
The environment variables for the branch. |
enablePullRequestPreview |
Boolean | No |
Enables pull request previews for this branch. |
enablePerformanceMode |
Boolean | No |
Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. |
enableBasicAuth |
Boolean | No |
Enables basic authorization for the branch. |
enableNotification |
Boolean | No |
Enables notifications for the branch. |
tags |
Object | No |
The tag for the branch. |
stage |
String | No |
Describes the current stage for the branch. Valid values:
|
basicAuthCredentials |
String | No |
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format |
backendEnvironmentArn |
String | No |
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. |
framework |
String | No |
The framework for the branch. |
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.