2025/02/17 - AWS Amplify - 10 updated api methods
Changes Add ComputeRoleArn to CreateApp, UpdateApp, CreateBranch, and UpdateBranch, allowing caller to specify a role to be assumed by Amplify Hosting for server-side rendered applications.
{'computeRoleArn': 'string'}
Response {'app': {'computeRoleArn': 'string'}}
Creates a new Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_app(
name='string',
description='string',
repository='string',
platform='WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
computeRoleArn='string',
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',
customHeaders='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'
},
cacheConfig={
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
}
)
string
[REQUIRED]
The name of the Amplify app.
string
The description of the Amplify app.
string
The Git repository for the Amplify app.
string
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.
string
The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
string
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
string
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 using SSH cloning. The OAuth token is not stored.
Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.
You must specify either oauthToken or accessToken when you create a new app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
string
The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.
You must specify either accessToken or oauthToken when you create a new app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
dict
The environment variables map for an Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
(string) --
(string) --
boolean
Enables the auto building of branches for an Amplify app.
boolean
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
boolean
Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
string
The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
list
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 permanently) 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.
dict
The tag for an Amplify app.
(string) --
(string) --
string
The build specification (build spec) for an Amplify app.
string
The custom HTTP headers for an Amplify app.
boolean
Enables automated branch creation for an Amplify app.
list
The automated branch creation glob patterns for an Amplify app.
(string) --
dict
The automated branch creation configuration for an 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
dict
The cache configuration for the Amplify app.
type (string) -- [REQUIRED]
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'computeRoleArn': 'string',
'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',
'customHeaders': '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'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4',
'cacheConfig': {
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
},
'webhookCreateTime': datetime(2015, 1, 1),
'wafConfiguration': {
'webAclArn': 'string',
'wafStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCESS'|'DISASSOCIATING'|'DISASSOCIATION_FAILED',
'statusReason': '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 Git repository for the Amplify app.
platform (string) --
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
createTime (datetime) --
A timestamp of when Amplify created the application.
updateTime (datetime) --
A timestamp of when Amplify updated the application.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
iamServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
(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. You must base64-encode the authorization credentials and provide them in the format user:password.
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 permanently) 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.
customHeaders (string) --
Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
cacheConfig (dict) --
The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
type (string) --
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
webhookCreateTime (datetime) --
A timestamp of when Amplify created the webhook in your Git repository.
wafConfiguration (dict) --
Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
webAclArn (string) --
The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
wafStatus (string) --
The status of the process to associate or disassociate a web ACL to an Amplify app.
statusReason (string) --
The reason for the current status of the Firewall configuration.
{'computeRoleArn': 'string'}
Response {'branch': {'computeRoleArn': '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'
},
computeRoleArn='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name for the branch.
string
The description for the branch.
string
Describes the current stage for the branch.
string
The framework for the branch.
boolean
Enables notifications for the branch.
boolean
Enables auto building for the branch.
dict
The environment variables for the branch.
(string) --
(string) --
string
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
boolean
Enables basic authorization for the branch.
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.
dict
The tag for the branch.
(string) --
(string) --
string
The build specification (build spec) for the branch.
string
The content Time To Live (TTL) for the website in seconds.
string
The display name for a branch. This is used as the default domain prefix.
boolean
Enables pull request previews for this branch.
string
The Amplify environment name for the pull request.
string
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
dict
The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
string
The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string',
'backend': {
'stackArn': 'string'
},
'computeRoleArn': 'string'
}
}
Response Structure
(dict) --
The result structure for 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) --
A timestamp of when Amplify created the branch.
updateTime (datetime) --
A timestamp for the last updated time for a branch.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
(string) --
(string) --
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
(string) --
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (string) --
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
(string) --
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend (dict) --
Describes the backend associated with an Amplify Branch.
This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
{'app': {'computeRoleArn': 'string'}}
Deletes an existing Amplify app specified by an app ID.
See also: AWS API Documentation
Request Syntax
client.delete_app(
appId='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'computeRoleArn': 'string',
'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',
'customHeaders': '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'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4',
'cacheConfig': {
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
},
'webhookCreateTime': datetime(2015, 1, 1),
'wafConfiguration': {
'webAclArn': 'string',
'wafStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCESS'|'DISASSOCIATING'|'DISASSOCIATION_FAILED',
'statusReason': '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 Git repository for the Amplify app.
platform (string) --
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
createTime (datetime) --
A timestamp of when Amplify created the application.
updateTime (datetime) --
A timestamp of when Amplify updated the application.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
iamServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
(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. You must base64-encode the authorization credentials and provide them in the format user:password.
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 permanently) 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.
customHeaders (string) --
Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
cacheConfig (dict) --
The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
type (string) --
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
webhookCreateTime (datetime) --
A timestamp of when Amplify created the webhook in your Git repository.
wafConfiguration (dict) --
Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
webAclArn (string) --
The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
wafStatus (string) --
The status of the process to associate or disassociate a web ACL to an Amplify app.
statusReason (string) --
The reason for the current status of the Firewall configuration.
{'branch': {'computeRoleArn': 'string'}}
Deletes a branch for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.delete_branch(
appId='string',
branchName='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string',
'backend': {
'stackArn': 'string'
},
'computeRoleArn': 'string'
}
}
Response Structure
(dict) --
The result structure for the 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) --
A timestamp of when Amplify created the branch.
updateTime (datetime) --
A timestamp for the last updated time for a branch.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
(string) --
(string) --
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
(string) --
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (string) --
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
(string) --
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend (dict) --
Describes the backend associated with an Amplify Branch.
This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
{'app': {'computeRoleArn': 'string'}}
Returns an existing Amplify app specified by an app ID.
See also: AWS API Documentation
Request Syntax
client.get_app(
appId='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'computeRoleArn': 'string',
'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',
'customHeaders': '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'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4',
'cacheConfig': {
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
},
'webhookCreateTime': datetime(2015, 1, 1),
'wafConfiguration': {
'webAclArn': 'string',
'wafStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCESS'|'DISASSOCIATING'|'DISASSOCIATION_FAILED',
'statusReason': '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 Git repository for the Amplify app.
platform (string) --
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
createTime (datetime) --
A timestamp of when Amplify created the application.
updateTime (datetime) --
A timestamp of when Amplify updated the application.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
iamServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
(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. You must base64-encode the authorization credentials and provide them in the format user:password.
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 permanently) 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.
customHeaders (string) --
Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
cacheConfig (dict) --
The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
type (string) --
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
webhookCreateTime (datetime) --
A timestamp of when Amplify created the webhook in your Git repository.
wafConfiguration (dict) --
Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
webAclArn (string) --
The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
wafStatus (string) --
The status of the process to associate or disassociate a web ACL to an Amplify app.
statusReason (string) --
The reason for the current status of the Firewall configuration.
{'branch': {'computeRoleArn': 'string'}}
Returns a branch for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_branch(
appId='string',
branchName='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string',
'backend': {
'stackArn': 'string'
},
'computeRoleArn': 'string'
}
}
Response Structure
(dict) --
branch (dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
(string) --
(string) --
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
A timestamp of when Amplify created the branch.
updateTime (datetime) --
A timestamp for the last updated time for a branch.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
(string) --
(string) --
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
(string) --
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (string) --
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
(string) --
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend (dict) --
Describes the backend associated with an Amplify Branch.
This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
{'apps': {'computeRoleArn': 'string'}}
Returns a list of the existing Amplify apps.
See also: AWS API Documentation
Request Syntax
client.list_apps(
nextToken='string',
maxResults=123
)
string
A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
integer
The maximum number of records to list in a single response.
dict
Response Syntax
{
'apps': [
{
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'computeRoleArn': 'string',
'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',
'customHeaders': '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'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4',
'cacheConfig': {
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
},
'webhookCreateTime': datetime(2015, 1, 1),
'wafConfiguration': {
'webAclArn': 'string',
'wafStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCESS'|'DISASSOCIATING'|'DISASSOCIATION_FAILED',
'statusReason': '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 Git repository for the Amplify app.
platform (string) --
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
createTime (datetime) --
A timestamp of when Amplify created the application.
updateTime (datetime) --
A timestamp of when Amplify updated the application.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
iamServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
(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. You must base64-encode the authorization credentials and provide them in the format user:password.
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 permanently) 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.
customHeaders (string) --
Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
cacheConfig (dict) --
The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
type (string) --
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
webhookCreateTime (datetime) --
A timestamp of when Amplify created the webhook in your Git repository.
wafConfiguration (dict) --
Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
webAclArn (string) --
The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
wafStatus (string) --
The status of the process to associate or disassociate a web ACL to an Amplify app.
statusReason (string) --
The reason for the current status of the Firewall configuration.
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.
{'branches': {'computeRoleArn': 'string'}}
Lists the branches of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.list_branches(
appId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
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.
integer
The maximum number of records to list in a single response.
dict
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'
},
'computeRoleArn': '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) --
A timestamp of when Amplify created the branch.
updateTime (datetime) --
A timestamp for the last updated time for a branch.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
(string) --
(string) --
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
(string) --
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (string) --
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
(string) --
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend (dict) --
Describes the backend associated with an Amplify Branch.
This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
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.
{'computeRoleArn': 'string'}
Response {'app': {'computeRoleArn': 'string'}}
Updates an existing Amplify app.
See also: AWS API Documentation
Request Syntax
client.update_app(
appId='string',
name='string',
description='string',
platform='WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
computeRoleArn='string',
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',
customHeaders='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',
cacheConfig={
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
}
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
The name for an Amplify app.
string
The description for an Amplify app.
string
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE.
string
The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
string
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
dict
The environment variables for an Amplify app.
(string) --
(string) --
boolean
Enables branch auto-building for an Amplify app.
boolean
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
boolean
Enables basic authorization for an Amplify app.
string
The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
list
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 permanently) 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.
string
The build specification (build spec) for an Amplify app.
string
The custom HTTP headers for an Amplify app.
boolean
Enables automated branch creation for an Amplify app.
list
Describes the automated branch creation glob patterns for an Amplify app.
(string) --
dict
The automated branch creation configuration for an 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
string
The name of the Git repository for an Amplify app.
string
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 using SSH cloning. The OAuth token is not stored.
Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.
To authorize access to GitHub as your repository provider, use accessToken.
You must specify either oauthToken or accessToken when you update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
string
The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.
You must specify either accessToken or oauthToken when you update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
dict
The cache configuration for the Amplify app.
type (string) -- [REQUIRED]
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'computeRoleArn': 'string',
'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',
'customHeaders': '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'
},
'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4',
'cacheConfig': {
'type': 'AMPLIFY_MANAGED'|'AMPLIFY_MANAGED_NO_COOKIES'
},
'webhookCreateTime': datetime(2015, 1, 1),
'wafConfiguration': {
'webAclArn': 'string',
'wafStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCESS'|'DISASSOCIATING'|'DISASSOCIATION_FAILED',
'statusReason': '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 Git repository for the Amplify app.
platform (string) --
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE.
createTime (datetime) --
A timestamp of when Amplify created the application.
updateTime (datetime) --
A timestamp of when Amplify updated the application.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
iamServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
(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. You must base64-encode the authorization credentials and provide them in the format user:password.
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 permanently) 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.
customHeaders (string) --
Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.
enableBasicAuth (boolean) --
Enables basic authorization for the autocreated branch.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec (string) --
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
repositoryCloneMethod (string) --
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
cacheConfig (dict) --
The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
type (string) --
The type of cache configuration to use for an Amplify app.
The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
webhookCreateTime (datetime) --
A timestamp of when Amplify created the webhook in your Git repository.
wafConfiguration (dict) --
Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
webAclArn (string) --
The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
wafStatus (string) --
The status of the process to associate or disassociate a web ACL to an Amplify app.
statusReason (string) --
The reason for the current status of the Firewall configuration.
{'computeRoleArn': 'string'}
Response {'branch': {'computeRoleArn': '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'
},
computeRoleArn='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch.
string
The description for the branch.
string
The framework for the branch.
string
Describes the current stage for the branch.
boolean
Enables notifications for the branch.
boolean
Enables auto building for the branch.
dict
The environment variables for the branch.
(string) --
(string) --
string
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
boolean
Enables basic authorization for the branch.
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.
string
The build specification (build spec) for the branch.
string
The content Time to Live (TTL) for the website in seconds.
string
The display name for a branch. This is used as the default domain prefix.
boolean
Enables pull request previews for this branch.
string
The Amplify environment name for the pull request.
string
The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
dict
The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
string
The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'displayName': 'string',
'enableNotification': True|False,
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'environmentVariables': {
'string': 'string'
},
'enableAutoBuild': True|False,
'customDomains': [
'string',
],
'framework': 'string',
'activeJobId': 'string',
'totalNumberOfJobs': 'string',
'enableBasicAuth': True|False,
'enablePerformanceMode': True|False,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string',
'backend': {
'stackArn': 'string'
},
'computeRoleArn': 'string'
}
}
Response Structure
(dict) --
The result structure for the update branch request.
branch (dict) --
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn (string) --
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName (string) --
The name for the branch that is part of an Amplify app.
description (string) --
The description for the branch that is part of an Amplify app.
tags (dict) --
The tag for the branch of an Amplify app.
(string) --
(string) --
stage (string) --
The current stage for the branch that is part of an Amplify app.
displayName (string) --
The display name for the branch. This is used as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch that is part of an Amplify app.
createTime (datetime) --
A timestamp of when Amplify created the branch.
updateTime (datetime) --
A timestamp for the last updated time for a branch.
environmentVariables (dict) --
The environment variables specific to a branch of an Amplify app.
(string) --
(string) --
enableAutoBuild (boolean) --
Enables auto-building on push for a branch of an Amplify app.
customDomains (list) --
The custom domains for a branch of an Amplify app.
(string) --
framework (string) --
The framework for a branch of an Amplify app.
activeJobId (string) --
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs (string) --
The total number of jobs that are part of an Amplify app.
enableBasicAuth (boolean) --
Enables basic authorization for a branch of an Amplify app.
enablePerformanceMode (boolean) --
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
thumbnailUrl (string) --
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials (string) --
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
buildSpec (string) --
The build specification (build spec) content for the branch of an Amplify app.
ttl (string) --
The content Time to Live (TTL) for the website in seconds.
associatedResources (list) --
A list of custom resources that are linked to this branch.
(string) --
enablePullRequestPreview (boolean) --
Enables pull request previews for the branch.
pullRequestEnvironmentName (string) --
The Amplify environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
backend (dict) --
Describes the backend associated with an Amplify Branch.
This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
stackArn (string) --
The Amazon Resource Name (ARN) for the CloudFormation stack.
computeRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.