String appId
Unique Id for the Amplify App.
String appArn
ARN for the Amplify App.
String name
Name for the Amplify App.
Map<K,V> tags
Tag for Amplify App.
String description
Description for the Amplify App.
String repository
Repository for the Amplify App.
String platform
Platform for the Amplify App.
Date createTime
Create date / time for the Amplify App.
Date updateTime
Update date / time for the Amplify App.
String iamServiceRoleArn
IAM service role ARN for the Amplify App.
Map<K,V> environmentVariables
Environment Variables for the Amplify App.
String defaultDomain
Default domain for the Amplify App.
Boolean enableBranchAutoBuild
Enables auto-building of branches for the Amplify App.
Boolean enableBasicAuth
Enables Basic Authorization for branches for the Amplify App.
String basicAuthCredentials
Basic Authorization credentials for branches for the Amplify App.
List<E> customRules
Custom redirect / rewrite rules for the Amplify App.
ProductionBranch productionBranch
Structure with Production Branch information.
String buildSpec
BuildSpec content for Amplify App.
Boolean enableAutoBranchCreation
Enables automated branch creation for the Amplify App.
List<E> autoBranchCreationPatterns
Automated branch creation glob patterns for the Amplify App.
AutoBranchCreationConfig autoBranchCreationConfig
Automated branch creation config for the Amplify App.
String stage
Stage for the auto created branch.
String framework
Framework for the auto created branch.
Boolean enableAutoBuild
Enables auto building for the auto created branch.
Map<K,V> environmentVariables
Environment Variables for the auto created branch.
String basicAuthCredentials
Basic Authorization credentials for the auto created branch.
Boolean enableBasicAuth
Enables Basic Auth for the auto created branch.
String buildSpec
BuildSpec for the auto created branch.
Boolean enablePullRequestPreview
Enables Pull Request Preview for auto created branch.
String pullRequestEnvironmentName
The Amplify Environment name for the pull request.
String backendEnvironmentArn
Arn for a backend environment, part of an Amplify App.
String environmentName
Name for a backend environment, part of an Amplify App.
String stackName
CloudFormation stack name of backend environment.
String deploymentArtifacts
Name of deployment artifacts.
Date createTime
Creation date and time for a backend environment, part of an Amplify App.
Date updateTime
Last updated date and time for a backend environment, part of an Amplify App.
String branchArn
ARN for a branch, part of an Amplify App.
String branchName
Name for a branch, part of an Amplify App.
String description
Description for a branch, part of an Amplify App.
Map<K,V> tags
Tag for branch for Amplify App.
String stage
Stage for a branch, part of an Amplify App.
String displayName
Display name for a branch, will use as the default domain prefix.
Boolean enableNotification
Enables notifications for a branch, part of an Amplify App.
Date createTime
Creation date and time for a branch, part of an Amplify App.
Date updateTime
Last updated date and time for a branch, part of an Amplify App.
Map<K,V> environmentVariables
Environment Variables specific to a branch, part of an Amplify App.
Boolean enableAutoBuild
Enables auto-building on push for a branch, part of an Amplify App.
List<E> customDomains
Custom domains for a branch, part of an Amplify App.
String framework
Framework for a branch, part of an Amplify App.
String activeJobId
Id of the active job for a branch, part of an Amplify App.
String totalNumberOfJobs
Total number of Jobs part of an Amplify App.
Boolean enableBasicAuth
Enables Basic Authorization for a branch, part of an Amplify App.
String thumbnailUrl
Thumbnail URL for the branch.
String basicAuthCredentials
Basic Authorization credentials for a branch, part of an Amplify App.
String buildSpec
BuildSpec content for branch for Amplify App.
String ttl
The content TTL for the website in seconds.
List<E> associatedResources
List of custom resources that are linked to this branch.
Boolean enablePullRequestPreview
Enables Pull Request Preview for this branch.
String pullRequestEnvironmentName
The Amplify Environment name for the pull request.
String destinationBranch
The destination branch if the branch is a pull request branch.
String sourceBranch
The source branch if the branch is a pull request branch.
String backendEnvironmentArn
ARN for a Backend Environment, part of an Amplify App.
String name
Name for the Amplify App
String description
Description for an Amplify App
String repository
Repository for an Amplify App
String platform
Platform / framework for an Amplify App
String iamServiceRoleArn
AWS IAM service role for an Amplify App
String oauthToken
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.
String accessToken
Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.
Map<K,V> environmentVariables
Environment variables map for an Amplify App.
Boolean enableBranchAutoBuild
Enable the auto building of branches for an Amplify App.
Boolean enableBasicAuth
Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
String basicAuthCredentials
Credentials for Basic Authorization for an Amplify App.
List<E> customRules
Custom rewrite / redirect rules for an Amplify App.
Map<K,V> tags
Tag for an Amplify App
String buildSpec
BuildSpec for an Amplify App
Boolean enableAutoBranchCreation
Enables automated branch creation for the Amplify App.
List<E> autoBranchCreationPatterns
Automated branch creation glob patterns for the Amplify App.
AutoBranchCreationConfig autoBranchCreationConfig
Automated branch creation config for the Amplify App.
App app
BackendEnvironment backendEnvironment
Backend environment structure for an amplify App.
String appId
Unique Id for an Amplify App.
String branchName
Name for the branch.
String description
Description for the branch.
String stage
Stage for the branch.
String framework
Framework for the branch.
Boolean enableNotification
Enables notifications for the branch.
Boolean enableAutoBuild
Enables auto building for the branch.
Map<K,V> environmentVariables
Environment Variables for the branch.
String basicAuthCredentials
Basic Authorization credentials for the branch.
Boolean enableBasicAuth
Enables Basic Auth for the branch.
Map<K,V> tags
Tag for the branch.
String buildSpec
BuildSpec for the branch.
String ttl
The content TTL for the website in seconds.
String displayName
Display name for a branch, will use as the default domain prefix.
Boolean enablePullRequestPreview
Enables Pull Request Preview for this branch.
String pullRequestEnvironmentName
The Amplify Environment name for the pull request.
String backendEnvironmentArn
ARN for a Backend Environment, part of an Amplify App.
Branch branch
Branch structure for an Amplify App.
String appId
Unique Id for an Amplify App.
String branchName
Name for the branch, for the Job.
Map<K,V> fileMap
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.
String jobId
The jobId for this deployment, will supply to start deployment api.
Map<K,V> fileUploadUrls
When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url.
String zipUploadUrl
When the fileMap argument is NOT provided. This zipUploadUrl will be returned.
String appId
Unique Id for an Amplify App.
String domainName
Domain name for the Domain Association.
Boolean enableAutoSubDomain
Enables automated creation of Subdomains for branches. (Currently not supported)
List<E> subDomainSettings
Setting structure for the Subdomain.
DomainAssociation domainAssociation
Domain Association structure.
Webhook webhook
Webhook structure.
String source
The source pattern for a URL rewrite or redirect rule.
String target
The target pattern for a URL rewrite or redirect rule.
String status
The status code for a URL rewrite or redirect rule.
String condition
The condition for a URL rewrite or redirect rule, e.g. country code.
String appId
Unique Id for an Amplify App.
App app
BackendEnvironment backendEnvironment
Backend environment structure for an Amplify App.
Branch branch
Branch structure for an Amplify App.
DomainAssociation domainAssociation
JobSummary jobSummary
String webhookId
Unique Id for a webhook.
Webhook webhook
Webhook structure.
String domainAssociationArn
ARN for the Domain Association.
String domainName
Name of the domain.
Boolean enableAutoSubDomain
Enables automated creation of Subdomains for branches. (Currently not supported)
String domainStatus
Status fo the Domain Association.
String statusReason
Reason for the current status of the Domain Association.
String certificateVerificationDNSRecord
DNS Record for certificate verification.
List<E> subDomains
Subdomains for the Domain Association.
String logUrl
Pre-signed URL for the requested access logs.
String appId
Unique Id for an Amplify App.
App app
String artifactId
Unique Id for a artifact.
BackendEnvironment backendEnvironment
Backend environment structure for an an Amplify App.
Branch branch
DomainAssociation domainAssociation
Domain Association structure.
Job job
String webhookId
Unique Id for a webhook.
Webhook webhook
Webhook structure.
JobSummary summary
Summary for an execution job for an Amplify App.
List<E> steps
Execution steps for an execution job, for an Amplify App.
String jobArn
Arn for the Job.
String jobId
Unique Id for the Job.
String commitId
Commit Id from 3rd party repository provider for the Job.
String commitMessage
Commit message from 3rd party repository provider for the Job.
Date commitTime
Commit date / time for the Job.
Date startTime
Start date / time for the Job.
String status
Status for the Job.
Date endTime
End date / time for the Job.
String jobType
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.
String appId
Unique Id for an Amplify App.
String branchName
Name for a branch, part of an Amplify App.
String jobId
Unique Id for an Job.
String nextToken
Pagination token. Set to null to start listing artifacts from start. If non-null pagination token is returned in a result, then pass its value in here to list more artifacts.
Integer maxResults
Maximum number of records to list in a single response.
String appId
Unique Id for an amplify App.
String environmentName
Name of the backend environment
String nextToken
Pagination token. Set to null to start listing backen environments from start. If a non-null pagination token is returned in a result, then pass its value in here to list more backend environments.
Integer maxResults
Maximum number of records to list in a single response.
String appId
Unique Id for an Amplify App.
String nextToken
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 maxResults
Maximum number of records to list in a single response.
String appId
Unique Id for an Amplify App.
String nextToken
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 maxResults
Maximum number of records to list in a single response.
String appId
Unique Id for an Amplify App.
String branchName
Name for a branch.
String nextToken
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 maxResults
Maximum number of records to list in a single response.
String resourceArn
Resource arn used to list tags.
String appId
Unique Id for an Amplify App.
String nextToken
Pagination token. Set to null to start listing webhooks from start. If non-null pagination token is returned in a result, then pass its value in here to list more webhooks.
Integer maxResults
Maximum number of records to list in a single response.
String code
String appId
Unique Id for an Amplify App.
String branchName
Name for the branch, for the Job.
String jobId
The job id for this deployment, generated by create deployment request.
String sourceUrl
The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.
JobSummary jobSummary
Summary for the Job.
String appId
Unique Id for an Amplify App.
String branchName
Name for the branch, for the Job.
String jobId
Unique Id for an existing job. Required for "RETRY" JobType.
String jobType
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.
String jobReason
Descriptive reason for starting this job.
String commitId
Commit Id from 3rd party repository provider for the Job.
String commitMessage
Commit message from 3rd party repository provider for the Job.
Date commitTime
Commit date / time for the Job.
JobSummary jobSummary
Summary for the Job.
String stepName
Name of the execution step.
Date startTime
Start date/ time of the execution step.
String status
Status of the execution step.
Date endTime
End date/ time of the execution step.
String logUrl
URL to the logs for the execution step.
String artifactsUrl
URL to the artifact for the execution step.
String testArtifactsUrl
URL to the test artifact for the execution step.
String testConfigUrl
URL to the test config for the execution step.
Map<K,V> screenshots
List of screenshot URLs for the execution step, if relevant.
String statusReason
The reason for current step status.
String context
The context for current step, will include build image if step is build.
JobSummary jobSummary
Summary for the Job.
SubDomainSetting subDomainSetting
Setting structure for the Subdomain.
Boolean verified
Verified status of the Subdomain
String dnsRecord
DNS record for the Subdomain.
String appId
Unique Id for an Amplify App.
String name
Name for an Amplify App.
String description
Description for an Amplify App.
String platform
Platform for an Amplify App.
String iamServiceRoleArn
IAM service role for an Amplify App.
Map<K,V> environmentVariables
Environment Variables for an Amplify App.
Boolean enableBranchAutoBuild
Enables branch auto-building for an Amplify App.
Boolean enableBasicAuth
Enables Basic Authorization for an Amplify App.
String basicAuthCredentials
Basic Authorization credentials for an Amplify App.
List<E> customRules
Custom redirect / rewrite rules for an Amplify App.
String buildSpec
BuildSpec for an Amplify App.
Boolean enableAutoBranchCreation
Enables automated branch creation for the Amplify App.
List<E> autoBranchCreationPatterns
Automated branch creation glob patterns for the Amplify App.
AutoBranchCreationConfig autoBranchCreationConfig
Automated branch creation branchConfig for the Amplify App.
String repository
Repository for an Amplify App
String oauthToken
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.
String accessToken
Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.
App app
App structure for the updated App.
String appId
Unique Id for an Amplify App.
String branchName
Name for the branch.
String description
Description for the branch.
String framework
Framework for the branch.
String stage
Stage for the branch.
Boolean enableNotification
Enables notifications for the branch.
Boolean enableAutoBuild
Enables auto building for the branch.
Map<K,V> environmentVariables
Environment Variables for the branch.
String basicAuthCredentials
Basic Authorization credentials for the branch.
Boolean enableBasicAuth
Enables Basic Auth for the branch.
String buildSpec
BuildSpec for the branch.
String ttl
The content TTL for the website in seconds.
String displayName
Display name for a branch, will use as the default domain prefix.
Boolean enablePullRequestPreview
Enables Pull Request Preview for this branch.
String pullRequestEnvironmentName
The Amplify Environment name for the pull request.
String backendEnvironmentArn
ARN for a Backend Environment, part of an Amplify App.
Branch branch
Branch structure for an Amplify App.
String appId
Unique Id for an Amplify App.
String domainName
Name of the domain.
Boolean enableAutoSubDomain
Enables automated creation of Subdomains for branches. (Currently not supported)
List<E> subDomainSettings
Setting structure for the Subdomain.
DomainAssociation domainAssociation
Domain Association structure.
Webhook webhook
Webhook structure.
String webhookArn
ARN for the webhook.
String webhookId
Id of the webhook.
String webhookUrl
Url of the webhook.
String branchName
Name for a branch, part of an Amplify App.
String description
Description for a webhook.
Date createTime
Create date / time for a webhook.
Date updateTime
Update date / time for a webhook.
Copyright © 2020. All rights reserved.