AWS API Changes

2019/10/31 - AWS Amplify - 10 updated api methods

Changes Update amplify client to latest version

CreateApp (updated)

Link ¶
Changes (request, response)
Request

{'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}

Response

{'app': {'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}}

Creates a new Amplify App.

See also: AWS API Documentation

Request Syntax

client.create_app(
    name='string',
    description='string',
    repository='string',
    platform='WEB',
    iamServiceRoleArn='string',
    oauthToken='string',
    accessToken='string',
    environmentVariables={
        'string': 'string'
    },
    enableBranchAutoBuild=True|False,
    enableBasicAuth=True|False,
    basicAuthCredentials='string',
    customRules=[
        {
            'source': 'string',
            'target': 'string',
            'status': 'string',
            'condition': 'string'
        },
    ],
    tags={
        'string': 'string'
    },
    buildSpec='string',
    enableAutoBranchCreation=True|False,
    autoBranchCreationPatterns=[
        'string',
    ],
    autoBranchCreationConfig={
        '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'
    }
)

type name:

string

param name:

[REQUIRED]

Name for the Amplify App

type description:

string

param description:

Description for an Amplify App

type repository:

string

param repository:

Repository for an Amplify App

type platform:

string

param platform:

Platform / framework for an Amplify App

type iamServiceRoleArn:

string

param iamServiceRoleArn:

AWS IAM service role for an Amplify App

type oauthToken:

string

param oauthToken:

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.

type accessToken:

string

param accessToken:

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.

type environmentVariables:

dict

param environmentVariables:

Environment variables map for an Amplify App.

(string) --
- (string) --

type enableBranchAutoBuild:

boolean

param enableBranchAutoBuild:

Enable the auto building of branches for an Amplify App.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

type basicAuthCredentials:

string

param basicAuthCredentials:

Credentials for Basic Authorization for an Amplify App.

type customRules:

list

param customRules:

Custom rewrite / redirect rules for an Amplify App.

(dict) --

Custom rewrite / redirect rule.
- source (string) -- [REQUIRED]
  
  The source pattern for a URL rewrite or redirect rule.
- target (string) -- [REQUIRED]
  
  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.

type tags:

dict

param tags:

Tag for an Amplify App

(string) --
- (string) --

type buildSpec:

string

param buildSpec:

BuildSpec for an Amplify App

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for the Amplify App.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

Automated branch creation glob patterns for the Amplify App.

(string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

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 (dict) --

Environment Variables for the auto created branch.
- (string) --
  - (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.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            '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'
        }
    }
}

Response Structure

(dict) --
- app (dict) --
  
  Amplify App represents different branches of a repository for building, deploying, and hosting.
  - appId (string) --
    
    Unique Id for the Amplify App.
  - appArn (string) --
    
    ARN for the Amplify App.
  - name (string) --
    
    Name for the Amplify App.
  - tags (dict) --
    
    Tag for Amplify App.
    - (string) --
      - (string) --
  - description (string) --
    
    Description for the Amplify App.
  - repository (string) --
    
    Repository for the Amplify App.
  - platform (string) --
    
    Platform for the Amplify App.
  - createTime (datetime) --
    
    Create date / time for the Amplify App.
  - updateTime (datetime) --
    
    Update date / time for the Amplify App.
  - iamServiceRoleArn (string) --
    
    IAM service role ARN for the Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables for the Amplify App.
    - (string) --
      - (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.
    - (dict) --
      
      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 (dict) --
    
    Structure with Production Branch information.
    - lastDeployTime (datetime) --
      
      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 (dict) --
    
    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 (dict) --
      
      Environment Variables for the auto created branch.
      - (string) --
        
        (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.

CreateBranch (updated)

Link ¶
Changes (request, response)
Request

{'backendEnvironmentArn': 'string', 'pullRequestEnvironmentName': 'string'}

Response

{'branch': {'backendEnvironmentArn': 'string',
            'pullRequestEnvironmentName': 'string'}}

Creates a new Branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

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

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type branchName:

string

param branchName:

[REQUIRED]

Name for the branch.

type description:

string

param description:

Description for the branch.

type stage:

string

param stage:

Stage for the branch.

type framework:

string

param framework:

Framework for the branch.

type enableNotification:

boolean

param enableNotification:

Enables notifications for the branch.

type enableAutoBuild:

boolean

param enableAutoBuild:

Enables auto building for the branch.

type environmentVariables:

dict

param environmentVariables:

Environment Variables for the branch.

(string) --
- (string) --

type basicAuthCredentials:

string

param basicAuthCredentials:

Basic Authorization credentials for the branch.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables Basic Auth for the branch.

type tags:

dict

param tags:

Tag for the branch.

(string) --
- (string) --

type buildSpec:

string

param buildSpec:

BuildSpec for the branch.

type ttl:

string

param ttl:

The content TTL for the website in seconds.

type displayName:

string

param displayName:

Display name for a branch, will use as the default domain prefix.

type enablePullRequestPreview:

boolean

param enablePullRequestPreview:

Enables Pull Request Preview for this branch.

type pullRequestEnvironmentName:

string

param pullRequestEnvironmentName:

The Amplify Environment name for the pull request.

type backendEnvironmentArn:

string

param backendEnvironmentArn:

ARN for a Backend Environment, part of an Amplify App.

rtype:

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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string',
        'associatedResources': [
            'string',
        ],
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string',
        'destinationBranch': 'string',
        'sourceBranch': 'string',
        'backendEnvironmentArn': 'string'
    }
}

Response Structure

(dict) --

Result structure for create branch request.
- branch (dict) --
  
  Branch structure for an Amplify App.
  - branchArn (string) --
    
    ARN for a branch, part of an Amplify App.
  - branchName (string) --
    
    Name for a branch, part of an Amplify App.
  - description (string) --
    
    Description for a branch, part of an Amplify App.
  - tags (dict) --
    
    Tag for branch for Amplify App.
    - (string) --
      - (string) --
  - stage (string) --
    
    Stage for a branch, part of an Amplify App.
  - displayName (string) --
    
    Display name for a branch, will use as the default domain prefix.
  - enableNotification (boolean) --
    
    Enables notifications for a branch, part of an Amplify App.
  - createTime (datetime) --
    
    Creation date and time for a branch, part of an Amplify App.
  - updateTime (datetime) --
    
    Last updated date and time for a branch, part of an Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables specific to a branch, part of an Amplify App.
    - (string) --
      - (string) --
  - enableAutoBuild (boolean) --
    
    Enables auto-building on push for a branch, part of an Amplify App.
  - customDomains (list) --
    
    Custom domains for a branch, part of an Amplify App.
    - (string) --
  - framework (string) --
    
    Framework for a branch, part of an Amplify App.
  - activeJobId (string) --
    
    Id of the active job for a branch, part of an Amplify App.
  - totalNumberOfJobs (string) --
    
    Total number of Jobs part of an Amplify App.
  - enableBasicAuth (boolean) --
    
    Enables Basic Authorization for a branch, part of an Amplify App.
  - thumbnailUrl (string) --
    
    Thumbnail URL for the branch.
  - basicAuthCredentials (string) --
    
    Basic Authorization credentials for a branch, part of an Amplify App.
  - buildSpec (string) --
    
    BuildSpec content for branch for Amplify App.
  - ttl (string) --
    
    The content TTL for the website in seconds.
  - associatedResources (list) --
    
    List of custom resources that are linked to this branch.
    - (string) --
  - enablePullRequestPreview (boolean) --
    
    Enables Pull Request Preview for this 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) --
    
    ARN for a Backend Environment, part of an Amplify App.

DeleteApp (updated)

Link ¶
Changes (response)

{'app': {'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}}

Delete an existing Amplify App by appId.

See also: AWS API Documentation

Request Syntax

client.delete_app(
    appId='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            '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'
        }
    }
}

Response Structure

(dict) --

Result structure for an Amplify App delete request.
- app (dict) --
  
  Amplify App represents different branches of a repository for building, deploying, and hosting.
  - appId (string) --
    
    Unique Id for the Amplify App.
  - appArn (string) --
    
    ARN for the Amplify App.
  - name (string) --
    
    Name for the Amplify App.
  - tags (dict) --
    
    Tag for Amplify App.
    - (string) --
      - (string) --
  - description (string) --
    
    Description for the Amplify App.
  - repository (string) --
    
    Repository for the Amplify App.
  - platform (string) --
    
    Platform for the Amplify App.
  - createTime (datetime) --
    
    Create date / time for the Amplify App.
  - updateTime (datetime) --
    
    Update date / time for the Amplify App.
  - iamServiceRoleArn (string) --
    
    IAM service role ARN for the Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables for the Amplify App.
    - (string) --
      - (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.
    - (dict) --
      
      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 (dict) --
    
    Structure with Production Branch information.
    - lastDeployTime (datetime) --
      
      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 (dict) --
    
    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 (dict) --
      
      Environment Variables for the auto created branch.
      - (string) --
        
        (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.

DeleteBranch (updated)

Link ¶
Changes (response)

{'branch': {'backendEnvironmentArn': 'string',
            'pullRequestEnvironmentName': 'string'}}

Deletes a branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

client.delete_branch(
    appId='string',
    branchName='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type branchName:

string

param branchName:

[REQUIRED]

Name for the branch.

rtype:

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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string',
        'associatedResources': [
            'string',
        ],
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string',
        'destinationBranch': 'string',
        'sourceBranch': 'string',
        'backendEnvironmentArn': 'string'
    }
}

Response Structure

(dict) --

Result structure for delete branch request.
- branch (dict) --
  
  Branch structure for an Amplify App.
  - branchArn (string) --
    
    ARN for a branch, part of an Amplify App.
  - branchName (string) --
    
    Name for a branch, part of an Amplify App.
  - description (string) --
    
    Description for a branch, part of an Amplify App.
  - tags (dict) --
    
    Tag for branch for Amplify App.
    - (string) --
      - (string) --
  - stage (string) --
    
    Stage for a branch, part of an Amplify App.
  - displayName (string) --
    
    Display name for a branch, will use as the default domain prefix.
  - enableNotification (boolean) --
    
    Enables notifications for a branch, part of an Amplify App.
  - createTime (datetime) --
    
    Creation date and time for a branch, part of an Amplify App.
  - updateTime (datetime) --
    
    Last updated date and time for a branch, part of an Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables specific to a branch, part of an Amplify App.
    - (string) --
      - (string) --
  - enableAutoBuild (boolean) --
    
    Enables auto-building on push for a branch, part of an Amplify App.
  - customDomains (list) --
    
    Custom domains for a branch, part of an Amplify App.
    - (string) --
  - framework (string) --
    
    Framework for a branch, part of an Amplify App.
  - activeJobId (string) --
    
    Id of the active job for a branch, part of an Amplify App.
  - totalNumberOfJobs (string) --
    
    Total number of Jobs part of an Amplify App.
  - enableBasicAuth (boolean) --
    
    Enables Basic Authorization for a branch, part of an Amplify App.
  - thumbnailUrl (string) --
    
    Thumbnail URL for the branch.
  - basicAuthCredentials (string) --
    
    Basic Authorization credentials for a branch, part of an Amplify App.
  - buildSpec (string) --
    
    BuildSpec content for branch for Amplify App.
  - ttl (string) --
    
    The content TTL for the website in seconds.
  - associatedResources (list) --
    
    List of custom resources that are linked to this branch.
    - (string) --
  - enablePullRequestPreview (boolean) --
    
    Enables Pull Request Preview for this 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) --
    
    ARN for a Backend Environment, part of an Amplify App.

GetApp (updated)

Link ¶
Changes (response)

{'app': {'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}}

Retrieves an existing Amplify App by appId.

See also: AWS API Documentation

Request Syntax

client.get_app(
    appId='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            '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'
        }
    }
}

Response Structure

(dict) --
- app (dict) --
  
  Amplify App represents different branches of a repository for building, deploying, and hosting.
  - appId (string) --
    
    Unique Id for the Amplify App.
  - appArn (string) --
    
    ARN for the Amplify App.
  - name (string) --
    
    Name for the Amplify App.
  - tags (dict) --
    
    Tag for Amplify App.
    - (string) --
      - (string) --
  - description (string) --
    
    Description for the Amplify App.
  - repository (string) --
    
    Repository for the Amplify App.
  - platform (string) --
    
    Platform for the Amplify App.
  - createTime (datetime) --
    
    Create date / time for the Amplify App.
  - updateTime (datetime) --
    
    Update date / time for the Amplify App.
  - iamServiceRoleArn (string) --
    
    IAM service role ARN for the Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables for the Amplify App.
    - (string) --
      - (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.
    - (dict) --
      
      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 (dict) --
    
    Structure with Production Branch information.
    - lastDeployTime (datetime) --
      
      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 (dict) --
    
    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 (dict) --
      
      Environment Variables for the auto created branch.
      - (string) --
        
        (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.

GetBranch (updated)

Link ¶
Changes (response)

{'branch': {'backendEnvironmentArn': 'string',
            'pullRequestEnvironmentName': 'string'}}

Retrieves a branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

client.get_branch(
    appId='string',
    branchName='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type branchName:

string

param branchName:

[REQUIRED]

Name for the branch.

rtype:

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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string',
        'associatedResources': [
            'string',
        ],
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string',
        'destinationBranch': 'string',
        'sourceBranch': 'string',
        'backendEnvironmentArn': 'string'
    }
}

Response Structure

(dict) --
- branch (dict) --
  
  Branch for an Amplify App, which maps to a 3rd party repository branch.
  - branchArn (string) --
    
    ARN for a branch, part of an Amplify App.
  - branchName (string) --
    
    Name for a branch, part of an Amplify App.
  - description (string) --
    
    Description for a branch, part of an Amplify App.
  - tags (dict) --
    
    Tag for branch for Amplify App.
    - (string) --
      - (string) --
  - stage (string) --
    
    Stage for a branch, part of an Amplify App.
  - displayName (string) --
    
    Display name for a branch, will use as the default domain prefix.
  - enableNotification (boolean) --
    
    Enables notifications for a branch, part of an Amplify App.
  - createTime (datetime) --
    
    Creation date and time for a branch, part of an Amplify App.
  - updateTime (datetime) --
    
    Last updated date and time for a branch, part of an Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables specific to a branch, part of an Amplify App.
    - (string) --
      - (string) --
  - enableAutoBuild (boolean) --
    
    Enables auto-building on push for a branch, part of an Amplify App.
  - customDomains (list) --
    
    Custom domains for a branch, part of an Amplify App.
    - (string) --
  - framework (string) --
    
    Framework for a branch, part of an Amplify App.
  - activeJobId (string) --
    
    Id of the active job for a branch, part of an Amplify App.
  - totalNumberOfJobs (string) --
    
    Total number of Jobs part of an Amplify App.
  - enableBasicAuth (boolean) --
    
    Enables Basic Authorization for a branch, part of an Amplify App.
  - thumbnailUrl (string) --
    
    Thumbnail URL for the branch.
  - basicAuthCredentials (string) --
    
    Basic Authorization credentials for a branch, part of an Amplify App.
  - buildSpec (string) --
    
    BuildSpec content for branch for Amplify App.
  - ttl (string) --
    
    The content TTL for the website in seconds.
  - associatedResources (list) --
    
    List of custom resources that are linked to this branch.
    - (string) --
  - enablePullRequestPreview (boolean) --
    
    Enables Pull Request Preview for this 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) --
    
    ARN for a Backend Environment, part of an Amplify App.

ListApps (updated)

Link ¶
Changes (response)

{'apps': {'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}}

Lists existing Amplify Apps.

See also: AWS API Documentation

Request Syntax

client.list_apps(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

type maxResults:

integer

param maxResults:

Maximum number of records to list in a single response.

rtype:

dict

returns:

Response Syntax

{
    'apps': [
        {
            'appId': 'string',
            'appArn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            },
            'description': 'string',
            'repository': 'string',
            'platform': 'WEB',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'iamServiceRoleArn': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'defaultDomain': 'string',
            'enableBranchAutoBuild': True|False,
            'enableBasicAuth': True|False,
            'basicAuthCredentials': 'string',
            'customRules': [
                {
                    'source': 'string',
                    'target': 'string',
                    'status': 'string',
                    'condition': 'string'
                },
            ],
            'productionBranch': {
                'lastDeployTime': datetime(2015, 1, 1),
                'status': 'string',
                'thumbnailUrl': 'string',
                'branchName': 'string'
            },
            'buildSpec': 'string',
            'enableAutoBranchCreation': True|False,
            'autoBranchCreationPatterns': [
                'string',
            ],
            'autoBranchCreationConfig': {
                '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'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

Result structure for an Amplify App list request.
- apps (list) --
  
  List of Amplify Apps.
  - (dict) --
    
    Amplify App represents different branches of a repository for building, deploying, and hosting.
    - appId (string) --
      
      Unique Id for the Amplify App.
    - appArn (string) --
      
      ARN for the Amplify App.
    - name (string) --
      
      Name for the Amplify App.
    - tags (dict) --
      
      Tag for Amplify App.
      - (string) --
        
        (string) --
    - description (string) --
      
      Description for the Amplify App.
    - repository (string) --
      
      Repository for the Amplify App.
    - platform (string) --
      
      Platform for the Amplify App.
    - createTime (datetime) --
      
      Create date / time for the Amplify App.
    - updateTime (datetime) --
      
      Update date / time for the Amplify App.
    - iamServiceRoleArn (string) --
      
      IAM service role ARN for the Amplify App.
    - environmentVariables (dict) --
      
      Environment Variables for the Amplify App.
      - (string) --
        
        (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.
      - (dict) --
        
        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 (dict) --
      
      Structure with Production Branch information.
      - lastDeployTime (datetime) --
        
        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 (dict) --
      
      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 (dict) --
        
        Environment Variables for the auto created branch.
        
        (string) --
        
        (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.
- nextToken (string) --
  
  Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

ListBranches (updated)

Link ¶
Changes (response)

{'branches': {'backendEnvironmentArn': 'string',
              'pullRequestEnvironmentName': 'string'}}

Lists branches for an Amplify App.

See also: AWS API Documentation

Request Syntax

client.list_branches(
    appId='string',
    nextToken='string',
    maxResults=123
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type nextToken:

string

param nextToken:

Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.

type maxResults:

integer

param maxResults:

Maximum number of records to list in a single response.

rtype:

dict

returns:

Response Syntax

{
    'branches': [
        {
            '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,
            'thumbnailUrl': 'string',
            'basicAuthCredentials': 'string',
            'buildSpec': 'string',
            'ttl': 'string',
            'associatedResources': [
                'string',
            ],
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string',
            'destinationBranch': 'string',
            'sourceBranch': 'string',
            'backendEnvironmentArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

Result structure for list branches request.
- branches (list) --
  
  List of branches for an Amplify App.
  - (dict) --
    
    Branch for an Amplify App, which maps to a 3rd party repository branch.
    - branchArn (string) --
      
      ARN for a branch, part of an Amplify App.
    - branchName (string) --
      
      Name for a branch, part of an Amplify App.
    - description (string) --
      
      Description for a branch, part of an Amplify App.
    - tags (dict) --
      
      Tag for branch for Amplify App.
      - (string) --
        
        (string) --
    - stage (string) --
      
      Stage for a branch, part of an Amplify App.
    - displayName (string) --
      
      Display name for a branch, will use as the default domain prefix.
    - enableNotification (boolean) --
      
      Enables notifications for a branch, part of an Amplify App.
    - createTime (datetime) --
      
      Creation date and time for a branch, part of an Amplify App.
    - updateTime (datetime) --
      
      Last updated date and time for a branch, part of an Amplify App.
    - environmentVariables (dict) --
      
      Environment Variables specific to a branch, part of an Amplify App.
      - (string) --
        
        (string) --
    - enableAutoBuild (boolean) --
      
      Enables auto-building on push for a branch, part of an Amplify App.
    - customDomains (list) --
      
      Custom domains for a branch, part of an Amplify App.
      - (string) --
    - framework (string) --
      
      Framework for a branch, part of an Amplify App.
    - activeJobId (string) --
      
      Id of the active job for a branch, part of an Amplify App.
    - totalNumberOfJobs (string) --
      
      Total number of Jobs part of an Amplify App.
    - enableBasicAuth (boolean) --
      
      Enables Basic Authorization for a branch, part of an Amplify App.
    - thumbnailUrl (string) --
      
      Thumbnail URL for the branch.
    - basicAuthCredentials (string) --
      
      Basic Authorization credentials for a branch, part of an Amplify App.
    - buildSpec (string) --
      
      BuildSpec content for branch for Amplify App.
    - ttl (string) --
      
      The content TTL for the website in seconds.
    - associatedResources (list) --
      
      List of custom resources that are linked to this branch.
      - (string) --
    - enablePullRequestPreview (boolean) --
      
      Enables Pull Request Preview for this 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) --
      
      ARN for a Backend Environment, part of an Amplify App.
- nextToken (string) --
  
  Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

UpdateApp (updated)

Link ¶
Changes (request, response)
Request

{'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}

Response

{'app': {'autoBranchCreationConfig': {'pullRequestEnvironmentName': 'string'}}}

Updates an existing Amplify App.

See also: AWS API Documentation

Request Syntax

client.update_app(
    appId='string',
    name='string',
    description='string',
    platform='WEB',
    iamServiceRoleArn='string',
    environmentVariables={
        'string': 'string'
    },
    enableBranchAutoBuild=True|False,
    enableBasicAuth=True|False,
    basicAuthCredentials='string',
    customRules=[
        {
            'source': 'string',
            'target': 'string',
            'status': 'string',
            'condition': 'string'
        },
    ],
    buildSpec='string',
    enableAutoBranchCreation=True|False,
    autoBranchCreationPatterns=[
        'string',
    ],
    autoBranchCreationConfig={
        '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',
    oauthToken='string',
    accessToken='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type name:

string

param name:

Name for an Amplify App.

type description:

string

param description:

Description for an Amplify App.

type platform:

string

param platform:

Platform for an Amplify App.

type iamServiceRoleArn:

string

param iamServiceRoleArn:

IAM service role for an Amplify App.

type environmentVariables:

dict

param environmentVariables:

Environment Variables for an Amplify App.

(string) --
- (string) --

type enableBranchAutoBuild:

boolean

param enableBranchAutoBuild:

Enables branch auto-building for an Amplify App.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables Basic Authorization for an Amplify App.

type basicAuthCredentials:

string

param basicAuthCredentials:

Basic Authorization credentials for an Amplify App.

type customRules:

list

param customRules:

Custom redirect / rewrite rules for an Amplify App.

(dict) --

Custom rewrite / redirect rule.
- source (string) -- [REQUIRED]
  
  The source pattern for a URL rewrite or redirect rule.
- target (string) -- [REQUIRED]
  
  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.

type buildSpec:

string

param buildSpec:

BuildSpec for an Amplify App.

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for the Amplify App.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

Automated branch creation glob patterns for the Amplify App.

(string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

Automated branch creation branchConfig 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 (dict) --

Environment Variables for the auto created branch.
- (string) --
  - (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.

type repository:

string

param repository:

Repository for an Amplify App

type oauthToken:

string

param oauthToken:

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.

type accessToken:

string

param accessToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            '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'
        }
    }
}

Response Structure

(dict) --

Result structure for an Amplify App update request.
- app (dict) --
  
  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 (dict) --
    
    Tag for Amplify App.
    - (string) --
      - (string) --
  - description (string) --
    
    Description for the Amplify App.
  - repository (string) --
    
    Repository for the Amplify App.
  - platform (string) --
    
    Platform for the Amplify App.
  - createTime (datetime) --
    
    Create date / time for the Amplify App.
  - updateTime (datetime) --
    
    Update date / time for the Amplify App.
  - iamServiceRoleArn (string) --
    
    IAM service role ARN for the Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables for the Amplify App.
    - (string) --
      - (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.
    - (dict) --
      
      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 (dict) --
    
    Structure with Production Branch information.
    - lastDeployTime (datetime) --
      
      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 (dict) --
    
    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 (dict) --
      
      Environment Variables for the auto created branch.
      - (string) --
        
        (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.

UpdateBranch (updated)

Link ¶
Changes (request, response)
Request

{'backendEnvironmentArn': 'string', 'pullRequestEnvironmentName': 'string'}

Response

{'branch': {'backendEnvironmentArn': 'string',
            'pullRequestEnvironmentName': 'string'}}

Updates a branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

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,
    buildSpec='string',
    ttl='string',
    displayName='string',
    enablePullRequestPreview=True|False,
    pullRequestEnvironmentName='string',
    backendEnvironmentArn='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type branchName:

string

param branchName:

[REQUIRED]

Name for the branch.

type description:

string

param description:

Description for the branch.

type framework:

string

param framework:

Framework for the branch.

type stage:

string

param stage:

Stage for the branch.

type enableNotification:

boolean

param enableNotification:

Enables notifications for the branch.

type enableAutoBuild:

boolean

param enableAutoBuild:

Enables auto building for the branch.

type environmentVariables:

dict

param environmentVariables:

Environment Variables for the branch.

(string) --
- (string) --

type basicAuthCredentials:

string

param basicAuthCredentials:

Basic Authorization credentials for the branch.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables Basic Auth for the branch.

type buildSpec:

string

param buildSpec:

BuildSpec for the branch.

type ttl:

string

param ttl:

The content TTL for the website in seconds.

type displayName:

string

param displayName:

Display name for a branch, will use as the default domain prefix.

type enablePullRequestPreview:

boolean

param enablePullRequestPreview:

Enables Pull Request Preview for this branch.

type pullRequestEnvironmentName:

string

param pullRequestEnvironmentName:

The Amplify Environment name for the pull request.

type backendEnvironmentArn:

string

param backendEnvironmentArn:

ARN for a Backend Environment, part of an Amplify App.

rtype:

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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string',
        'associatedResources': [
            'string',
        ],
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string',
        'destinationBranch': 'string',
        'sourceBranch': 'string',
        'backendEnvironmentArn': 'string'
    }
}

Response Structure

(dict) --

Result structure for update branch request.
- branch (dict) --
  
  Branch structure for an Amplify App.
  - branchArn (string) --
    
    ARN for a branch, part of an Amplify App.
  - branchName (string) --
    
    Name for a branch, part of an Amplify App.
  - description (string) --
    
    Description for a branch, part of an Amplify App.
  - tags (dict) --
    
    Tag for branch for Amplify App.
    - (string) --
      - (string) --
  - stage (string) --
    
    Stage for a branch, part of an Amplify App.
  - displayName (string) --
    
    Display name for a branch, will use as the default domain prefix.
  - enableNotification (boolean) --
    
    Enables notifications for a branch, part of an Amplify App.
  - createTime (datetime) --
    
    Creation date and time for a branch, part of an Amplify App.
  - updateTime (datetime) --
    
    Last updated date and time for a branch, part of an Amplify App.
  - environmentVariables (dict) --
    
    Environment Variables specific to a branch, part of an Amplify App.
    - (string) --
      - (string) --
  - enableAutoBuild (boolean) --
    
    Enables auto-building on push for a branch, part of an Amplify App.
  - customDomains (list) --
    
    Custom domains for a branch, part of an Amplify App.
    - (string) --
  - framework (string) --
    
    Framework for a branch, part of an Amplify App.
  - activeJobId (string) --
    
    Id of the active job for a branch, part of an Amplify App.
  - totalNumberOfJobs (string) --
    
    Total number of Jobs part of an Amplify App.
  - enableBasicAuth (boolean) --
    
    Enables Basic Authorization for a branch, part of an Amplify App.
  - thumbnailUrl (string) --
    
    Thumbnail URL for the branch.
  - basicAuthCredentials (string) --
    
    Basic Authorization credentials for a branch, part of an Amplify App.
  - buildSpec (string) --
    
    BuildSpec content for branch for Amplify App.
  - ttl (string) --
    
    The content TTL for the website in seconds.
  - associatedResources (list) --
    
    List of custom resources that are linked to this branch.
    - (string) --
  - enablePullRequestPreview (boolean) --
    
    Enables Pull Request Preview for this 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) --
    
    ARN for a Backend Environment, part of an Amplify App.