2018/11/26 - AWS Amplify - 20 new api methods
Changes Update amplify client to latest version
Creates a new Amplify App.
See also: AWS API Documentation
Request Syntax
client.create_app(
name='string',
description='string',
repository='string',
platform='IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
iamServiceRoleArn='string',
oauthToken='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'
)
string
[REQUIRED]
Name for the Amplify App
string
Description for an Amplify App
string
[REQUIRED]
Repository for an Amplify App
string
[REQUIRED]
Platform / framework for an Amplify App
string
AWS IAM service role for an Amplify App
string
[REQUIRED]
OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.
dict
Environment variables map for an Amplify App.
(string) --
(string) --
boolean
Enable the auto building of branches for an Amplify App.
boolean
Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
string
Credentials for Basic Authorization for an Amplify App.
list
Custom rewrite / redirect rules for an Amplify App.
(dict) --
Custom rewrite / 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.
condition (string) --
The condition for a URL rewrite or redirect rule, e.g. country code.
dict
Tag for an Amplify App
(string) --
(string) --
string
BuildSpec for an Amplify App
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
'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'
}
}
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.
(string) --
(string) --
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.
(string) --
(string) --
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.
Deletes a DomainAssociation.
See also: AWS API Documentation
Request Syntax
client.delete_domain_association(
appId='string',
domainName='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[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',
'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.
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.
Get a job for a branch, part of an Amplify App.
See also: AWS API Documentation
Request Syntax
client.get_job(
appId='string',
branchName='string',
jobId='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch, for the Job.
string
[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'|'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',
'screenshots': {
'string': '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.
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 teh artifact for the execution step.
screenshots (dict) --
List of screenshot Urls for the execution step, if relevant.
(string) --
(string) --
Updates a branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
client.update_branch(
appId='string',
branchName='string',
description='string',
framework='string',
stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
enableNotification=True|False,
enableAutoBuild=True|False,
environmentVariables={
'string': 'string'
},
basicAuthCredentials='string',
enableBasicAuth=True|False,
buildSpec='string',
ttl='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch.
string
Description for the branch.
string
Framework for the branch.
string
Stage for the branch.
boolean
Enables notifications for the branch.
boolean
Enables auto building for the branch.
dict
Environment Variables for the branch.
(string) --
(string) --
string
Basic Authorization credentials for the branch.
boolean
Enables Basic Auth for the branch.
string
BuildSpec for the branch.
string
The content TTL for the website in seconds.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
'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'
}
}
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.
(string) --
(string) --
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, part of an Amplify App.
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.
(string) --
(string) --
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.
(string) --
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.
Updates an existing Amplify App.
See also: AWS API Documentation
Request Syntax
client.update_app(
appId='string',
name='string',
description='string',
platform='IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
iamServiceRoleArn='string',
environmentVariables={
'string': 'string'
},
enableBranchAutoBuild=True|False,
enableBasicAuth=True|False,
basicAuthCredentials='string',
customRules=[
{
'source': 'string',
'target': 'string',
'status': 'string',
'condition': 'string'
},
],
buildSpec='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
Name for an Amplify App.
string
Description for an Amplify App.
string
Platform for an Amplify App.
string
IAM service role for an Amplify App.
dict
Environment Variables for an Amplify App.
(string) --
(string) --
boolean
Enables branch auto-building for an Amplify App.
boolean
Enables Basic Authorization for an Amplify App.
string
Basic Authorization credentials for an Amplify App.
list
Custom redirect / rewrite rules for an Amplify App.
(dict) --
Custom rewrite / 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.
condition (string) --
The condition for a URL rewrite or redirect rule, e.g. country code.
string
BuildSpec for an Amplify App.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
'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'
}
}
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.
(string) --
(string) --
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.
(string) --
(string) --
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.
List Jobs for a branch, part of an Amplify App.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
appId='string',
branchName='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for a branch.
string
Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.
integer
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': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'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.
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.
Creates a new Branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
client.create_branch(
appId='string',
branchName='string',
description='string',
stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
framework='string',
enableNotification=True|False,
enableAutoBuild=True|False,
environmentVariables={
'string': 'string'
},
basicAuthCredentials='string',
enableBasicAuth=True|False,
tags={
'string': 'string'
},
buildSpec='string',
ttl='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch.
string
Description for the branch.
string
Stage for the branch.
string
Framework for the branch.
boolean
Enables notifications for the branch.
boolean
Enables auto building for the branch.
dict
Environment Variables for the branch.
(string) --
(string) --
string
Basic Authorization credentials for the branch.
boolean
Enables Basic Auth for the branch.
dict
Tag for the branch.
(string) --
(string) --
string
BuildSpec for the branch.
string
The content TTL for the website in seconds.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
'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'
}
}
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.
(string) --
(string) --
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, part of an Amplify App.
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.
(string) --
(string) --
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.
(string) --
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.
List domains with an app
See also: AWS API Documentation
Request Syntax
client.list_domain_associations(
appId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
Unique Id for an Amplify App.
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.
integer
Maximum number of records to list in a single response.
dict
Response Syntax
{
'domainAssociations': [
{
'domainAssociationArn': 'string',
'domainName': 'string',
'enableAutoSubDomain': True|False,
'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED',
'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.
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.
Retrieves domain info that corresponds to an appId and domainName.
See also: AWS API Documentation
Request Syntax
client.get_domain_association(
appId='string',
domainName='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[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',
'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.
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.
Deletes a branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
client.delete_branch(
appId='string',
branchName='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
'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'
}
}
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.
(string) --
(string) --
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, part of an Amplify App.
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.
(string) --
(string) --
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.
(string) --
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.
Delete an existing Amplify App by appId.
See also: AWS API Documentation
Request Syntax
client.delete_app(
appId='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
'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'
}
}
Response Structure
(dict) --
Result structure for an Amplify App delete request.
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.
(string) --
(string) --
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.
(string) --
(string) --
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.
Create a new DomainAssociation on an App
See also: AWS API Documentation
Request Syntax
client.create_domain_association(
appId='string',
domainName='string',
enableAutoSubDomain=True|False,
subDomainSettings=[
{
'prefix': 'string',
'branchName': 'string'
},
]
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Domain name for the Domain Association.
boolean
Enables automated creation of Subdomains for branches.
list
[REQUIRED]
Setting structure for the Subdomain.
(dict) --
Setting for the Subdomain.
prefix (string) -- [REQUIRED]
Prefix setting for the Subdomain.
branchName (string) -- [REQUIRED]
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',
'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.
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.
Lists existing Amplify Apps.
See also: AWS API Documentation
Request Syntax
client.list_apps(
nextToken='string',
maxResults=123
)
string
Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
integer
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': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
'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'
},
],
'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.
(string) --
(string) --
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.
(string) --
(string) --
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.
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.
Delete a job, for an Amplify branch, part of Amplify App.
See also: AWS API Documentation
Request Syntax
client.delete_job(
appId='string',
branchName='string',
jobId='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch, for the Job.
string
[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'|'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.
Starts a new job for a branch, part of an Amplify App.
See also: AWS API Documentation
Request Syntax
client.start_job(
appId='string',
branchName='string',
jobId='string',
jobType='RELEASE'|'RETRY'|'WEB_HOOK',
jobReason='string',
commitId='string',
commitMessage='string',
commitTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch, for the Job.
string
Unique Id for the Job.
string
[REQUIRED]
Type for the Job.
string
Reason for the Job.
string
Commit Id from 3rd party repository provider for the Job.
string
Commit message from 3rd party repository provider for the Job.
datetime
Commit date / 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': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'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.
Create a new DomainAssociation on an App
See also: AWS API Documentation
Request Syntax
client.update_domain_association(
appId='string',
domainName='string',
enableAutoSubDomain=True|False,
subDomainSettings=[
{
'prefix': 'string',
'branchName': 'string'
},
]
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name of the domain.
boolean
Enables automated creation of Subdomains for branches.
list
[REQUIRED]
Setting structure for the Subdomain.
(dict) --
Setting for the Subdomain.
prefix (string) -- [REQUIRED]
Prefix setting for the Subdomain.
branchName (string) -- [REQUIRED]
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',
'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.
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.
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
See also: AWS API Documentation
Request Syntax
client.stop_job(
appId='string',
branchName='string',
jobId='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch, for the Job.
string
[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'|'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.
Retrieves a branch for an Amplify App.
See also: AWS API Documentation
Request Syntax
client.get_branch(
appId='string',
branchName='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
[REQUIRED]
Name for the branch.
dict
Response Syntax
{
'branch': {
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
'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'
}
}
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.
(string) --
(string) --
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, part of an Amplify App.
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.
(string) --
(string) --
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.
(string) --
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.
Retrieves an existing Amplify App by appId.
See also: AWS API Documentation
Request Syntax
client.get_app(
appId='string'
)
string
[REQUIRED]
Unique Id for an Amplify App.
dict
Response Syntax
{
'app': {
'appId': 'string',
'appArn': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'description': 'string',
'repository': 'string',
'platform': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
'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'
}
}
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.
(string) --
(string) --
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.
(string) --
(string) --
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.
Lists branches for an Amplify App.
See also: AWS API Documentation
Request Syntax
client.list_branches(
appId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
Unique Id for an Amplify App.
string
Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.
integer
Maximum number of records to list in a single response.
dict
Response Syntax
{
'branches': [
{
'branchArn': 'string',
'branchName': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
'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'
},
],
'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.
(string) --
(string) --
stage (string) --
Stage for a branch, part of an Amplify App.
displayName (string) --
Display name for a branch, part of an Amplify App.
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.
(string) --
(string) --
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.
(string) --
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.
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.