Table of Contents
A low-level client representing AWS Amplify:
import boto3
client = boto3.client('amplify')
These are the available methods:
Check if an operation can be paginated.
Creates a new Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.create_app(
name='string',
description='string',
repository='string',
platform='WEB',
iamServiceRoleArn='string',
oauthToken='string',
accessToken='string',
environmentVariables={
'string': 'string'
},
enableBranchAutoBuild=True|False,
enableBasicAuth=True|False,
basicAuthCredentials='string',
customRules=[
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
tags={
'string': 'string'
},
buildSpec='string',
enableAutoBranchCreation=True|False,
autoBranchCreationPatterns=[
'string',
],
autoBranchCreationConfig={
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
)
[REQUIRED]
Name for the Amplify App
Environment variables map for an Amplify App.
Custom rewrite / redirect rules for an Amplify App.
Custom rewrite / redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
The condition for a URL rewrite or redirect rule, e.g. country code.
Tag for an Amplify App
Automated branch creation glob patterns for the Amplify App.
Automated branch creation config for the Amplify App.
Stage for the auto created branch.
Framework for the auto created branch.
Enables auto building for the auto created branch.
Environment Variables for the auto created branch.
Basic Authorization credentials for the auto created branch.
Enables Basic Auth for the auto created branch.
BuildSpec for the auto created branch.
Enables Pull Request Preview for auto created branch.
The Amplify Environment name for the pull request.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
}
}
Response Structure
(dict) --
app (dict) --
Amplify App represents different branches of a repository for building, deploying, and hosting.
appId (string) --
Unique Id for the Amplify App.
appArn (string) --
ARN for the Amplify App.
name (string) --
Name for the Amplify App.
tags (dict) --
Tag for Amplify App.
description (string) --
Description for the Amplify App.
repository (string) --
Repository for the Amplify App.
platform (string) --
Platform for the Amplify App.
createTime (datetime) --
Create date / time for the Amplify App.
updateTime (datetime) --
Update date / time for the Amplify App.
iamServiceRoleArn (string) --
IAM service role ARN for the Amplify App.
environmentVariables (dict) --
Environment Variables for the Amplify App.
defaultDomain (string) --
Default domain for the Amplify App.
enableBranchAutoBuild (boolean) --
Enables auto-building of branches for the Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for branches for the Amplify App.
basicAuthCredentials (string) --
Basic Authorization credentials for branches for the Amplify App.
customRules (list) --
Custom redirect / rewrite rules for the Amplify App.
(dict) --
Custom rewrite / redirect rule.
source (string) --
The source pattern for a URL rewrite or redirect rule.
target (string) --
The target pattern for a URL rewrite or redirect rule.
status (string) --
The status code for a URL rewrite or redirect rule.
condition (string) --
The condition for a URL rewrite or redirect rule, e.g. country code.
productionBranch (dict) --
Structure with Production Branch information.
lastDeployTime (datetime) --
Last Deploy Time of Production Branch.
status (string) --
Status of Production Branch.
thumbnailUrl (string) --
Thumbnail URL for Production Branch.
branchName (string) --
Branch Name for Production Branch.
buildSpec (string) --
BuildSpec content for Amplify App.
enableAutoBranchCreation (boolean) --
Enables automated branch creation for the Amplify App.
autoBranchCreationPatterns (list) --
Automated branch creation glob patterns for the Amplify App.
autoBranchCreationConfig (dict) --
Automated branch creation config for the Amplify App.
stage (string) --
Stage for the auto created branch.
framework (string) --
Framework for the auto created branch.
enableAutoBuild (boolean) --
Enables auto building for the auto created branch.
environmentVariables (dict) --
Environment Variables for the auto created branch.
basicAuthCredentials (string) --
Basic Authorization credentials for the auto created branch.
enableBasicAuth (boolean) --
Enables Basic Auth for the auto created branch.
buildSpec (string) --
BuildSpec for the auto created branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for auto created branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
Exceptions
Creates a new backend environment for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.create_backend_environment(
appId='string',
environmentName='string',
stackName='string',
deploymentArtifacts='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the backend environment.
dict
Response Syntax
{
'backendEnvironment': {
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Result structure for create backend environment.
backendEnvironment (dict) --
Backend environment structure for an amplify App.
backendEnvironmentArn (string) --
Arn for a backend environment, part of an Amplify App.
environmentName (string) --
Name for a backend environment, part of an Amplify App.
stackName (string) --
CloudFormation stack name of backend environment.
deploymentArtifacts (string) --
Name of deployment artifacts.
createTime (datetime) --
Creation date and time for a backend environment, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a backend environment, part of an Amplify App.
Exceptions
Creates a new Branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.create_branch(
appId='string',
branchName='string',
description='string',
stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
framework='string',
enableNotification=True|False,
enableAutoBuild=True|False,
environmentVariables={
'string': 'string'
},
basicAuthCredentials='string',
enableBasicAuth=True|False,
tags={
'string': 'string'
},
buildSpec='string',
ttl='string',
displayName='string',
enablePullRequestPreview=True|False,
pullRequestEnvironmentName='string',
backendEnvironmentArn='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch.
Environment Variables for the branch.
Tag for 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,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
Result structure for create branch request.
branch (dict) --
Branch structure for an Amplify App.
branchArn (string) --
ARN for a branch, part of an Amplify App.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a branch, part of an Amplify App.
tags (dict) --
Tag for branch for Amplify App.
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, will use as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch, part of an Amplify App.
createTime (datetime) --
Creation date and time for a branch, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a branch, part of an Amplify App.
environmentVariables (dict) --
Environment Variables specific to a branch, part of an Amplify App.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch, part of an Amplify App.
customDomains (list) --
Custom domains for a branch, part of an Amplify App.
framework (string) --
Framework for a branch, part of an Amplify App.
activeJobId (string) --
Id of the active job for a branch, part of an Amplify App.
totalNumberOfJobs (string) --
Total number of Jobs part of an Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for a branch, part of an Amplify App.
thumbnailUrl (string) --
Thumbnail URL for the branch.
basicAuthCredentials (string) --
Basic Authorization credentials for a branch, part of an Amplify App.
buildSpec (string) --
BuildSpec content for branch for Amplify App.
ttl (string) --
The content TTL for the website in seconds.
associatedResources (list) --
List of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for this branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
ARN for a Backend Environment, part of an Amplify App.
Exceptions
Create a deployment for manual deploy apps. (Apps are not connected to repository)
See also: AWS API Documentation
Request Syntax
response = client.create_deployment(
appId='string',
branchName='string',
fileMap={
'string': 'string'
}
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch, for the Job.
Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files.
dict
Response Syntax
{
'jobId': 'string',
'fileUploadUrls': {
'string': 'string'
},
'zipUploadUrl': 'string'
}
Response Structure
(dict) --
Result structure for create a new deployment.
jobId (string) --
The jobId for this deployment, will supply to start deployment api.
fileUploadUrls (dict) --
When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url.
zipUploadUrl (string) --
When the fileMap argument is NOT provided. This zipUploadUrl will be returned.
Exceptions
Create a new DomainAssociation on an App
See also: AWS API Documentation
Request Syntax
response = client.create_domain_association(
appId='string',
domainName='string',
enableAutoSubDomain=True|False,
subDomainSettings=[
{
'prefix': 'string',
'branchName': 'string'
},
]
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Domain name for the Domain Association.
[REQUIRED]
Setting structure for the Subdomain.
Setting for the Subdomain.
Prefix setting for the Subdomain.
Branch name setting for the Subdomain.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
Result structure for the create Domain Association request.
domainAssociation (dict) --
Domain Association structure.
domainAssociationArn (string) --
ARN for the Domain Association.
domainName (string) --
Name of the domain.
enableAutoSubDomain (boolean) --
Enables automated creation of Subdomains for branches. (Currently not supported)
domainStatus (string) --
Status fo the Domain Association.
statusReason (string) --
Reason for the current status of the Domain Association.
certificateVerificationDNSRecord (string) --
DNS Record for certificate verification.
subDomains (list) --
Subdomains for the Domain Association.
(dict) --
Subdomain for the Domain Association.
subDomainSetting (dict) --
Setting structure for the Subdomain.
prefix (string) --
Prefix setting for the Subdomain.
branchName (string) --
Branch name setting for the Subdomain.
verified (boolean) --
Verified status of the Subdomain
dnsRecord (string) --
DNS record for the Subdomain.
Exceptions
Create a new webhook on an App.
See also: AWS API Documentation
Request Syntax
response = client.create_webhook(
appId='string',
branchName='string',
description='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for a branch, part of an Amplify App.
dict
Response Syntax
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Result structure for the create webhook request.
webhook (dict) --
Webhook structure.
webhookArn (string) --
ARN for the webhook.
webhookId (string) --
Id of the webhook.
webhookUrl (string) --
Url of the webhook.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a webhook.
createTime (datetime) --
Create date / time for a webhook.
updateTime (datetime) --
Update date / time for a webhook.
Exceptions
Delete an existing Amplify App by appId.
See also: AWS API Documentation
Request Syntax
response = client.delete_app(
appId='string'
)
[REQUIRED]
Unique Id for an Amplify App.
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
}
}
Response Structure
Result structure for an Amplify App delete request.
Amplify App represents different branches of a repository for building, deploying, and hosting.
Unique Id for the Amplify App.
ARN for the Amplify App.
Name for the Amplify App.
Tag for Amplify App.
Description for the Amplify App.
Repository for the Amplify App.
Platform for the Amplify App.
Create date / time for the Amplify App.
Update date / time for the Amplify App.
IAM service role ARN for the Amplify App.
Environment Variables for the Amplify App.
Default domain for the Amplify App.
Enables auto-building of branches for the Amplify App.
Enables Basic Authorization for branches for the Amplify App.
Basic Authorization credentials for branches for the Amplify App.
Custom redirect / rewrite rules for the Amplify App.
Custom rewrite / redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
The condition for a URL rewrite or redirect rule, e.g. country code.
Structure with Production Branch information.
Last Deploy Time of Production Branch.
Status of Production Branch.
Thumbnail URL for Production Branch.
Branch Name for Production Branch.
BuildSpec content for Amplify App.
Enables automated branch creation for the Amplify App.
Automated branch creation glob patterns for the Amplify App.
Automated branch creation config for the Amplify App.
Stage for the auto created branch.
Framework for the auto created branch.
Enables auto building for the auto created branch.
Environment Variables for the auto created branch.
Basic Authorization credentials for the auto created branch.
Enables Basic Auth for the auto created branch.
BuildSpec for the auto created branch.
Enables Pull Request Preview for auto created branch.
The Amplify Environment name for the pull request.
Exceptions
Delete backend environment for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.delete_backend_environment(
appId='string',
environmentName='string'
)
[REQUIRED]
Unique Id of an Amplify App.
[REQUIRED]
Name of a backend environment of an Amplify App.
dict
Response Syntax
{
'backendEnvironment': {
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Result structure of a delete backend environment result.
backendEnvironment (dict) --
Backend environment structure for an Amplify App.
backendEnvironmentArn (string) --
Arn for a backend environment, part of an Amplify App.
environmentName (string) --
Name for a backend environment, part of an Amplify App.
stackName (string) --
CloudFormation stack name of backend environment.
deploymentArtifacts (string) --
Name of deployment artifacts.
createTime (datetime) --
Creation date and time for a backend environment, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a backend environment, part of an Amplify App.
Exceptions
Deletes a branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.delete_branch(
appId='string',
branchName='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for 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,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
Result structure for delete branch request.
branch (dict) --
Branch structure for an Amplify App.
branchArn (string) --
ARN for a branch, part of an Amplify App.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a branch, part of an Amplify App.
tags (dict) --
Tag for branch for Amplify App.
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, will use as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch, part of an Amplify App.
createTime (datetime) --
Creation date and time for a branch, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a branch, part of an Amplify App.
environmentVariables (dict) --
Environment Variables specific to a branch, part of an Amplify App.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch, part of an Amplify App.
customDomains (list) --
Custom domains for a branch, part of an Amplify App.
framework (string) --
Framework for a branch, part of an Amplify App.
activeJobId (string) --
Id of the active job for a branch, part of an Amplify App.
totalNumberOfJobs (string) --
Total number of Jobs part of an Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for a branch, part of an Amplify App.
thumbnailUrl (string) --
Thumbnail URL for the branch.
basicAuthCredentials (string) --
Basic Authorization credentials for a branch, part of an Amplify App.
buildSpec (string) --
BuildSpec content for branch for Amplify App.
ttl (string) --
The content TTL for the website in seconds.
associatedResources (list) --
List of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for this branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
ARN for a Backend Environment, part of an Amplify App.
Exceptions
Deletes a DomainAssociation.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain_association(
appId='string',
domainName='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name of the domain.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
domainAssociation (dict) --
Structure for Domain Association, which associates a custom domain with an Amplify App.
domainAssociationArn (string) --
ARN for the Domain Association.
domainName (string) --
Name of the domain.
enableAutoSubDomain (boolean) --
Enables automated creation of Subdomains for branches. (Currently not supported)
domainStatus (string) --
Status fo the Domain Association.
statusReason (string) --
Reason for the current status of the Domain Association.
certificateVerificationDNSRecord (string) --
DNS Record for certificate verification.
subDomains (list) --
Subdomains for the Domain Association.
(dict) --
Subdomain for the Domain Association.
subDomainSetting (dict) --
Setting structure for the Subdomain.
prefix (string) --
Prefix setting for the Subdomain.
branchName (string) --
Branch name setting for the Subdomain.
verified (boolean) --
Verified status of the Subdomain
dnsRecord (string) --
DNS record for the Subdomain.
Exceptions
Delete a job, for an Amplify branch, part of Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch, for the Job.
[REQUIRED]
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': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
Result structure for the delete job request.
jobSummary (dict) --
Structure for the summary of a Job.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
Exceptions
Deletes a webhook.
See also: AWS API Documentation
Request Syntax
response = client.delete_webhook(
webhookId='string'
)
[REQUIRED]
Unique Id for a webhook.
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
Result structure for the delete webhook request.
Webhook structure.
ARN for the webhook.
Id of the webhook.
Url of the webhook.
Name for a branch, part of an Amplify App.
Description for a webhook.
Create date / time for a webhook.
Update date / time for a webhook.
Exceptions
Retrieve website access logs for a specific time range via a pre-signed URL.
See also: AWS API Documentation
Request Syntax
response = client.generate_access_logs(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
domainName='string',
appId='string'
)
[REQUIRED]
Name of the domain.
[REQUIRED]
Unique Id for an Amplify App.
dict
Response Syntax
{
'logUrl': 'string'
}
Response Structure
(dict) --
Result structure for the generate access logs request.
logUrl (string) --
Pre-signed URL for the requested access logs.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves an existing Amplify App by appId.
See also: AWS API Documentation
Request Syntax
response = client.get_app(
appId='string'
)
[REQUIRED]
Unique Id for an Amplify App.
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
}
}
Response Structure
Amplify App represents different branches of a repository for building, deploying, and hosting.
Unique Id for the Amplify App.
ARN for the Amplify App.
Name for the Amplify App.
Tag for Amplify App.
Description for the Amplify App.
Repository for the Amplify App.
Platform for the Amplify App.
Create date / time for the Amplify App.
Update date / time for the Amplify App.
IAM service role ARN for the Amplify App.
Environment Variables for the Amplify App.
Default domain for the Amplify App.
Enables auto-building of branches for the Amplify App.
Enables Basic Authorization for branches for the Amplify App.
Basic Authorization credentials for branches for the Amplify App.
Custom redirect / rewrite rules for the Amplify App.
Custom rewrite / redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
The condition for a URL rewrite or redirect rule, e.g. country code.
Structure with Production Branch information.
Last Deploy Time of Production Branch.
Status of Production Branch.
Thumbnail URL for Production Branch.
Branch Name for Production Branch.
BuildSpec content for Amplify App.
Enables automated branch creation for the Amplify App.
Automated branch creation glob patterns for the Amplify App.
Automated branch creation config for the Amplify App.
Stage for the auto created branch.
Framework for the auto created branch.
Enables auto building for the auto created branch.
Environment Variables for the auto created branch.
Basic Authorization credentials for the auto created branch.
Enables Basic Auth for the auto created branch.
BuildSpec for the auto created branch.
Enables Pull Request Preview for auto created branch.
The Amplify Environment name for the pull request.
Exceptions
Retrieves artifact info that corresponds to a artifactId.
See also: AWS API Documentation
Request Syntax
response = client.get_artifact_url(
artifactId='string'
)
[REQUIRED]
Unique Id for a artifact.
{
'artifactId': 'string',
'artifactUrl': 'string'
}
Response Structure
Result structure for the get artifact request.
Unique Id for a artifact.
Presigned url for the artifact.
Exceptions
Retrieves a backend environment for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_environment(
appId='string',
environmentName='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the backend environment.
dict
Response Syntax
{
'backendEnvironment': {
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Result structure for get backend environment result.
backendEnvironment (dict) --
Backend environment structure for an an Amplify App.
backendEnvironmentArn (string) --
Arn for a backend environment, part of an Amplify App.
environmentName (string) --
Name for a backend environment, part of an Amplify App.
stackName (string) --
CloudFormation stack name of backend environment.
deploymentArtifacts (string) --
Name of deployment artifacts.
createTime (datetime) --
Creation date and time for a backend environment, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a backend environment, part of an Amplify App.
Exceptions
Retrieves a branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.get_branch(
appId='string',
branchName='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for 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,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
branch (dict) --
Branch for an Amplify App, which maps to a 3rd party repository branch.
branchArn (string) --
ARN for a branch, part of an Amplify App.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a branch, part of an Amplify App.
tags (dict) --
Tag for branch for Amplify App.
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, will use as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch, part of an Amplify App.
createTime (datetime) --
Creation date and time for a branch, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a branch, part of an Amplify App.
environmentVariables (dict) --
Environment Variables specific to a branch, part of an Amplify App.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch, part of an Amplify App.
customDomains (list) --
Custom domains for a branch, part of an Amplify App.
framework (string) --
Framework for a branch, part of an Amplify App.
activeJobId (string) --
Id of the active job for a branch, part of an Amplify App.
totalNumberOfJobs (string) --
Total number of Jobs part of an Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for a branch, part of an Amplify App.
thumbnailUrl (string) --
Thumbnail URL for the branch.
basicAuthCredentials (string) --
Basic Authorization credentials for a branch, part of an Amplify App.
buildSpec (string) --
BuildSpec content for branch for Amplify App.
ttl (string) --
The content TTL for the website in seconds.
associatedResources (list) --
List of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for this branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
ARN for a Backend Environment, part of an Amplify App.
Exceptions
Retrieves domain info that corresponds to an appId and domainName.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_association(
appId='string',
domainName='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name of the domain.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
Result structure for the get Domain Association request.
domainAssociation (dict) --
Domain Association structure.
domainAssociationArn (string) --
ARN for the Domain Association.
domainName (string) --
Name of the domain.
enableAutoSubDomain (boolean) --
Enables automated creation of Subdomains for branches. (Currently not supported)
domainStatus (string) --
Status fo the Domain Association.
statusReason (string) --
Reason for the current status of the Domain Association.
certificateVerificationDNSRecord (string) --
DNS Record for certificate verification.
subDomains (list) --
Subdomains for the Domain Association.
(dict) --
Subdomain for the Domain Association.
subDomainSetting (dict) --
Setting structure for the Subdomain.
prefix (string) --
Prefix setting for the Subdomain.
branchName (string) --
Branch name setting for the Subdomain.
verified (boolean) --
Verified status of the Subdomain
dnsRecord (string) --
DNS record for the Subdomain.
Exceptions
Get a job for a branch, part of an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.get_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch, for the Job.
[REQUIRED]
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': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
},
'steps': [
{
'stepName': 'string',
'startTime': datetime(2015, 1, 1),
'status': '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) --
Structure for an execution job for an Amplify App.
summary (dict) --
Summary for an execution job for an Amplify App.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
steps (list) --
Execution steps for an execution job, for an Amplify App.
(dict) --
Structure for an execution step for an execution job, for an Amplify App.
stepName (string) --
Name of the execution step.
startTime (datetime) --
Start date/ time of the execution step.
status (string) --
Status of the execution step.
endTime (datetime) --
End date/ time of the execution step.
logUrl (string) --
URL to the logs for the execution step.
artifactsUrl (string) --
URL to the artifact for the execution step.
testArtifactsUrl (string) --
URL to the test artifact for the execution step.
testConfigUrl (string) --
URL to the test config for the execution step.
screenshots (dict) --
List of screenshot URLs for the execution step, if relevant.
statusReason (string) --
The reason for current step status.
context (string) --
The context for current step, will include build image if step is build.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Retrieves webhook info that corresponds to a webhookId.
See also: AWS API Documentation
Request Syntax
response = client.get_webhook(
webhookId='string'
)
[REQUIRED]
Unique Id for a webhook.
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
Result structure for the get webhook request.
Webhook structure.
ARN for the webhook.
Id of the webhook.
Url of the webhook.
Name for a branch, part of an Amplify App.
Description for a webhook.
Create date / time for a webhook.
Update date / time for a webhook.
Exceptions
Lists existing Amplify Apps.
See also: AWS API Documentation
Request Syntax
response = client.list_apps(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'apps': [
{
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure for an Amplify App list request.
apps (list) --
List of Amplify Apps.
(dict) --
Amplify App represents different branches of a repository for building, deploying, and hosting.
appId (string) --
Unique Id for the Amplify App.
appArn (string) --
ARN for the Amplify App.
name (string) --
Name for the Amplify App.
tags (dict) --
Tag for Amplify App.
description (string) --
Description for the Amplify App.
repository (string) --
Repository for the Amplify App.
platform (string) --
Platform for the Amplify App.
createTime (datetime) --
Create date / time for the Amplify App.
updateTime (datetime) --
Update date / time for the Amplify App.
iamServiceRoleArn (string) --
IAM service role ARN for the Amplify App.
environmentVariables (dict) --
Environment Variables for the Amplify App.
defaultDomain (string) --
Default domain for the Amplify App.
enableBranchAutoBuild (boolean) --
Enables auto-building of branches for the Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for branches for the Amplify App.
basicAuthCredentials (string) --
Basic Authorization credentials for branches for the Amplify App.
customRules (list) --
Custom redirect / rewrite rules for the Amplify App.
(dict) --
Custom rewrite / redirect rule.
source (string) --
The source pattern for a URL rewrite or redirect rule.
target (string) --
The target pattern for a URL rewrite or redirect rule.
status (string) --
The status code for a URL rewrite or redirect rule.
condition (string) --
The condition for a URL rewrite or redirect rule, e.g. country code.
productionBranch (dict) --
Structure with Production Branch information.
lastDeployTime (datetime) --
Last Deploy Time of Production Branch.
status (string) --
Status of Production Branch.
thumbnailUrl (string) --
Thumbnail URL for Production Branch.
branchName (string) --
Branch Name for Production Branch.
buildSpec (string) --
BuildSpec content for Amplify App.
enableAutoBranchCreation (boolean) --
Enables automated branch creation for the Amplify App.
autoBranchCreationPatterns (list) --
Automated branch creation glob patterns for the Amplify App.
autoBranchCreationConfig (dict) --
Automated branch creation config for the Amplify App.
stage (string) --
Stage for the auto created branch.
framework (string) --
Framework for the auto created branch.
enableAutoBuild (boolean) --
Enables auto building for the auto created branch.
environmentVariables (dict) --
Environment Variables for the auto created branch.
basicAuthCredentials (string) --
Basic Authorization credentials for the auto created branch.
enableBasicAuth (boolean) --
Enables Basic Auth for the auto created branch.
buildSpec (string) --
BuildSpec for the auto created branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for auto created branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
nextToken (string) --
Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.
Exceptions
List artifacts with an app, a branch, a job and an artifact type.
See also: AWS API Documentation
Request Syntax
response = client.list_artifacts(
appId='string',
branchName='string',
jobId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for a branch, part of an Amplify App.
[REQUIRED]
Unique Id for an Job.
dict
Response Syntax
{
'artifacts': [
{
'artifactFileName': 'string',
'artifactId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure for the list artifacts request.
artifacts (list) --
List of artifacts.
(dict) --
Structure for artifact.
artifactFileName (string) --
File name for the artifact.
artifactId (string) --
Unique Id for a artifact.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
Lists backend environments for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.list_backend_environments(
appId='string',
environmentName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Unique Id for an amplify App.
dict
Response Syntax
{
'backendEnvironments': [
{
'backendEnvironmentArn': 'string',
'environmentName': 'string',
'stackName': 'string',
'deploymentArtifacts': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure for list backend environments result.
backendEnvironments (list) --
List of backend environments for an Amplify App.
(dict) --
Backend environment for an Amplify App.
backendEnvironmentArn (string) --
Arn for a backend environment, part of an Amplify App.
environmentName (string) --
Name for a backend environment, part of an Amplify App.
stackName (string) --
CloudFormation stack name of backend environment.
deploymentArtifacts (string) --
Name of deployment artifacts.
createTime (datetime) --
Creation date and time for a backend environment, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a backend environment, part of an Amplify App.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
Lists branches for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.list_branches(
appId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Unique Id for an Amplify App.
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,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure for list branches request.
branches (list) --
List of branches for an Amplify App.
(dict) --
Branch for an Amplify App, which maps to a 3rd party repository branch.
branchArn (string) --
ARN for a branch, part of an Amplify App.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a branch, part of an Amplify App.
tags (dict) --
Tag for branch for Amplify App.
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, will use as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch, part of an Amplify App.
createTime (datetime) --
Creation date and time for a branch, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a branch, part of an Amplify App.
environmentVariables (dict) --
Environment Variables specific to a branch, part of an Amplify App.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch, part of an Amplify App.
customDomains (list) --
Custom domains for a branch, part of an Amplify App.
framework (string) --
Framework for a branch, part of an Amplify App.
activeJobId (string) --
Id of the active job for a branch, part of an Amplify App.
totalNumberOfJobs (string) --
Total number of Jobs part of an Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for a branch, part of an Amplify App.
thumbnailUrl (string) --
Thumbnail URL for the branch.
basicAuthCredentials (string) --
Basic Authorization credentials for a branch, part of an Amplify App.
buildSpec (string) --
BuildSpec content for branch for Amplify App.
ttl (string) --
The content TTL for the website in seconds.
associatedResources (list) --
List of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for this branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
ARN for a Backend Environment, part of an Amplify App.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
List domains with an app
See also: AWS API Documentation
Request Syntax
response = client.list_domain_associations(
appId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Unique Id for an Amplify App.
dict
Response Syntax
{
'domainAssociations': [
{
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure for the list Domain Association request.
domainAssociations (list) --
List of Domain Associations.
(dict) --
Structure for Domain Association, which associates a custom domain with an Amplify App.
domainAssociationArn (string) --
ARN for the Domain Association.
domainName (string) --
Name of the domain.
enableAutoSubDomain (boolean) --
Enables automated creation of Subdomains for branches. (Currently not supported)
domainStatus (string) --
Status fo the Domain Association.
statusReason (string) --
Reason for the current status of the Domain Association.
certificateVerificationDNSRecord (string) --
DNS Record for certificate verification.
subDomains (list) --
Subdomains for the Domain Association.
(dict) --
Subdomain for the Domain Association.
subDomainSetting (dict) --
Setting structure for the Subdomain.
prefix (string) --
Prefix setting for the Subdomain.
branchName (string) --
Branch name setting for the Subdomain.
verified (boolean) --
Verified status of the Subdomain
dnsRecord (string) --
DNS record for the Subdomain.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
List Jobs for a branch, part of an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.list_jobs(
appId='string',
branchName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for a branch.
dict
Response Syntax
{
'jobSummaries': [
{
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Maximum number of records to list in a single response.
jobSummaries (list) --
Result structure for list job result request.
(dict) --
Structure for the summary of a Job.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
List tags for resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
Resource arn used to list tags.
{
'tags': {
'string': 'string'
}
}
Response Structure
Response for list tags.
Tags result for response.
Exceptions
List webhooks with an app.
See also: AWS API Documentation
Request Syntax
response = client.list_webhooks(
appId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
Unique Id for an Amplify App.
dict
Response Syntax
{
'webhooks': [
{
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Result structure for the list webhooks request.
webhooks (list) --
List of webhooks.
(dict) --
Structure for webhook, which associates a webhook with an Amplify App.
webhookArn (string) --
ARN for the webhook.
webhookId (string) --
Id of the webhook.
webhookUrl (string) --
Url of the webhook.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a webhook.
createTime (datetime) --
Create date / time for a webhook.
updateTime (datetime) --
Update date / time for a webhook.
nextToken (string) --
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
Exceptions
Start a deployment for manual deploy apps. (Apps are not connected to repository)
See also: AWS API Documentation
Request Syntax
response = client.start_deployment(
appId='string',
branchName='string',
jobId='string',
sourceUrl='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch, 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': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
Result structure for start a deployment.
jobSummary (dict) --
Summary for the Job.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
Exceptions
Starts a new job for a branch, part of an Amplify App.
See also: AWS API Documentation
Request Syntax
response = 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)
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch, for the Job.
[REQUIRED]
Type for the Job. Available JobTypes are: n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
Result structure for run job request.
jobSummary (dict) --
Summary for the Job.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
Exceptions
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.stop_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch, for the Job.
[REQUIRED]
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': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
Result structure for the stop job request.
jobSummary (dict) --
Summary for the Job.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
Exceptions
Tag resource with tag key and value.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
Resource arn used to tag resource.
[REQUIRED]
Tags used to tag resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Response for tag resource.
Exceptions
Untag resource with resourceArn.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
Resource arn used to untag resource.
[REQUIRED]
Tag keys used to untag resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Response for untag resource.
Exceptions
Updates an existing Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.update_app(
appId='string',
name='string',
description='string',
platform='WEB',
iamServiceRoleArn='string',
environmentVariables={
'string': 'string'
},
enableBranchAutoBuild=True|False,
enableBasicAuth=True|False,
basicAuthCredentials='string',
customRules=[
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
buildSpec='string',
enableAutoBranchCreation=True|False,
autoBranchCreationPatterns=[
'string',
],
autoBranchCreationConfig={
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
},
repository='string',
oauthToken='string',
accessToken='string'
)
[REQUIRED]
Unique Id for an Amplify App.
Environment Variables for an Amplify App.
Custom redirect / rewrite rules for an Amplify App.
Custom rewrite / redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
The condition for a URL rewrite or redirect rule, e.g. country code.
Automated branch creation glob patterns for the Amplify App.
Automated branch creation branchConfig for the Amplify App.
Stage for the auto created branch.
Framework for the auto created branch.
Enables auto building for the auto created branch.
Environment Variables for the auto created branch.
Basic Authorization credentials for the auto created branch.
Enables Basic Auth for the auto created branch.
BuildSpec for the auto created branch.
Enables Pull Request Preview for auto created branch.
The Amplify Environment name for the pull request.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
}
}
Response Structure
(dict) --
Result structure for an Amplify App update request.
app (dict) --
App structure for the updated App.
appId (string) --
Unique Id for the Amplify App.
appArn (string) --
ARN for the Amplify App.
name (string) --
Name for the Amplify App.
tags (dict) --
Tag for Amplify App.
description (string) --
Description for the Amplify App.
repository (string) --
Repository for the Amplify App.
platform (string) --
Platform for the Amplify App.
createTime (datetime) --
Create date / time for the Amplify App.
updateTime (datetime) --
Update date / time for the Amplify App.
iamServiceRoleArn (string) --
IAM service role ARN for the Amplify App.
environmentVariables (dict) --
Environment Variables for the Amplify App.
defaultDomain (string) --
Default domain for the Amplify App.
enableBranchAutoBuild (boolean) --
Enables auto-building of branches for the Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for branches for the Amplify App.
basicAuthCredentials (string) --
Basic Authorization credentials for branches for the Amplify App.
customRules (list) --
Custom redirect / rewrite rules for the Amplify App.
(dict) --
Custom rewrite / redirect rule.
source (string) --
The source pattern for a URL rewrite or redirect rule.
target (string) --
The target pattern for a URL rewrite or redirect rule.
status (string) --
The status code for a URL rewrite or redirect rule.
condition (string) --
The condition for a URL rewrite or redirect rule, e.g. country code.
productionBranch (dict) --
Structure with Production Branch information.
lastDeployTime (datetime) --
Last Deploy Time of Production Branch.
status (string) --
Status of Production Branch.
thumbnailUrl (string) --
Thumbnail URL for Production Branch.
branchName (string) --
Branch Name for Production Branch.
buildSpec (string) --
BuildSpec content for Amplify App.
enableAutoBranchCreation (boolean) --
Enables automated branch creation for the Amplify App.
autoBranchCreationPatterns (list) --
Automated branch creation glob patterns for the Amplify App.
autoBranchCreationConfig (dict) --
Automated branch creation config for the Amplify App.
stage (string) --
Stage for the auto created branch.
framework (string) --
Framework for the auto created branch.
enableAutoBuild (boolean) --
Enables auto building for the auto created branch.
environmentVariables (dict) --
Environment Variables for the auto created branch.
basicAuthCredentials (string) --
Basic Authorization credentials for the auto created branch.
enableBasicAuth (boolean) --
Enables Basic Auth for the auto created branch.
buildSpec (string) --
BuildSpec for the auto created branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for auto created branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
Exceptions
Updates a branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
response = client.update_branch(
appId='string',
branchName='string',
description='string',
framework='string',
stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
enableNotification=True|False,
enableAutoBuild=True|False,
environmentVariables={
'string': 'string'
},
basicAuthCredentials='string',
enableBasicAuth=True|False,
buildSpec='string',
ttl='string',
displayName='string',
enablePullRequestPreview=True|False,
pullRequestEnvironmentName='string',
backendEnvironmentArn='string'
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for the branch.
Environment Variables for 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,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
}
}
Response Structure
(dict) --
Result structure for update branch request.
branch (dict) --
Branch structure for an Amplify App.
branchArn (string) --
ARN for a branch, part of an Amplify App.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a branch, part of an Amplify App.
tags (dict) --
Tag for branch for Amplify App.
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, will use as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch, part of an Amplify App.
createTime (datetime) --
Creation date and time for a branch, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a branch, part of an Amplify App.
environmentVariables (dict) --
Environment Variables specific to a branch, part of an Amplify App.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch, part of an Amplify App.
customDomains (list) --
Custom domains for a branch, part of an Amplify App.
framework (string) --
Framework for a branch, part of an Amplify App.
activeJobId (string) --
Id of the active job for a branch, part of an Amplify App.
totalNumberOfJobs (string) --
Total number of Jobs part of an Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for a branch, part of an Amplify App.
thumbnailUrl (string) --
Thumbnail URL for the branch.
basicAuthCredentials (string) --
Basic Authorization credentials for a branch, part of an Amplify App.
buildSpec (string) --
BuildSpec content for branch for Amplify App.
ttl (string) --
The content TTL for the website in seconds.
associatedResources (list) --
List of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for this branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
ARN for a Backend Environment, part of an Amplify App.
Exceptions
Create a new DomainAssociation on an App
See also: AWS API Documentation
Request Syntax
response = client.update_domain_association(
appId='string',
domainName='string',
enableAutoSubDomain=True|False,
subDomainSettings=[
{
'prefix': 'string',
'branchName': 'string'
},
]
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name of the domain.
[REQUIRED]
Setting structure for the Subdomain.
Setting for the Subdomain.
Prefix setting for the Subdomain.
Branch name setting for the Subdomain.
dict
Response Syntax
{
'domainAssociation': {
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
}
}
Response Structure
(dict) --
Result structure for the update Domain Association request.
domainAssociation (dict) --
Domain Association structure.
domainAssociationArn (string) --
ARN for the Domain Association.
domainName (string) --
Name of the domain.
enableAutoSubDomain (boolean) --
Enables automated creation of Subdomains for branches. (Currently not supported)
domainStatus (string) --
Status fo the Domain Association.
statusReason (string) --
Reason for the current status of the Domain Association.
certificateVerificationDNSRecord (string) --
DNS Record for certificate verification.
subDomains (list) --
Subdomains for the Domain Association.
(dict) --
Subdomain for the Domain Association.
subDomainSetting (dict) --
Setting structure for the Subdomain.
prefix (string) --
Prefix setting for the Subdomain.
branchName (string) --
Branch name setting for the Subdomain.
verified (boolean) --
Verified status of the Subdomain
dnsRecord (string) --
DNS record for the Subdomain.
Exceptions
Update a webhook.
See also: AWS API Documentation
Request Syntax
response = client.update_webhook(
webhookId='string',
branchName='string',
description='string'
)
[REQUIRED]
Unique Id for a webhook.
dict
Response Syntax
{
'webhook': {
'webhookArn': 'string',
'webhookId': 'string',
'webhookUrl': 'string',
'branchName': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Result structure for the update webhook request.
webhook (dict) --
Webhook structure.
webhookArn (string) --
ARN for the webhook.
webhookId (string) --
Id of the webhook.
webhookUrl (string) --
Url of the webhook.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a webhook.
createTime (datetime) --
Create date / time for a webhook.
updateTime (datetime) --
Update date / time for a webhook.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_apps')
Creates an iterator that will paginate through responses from Amplify.Client.list_apps().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'apps': [
{
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'WEB',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'iamServiceRoleArn': 'string',
'environmentVariables': {
'string': 'string'
},
'defaultDomain': 'string',
'enableBranchAutoBuild': True|False,
'enableBasicAuth': True|False,
'basicAuthCredentials': 'string',
'customRules': [
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
'productionBranch': {
'lastDeployTime': datetime(2015, 1, 1),
'status': 'string',
'thumbnailUrl': 'string',
'branchName': 'string'
},
'buildSpec': 'string',
'enableAutoBranchCreation': True|False,
'autoBranchCreationPatterns': [
'string',
],
'autoBranchCreationConfig': {
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
'framework': 'string',
'enableAutoBuild': True|False,
'environmentVariables': {
'string': 'string'
},
'basicAuthCredentials': 'string',
'enableBasicAuth': True|False,
'buildSpec': 'string',
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Result structure for an Amplify App list request.
List of Amplify Apps.
Amplify App represents different branches of a repository for building, deploying, and hosting.
Unique Id for the Amplify App.
ARN for the Amplify App.
Name for the Amplify App.
Tag for Amplify App.
Description for the Amplify App.
Repository for the Amplify App.
Platform for the Amplify App.
Create date / time for the Amplify App.
Update date / time for the Amplify App.
IAM service role ARN for the Amplify App.
Environment Variables for the Amplify App.
Default domain for the Amplify App.
Enables auto-building of branches for the Amplify App.
Enables Basic Authorization for branches for the Amplify App.
Basic Authorization credentials for branches for the Amplify App.
Custom redirect / rewrite rules for the Amplify App.
Custom rewrite / redirect rule.
The source pattern for a URL rewrite or redirect rule.
The target pattern for a URL rewrite or redirect rule.
The status code for a URL rewrite or redirect rule.
The condition for a URL rewrite or redirect rule, e.g. country code.
Structure with Production Branch information.
Last Deploy Time of Production Branch.
Status of Production Branch.
Thumbnail URL for Production Branch.
Branch Name for Production Branch.
BuildSpec content for Amplify App.
Enables automated branch creation for the Amplify App.
Automated branch creation glob patterns for the Amplify App.
Automated branch creation config for the Amplify App.
Stage for the auto created branch.
Framework for the auto created branch.
Enables auto building for the auto created branch.
Environment Variables for the auto created branch.
Basic Authorization credentials for the auto created branch.
Enables Basic Auth for the auto created branch.
BuildSpec for the auto created branch.
Enables Pull Request Preview for auto created branch.
The Amplify Environment name for the pull request.
A token to resume pagination.
paginator = client.get_paginator('list_branches')
Creates an iterator that will paginate through responses from Amplify.Client.list_branches().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
appId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Unique Id for an Amplify App.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous 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,
'thumbnailUrl': 'string',
'basicAuthCredentials': 'string',
'buildSpec': 'string',
'ttl': 'string',
'associatedResources': [
'string',
],
'enablePullRequestPreview': True|False,
'pullRequestEnvironmentName': 'string',
'destinationBranch': 'string',
'sourceBranch': 'string',
'backendEnvironmentArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Result structure for list branches request.
branches (list) --
List of branches for an Amplify App.
(dict) --
Branch for an Amplify App, which maps to a 3rd party repository branch.
branchArn (string) --
ARN for a branch, part of an Amplify App.
branchName (string) --
Name for a branch, part of an Amplify App.
description (string) --
Description for a branch, part of an Amplify App.
tags (dict) --
Tag for branch for Amplify App.
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, will use as the default domain prefix.
enableNotification (boolean) --
Enables notifications for a branch, part of an Amplify App.
createTime (datetime) --
Creation date and time for a branch, part of an Amplify App.
updateTime (datetime) --
Last updated date and time for a branch, part of an Amplify App.
environmentVariables (dict) --
Environment Variables specific to a branch, part of an Amplify App.
enableAutoBuild (boolean) --
Enables auto-building on push for a branch, part of an Amplify App.
customDomains (list) --
Custom domains for a branch, part of an Amplify App.
framework (string) --
Framework for a branch, part of an Amplify App.
activeJobId (string) --
Id of the active job for a branch, part of an Amplify App.
totalNumberOfJobs (string) --
Total number of Jobs part of an Amplify App.
enableBasicAuth (boolean) --
Enables Basic Authorization for a branch, part of an Amplify App.
thumbnailUrl (string) --
Thumbnail URL for the branch.
basicAuthCredentials (string) --
Basic Authorization credentials for a branch, part of an Amplify App.
buildSpec (string) --
BuildSpec content for branch for Amplify App.
ttl (string) --
The content TTL for the website in seconds.
associatedResources (list) --
List of custom resources that are linked to this branch.
enablePullRequestPreview (boolean) --
Enables Pull Request Preview for this branch.
pullRequestEnvironmentName (string) --
The Amplify Environment name for the pull request.
destinationBranch (string) --
The destination branch if the branch is a pull request branch.
sourceBranch (string) --
The source branch if the branch is a pull request branch.
backendEnvironmentArn (string) --
ARN for a Backend Environment, part of an Amplify App.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_domain_associations')
Creates an iterator that will paginate through responses from Amplify.Client.list_domain_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
appId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Unique Id for an Amplify App.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'domainAssociations': [
{
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
'statusReason': 'string',
'certificateVerificationDNSRecord': 'string',
'subDomains': [
{
'subDomainSetting': {
'prefix': 'string',
'branchName': 'string'
},
'verified': True|False,
'dnsRecord': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Result structure for the list Domain Association request.
domainAssociations (list) --
List of Domain Associations.
(dict) --
Structure for Domain Association, which associates a custom domain with an Amplify App.
domainAssociationArn (string) --
ARN for the Domain Association.
domainName (string) --
Name of the domain.
enableAutoSubDomain (boolean) --
Enables automated creation of Subdomains for branches. (Currently not supported)
domainStatus (string) --
Status fo the Domain Association.
statusReason (string) --
Reason for the current status of the Domain Association.
certificateVerificationDNSRecord (string) --
DNS Record for certificate verification.
subDomains (list) --
Subdomains for the Domain Association.
(dict) --
Subdomain for the Domain Association.
subDomainSetting (dict) --
Setting structure for the Subdomain.
prefix (string) --
Prefix setting for the Subdomain.
branchName (string) --
Branch name setting for the Subdomain.
verified (boolean) --
Verified status of the Subdomain
dnsRecord (string) --
DNS record for the Subdomain.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_jobs')
Creates an iterator that will paginate through responses from Amplify.Client.list_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
appId='string',
branchName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Unique Id for an Amplify App.
[REQUIRED]
Name for a branch.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'jobSummaries': [
{
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Maximum number of records to list in a single response.
jobSummaries (list) --
Result structure for list job result request.
(dict) --
Structure for the summary of a Job.
jobArn (string) --
Arn for the Job.
jobId (string) --
Unique Id for the Job.
commitId (string) --
Commit Id from 3rd party repository provider for the Job.
commitMessage (string) --
Commit message from 3rd party repository provider for the Job.
commitTime (datetime) --
Commit date / time for the Job.
startTime (datetime) --
Start date / time for the Job.
status (string) --
Status for the Job.
endTime (datetime) --
End date / time for the Job.
jobType (string) --
Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
NextToken (string) --
A token to resume pagination.