Amazon Amplify Amplify Branches API
The Amplify Branches API from Amazon Amplify — 2 operation(s) for amplify branches.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-amplify:amazon-amplify-branches-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: AWS Amplify Branches API
version: '2017-07-25'
description: Generated from AWS's published Smithy model for AWS Amplify. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://amplify.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/apps/{appId}/branches:
post:
operationId: CreateBranch
summary: Create Branch
description: Creates a new branch for an Amplify app.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBranchResult'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'503':
description: DependentServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/DependentServiceFailureException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'429':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBranchRequest'
tags:
- Branches
get:
operationId: ListBranches
summary: List Branches
description: Lists the branches of an Amplify app.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListBranchesResult'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListBranchesRequest'
tags:
- Branches
/apps/{appId}/branches/{branchName}:
delete:
operationId: DeleteBranch
summary: Delete Branch
description: Deletes a branch for an Amplify app.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteBranchResult'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'503':
description: DependentServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/DependentServiceFailureException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteBranchRequest'
tags:
- Branches
get:
operationId: GetBranch
summary: Get Branch
description: Returns a branch for an Amplify app.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetBranchResult'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetBranchRequest'
tags:
- Branches
post:
operationId: UpdateBranch
summary: Update Branch
description: Updates a branch for an Amplify app.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBranchResult'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'503':
description: DependentServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/DependentServiceFailureException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBranchRequest'
tags:
- Branches
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: amplify
schemas:
Backend:
type: object
properties:
stackArn:
type: string
description: The Amazon Resource Name (ARN) for the CloudFormation stack.
BadRequestException:
type: object
properties:
message:
type: string
Branch:
type: object
properties:
branchArn:
type: string
description: The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName:
type: string
description: The name for the branch that is part of an Amplify app.
description:
type: string
description: The description for the branch that is part of an Amplify app.
tags:
type: object
additionalProperties:
type: string
description: The tag for the branch of an Amplify app.
stage:
type: string
enum:
- PRODUCTION
- BETA
- DEVELOPMENT
- EXPERIMENTAL
- PULL_REQUEST
description: The current stage for the branch that is part of an Amplify app.
displayName:
type: string
description: The display name for the branch. This is used as the default domain prefix.
enableNotification:
type: boolean
description: Enables notifications for a branch that is part of an Amplify app.
createTime:
type: string
format: date-time
description: A timestamp of when Amplify created the branch.
updateTime:
type: string
format: date-time
description: A timestamp for the last updated time for a branch.
environmentVariables:
type: object
additionalProperties:
type: string
description: The environment variables specific to a branch of an Amplify app.
enableAutoBuild:
type: boolean
description: Enables auto-building on push for a branch of an Amplify app.
enableSkewProtection:
type: boolean
description: Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection
is available to Amplify applications to eliminate version skew issues between client and servers in web applications.
When you apply skew protection to a branch, you can ensure that your clients always interact with the correct
version of server-side assets, regardless of when a deployment occurs. For more information about skew protection,
see Skew protection for Amplify deployments in the Amplify User Guide.
customDomains:
type: array
items:
type: string
description: The custom domains for a branch of an Amplify app.
framework:
type: string
description: The framework for a branch of an Amplify app.
activeJobId:
type: string
description: The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs:
type: string
description: The total number of jobs that are part of an Amplify app.
enableBasicAuth:
type: boolean
description: Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode:
type: boolean
description: 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.
thumbnailUrl:
type: string
description: The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials:
type: string
description: The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization
credentials and provide them in the format user:password.
buildSpec:
type: string
description: The build specification (build spec) content for the branch of an Amplify app.
ttl:
type: string
description: The content Time to Live (TTL) for the website in seconds.
associatedResources:
type: array
items:
type: string
description: A list of custom resources that are linked to this branch.
enablePullRequestPreview:
type: boolean
description: Enables pull request previews for the branch.
pullRequestEnvironmentName:
type: string
description: The Amplify environment name for the pull request.
destinationBranch:
type: string
description: The destination branch if the branch is a pull request branch.
sourceBranch:
type: string
description: The source branch if the branch is a pull request branch.
backendEnvironmentArn:
type: string
description: The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. This property
is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the
app's backend infrastructure using Typescript code.
backend:
$ref: '#/components/schemas/Backend'
computeRoleArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows
the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's
permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User
Guide.
required:
- branchArn
- branchName
- description
- stage
- displayName
- enableNotification
- createTime
- updateTime
- environmentVariables
- enableAutoBuild
- customDomains
- framework
- activeJobId
- totalNumberOfJobs
- enableBasicAuth
- ttl
- enablePullRequestPreview
CreateBranchRequest:
type: object
properties:
appId:
type: string
description: The unique ID for an Amplify app.
branchName:
type: string
description: The name for the branch.
description:
type: string
description: The description for the branch.
stage:
type: string
enum:
- PRODUCTION
- BETA
- DEVELOPMENT
- EXPERIMENTAL
- PULL_REQUEST
description: Describes the current stage for the branch.
framework:
type: string
description: The framework for the branch.
enableNotification:
type: boolean
description: Enables notifications for the branch.
enableAutoBuild:
type: boolean
description: Enables auto building for the branch.
enableSkewProtection:
type: boolean
description: Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection
is available to Amplify applications to eliminate version skew issues between client and servers in web applications.
When you apply skew protection to a branch, you can ensure that your clients always interact with the correct
version of server-side assets, regardless of when a deployment occurs. For more information about skew protection,
see Skew protection for Amplify deployments in the Amplify User Guide.
environmentVariables:
type: object
additionalProperties:
type: string
description: The environment variables for the branch.
basicAuthCredentials:
type: string
description: The basic authorization credentials for the branch. You must base64-encode the authorization credentials
and provide them in the format user:password.
enableBasicAuth:
type: boolean
description: Enables basic authorization for the branch.
enablePerformanceMode:
type: boolean
description: 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.
tags:
type: object
additionalProperties:
type: string
description: The tag for the branch.
buildSpec:
type: string
description: The build specification (build spec) for the branch.
ttl:
type: string
description: The content Time To Live (TTL) for the website in seconds.
displayName:
type: string
description: The display name for a branch. This is used as the default domain prefix.
enablePullRequestPreview:
type: boolean
description: Enables pull request previews for this branch.
pullRequestEnvironmentName:
type: string
description: The Amplify environment name for the pull request.
backendEnvironmentArn:
type: string
description: The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This
field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify
command line interface (CLI).
backend:
$ref: '#/components/schemas/Backend'
computeRoleArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute
role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based
on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in
the Amplify User Guide.
required:
- appId
- branchName
CreateBranchResult:
type: object
properties:
branch:
$ref: '#/components/schemas/Branch'
required:
- branch
DeleteBranchRequest:
type: object
properties:
appId:
type: string
description: The unique ID for an Amplify app.
branchName:
type: string
description: The name of the branch.
required:
- appId
- branchName
DeleteBranchResult:
type: object
properties:
branch:
$ref: '#/components/schemas/Branch'
required:
- branch
DependentServiceFailureException:
type: object
properties:
message:
type: string
GetBranchRequest:
type: object
properties:
appId:
type: string
description: The unique ID for an Amplify app.
branchName:
type: string
description: The name of the branch.
required:
- appId
- branchName
GetBranchResult:
type: object
properties:
branch:
$ref: '#/components/schemas/Branch'
required:
- branch
InternalFailureException:
type: object
properties:
message:
type: string
LimitExceededException:
type: object
properties:
message:
type: string
ListBranchesRequest:
type: object
properties:
appId:
type: string
description: The unique ID for an Amplify app.
nextToken:
type: string
description: 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.
maxResults:
type: integer
description: The maximum number of records to list in a single response.
required:
- appId
ListBranchesResult:
type: object
properties:
branches:
type: array
items:
$ref: '#/components/schemas/Branch'
description: A list of branches for an Amplify app.
nextToken:
type: string
description: A pagination token. If a non-null pagination token is returned in a result, pass its value in another
request to retrieve more entries.
required:
- branches
NotFoundException:
type: object
properties:
message:
type: string
UnauthorizedException:
type: object
properties:
message:
type: string
UpdateBranchRequest:
type: object
properties:
appId:
type: string
description: The unique ID for an Amplify app.
branchName:
type: string
description: The name of the branch.
description:
type: string
description: The description for the branch.
framework:
type: string
description: The framework for the branch.
stage:
type: string
enum:
- PRODUCTION
- BETA
- DEVELOPMENT
- EXPERIMENTAL
- PULL_REQUEST
description: Describes the current stage for the branch.
enableNotification:
type: boolean
description: Enables notifications for the branch.
enableAutoBuild:
type: boolean
description: Enables auto building for the branch.
enableSkewProtection:
type: boolean
description: Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection
is available to Amplify applications to eliminate version skew issues between client and servers in web applications.
When you apply skew protection to a branch, you can ensure that your clients always interact with the correct
version of server-side assets, regardless of when a deployment occurs. For more information about skew protection,
see Skew protection for Amplify deployments in the Amplify User Guide.
environmentVariables:
type: object
additionalProperties:
type: string
description: The environment variables for the branch.
basicAuthCredentials:
type: string
description: The basic authorization credentials for the branch. You must base64-encode the authorization credentials
and provide them in the format user:password.
enableBasicAuth:
type: boolean
description: Enables basic authorization for the branch.
enablePerformanceMode:
type: boolean
description: 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.
buildSpec:
type: string
description: The build specification (build spec) for the branch.
ttl:
type: string
description: The content Time to Live (TTL) for the website in seconds.
displayName:
type: string
description: The display name for a branch. This is used as the default domain prefix.
enablePullRequestPreview:
type: boolean
description: Enables pull request previews for this branch.
pullRequestEnvironmentName:
type: string
description: The Amplify environment name for the pull request.
backendEnvironmentArn:
type: string
description: The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This
field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify
command line interface (CLI).
backend:
$ref: '#/components/schemas/Backend'
computeRoleArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute
role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based
on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in
the Amplify User Guide.
required:
- appId
- branchName
UpdateBranchResult:
type: object
properties:
branch:
$ref: '#/components/schemas/Branch'
required:
- branch
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amplify/service/2017-07-25/amplify-2017-07-25.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)