2024/12/18 - AWS Amplify - 11 updated api methods
Changes Added WAF Configuration to Amplify Apps
{'app': {'wafConfiguration': {'statusReason': 'string',
'wafStatus': 'ASSOCIATING | ASSOCIATION_FAILED | '
'ASSOCIATION_SUCCESS | '
'DISASSOCIATING | '
'DISASSOCIATION_FAILED',
'webAclArn': 'string'},
'webhookCreateTime': 'timestamp'}}
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',
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 AWS Identity and Access Management (IAM) service role 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 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),
'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.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
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.
{'app': {'wafConfiguration': {'statusReason': 'string',
'wafStatus': 'ASSOCIATING | ASSOCIATION_FAILED | '
'ASSOCIATION_SUCCESS | '
'DISASSOCIATING | '
'DISASSOCIATION_FAILED',
'webAclArn': 'string'},
'webhookCreateTime': 'timestamp'}}
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),
'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.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
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.
{'jobSummary': {'status': {'CREATED'}}}
Deletes a job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.delete_job(
appId='string',
branchName='string',
jobId='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch to use for the job.
string
[REQUIRED]
The unique ID for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
'sourceUrl': 'string',
'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
}
}
Response Structure
(dict) --
The result structure for the delete job request.
jobSummary (dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
sourceUrl (string) --
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
sourceUrlType (string) --
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
{'app': {'wafConfiguration': {'statusReason': 'string',
'wafStatus': 'ASSOCIATING | ASSOCIATION_FAILED | '
'ASSOCIATION_SUCCESS | '
'DISASSOCIATING | '
'DISASSOCIATION_FAILED',
'webAclArn': 'string'},
'webhookCreateTime': 'timestamp'}}
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),
'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.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
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.
{'job': {'steps': {'status': {'CREATED'}}, 'summary': {'status': {'CREATED'}}}}
Returns a job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_job(
appId='string',
branchName='string',
jobId='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch to use for the job.
string
[REQUIRED]
The unique ID for the job.
dict
Response Syntax
{
'job': {
'summary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
'sourceUrl': 'string',
'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
},
'steps': [
{
'stepName': 'string',
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'logUrl': 'string',
'artifactsUrl': 'string',
'testArtifactsUrl': 'string',
'testConfigUrl': 'string',
'screenshots': {
'string': 'string'
},
'statusReason': 'string',
'context': 'string'
},
]
}
}
Response Structure
(dict) --
job (dict) --
Describes an execution job for an Amplify app.
summary (dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
sourceUrl (string) --
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
sourceUrlType (string) --
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
steps (list) --
The execution steps for an execution job, for an Amplify app.
(dict) --
Describes an execution step, for an execution job, for an Amplify app.
stepName (string) --
The name of the execution step.
startTime (datetime) --
The start date and time of the execution step.
status (string) --
The status of the execution step.
endTime (datetime) --
The end date and time of the execution step.
logUrl (string) --
The URL to the logs for the execution step.
artifactsUrl (string) --
The URL to the artifact for the execution step.
testArtifactsUrl (string) --
The URL to the test artifact for the execution step.
testConfigUrl (string) --
The URL to the test configuration for the execution step.
screenshots (dict) --
The list of screenshot URLs for the execution step, if relevant.
(string) --
(string) --
statusReason (string) --
The reason for the current step status.
context (string) --
The context for the current step. Includes a build image if the step is build.
{'apps': {'wafConfiguration': {'statusReason': 'string',
'wafStatus': 'ASSOCIATING | ASSOCIATION_FAILED '
'| ASSOCIATION_SUCCESS | '
'DISASSOCIATING | '
'DISASSOCIATION_FAILED',
'webAclArn': 'string'},
'webhookCreateTime': 'timestamp'}}
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),
'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.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
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.
{'jobSummaries': {'status': {'CREATED'}}}
Lists the jobs for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
appId='string',
branchName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch to use for the request.
string
A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
integer
The maximum number of records to list in a single response.
dict
Response Syntax
{
'jobSummaries': [
{
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
'sourceUrl': 'string',
'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The maximum number of records to list in a single response.
jobSummaries (list) --
The result structure for the list job result request.
(dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
sourceUrl (string) --
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
sourceUrlType (string) --
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
nextToken (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.
{'jobSummary': {'status': {'CREATED'}}}
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
See also: AWS API Documentation
Request Syntax
client.start_deployment(
appId='string',
branchName='string',
jobId='string',
sourceUrl='string',
sourceUrlType='ZIP'|'BUCKET_PREFIX'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch to use for the deployment job.
string
The job ID for this deployment that is generated by the CreateDeployment request.
string
The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
string
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
'sourceUrl': 'string',
'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
}
}
Response Structure
(dict) --
The result structure for the start a deployment request.
jobSummary (dict) --
The summary for the job.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
sourceUrl (string) --
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
sourceUrlType (string) --
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
{'jobSummary': {'status': {'CREATED'}}}
Starts a new job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.start_job(
appId='string',
branchName='string',
jobId='string',
jobType='RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
jobReason='string',
commitId='string',
commitMessage='string',
commitTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch to use for the job.
string
The unique ID for an existing job. This is required if the value of jobType is RETRY.
string
[REQUIRED]
Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.
The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.
string
A descriptive reason for starting the job.
string
The commit ID from a third-party repository provider for the job.
string
The commit message from a third-party repository provider for the job.
datetime
The commit date and time for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
'sourceUrl': 'string',
'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
}
}
Response Structure
(dict) --
The result structure for the run job request.
jobSummary (dict) --
The summary for the job.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
sourceUrl (string) --
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
sourceUrlType (string) --
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
{'jobSummary': {'status': {'CREATED'}}}
Stops a job that is in progress for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.stop_job(
appId='string',
branchName='string',
jobId='string'
)
string
[REQUIRED]
The unique ID for an Amplify app.
string
[REQUIRED]
The name of the branch to use for the stop job request.
string
[REQUIRED]
The unique id for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'CREATED'|'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK',
'sourceUrl': 'string',
'sourceUrlType': 'ZIP'|'BUCKET_PREFIX'
}
}
Response Structure
(dict) --
The result structure for the stop job request.
jobSummary (dict) --
The summary for the job.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
sourceUrl (string) --
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
sourceUrlType (string) --
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
{'app': {'wafConfiguration': {'statusReason': 'string',
'wafStatus': 'ASSOCIATING | ASSOCIATION_FAILED | '
'ASSOCIATION_SUCCESS | '
'DISASSOCIATING | '
'DISASSOCIATION_FAILED',
'webAclArn': 'string'},
'webhookCreateTime': 'timestamp'}}
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',
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 AWS Identity and Access Management (IAM) service role for an 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),
'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.
iamServiceRoleArn (string) --
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables (dict) --
The environment variables for the Amplify app.
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.