AWS Amplify

2023/10/31 - AWS Amplify - 5 updated api methods

Changes  Add backend field to CreateBranch and UpdateBranch requests. Add pagination support for ListApps, ListDomainAssociations, ListBranches, and ListJobs

CreateBranch (updated) Link ¶
Changes (request, response)
Request 
{'backend': {'stackArn': 'string'}}
Response 
{'branch': {'backend': {'stackArn': '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,
    enablePerformanceMode=True|False,
    tags={
        'string': 'string'
    },
    buildSpec='string',
    ttl='string',
    displayName='string',
    enablePullRequestPreview=True|False,
    pullRequestEnvironmentName='string',
    backendEnvironmentArn='string',
    backend={
        'stackArn': '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. You must base64-encode the authorization credentials and provide them in the format user:password .

type enableBasicAuth

boolean

param enableBasicAuth

Enables basic authorization for the branch.

type enablePerformanceMode

boolean

param enablePerformanceMode

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

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 previews 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.

type backend

dict

param backend

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

  • stackArn (string) --

    The Amazon Resource Name (ARN) for the CloudFormation stack.

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',
        'backend': {
            'stackArn': '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) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • thumbnailUrl (string) --

        The thumbnail URL for the branch of an Amplify app.

      • basicAuthCredentials (string) --

        The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .

      • buildSpec (string) --

        The build specification (build spec) content for the branch of an Amplify app.

      • ttl (string) --

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

      • associatedResources (list) --

        A list of custom resources that are linked to this branch.

        • (string) --

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

      • destinationBranch (string) --

        The destination branch if the branch is a pull request branch.

      • sourceBranch (string) --

        The source branch if the branch is a pull request branch.

      • backendEnvironmentArn (string) --

        The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

      • backend (dict) --

        Describes the backend properties associated with an Amplify Branch .

        • stackArn (string) --

          The Amazon Resource Name (ARN) for the CloudFormation stack.

DeleteBranch (updated) Link ¶
Changes (response) 
{'branch': {'backend': {'stackArn': '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]

The unique ID for an Amplify app.

type branchName

string

param branchName

[REQUIRED]

The name of 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',
        'backend': {
            'stackArn': '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) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • thumbnailUrl (string) --

        The thumbnail URL for the branch of an Amplify app.

      • basicAuthCredentials (string) --

        The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .

      • buildSpec (string) --

        The build specification (build spec) content for the branch of an Amplify app.

      • ttl (string) --

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

      • associatedResources (list) --

        A list of custom resources that are linked to this branch.

        • (string) --

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

      • destinationBranch (string) --

        The destination branch if the branch is a pull request branch.

      • sourceBranch (string) --

        The source branch if the branch is a pull request branch.

      • backendEnvironmentArn (string) --

        The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

      • backend (dict) --

        Describes the backend properties associated with an Amplify Branch .

        • stackArn (string) --

          The Amazon Resource Name (ARN) for the CloudFormation stack.

GetBranch (updated) Link ¶
Changes (response) 
{'branch': {'backend': {'stackArn': 'string'}}}

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 of 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',
        'backend': {
            'stackArn': '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) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • thumbnailUrl (string) --

        The thumbnail URL for the branch of an Amplify app.

      • basicAuthCredentials (string) --

        The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .

      • buildSpec (string) --

        The build specification (build spec) content for the branch of an Amplify app.

      • ttl (string) --

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

      • associatedResources (list) --

        A list of custom resources that are linked to this branch.

        • (string) --

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

      • destinationBranch (string) --

        The destination branch if the branch is a pull request branch.

      • sourceBranch (string) --

        The source branch if the branch is a pull request branch.

      • backendEnvironmentArn (string) --

        The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

      • backend (dict) --

        Describes the backend properties associated with an Amplify Branch .

        • stackArn (string) --

          The Amazon Resource Name (ARN) for the CloudFormation stack.

ListBranches (updated) Link ¶
Changes (response) 
{'branches': {'backend': {'stackArn': 'string'}}}

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',
            'backend': {
                'stackArn': '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) --

          Enables performance mode for the branch.

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

        • thumbnailUrl (string) --

          The thumbnail URL for the branch of an Amplify app.

        • basicAuthCredentials (string) --

          The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .

        • buildSpec (string) --

          The build specification (build spec) content for the branch of an Amplify app.

        • ttl (string) --

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

        • associatedResources (list) --

          A list of custom resources that are linked to this branch.

          • (string) --

        • enablePullRequestPreview (boolean) --

          Enables pull request previews for the branch.

        • pullRequestEnvironmentName (string) --

          The Amplify environment name for the pull request.

        • destinationBranch (string) --

          The destination branch if the branch is a pull request branch.

        • sourceBranch (string) --

          The source branch if the branch is a pull request branch.

        • backendEnvironmentArn (string) --

          The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

        • backend (dict) --

          Describes the backend properties associated with an Amplify Branch .

          • stackArn (string) --

            The Amazon Resource Name (ARN) for the CloudFormation stack.

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

UpdateBranch (updated) Link ¶
Changes (request, response)
Request 
{'backend': {'stackArn': 'string'}}
Response 
{'branch': {'backend': {'stackArn': '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,
    enablePerformanceMode=True|False,
    buildSpec='string',
    ttl='string',
    displayName='string',
    enablePullRequestPreview=True|False,
    pullRequestEnvironmentName='string',
    backendEnvironmentArn='string',
    backend={
        'stackArn': 'string'
    }
)
type appId

string

param appId

[REQUIRED]

The unique ID for an Amplify app.

type branchName

string

param branchName

[REQUIRED]

The name of 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. You must base64-encode the authorization credentials and provide them in the format user:password .

type enableBasicAuth

boolean

param enableBasicAuth

Enables basic authorization for the branch.

type enablePerformanceMode

boolean

param enablePerformanceMode

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

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 previews 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.

type backend

dict

param backend

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

  • stackArn (string) --

    The Amazon Resource Name (ARN) for the CloudFormation stack.

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',
        'backend': {
            'stackArn': '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) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • thumbnailUrl (string) --

        The thumbnail URL for the branch of an Amplify app.

      • basicAuthCredentials (string) --

        The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .

      • buildSpec (string) --

        The build specification (build spec) content for the branch of an Amplify app.

      • ttl (string) --

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

      • associatedResources (list) --

        A list of custom resources that are linked to this branch.

        • (string) --

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

      • destinationBranch (string) --

        The destination branch if the branch is a pull request branch.

      • sourceBranch (string) --

        The source branch if the branch is a pull request branch.

      • backendEnvironmentArn (string) --

        The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

      • backend (dict) --

        Describes the backend properties associated with an Amplify Branch .

        • stackArn (string) --

          The Amazon Resource Name (ARN) for the CloudFormation stack.