AWS Amplify

2020/10/09 - AWS Amplify - 10 updated api methods

Changes  Update amplify client to latest version

CreateApp (updated) Link ¶
Changes (request, response)
Request 
{'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}
Response 
{'app': {'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}}

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,
    enableBranchAutoDeletion=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,
        'enablePerformanceMode': True|False,
        'buildSpec': 'string',
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string'
    }
)
type name:

string

param name:

[REQUIRED]

The name for the Amplify app.

type description:

string

param description:

The description for an Amplify app.

type repository:

string

param repository:

The repository for an Amplify app.

type platform:

string

param platform:

The platform or framework for an Amplify app.

type iamServiceRoleArn:

string

param iamServiceRoleArn:

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

type oauthToken:

string

param oauthToken:

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. The OAuth token is not stored.

type accessToken:

string

param accessToken:

The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.

type environmentVariables:

dict

param environmentVariables:

The environment variables map for an Amplify app.

  • (string) --

    • (string) --

type enableBranchAutoBuild:

boolean

param enableBranchAutoBuild:

Enables the auto building of branches for an Amplify app.

type enableBranchAutoDeletion:

boolean

param enableBranchAutoDeletion:

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

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

type basicAuthCredentials:

string

param basicAuthCredentials:

The credentials for basic authorization for an Amplify app.

type customRules:

list

param customRules:

The custom rewrite and redirect rules for an Amplify app.

  • (dict) --

    Describes a custom rewrite or 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.

      200

      Represents a 200 rewrite rule.

      301

      Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

      302

      Represents a 302 temporary redirect rule.

      404

      Represents a 404 redirect rule.

      404-200

      Represents a 404 rewrite rule.

    • condition (string) --

      The condition for a URL rewrite or redirect rule, such as a country code.

type tags:

dict

param tags:

The tag for an Amplify app.

  • (string) --

    • (string) --

type buildSpec:

string

param buildSpec:

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

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for the Amplify app.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

The automated branch creation glob patterns for the Amplify app.

  • (string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

The automated branch creation configuration for the Amplify app.

  • stage (string) --

    Describes the current stage for the autocreated branch.

  • framework (string) --

    The framework for the autocreated branch.

  • enableAutoBuild (boolean) --

    Enables auto building for the autocreated branch.

  • environmentVariables (dict) --

    The environment variables for the autocreated branch.

    • (string) --

      • (string) --

  • basicAuthCredentials (string) --

    The basic authorization credentials for the autocreated branch.

  • enableBasicAuth (boolean) --

    Enables basic authorization for the autocreated branch.

  • enablePerformanceMode (boolean) --

    Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

  • buildSpec (string) --

    The build specification (build spec) for the autocreated branch.

  • enablePullRequestPreview (boolean) --

    Enables pull request preview for the autocreated 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,
        'enableBranchAutoDeletion': 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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • app (dict) --

      Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

      • appId (string) --

        The unique ID of the Amplify app.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the Amplify app.

      • name (string) --

        The name for the Amplify app.

      • tags (dict) --

        The tag for the Amplify app.

        • (string) --

          • (string) --

      • description (string) --

        The description for the Amplify app.

      • repository (string) --

        The repository for the Amplify app.

      • platform (string) --

        The platform for the Amplify app.

      • createTime (datetime) --

        Creates a date and time for the Amplify app.

      • updateTime (datetime) --

        Updates the date and time for the Amplify app.

      • iamServiceRoleArn (string) --

        The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

      • environmentVariables (dict) --

        The environment variables for the Amplify app.

        • (string) --

          • (string) --

      • defaultDomain (string) --

        The default domain for the Amplify app.

      • enableBranchAutoBuild (boolean) --

        Enables the auto-building of branches for the Amplify app.

      • enableBranchAutoDeletion (boolean) --

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

      • enableBasicAuth (boolean) --

        Enables basic authorization for the Amplify app's branches.

      • basicAuthCredentials (string) --

        The basic authorization credentials for branches for the Amplify app.

      • customRules (list) --

        Describes the custom redirect and rewrite rules for the Amplify app.

        • (dict) --

          Describes a custom rewrite or 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.

            200

            Represents a 200 rewrite rule.

            301

            Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

            302

            Represents a 302 temporary redirect rule.

            404

            Represents a 404 redirect rule.

            404-200

            Represents a 404 rewrite rule.

          • condition (string) --

            The condition for a URL rewrite or redirect rule, such as a country code.

      • productionBranch (dict) --

        Describes the information about a production branch of the Amplify app.

        • lastDeployTime (datetime) --

          The last deploy time of the production branch.

        • status (string) --

          The status of the production branch.

        • thumbnailUrl (string) --

          The thumbnail URL for the production branch.

        • branchName (string) --

          The branch name for the production branch.

      • buildSpec (string) --

        Describes the content of the build specification (build spec) for the Amplify app.

      • enableAutoBranchCreation (boolean) --

        Enables automated branch creation for the Amplify app.

      • autoBranchCreationPatterns (list) --

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

        • (string) --

      • autoBranchCreationConfig (dict) --

        Describes the automated branch creation configuration for the Amplify app.

        • stage (string) --

          Describes the current stage for the autocreated branch.

        • framework (string) --

          The framework for the autocreated branch.

        • enableAutoBuild (boolean) --

          Enables auto building for the autocreated branch.

        • environmentVariables (dict) --

          The environment variables for the autocreated branch.

          • (string) --

            • (string) --

        • basicAuthCredentials (string) --

          The basic authorization credentials for the autocreated branch.

        • enableBasicAuth (boolean) --

          Enables basic authorization for the autocreated branch.

        • enablePerformanceMode (boolean) --

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

        • buildSpec (string) --

          The build specification (build spec) for the autocreated branch.

        • enablePullRequestPreview (boolean) --

          Enables pull request preview for the autocreated branch.

        • pullRequestEnvironmentName (string) --

          The Amplify environment name for the pull request.

CreateBranch (updated) Link ¶
Changes (request, response)
Request 
{'enablePerformanceMode': 'boolean'}
Response 
{'branch': {'enablePerformanceMode': 'boolean'}}

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,
    enablePerformanceMode=True|False,
    tags={
        'string': 'string'
    },
    buildSpec='string',
    ttl='string',
    displayName='string',
    enablePullRequestPreview=True|False,
    pullRequestEnvironmentName='string',
    backendEnvironmentArn='string'
)
type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type branchName:

string

param branchName:

[REQUIRED]

The name for the branch.

type description:

string

param description:

The description for the branch.

type stage:

string

param stage:

Describes the current stage for the branch.

type framework:

string

param framework:

The 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:

The environment variables for the branch.

  • (string) --

    • (string) --

type basicAuthCredentials:

string

param basicAuthCredentials:

The basic authorization credentials for the branch.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables basic authorization for the branch.

type enablePerformanceMode:

boolean

param enablePerformanceMode:

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

type tags:

dict

param tags:

The tag for the branch.

  • (string) --

    • (string) --

type buildSpec:

string

param buildSpec:

The build specification (build spec) for the branch.

type ttl:

string

param ttl:

The content Time To Live (TTL) for the website in seconds.

type displayName:

string

param displayName:

The display name for a branch. This is used 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:

The Amazon Resource Name (ARN) for a backend environment that is 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,
        'enablePerformanceMode': 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) --

    The result structure for create branch request.

    • branch (dict) --

      Describes 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) --

        The creation date and time for a branch that is part of an Amplify app.

      • updateTime (datetime) --

        The last updated date and time for a branch that is part of an Amplify app.

      • 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) --

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that 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.

      • 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 preview 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.

DeleteApp (updated) Link ¶
Changes (response) 
{'app': {'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}}

Deletes an existing Amplify app specified by an app ID.

See also: AWS API Documentation

Request Syntax

client.delete_app(
    appId='string'
)
type appId:

string

param appId:

[REQUIRED]

The 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,
        'enableBranchAutoDeletion': 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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result structure for the delete app request.

    • app (dict) --

      Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

      • appId (string) --

        The unique ID of the Amplify app.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the Amplify app.

      • name (string) --

        The name for the Amplify app.

      • tags (dict) --

        The tag for the Amplify app.

        • (string) --

          • (string) --

      • description (string) --

        The description for the Amplify app.

      • repository (string) --

        The repository for the Amplify app.

      • platform (string) --

        The platform for the Amplify app.

      • createTime (datetime) --

        Creates a date and time for the Amplify app.

      • updateTime (datetime) --

        Updates the date and time for the Amplify app.

      • iamServiceRoleArn (string) --

        The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

      • environmentVariables (dict) --

        The environment variables for the Amplify app.

        • (string) --

          • (string) --

      • defaultDomain (string) --

        The default domain for the Amplify app.

      • enableBranchAutoBuild (boolean) --

        Enables the auto-building of branches for the Amplify app.

      • enableBranchAutoDeletion (boolean) --

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

      • enableBasicAuth (boolean) --

        Enables basic authorization for the Amplify app's branches.

      • basicAuthCredentials (string) --

        The basic authorization credentials for branches for the Amplify app.

      • customRules (list) --

        Describes the custom redirect and rewrite rules for the Amplify app.

        • (dict) --

          Describes a custom rewrite or 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.

            200

            Represents a 200 rewrite rule.

            301

            Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

            302

            Represents a 302 temporary redirect rule.

            404

            Represents a 404 redirect rule.

            404-200

            Represents a 404 rewrite rule.

          • condition (string) --

            The condition for a URL rewrite or redirect rule, such as a country code.

      • productionBranch (dict) --

        Describes the information about a production branch of the Amplify app.

        • lastDeployTime (datetime) --

          The last deploy time of the production branch.

        • status (string) --

          The status of the production branch.

        • thumbnailUrl (string) --

          The thumbnail URL for the production branch.

        • branchName (string) --

          The branch name for the production branch.

      • buildSpec (string) --

        Describes the content of the build specification (build spec) for the Amplify app.

      • enableAutoBranchCreation (boolean) --

        Enables automated branch creation for the Amplify app.

      • autoBranchCreationPatterns (list) --

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

        • (string) --

      • autoBranchCreationConfig (dict) --

        Describes the automated branch creation configuration for the Amplify app.

        • stage (string) --

          Describes the current stage for the autocreated branch.

        • framework (string) --

          The framework for the autocreated branch.

        • enableAutoBuild (boolean) --

          Enables auto building for the autocreated branch.

        • environmentVariables (dict) --

          The environment variables for the autocreated branch.

          • (string) --

            • (string) --

        • basicAuthCredentials (string) --

          The basic authorization credentials for the autocreated branch.

        • enableBasicAuth (boolean) --

          Enables basic authorization for the autocreated branch.

        • enablePerformanceMode (boolean) --

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

        • buildSpec (string) --

          The build specification (build spec) for the autocreated branch.

        • enablePullRequestPreview (boolean) --

          Enables pull request preview for the autocreated branch.

        • pullRequestEnvironmentName (string) --

          The Amplify environment name for the pull request.

DeleteBranch (updated) Link ¶
Changes (response) 
{'branch': {'enablePerformanceMode': 'boolean'}}

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]

The unique ID for an Amplify app.

type branchName:

string

param branchName:

[REQUIRED]

The 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,
        'enablePerformanceMode': 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) --

    The result structure for the delete 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) --

        The creation date and time for a branch that is part of an Amplify app.

      • updateTime (datetime) --

        The last updated date and time for a branch that is part of an Amplify app.

      • 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) --

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that 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.

      • 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 preview 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.

GetApp (updated) Link ¶
Changes (response) 
{'app': {'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}}

Returns an existing Amplify app by appID.

See also: AWS API Documentation

Request Syntax

client.get_app(
    appId='string'
)
type appId:

string

param appId:

[REQUIRED]

The 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,
        'enableBranchAutoDeletion': 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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • app (dict) --

      Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

      • appId (string) --

        The unique ID of the Amplify app.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the Amplify app.

      • name (string) --

        The name for the Amplify app.

      • tags (dict) --

        The tag for the Amplify app.

        • (string) --

          • (string) --

      • description (string) --

        The description for the Amplify app.

      • repository (string) --

        The repository for the Amplify app.

      • platform (string) --

        The platform for the Amplify app.

      • createTime (datetime) --

        Creates a date and time for the Amplify app.

      • updateTime (datetime) --

        Updates the date and time for the Amplify app.

      • iamServiceRoleArn (string) --

        The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

      • environmentVariables (dict) --

        The environment variables for the Amplify app.

        • (string) --

          • (string) --

      • defaultDomain (string) --

        The default domain for the Amplify app.

      • enableBranchAutoBuild (boolean) --

        Enables the auto-building of branches for the Amplify app.

      • enableBranchAutoDeletion (boolean) --

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

      • enableBasicAuth (boolean) --

        Enables basic authorization for the Amplify app's branches.

      • basicAuthCredentials (string) --

        The basic authorization credentials for branches for the Amplify app.

      • customRules (list) --

        Describes the custom redirect and rewrite rules for the Amplify app.

        • (dict) --

          Describes a custom rewrite or 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.

            200

            Represents a 200 rewrite rule.

            301

            Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

            302

            Represents a 302 temporary redirect rule.

            404

            Represents a 404 redirect rule.

            404-200

            Represents a 404 rewrite rule.

          • condition (string) --

            The condition for a URL rewrite or redirect rule, such as a country code.

      • productionBranch (dict) --

        Describes the information about a production branch of the Amplify app.

        • lastDeployTime (datetime) --

          The last deploy time of the production branch.

        • status (string) --

          The status of the production branch.

        • thumbnailUrl (string) --

          The thumbnail URL for the production branch.

        • branchName (string) --

          The branch name for the production branch.

      • buildSpec (string) --

        Describes the content of the build specification (build spec) for the Amplify app.

      • enableAutoBranchCreation (boolean) --

        Enables automated branch creation for the Amplify app.

      • autoBranchCreationPatterns (list) --

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

        • (string) --

      • autoBranchCreationConfig (dict) --

        Describes the automated branch creation configuration for the Amplify app.

        • stage (string) --

          Describes the current stage for the autocreated branch.

        • framework (string) --

          The framework for the autocreated branch.

        • enableAutoBuild (boolean) --

          Enables auto building for the autocreated branch.

        • environmentVariables (dict) --

          The environment variables for the autocreated branch.

          • (string) --

            • (string) --

        • basicAuthCredentials (string) --

          The basic authorization credentials for the autocreated branch.

        • enableBasicAuth (boolean) --

          Enables basic authorization for the autocreated branch.

        • enablePerformanceMode (boolean) --

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

        • buildSpec (string) --

          The build specification (build spec) for the autocreated branch.

        • enablePullRequestPreview (boolean) --

          Enables pull request preview for the autocreated branch.

        • pullRequestEnvironmentName (string) --

          The Amplify environment name for the pull request.

GetBranch (updated) Link ¶
Changes (response) 
{'branch': {'enablePerformanceMode': 'boolean'}}

Returns 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]

The unique ID for an Amplify app.

type branchName:

string

param branchName:

[REQUIRED]

The 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,
        'enablePerformanceMode': 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) --

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

        The creation date and time for a branch that is part of an Amplify app.

      • updateTime (datetime) --

        The last updated date and time for a branch that is part of an Amplify app.

      • 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) --

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that 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.

      • 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 preview 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.

ListApps (updated) Link ¶
Changes (response) 
{'apps': {'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}}

Returns a list of the existing Amplify apps.

See also: AWS API Documentation

Request Syntax

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

string

param nextToken:

A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

type maxResults:

integer

param maxResults:

The 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,
            'enableBranchAutoDeletion': 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,
                'enablePerformanceMode': True|False,
                'buildSpec': 'string',
                'enablePullRequestPreview': True|False,
                'pullRequestEnvironmentName': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The result structure for an Amplify app list request.

    • apps (list) --

      A list of Amplify apps.

      • (dict) --

        Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

        • appId (string) --

          The unique ID of the Amplify app.

        • appArn (string) --

          The Amazon Resource Name (ARN) of the Amplify app.

        • name (string) --

          The name for the Amplify app.

        • tags (dict) --

          The tag for the Amplify app.

          • (string) --

            • (string) --

        • description (string) --

          The description for the Amplify app.

        • repository (string) --

          The repository for the Amplify app.

        • platform (string) --

          The platform for the Amplify app.

        • createTime (datetime) --

          Creates a date and time for the Amplify app.

        • updateTime (datetime) --

          Updates the date and time for the Amplify app.

        • iamServiceRoleArn (string) --

          The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

        • environmentVariables (dict) --

          The environment variables for the Amplify app.

          • (string) --

            • (string) --

        • defaultDomain (string) --

          The default domain for the Amplify app.

        • enableBranchAutoBuild (boolean) --

          Enables the auto-building of branches for the Amplify app.

        • enableBranchAutoDeletion (boolean) --

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

        • enableBasicAuth (boolean) --

          Enables basic authorization for the Amplify app's branches.

        • basicAuthCredentials (string) --

          The basic authorization credentials for branches for the Amplify app.

        • customRules (list) --

          Describes the custom redirect and rewrite rules for the Amplify app.

          • (dict) --

            Describes a custom rewrite or 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.

              200

              Represents a 200 rewrite rule.

              301

              Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

              302

              Represents a 302 temporary redirect rule.

              404

              Represents a 404 redirect rule.

              404-200

              Represents a 404 rewrite rule.

            • condition (string) --

              The condition for a URL rewrite or redirect rule, such as a country code.

        • productionBranch (dict) --

          Describes the information about a production branch of the Amplify app.

          • lastDeployTime (datetime) --

            The last deploy time of the production branch.

          • status (string) --

            The status of the production branch.

          • thumbnailUrl (string) --

            The thumbnail URL for the production branch.

          • branchName (string) --

            The branch name for the production branch.

        • buildSpec (string) --

          Describes the content of the build specification (build spec) for the Amplify app.

        • enableAutoBranchCreation (boolean) --

          Enables automated branch creation for the Amplify app.

        • autoBranchCreationPatterns (list) --

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

          • (string) --

        • autoBranchCreationConfig (dict) --

          Describes the automated branch creation configuration for the Amplify app.

          • stage (string) --

            Describes the current stage for the autocreated branch.

          • framework (string) --

            The framework for the autocreated branch.

          • enableAutoBuild (boolean) --

            Enables auto building for the autocreated branch.

          • environmentVariables (dict) --

            The environment variables for the autocreated branch.

            • (string) --

              • (string) --

          • basicAuthCredentials (string) --

            The basic authorization credentials for the autocreated branch.

          • enableBasicAuth (boolean) --

            Enables basic authorization for the autocreated branch.

          • enablePerformanceMode (boolean) --

            Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

          • buildSpec (string) --

            The build specification (build spec) for the autocreated branch.

          • enablePullRequestPreview (boolean) --

            Enables pull request preview for the autocreated branch.

          • pullRequestEnvironmentName (string) --

            The Amplify environment name for the pull request.

    • nextToken (string) --

      A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.

ListBranches (updated) Link ¶
Changes (response) 
{'branches': {'enablePerformanceMode': 'boolean'}}

Lists the branches of 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]

The unique ID for an Amplify app.

type nextToken:

string

param nextToken:

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.

type maxResults:

integer

param maxResults:

The 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,
            'enablePerformanceMode': 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) --

    The result structure for the list branches request.

    • branches (list) --

      A list of branches for an Amplify app.

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

          The creation date and time for a branch that is part of an Amplify app.

        • updateTime (datetime) --

          The last updated date and time for a branch that is part of an Amplify app.

        • 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) --

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that 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.

        • 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 preview 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.

    • nextToken (string) --

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

UpdateApp (updated) Link ¶
Changes (request, response)
Request 
{'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}
Response 
{'app': {'autoBranchCreationConfig': {'enablePerformanceMode': 'boolean'}}}

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,
    enableBranchAutoDeletion=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,
        'enablePerformanceMode': True|False,
        'buildSpec': 'string',
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string'
    },
    repository='string',
    oauthToken='string',
    accessToken='string'
)
type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type name:

string

param name:

The name for an Amplify app.

type description:

string

param description:

The description for an Amplify app.

type platform:

string

param platform:

The platform for an Amplify app.

type iamServiceRoleArn:

string

param iamServiceRoleArn:

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

type environmentVariables:

dict

param environmentVariables:

The environment variables for an Amplify app.

  • (string) --

    • (string) --

type enableBranchAutoBuild:

boolean

param enableBranchAutoBuild:

Enables branch auto-building for an Amplify app.

type enableBranchAutoDeletion:

boolean

param enableBranchAutoDeletion:

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

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables basic authorization for an Amplify app.

type basicAuthCredentials:

string

param basicAuthCredentials:

The basic authorization credentials for an Amplify app.

type customRules:

list

param customRules:

The custom redirect and rewrite rules for an Amplify app.

  • (dict) --

    Describes a custom rewrite or 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.

      200

      Represents a 200 rewrite rule.

      301

      Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

      302

      Represents a 302 temporary redirect rule.

      404

      Represents a 404 redirect rule.

      404-200

      Represents a 404 rewrite rule.

    • condition (string) --

      The condition for a URL rewrite or redirect rule, such as a country code.

type buildSpec:

string

param buildSpec:

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

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for the Amplify app.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

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

  • (string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

The automated branch creation configuration for the Amplify app.

  • stage (string) --

    Describes the current stage for the autocreated branch.

  • framework (string) --

    The framework for the autocreated branch.

  • enableAutoBuild (boolean) --

    Enables auto building for the autocreated branch.

  • environmentVariables (dict) --

    The environment variables for the autocreated branch.

    • (string) --

      • (string) --

  • basicAuthCredentials (string) --

    The basic authorization credentials for the autocreated branch.

  • enableBasicAuth (boolean) --

    Enables basic authorization for the autocreated branch.

  • enablePerformanceMode (boolean) --

    Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

  • buildSpec (string) --

    The build specification (build spec) for the autocreated branch.

  • enablePullRequestPreview (boolean) --

    Enables pull request preview for the autocreated branch.

  • pullRequestEnvironmentName (string) --

    The Amplify environment name for the pull request.

type repository:

string

param repository:

The name of the repository for an Amplify app

type oauthToken:

string

param oauthToken:

The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

type accessToken:

string

param accessToken:

The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The 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,
        'enableBranchAutoDeletion': 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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The result structure for an Amplify app update request.

    • app (dict) --

      Represents the updated Amplify app.

      • appId (string) --

        The unique ID of the Amplify app.

      • appArn (string) --

        The Amazon Resource Name (ARN) of the Amplify app.

      • name (string) --

        The name for the Amplify app.

      • tags (dict) --

        The tag for the Amplify app.

        • (string) --

          • (string) --

      • description (string) --

        The description for the Amplify app.

      • repository (string) --

        The repository for the Amplify app.

      • platform (string) --

        The platform for the Amplify app.

      • createTime (datetime) --

        Creates a date and time for the Amplify app.

      • updateTime (datetime) --

        Updates the date and time for the Amplify app.

      • iamServiceRoleArn (string) --

        The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

      • environmentVariables (dict) --

        The environment variables for the Amplify app.

        • (string) --

          • (string) --

      • defaultDomain (string) --

        The default domain for the Amplify app.

      • enableBranchAutoBuild (boolean) --

        Enables the auto-building of branches for the Amplify app.

      • enableBranchAutoDeletion (boolean) --

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

      • enableBasicAuth (boolean) --

        Enables basic authorization for the Amplify app's branches.

      • basicAuthCredentials (string) --

        The basic authorization credentials for branches for the Amplify app.

      • customRules (list) --

        Describes the custom redirect and rewrite rules for the Amplify app.

        • (dict) --

          Describes a custom rewrite or 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.

            200

            Represents a 200 rewrite rule.

            301

            Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

            302

            Represents a 302 temporary redirect rule.

            404

            Represents a 404 redirect rule.

            404-200

            Represents a 404 rewrite rule.

          • condition (string) --

            The condition for a URL rewrite or redirect rule, such as a country code.

      • productionBranch (dict) --

        Describes the information about a production branch of the Amplify app.

        • lastDeployTime (datetime) --

          The last deploy time of the production branch.

        • status (string) --

          The status of the production branch.

        • thumbnailUrl (string) --

          The thumbnail URL for the production branch.

        • branchName (string) --

          The branch name for the production branch.

      • buildSpec (string) --

        Describes the content of the build specification (build spec) for the Amplify app.

      • enableAutoBranchCreation (boolean) --

        Enables automated branch creation for the Amplify app.

      • autoBranchCreationPatterns (list) --

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

        • (string) --

      • autoBranchCreationConfig (dict) --

        Describes the automated branch creation configuration for the Amplify app.

        • stage (string) --

          Describes the current stage for the autocreated branch.

        • framework (string) --

          The framework for the autocreated branch.

        • enableAutoBuild (boolean) --

          Enables auto building for the autocreated branch.

        • environmentVariables (dict) --

          The environment variables for the autocreated branch.

          • (string) --

            • (string) --

        • basicAuthCredentials (string) --

          The basic authorization credentials for the autocreated branch.

        • enableBasicAuth (boolean) --

          Enables basic authorization for the autocreated branch.

        • enablePerformanceMode (boolean) --

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

        • buildSpec (string) --

          The build specification (build spec) for the autocreated branch.

        • enablePullRequestPreview (boolean) --

          Enables pull request preview for the autocreated branch.

        • pullRequestEnvironmentName (string) --

          The Amplify environment name for the pull request.

UpdateBranch (updated) Link ¶
Changes (request, response)
Request 
{'enablePerformanceMode': 'boolean'}
Response 
{'branch': {'enablePerformanceMode': 'boolean'}}

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

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type branchName:

string

param branchName:

[REQUIRED]

The name for the branch.

type description:

string

param description:

The description for the branch.

type framework:

string

param framework:

The framework for the branch.

type stage:

string

param stage:

Describes the current 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:

The environment variables for the branch.

  • (string) --

    • (string) --

type basicAuthCredentials:

string

param basicAuthCredentials:

The basic authorization credentials for the branch.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables basic authorization for the branch.

type enablePerformanceMode:

boolean

param enablePerformanceMode:

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

type buildSpec:

string

param buildSpec:

The build specification (build spec) for the branch.

type ttl:

string

param ttl:

The content Time to Live (TTL) for the website in seconds.

type displayName:

string

param displayName:

The display name for a branch. This is used 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:

The Amazon Resource Name (ARN) for a backend environment that is 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,
        'enablePerformanceMode': 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) --

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

        The creation date and time for a branch that is part of an Amplify app.

      • updateTime (datetime) --

        The last updated date and time for a branch that is part of an Amplify app.

      • 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) --

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that 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.

      • 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 preview 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.