POST

/apps/{appId}

http://amplify.{region}.amazonaws.com/apps/{appId}

Updates an existing Amplify app.

Access Token Required: API Key

Path Parameters

appIdstringrequired

The unique ID for an Amplify app.

Body Params

namestring

The name for an Amplify app.

platformstring

The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.

buildSpecstring

The build specification (build spec) file for an Amplify app build.

oauthTokenstring

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored. Use <code>oauthToken</code> for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use <code>accessToken</code>. You must specify either <code>oauthToken</code> or <code>accessToken</code> when you update an app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the Amplify User Guide .

repositorystring

The name of the repository for an Amplify app

accessTokenstring

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. Use <code>accessToken</code> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>. You must specify either <code>accessToken</code> or <code>oauthToken</code> when you update an app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the Amplify User Guide .

customRulesarray

The custom redirect and rewrite rules for an Amplify app.

descriptionstring

The description for an Amplify app.

customHeadersstring

The custom HTTP headers for an Amplify app.

enableBasicAuthboolean

Enables basic authorization for an Amplify app.

iamServiceRoleArnstring

The AWS Identity and Access Management (IAM) service role for an Amplify app.

basicAuthCredentialsstring

The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.

environmentVariablesobject

The environment variables for an Amplify app.

enableBranchAutoBuildboolean

Enables branch auto-building for an Amplify app.

autoBranchCreationConfigobject

Describes the automated branch creation configuration.

enableAutoBranchCreationboolean

Enables automated branch creation for an Amplify app.

enableBranchAutoDeletionboolean

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

autoBranchCreationPatternsarray

Describes the automated branch creation glob patterns for an Amplify app.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://amplify.{region}.amazonaws.com/apps/{appId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}