Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplify ]

update-app

Description

Updates an existing Amplify App.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-app
--app-id <value>
[--name <value>]
[--description <value>]
[--platform <value>]
[--iam-service-role-arn <value>]
[--environment-variables <value>]
[--enable-branch-auto-build | --no-enable-branch-auto-build]
[--enable-basic-auth | --no-enable-basic-auth]
[--basic-auth-credentials <value>]
[--custom-rules <value>]
[--build-spec <value>]
[--enable-auto-branch-creation | --no-enable-auto-branch-creation]
[--auto-branch-creation-patterns <value>]
[--auto-branch-creation-config <value>]
[--repository <value>]
[--oauth-token <value>]
[--access-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

Unique Id for an Amplify App.

--name (string)

Name for an Amplify App.

--description (string)

Description for an Amplify App.

--platform (string)

Platform for an Amplify App.

Possible values:

  • WEB

--iam-service-role-arn (string)

IAM service role for an Amplify App.

--environment-variables (map)

Environment Variables for an Amplify App.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--enable-branch-auto-build | --no-enable-branch-auto-build (boolean)

Enables branch auto-building for an Amplify App.

--enable-basic-auth | --no-enable-basic-auth (boolean)

Enables Basic Authorization for an Amplify App.

--basic-auth-credentials (string)

Basic Authorization credentials for an Amplify App.

--custom-rules (list)

Custom redirect / rewrite rules for an Amplify App.

Shorthand Syntax:

source=string,target=string,status=string,condition=string ...

JSON Syntax:

[
  {
    "source": "string",
    "target": "string",
    "status": "string",
    "condition": "string"
  }
  ...
]

--build-spec (string)

BuildSpec for an Amplify App.

--enable-auto-branch-creation | --no-enable-auto-branch-creation (boolean)

Enables automated branch creation for the Amplify App.

--auto-branch-creation-patterns (list)

Automated branch creation glob patterns for the Amplify App.

Syntax:

"string" "string" ...

--auto-branch-creation-config (structure)

Automated branch creation branchConfig for the Amplify App.

Shorthand Syntax:

stage=string,framework=string,enableAutoBuild=boolean,environmentVariables={KeyName1=string,KeyName2=string},basicAuthCredentials=string,enableBasicAuth=boolean,buildSpec=string,enablePullRequestPreview=boolean,pullRequestEnvironmentName=string

JSON Syntax:

{
  "stage": "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|"PULL_REQUEST",
  "framework": "string",
  "enableAutoBuild": true|false,
  "environmentVariables": {"string": "string"
    ...},
  "basicAuthCredentials": "string",
  "enableBasicAuth": true|false,
  "buildSpec": "string",
  "enablePullRequestPreview": true|false,
  "pullRequestEnvironmentName": "string"
}

--repository (string)

Repository for an Amplify App

--oauth-token (string)

OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

--access-token (string)

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

app -> (structure)

App structure for the updated App.

appId -> (string)

Unique Id for the Amplify App.

appArn -> (string)

ARN for the Amplify App.

name -> (string)

Name for the Amplify App.

tags -> (map)

Tag for Amplify App.

key -> (string)

value -> (string)

description -> (string)

Description for the Amplify App.

repository -> (string)

Repository for the Amplify App.

platform -> (string)

Platform for the Amplify App.

createTime -> (timestamp)

Create date / time for the Amplify App.

updateTime -> (timestamp)

Update date / time for the Amplify App.

iamServiceRoleArn -> (string)

IAM service role ARN for the Amplify App.

environmentVariables -> (map)

Environment Variables for the Amplify App.

key -> (string)

value -> (string)

defaultDomain -> (string)

Default domain for the Amplify App.

enableBranchAutoBuild -> (boolean)

Enables auto-building of branches for the Amplify App.

enableBasicAuth -> (boolean)

Enables Basic Authorization for branches for the Amplify App.

basicAuthCredentials -> (string)

Basic Authorization credentials for branches for the Amplify App.

customRules -> (list)

Custom redirect / rewrite rules for the Amplify App.

(structure)

Custom rewrite / redirect rule.

source -> (string)

The source pattern for a URL rewrite or redirect rule.

target -> (string)

The target pattern for a URL rewrite or redirect rule.

status -> (string)

The status code for a URL rewrite or redirect rule.

condition -> (string)

The condition for a URL rewrite or redirect rule, e.g. country code.

productionBranch -> (structure)

Structure with Production Branch information.

lastDeployTime -> (timestamp)

Last Deploy Time of Production Branch.

status -> (string)

Status of Production Branch.

thumbnailUrl -> (string)

Thumbnail URL for Production Branch.

branchName -> (string)

Branch Name for Production Branch.

buildSpec -> (string)

BuildSpec content for Amplify App.

enableAutoBranchCreation -> (boolean)

Enables automated branch creation for the Amplify App.

autoBranchCreationPatterns -> (list)

Automated branch creation glob patterns for the Amplify App.

(string)

autoBranchCreationConfig -> (structure)

Automated branch creation config for the Amplify App.

stage -> (string)

Stage for the auto created branch.

framework -> (string)

Framework for the auto created branch.

enableAutoBuild -> (boolean)

Enables auto building for the auto created branch.

environmentVariables -> (map)

Environment Variables for the auto created branch.

key -> (string)

value -> (string)

basicAuthCredentials -> (string)

Basic Authorization credentials for the auto created branch.

enableBasicAuth -> (boolean)

Enables Basic Auth for the auto created branch.

buildSpec -> (string)

BuildSpec for the auto created branch.

enablePullRequestPreview -> (boolean)

Enables Pull Request Preview for auto created branch.

pullRequestEnvironmentName -> (string)

The Amplify Environment name for the pull request.