Amplify / Client / update_branch

update_branch#

Amplify.Client.update_branch(**kwargs)#

Updates a branch for an Amplify app.

Request Syntax

response = client.update_branch(
    appId='string',
    branchName='string',
    description='string',
    framework='string',
    stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
    enableNotification=True|False,
    enableAutoBuild=True|False,
    environmentVariables={
        'string': 'string'
    },
    basicAuthCredentials='string',
    enableBasicAuth=True|False,
    enablePerformanceMode=True|False,
    buildSpec='string',
    ttl='string',
    displayName='string',
    enablePullRequestPreview=True|False,
    pullRequestEnvironmentName='string',
    backendEnvironmentArn='string',
    backend={
        'stackArn': 'string'
    },
    computeRoleArn='string'
)

Parameters:

appId (string) –
[REQUIRED]

The unique ID for an Amplify app.
branchName (string) –
[REQUIRED]

The name of the branch.
description (string) – The description for the branch.
framework (string) – The framework for the branch.
stage (string) – Describes the current stage for the branch.
enableNotification (boolean) – Enables notifications for the branch.
enableAutoBuild (boolean) – Enables auto building for the branch.
environmentVariables (dict) –
The environment variables for the branch.
- (string) –
  - (string) –
basicAuthCredentials (string) – The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) – Enables basic authorization for the branch.
enablePerformanceMode (boolean) –
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 (string) – The build specification (build spec) for the branch.
ttl (string) – The content Time to Live (TTL) for the website in seconds.
displayName (string) – The display name for a branch. This is used as the default domain prefix.
enablePullRequestPreview (boolean) – Enables pull request previews for this branch.
pullRequestEnvironmentName (string) – The Amplify environment name for the pull request.
backendEnvironmentArn (string) –
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 (dict) –
The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.
- stackArn (string) –
  
  The Amazon Resource Name (ARN) for the CloudFormation stack.
computeRoleArn (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'branch': {
        'branchArn': 'string',
        'branchName': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
        'displayName': 'string',
        'enableNotification': True|False,
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'environmentVariables': {
            'string': 'string'
        },
        'enableAutoBuild': True|False,
        'customDomains': [
            'string',
        ],
        'framework': 'string',
        'activeJobId': 'string',
        'totalNumberOfJobs': 'string',
        'enableBasicAuth': True|False,
        'enablePerformanceMode': True|False,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string',
        'associatedResources': [
            'string',
        ],
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string',
        'destinationBranch': 'string',
        'sourceBranch': 'string',
        'backendEnvironmentArn': 'string',
        'backend': {
            'stackArn': 'string'
        },
        'computeRoleArn': 'string'
    }
}

Response Structure

(dict) –

The result structure for the update branch request.
- branch (dict) –
  
  The branch for an Amplify app, which maps to a third-party repository branch.
  - branchArn (string) –
    
    The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
  - branchName (string) –
    
    The name for the branch that is part of an Amplify app.
  - description (string) –
    
    The description for the branch that is part of an Amplify app.
  - tags (dict) –
    
    The tag for the branch of an Amplify app.
    - (string) –
      - (string) –
  - stage (string) –
    
    The current stage for the branch that is part of an Amplify app.
  - displayName (string) –
    
    The display name for the branch. This is used as the default domain prefix.
  - enableNotification (boolean) –
    
    Enables notifications for a branch that is part of an Amplify app.
  - createTime (datetime) –
    
    A timestamp of when Amplify created the branch.
  - updateTime (datetime) –
    
    A timestamp for the last updated time for a branch.
  - environmentVariables (dict) –
    
    The environment variables specific to a branch of an Amplify app.
    - (string) –
      - (string) –
  - enableAutoBuild (boolean) –
    
    Enables auto-building on push for a branch of an Amplify app.
  - customDomains (list) –
    
    The custom domains for a branch of an Amplify app.
    - (string) –
  - framework (string) –
    
    The framework for a branch of an Amplify app.
  - activeJobId (string) –
    
    The ID of the active job for a branch of an Amplify app.
  - totalNumberOfJobs (string) –
    
    The total number of jobs that are part of an Amplify app.
  - enableBasicAuth (boolean) –
    
    Enables basic authorization for a branch of an Amplify app.
  - enablePerformanceMode (boolean) –
    
    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 (string) –
    
    The thumbnail URL for the branch of an Amplify app.
  - basicAuthCredentials (string) –
    
    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 (string) –
    
    The build specification (build spec) content for the branch of an Amplify app.
  - ttl (string) –
    
    The content Time to Live (TTL) for the website in seconds.
  - associatedResources (list) –
    
    A list of custom resources that are linked to this branch.
    - (string) –
  - enablePullRequestPreview (boolean) –
    
    Enables pull request previews for the branch.
  - pullRequestEnvironmentName (string) –
    
    The Amplify environment name for the pull request.
  - destinationBranch (string) –
    
    The destination branch if the branch is a pull request branch.
  - sourceBranch (string) –
    
    The source branch if the branch is a pull request branch.
  - backendEnvironmentArn (string) –
    
    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 (dict) –
    
    Describes the backend associated with an Amplify Branch.
    
    This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.
    - stackArn (string) –
      
      The Amazon Resource Name (ARN) for the CloudFormation stack.
  - computeRoleArn (string) –
    
    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.

update_branch#

Request Syntax

Response Syntax

Response Structure

Exceptions