Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

amplify

package

Go to main page

Versions in this module

v1

v1.3.0

Aug 3, 2026

v1.2.0

Aug 3, 2026

Changes in this version

+ var ErrValidation = awserr.New("BadRequestException", awserr.ErrInvalidParameter)

type App

+ AutoBranchCreationConfig *AutoBranchCreationConfig

+ AutoBranchCreationPatterns []string

+ BasicAuthCredentials string

+ BuildSpec string

+ CacheConfig *CacheConfig

+ CustomHeaders string

+ CustomRules []CustomRule

+ EnableAutoBranchCreation bool

+ EnableBasicAuth bool

+ EnableBranchAutoBuild bool

+ EnableBranchAutoDeletion bool

+ EnvironmentVariables map[string]string

+ IAMServiceRoleArn string

+ ProductionBranch *ProductionBranch

+ RepositoryCloneMethod string

+ type AppOptions struct

+ AutoBranchCreationConfig *AutoBranchCreationConfig

+ AutoBranchCreationPatterns []string

+ BasicAuthCredentials *string

+ BuildSpec *string

+ CacheConfig *CacheConfig

+ CustomHeaders *string

+ CustomRules []CustomRule

+ EnableAutoBranchCreation *bool

+ EnableBasicAuth *bool

+ EnableBranchAutoBuild *bool

+ EnableBranchAutoDeletion *bool

+ EnvironmentVariables map[string]string

+ IAMServiceRoleArn *string

type Artifact

+ AppID string

+ BranchName string

+ JobID string

+ type AutoBranchCreationConfig struct

+ BasicAuthCredentials string

+ BuildSpec string

+ EnableAutoBuild bool

+ EnableBasicAuth bool

+ EnablePerformanceMode bool

+ EnablePullRequestPreview bool

+ EnvironmentVariables map[string]string

+ Framework string

+ PullRequestEnvironmentName string

+ Stage string

type Branch

+ ActiveJobID string

+ AssociatedResources []string

+ BackendEnvironmentARN string

+ BasicAuthCredentials string

+ BuildSpec string

+ CustomDomains []string

+ DisplayName string

+ EnableBasicAuth bool

+ EnableNotification bool

+ EnablePerformanceMode bool

+ EnablePullRequestPreview bool

+ EnvironmentVariables map[string]string

+ Framework string

+ PullRequestEnvironmentName string

+ SourceBranch string

+ TTL string

+ TotalNumberOfJobs string

+ type BranchOptions struct

+ BackendEnvironmentARN *string

+ BasicAuthCredentials *string

+ BuildSpec *string

+ DisplayName *string

+ EnableBasicAuth *bool

+ EnableNotification *bool

+ EnablePerformanceMode *bool

+ EnablePullRequestPreview *bool

+ EnvironmentVariables map[string]string

+ Framework *string

+ PullRequestEnvironmentName *string

+ SourceBranch *string

+ TTL *string

+ type CacheConfig struct

+ Type string

+ type CustomRule struct

+ Condition string

+ Source string

+ Status string

+ Target string

type Job

+ CommitTime time.Time

+ type ProductionBranch struct

+ BranchName string

+ LastDeployTime time.Time

+ Status string

+ ThumbnailURL string

type Stage

+ const StageBeta

+ const StagePullRequest

v1.1.4

Jul 20, 2026

v1.1.3

Jul 20, 2026

v1.1.2

Jul 20, 2026

v1.1.1

Jul 20, 2026

v1.1.0

Jul 19, 2026

Changes in this version

+ var ErrAlreadyExists = awserr.New("BadRequestException", awserr.ErrAlreadyExists)

+ var ErrNotFound = awserr.New("NotFoundException", awserr.ErrNotFound)

+ type App struct

+ ARN string

+ AppID string

+ CreateTime time.Time

+ DefaultDomain string

+ Description string

+ Name string

+ Platform Platform

+ Repository string

+ Tags *tags.Tags

+ UpdateTime time.Time

+ type Artifact struct

+ ArtifactFileName string

+ ArtifactID string

+ ArtifactType string

+ type BackendEnvironment struct

+ AppID string

+ BackendEnvironmentARN string

+ CreateTime time.Time

+ DeploymentArtifacts string

+ EnvironmentName string

+ StackName string

+ UpdateTime time.Time

+ type Branch struct

+ AppID string

+ BranchARN string

+ BranchName string

+ CreateTime time.Time

+ Description string

+ EnableAutoBuild bool

+ Stage Stage

+ Tags *tags.Tags

+ UpdateTime time.Time

+ type DomainAssociation struct

+ ARN string

+ AppID string

+ CertificateVerificationDNSRecord string

+ DomainName string

+ DomainStatus DomainStatus

+ EnableAutoSubDomain bool

+ StatusReason string

+ SubDomains []SubDomain

+ type DomainStatus string

+ const DomainStatusAvailable

+ const DomainStatusCreating

+ const DomainStatusFailed

+ const DomainStatusPendingVerification

+ type Handler struct

+ AccountID string

+ Backend StorageBackend

+ DefaultRegion string

+ func NewHandler(backend StorageBackend) *Handler

+ func (h *Handler) ChaosOperations() []string

+ func (h *Handler) ChaosRegions() []string

+ func (h *Handler) ChaosServiceName() string

+ func (h *Handler) ExtractOperation(c *echo.Context) string

+ func (h *Handler) ExtractResource(c *echo.Context) string

+ func (h *Handler) GetSupportedOperations() []string

+ func (h *Handler) Handler() echo.HandlerFunc

+ func (h *Handler) MatchPriority() int

+ func (h *Handler) Name() string

+ func (h *Handler) Restore(ctx context.Context, data []byte) error

+ func (h *Handler) RouteMatcher() service.Matcher

+ func (h *Handler) Snapshot(ctx context.Context) []byte

+ func (h *Handler) StartWorker(ctx context.Context) error

+ func (h *Handler) WithJanitor(backend *InMemoryBackend, interval time.Duration, taskTimeout ...time.Duration) *Handler

+ type InMemoryBackend struct

+ func NewInMemoryBackend(accountID, region string) *InMemoryBackend

+ func (b *InMemoryBackend) CreateApp(name, description, repository, platform string, tagMap map[string]string) (*App, error)

+ func (b *InMemoryBackend) CreateBackendEnvironment(appID, environmentName, stackName, deploymentArtifacts string) (*BackendEnvironment, error)

+ func (b *InMemoryBackend) CreateBranch(appID, branchName, description, stage string, enableAutoBuild bool, ...) (*Branch, error)

+ func (b *InMemoryBackend) CreateDeployment(appID, branchName string) (string, string, error)

+ func (b *InMemoryBackend) CreateDomainAssociation(appID, domainName string, subDomains []SubDomainSetting, ...) (*DomainAssociation, error)

+ func (b *InMemoryBackend) CreateWebhook(appID, branchName, description string) (*Webhook, error)

+ func (b *InMemoryBackend) DeleteApp(appID string) error

+ func (b *InMemoryBackend) DeleteBackendEnvironment(appID, environmentName string) (*BackendEnvironment, error)

+ func (b *InMemoryBackend) DeleteBranch(appID, branchName string) error

+ func (b *InMemoryBackend) DeleteDomainAssociation(appID, domainName string) (*DomainAssociation, error)

+ func (b *InMemoryBackend) DeleteJob(appID, branchName, jobID string) (*Job, error)

+ func (b *InMemoryBackend) DeleteWebhook(webhookID string) (*Webhook, error)

+ func (b *InMemoryBackend) GenerateAccessLogs(appID, domainName, startTime, endTime string) (string, error)

+ func (b *InMemoryBackend) GetApp(appID string) (*App, error)

+ func (b *InMemoryBackend) GetArtifactURL(artifactID string) (string, string, error)

+ func (b *InMemoryBackend) GetBackendEnvironment(appID, environmentName string) (*BackendEnvironment, error)

+ func (b *InMemoryBackend) GetBranch(appID, branchName string) (*Branch, error)

+ func (b *InMemoryBackend) GetDomainAssociation(appID, domainName string) (*DomainAssociation, error)

+ func (b *InMemoryBackend) GetJob(appID, branchName, jobID string) (*Job, error)

+ func (b *InMemoryBackend) GetWebhook(webhookID string) (*Webhook, error)

+ func (b *InMemoryBackend) ListApps(nextToken string, maxResults int) ([]*App, string, error)

+ func (b *InMemoryBackend) ListArtifacts(appID, _, _, nextToken string, maxResults int) ([]*Artifact, string, error)

+ func (b *InMemoryBackend) ListBackendEnvironments(appID, nextToken string, maxResults int) ([]*BackendEnvironment, string, error)

+ func (b *InMemoryBackend) ListBranches(appID, nextToken string, maxResults int) ([]*Branch, string, error)

+ func (b *InMemoryBackend) ListDomainAssociations(appID, nextToken string, maxResults int) ([]*DomainAssociation, string, error)

+ func (b *InMemoryBackend) ListJobs(appID, branchName, nextToken string, maxResults int) ([]*Job, string, error)

+ func (b *InMemoryBackend) ListTagsForResource(resourceARN string) (map[string]string, error)

+ func (b *InMemoryBackend) ListWebhooks(appID, nextToken string, maxResults int) ([]*Webhook, string, error)

+ func (b *InMemoryBackend) Restore(ctx context.Context, data []byte) error

+ func (b *InMemoryBackend) Snapshot(ctx context.Context) []byte

+ func (b *InMemoryBackend) StartDeployment(appID, branchName, jobID, sourceURL string) (*Job, error)

+ func (b *InMemoryBackend) StartJob(appID, branchName, jobType, commitID, commitMsg string) (*Job, error)

+ func (b *InMemoryBackend) StopJob(appID, branchName, jobID string) (*Job, error)

+ func (b *InMemoryBackend) TagResource(resourceARN string, tagMap map[string]string) error

+ func (b *InMemoryBackend) UntagResource(resourceARN string, tagKeys []string) error

+ func (b *InMemoryBackend) UpdateApp(appID, name, description, repository, platform string) (*App, error)

+ func (b *InMemoryBackend) UpdateBranch(appID, branchName, description, stage string, enableAutoBuild bool) (*Branch, error)

+ func (b *InMemoryBackend) UpdateDomainAssociation(appID, domainName string, subDomains []SubDomainSetting, ...) (*DomainAssociation, error)

+ func (b *InMemoryBackend) UpdateWebhook(webhookID, branchName, description string) (*Webhook, error)

+ type Janitor struct

+ Backend *InMemoryBackend

+ Interval time.Duration

+ TaskTimeout time.Duration

+ func NewJanitor(backend *InMemoryBackend, interval time.Duration) *Janitor

+ func (j *Janitor) Run(ctx context.Context)

+ func (j *Janitor) SweepOnce(ctx context.Context)

+ type Job struct

+ AppID string

+ BranchName string

+ CommitID string

+ CommitMsg string

+ EndTime time.Time

+ JobARN string

+ JobID string

+ StartTime time.Time

+ Status JobStatus

+ Type JobType

+ type JobStatus string

+ const JobStatusCancelled

+ const JobStatusCancelling

+ const JobStatusFailed

+ const JobStatusPending

+ const JobStatusProvisioning

+ const JobStatusRunning

+ const JobStatusSucceed

+ type JobType string

+ const JobTypeManual

+ const JobTypeRelease

+ const JobTypeRetry

+ const JobTypeWebHook

+ type Platform string

+ const PlatformWEB

+ const PlatformWEBCOMPUTE

+ const PlatformWEBDYNAMIC

+ type Provider struct

+ func (p *Provider) Init(ctx *service.AppContext) (service.Registerable, error)

+ func (p *Provider) Name() string

+ type Stage string

+ const StageDevelopment

+ const StageExperimental

+ const StageProduction

+ const StageStaging

+ type StorageBackend interface

+ CreateApp func(name, description, repository, platform string, tagMap map[string]string) (*App, error)

+ CreateBackendEnvironment func(appID, environmentName, stackName, deploymentArtifacts string) (*BackendEnvironment, error)

+ CreateBranch func(appID, branchName, description, stage string, enableAutoBuild bool, ...) (*Branch, error)

+ CreateDeployment func(appID, branchName string) (string, string, error)

+ CreateDomainAssociation func(appID, domainName string, subDomains []SubDomainSetting, ...) (*DomainAssociation, error)

+ CreateWebhook func(appID, branchName, description string) (*Webhook, error)

+ DeleteApp func(appID string) error

+ DeleteBackendEnvironment func(appID, environmentName string) (*BackendEnvironment, error)

+ DeleteBranch func(appID, branchName string) error

+ DeleteDomainAssociation func(appID, domainName string) (*DomainAssociation, error)

+ DeleteJob func(appID, branchName, jobID string) (*Job, error)

+ DeleteWebhook func(webhookID string) (*Webhook, error)

+ GenerateAccessLogs func(appID, domainName, startTime, endTime string) (string, error)

+ GetApp func(appID string) (*App, error)

+ GetArtifactURL func(artifactID string) (string, string, error)

+ GetBackendEnvironment func(appID, environmentName string) (*BackendEnvironment, error)

+ GetBranch func(appID, branchName string) (*Branch, error)

+ GetDomainAssociation func(appID, domainName string) (*DomainAssociation, error)

+ GetJob func(appID, branchName, jobID string) (*Job, error)

+ GetWebhook func(webhookID string) (*Webhook, error)

+ ListApps func(nextToken string, maxResults int) ([]*App, string, error)

+ ListArtifacts func(appID, _, _, nextToken string, maxResults int) ([]*Artifact, string, error)

+ ListBackendEnvironments func(appID, nextToken string, maxResults int) ([]*BackendEnvironment, string, error)

+ ListBranches func(appID, nextToken string, maxResults int) ([]*Branch, string, error)

+ ListDomainAssociations func(appID, nextToken string, maxResults int) ([]*DomainAssociation, string, error)

+ ListJobs func(appID, branchName, nextToken string, maxResults int) ([]*Job, string, error)

+ ListTagsForResource func(resourceARN string) (map[string]string, error)

+ ListWebhooks func(appID, nextToken string, maxResults int) ([]*Webhook, string, error)

+ Restore func(ctx context.Context, data []byte) error

+ Snapshot func(ctx context.Context) []byte

+ StartDeployment func(appID, branchName, jobID, sourceURL string) (*Job, error)

+ StartJob func(appID, branchName, jobType, commitID, commitMsg string) (*Job, error)

+ StopJob func(appID, branchName, jobID string) (*Job, error)

+ TagResource func(resourceARN string, tagMap map[string]string) error

+ UntagResource func(resourceARN string, tagKeys []string) error

+ UpdateApp func(appID, name, description, repository, platform string) (*App, error)

+ UpdateBranch func(appID, branchName, description, stage string, enableAutoBuild bool) (*Branch, error)

+ UpdateDomainAssociation func(appID, domainName string, subDomains []SubDomainSetting, ...) (*DomainAssociation, error)

+ UpdateWebhook func(webhookID, branchName, description string) (*Webhook, error)

+ type SubDomain struct

+ DNSRecord string

+ SubDomainSetting SubDomainSetting

+ Verified bool

+ type SubDomainSetting struct

+ BranchName string

+ Prefix string

+ type Webhook struct

+ AppID string

+ BranchName string

+ CreateTime time.Time

+ Description string

+ UpdateTime time.Time

+ WebhookARN string

+ WebhookID string

+ WebhookURL string