types

package
v1.28.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 4 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App 

type App struct {

	// The Amazon Resource Name (ARN) of the Amplify app.
	//
	// This member is required.
	AppArn *string

	// The unique ID of the Amplify app.
	//
	// This member is required.
	AppId *string

	// A timestamp of when Amplify created the application.
	//
	// This member is required.
	CreateTime *time.Time

	// The default domain for the Amplify app.
	//
	// This member is required.
	DefaultDomain *string

	// The description for the Amplify app.
	//
	// This member is required.
	Description *string

	// Enables basic authorization for the Amplify app's branches.
	//
	// This member is required.
	EnableBasicAuth *bool

	// Enables the auto-building of branches for the Amplify app.
	//
	// This member is required.
	EnableBranchAutoBuild *bool

	// The environment variables for the Amplify app.
	//
	// For a list of the environment variables that are accessible to Amplify by
	// default, see [Amplify Environment variables]in the Amplify Hosting User Guide.
	//
	// [Amplify Environment variables]: https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html
	//
	// This member is required.
	EnvironmentVariables map[string]string

	// The name for the Amplify app.
	//
	// This member is required.
	Name *string

	// The platform for the Amplify app. For a static app, set the platform type to WEB
	// . For a dynamic server-side rendered (SSR) app, set the platform type to
	// WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only,
	// set the platform type to WEB_DYNAMIC .
	//
	// If you are deploying an SSG only app with Next.js 14 or later, you must use the
	// platform type WEB_COMPUTE .
	//
	// This member is required.
	Platform Platform

	// The Git repository for the Amplify app.
	//
	// This member is required.
	Repository *string

	// A timestamp of when Amplify updated the application.
	//
	// This member is required.
	UpdateTime *time.Time

	// Describes the automated branch creation configuration for the Amplify app.
	AutoBranchCreationConfig *AutoBranchCreationConfig

	// Describes the automated branch creation glob patterns for the Amplify app.
	AutoBranchCreationPatterns []string

	// The basic authorization credentials for branches for the Amplify app. You must
	// base64-encode the authorization credentials and provide them in the format
	// user:password .
	BasicAuthCredentials *string

	// Describes the content of the build specification (build spec) for the Amplify
	// app.
	BuildSpec *string

	// The cache configuration for the Amplify app. If you don't specify the cache
	// configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
	CacheConfig *CacheConfig

	// Describes the custom HTTP headers for the Amplify app.
	CustomHeaders *string

	// Describes the custom redirect and rewrite rules for the Amplify app.
	CustomRules []CustomRule

	// Enables automated branch creation for the Amplify app.
	EnableAutoBranchCreation *bool

	// Automatically disconnect a branch in the Amplify console when you delete a
	// branch from your Git repository.
	EnableBranchAutoDeletion *bool

	// The AWS Identity and Access Management (IAM) service role for the Amazon
	// Resource Name (ARN) of the Amplify app.
	IamServiceRoleArn *string

	// Describes the information about a production branch of the Amplify app.
	ProductionBranch *ProductionBranch

	// This is for internal use.
	//
	// The Amplify service uses this parameter to specify the authentication protocol
	// to use to access the Git repository for an Amplify app. Amplify specifies TOKEN
	// for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit
	// repository, and SSH for GitLab and Bitbucket repositories.
	RepositoryCloneMethod RepositoryCloneMethod

	// The tag for the Amplify app.
	Tags map[string]string

	// Describes the Firewall configuration for the Amplify app. Firewall support
	// enables you to protect your hosted applications with a direct integration with
	// WAF.
	WafConfiguration *WafConfiguration

	// A timestamp of when Amplify created the webhook in your Git repository.
	WebhookCreateTime *time.Time
	// contains filtered or unexported fields
}

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

type Artifact 

type Artifact struct {

	// The file name for the artifact.
	//
	// This member is required.
	ArtifactFileName *string

	// The unique ID for the artifact.
	//
	// This member is required.
	ArtifactId *string
	// contains filtered or unexported fields
}

Describes an artifact.

type AutoBranchCreationConfig 

type AutoBranchCreationConfig struct {

	// The basic authorization credentials for the autocreated branch. You must
	// base64-encode the authorization credentials and provide them in the format
	// user:password .
	BasicAuthCredentials *string

	// The build specification (build spec) for the autocreated branch.
	BuildSpec *string

	// Enables auto building for the autocreated branch.
	EnableAutoBuild *bool

	// Enables basic authorization for the autocreated branch.
	EnableBasicAuth *bool

	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content
	// cached at the edge for a longer interval. When performance mode is enabled,
	// hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode *bool

	// Enables pull request previews for the autocreated branch.
	EnablePullRequestPreview *bool

	// The environment variables for the autocreated branch.
	EnvironmentVariables map[string]string

	// The framework for the autocreated branch.
	Framework *string

	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string

	// Describes the current stage for the autocreated branch.
	Stage Stage
	// contains filtered or unexported fields
}

Describes the automated branch creation configuration.

type Backend added in v1.16.0 

type Backend struct {

	// The Amazon Resource Name (ARN) for the CloudFormation stack.
	StackArn *string
	// contains filtered or unexported fields
}

Describes the backend associated with an Amplify Branch .

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

type BackendEnvironment 

type BackendEnvironment struct {

	// The Amazon Resource Name (ARN) for a backend environment that is part of an
	// Amplify app.
	//
	// This member is required.
	BackendEnvironmentArn *string

	// The creation date and time for a backend environment that is part of an Amplify
	// app.
	//
	// This member is required.
	CreateTime *time.Time

	// The name for a backend environment that is part of an Amplify app.
	//
	// This member is required.
	EnvironmentName *string

	// The last updated date and time for a backend environment that is part of an
	// Amplify app.
	//
	// This member is required.
	UpdateTime *time.Time

	// The name of deployment artifacts.
	DeploymentArtifacts *string

	// The AWS CloudFormation stack name of a backend environment.
	StackName *string
	// contains filtered or unexported fields
}

Describes the backend environment associated with a Branch of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI).

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A request contains unexpected data.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type Branch 

type Branch struct {

	//  The ID of the active job for a branch of an Amplify app.
	//
	// This member is required.
	ActiveJobId *string

	//  The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
	//
	// This member is required.
	BranchArn *string

	//  The name for the branch that is part of an Amplify app.
	//
	// This member is required.
	BranchName *string

	// A timestamp of when Amplify created the branch.
	//
	// This member is required.
	CreateTime *time.Time

	//  The custom domains for a branch of an Amplify app.
	//
	// This member is required.
	CustomDomains []string

	//  The description for the branch that is part of an Amplify app.
	//
	// This member is required.
	Description *string

	//  The display name for the branch. This is used as the default domain prefix.
	//
	// This member is required.
	DisplayName *string

	//  Enables auto-building on push for a branch of an Amplify app.
	//
	// This member is required.
	EnableAutoBuild *bool

	//  Enables basic authorization for a branch of an Amplify app.
	//
	// This member is required.
	EnableBasicAuth *bool

	//  Enables notifications for a branch that is part of an Amplify app.
	//
	// This member is required.
	EnableNotification *bool

	//  Enables pull request previews for the branch.
	//
	// This member is required.
	EnablePullRequestPreview *bool

	//  The environment variables specific to a branch of an Amplify app.
	//
	// This member is required.
	EnvironmentVariables map[string]string

	//  The framework for a branch of an Amplify app.
	//
	// This member is required.
	Framework *string

	//  The current stage for the branch that is part of an Amplify app.
	//
	// This member is required.
	Stage Stage

	//  The total number of jobs that are part of an Amplify app.
	//
	// This member is required.
	TotalNumberOfJobs *string

	//  The content Time to Live (TTL) for the website in seconds.
	//
	// This member is required.
	Ttl *string

	// A timestamp for the last updated time for a branch.
	//
	// This member is required.
	UpdateTime *time.Time

	//  A list of custom resources that are linked to this branch.
	AssociatedResources []string

	// Describes the backend associated with an Amplify Branch .
	//
	// This property is available to Amplify Gen 2 apps only. When you deploy an
	// application with Amplify Gen 2, you provision the app's backend infrastructure
	// using Typescript code.
	Backend *Backend

	//  The Amazon Resource Name (ARN) for a backend environment that is part of an
	// Amplify app.
	//
	// This property is available to Amplify Gen 1 apps only. When you deploy an
	// application with Amplify Gen 2, you provision the app's backend infrastructure
	// using Typescript code.
	BackendEnvironmentArn *string

	//  The basic authorization credentials for a branch of an Amplify app. You must
	// base64-encode the authorization credentials and provide them in the format
	// user:password .
	BasicAuthCredentials *string

	//  The build specification (build spec) content for the branch of an Amplify app.
	BuildSpec *string

	//  The destination branch if the branch is a pull request branch.
	DestinationBranch *string

	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content
	// cached at the edge for a longer interval. When performance mode is enabled,
	// hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode *bool

	//  The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string

	//  The source branch if the branch is a pull request branch.
	SourceBranch *string

	//  The tag for the branch of an Amplify app.
	Tags map[string]string

	//  The thumbnail URL for the branch of an Amplify app.
	ThumbnailUrl *string
	// contains filtered or unexported fields
}

The branch for an Amplify app, which maps to a third-party repository branch.

type CacheConfig added in v1.24.0 

type CacheConfig struct {

	// The type of cache configuration to use for an Amplify app.
	//
	// The AMPLIFY_MANAGED cache configuration automatically applies an optimized
	// cache configuration for your app based on its platform, routing rules, and
	// rewrite rules. This is the default setting.
	//
	// The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as
	// AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.
	//
	// This member is required.
	Type CacheConfigType
	// contains filtered or unexported fields
}

Describes the cache configuration for an Amplify app.

For more information about how Amplify applies an optimal cache configuration for your app based on the type of content that is being served, see Managing cache configurationin the Amplify User guide.

type CacheConfigType added in v1.24.0 

type CacheConfigType string
const (
	CacheConfigTypeAmplifyManaged          CacheConfigType = "AMPLIFY_MANAGED"
	CacheConfigTypeAmplifyManagedNoCookies CacheConfigType = "AMPLIFY_MANAGED_NO_COOKIES"
)

Enum values for CacheConfigType

func (CacheConfigType) Values added in v1.24.0 

func (CacheConfigType) Values() []CacheConfigType

Values returns all known values for CacheConfigType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Certificate added in v1.20.0 

type Certificate struct {

	// The type of SSL/TLS certificate that you want to use.
	//
	// Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions
	// for you.
	//
	// Specify CUSTOM to use your own certificate that you have already added to
	// Certificate Manager in your Amazon Web Services account. Make sure you request
	// (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For
	// more information about using ACM, see [Importing certificates into Certificate Manager]in the ACM User guide.
	//
	// [Importing certificates into Certificate Manager]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
	//
	// This member is required.
	Type CertificateType

	// The DNS record for certificate verification.
	CertificateVerificationDNSRecord *string

	// The Amazon resource name (ARN) for a custom certificate that you have already
	// added to Certificate Manager in your Amazon Web Services account.
	//
	// This field is required only when the certificate type is CUSTOM .
	CustomCertificateArn *string
	// contains filtered or unexported fields
}

Describes the current SSL/TLS certificate that is in use for the domain. If you are using CreateDomainAssociation to create a new domain association, Certificate describes the new certificate that you are creating.

type CertificateSettings added in v1.20.0 

type CertificateSettings struct {

	// The certificate type.
	//
	// Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions
	// for you.
	//
	// Specify CUSTOM to use your own certificate that you have already added to
	// Certificate Manager in your Amazon Web Services account. Make sure you request
	// (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For
	// more information about using ACM, see [Importing certificates into Certificate Manager]in the ACM User guide.
	//
	// [Importing certificates into Certificate Manager]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
	//
	// This member is required.
	Type CertificateType

	// The Amazon resource name (ARN) for the custom certificate that you have already
	// added to Certificate Manager in your Amazon Web Services account.
	//
	// This field is required only when the certificate type is CUSTOM .
	CustomCertificateArn *string
	// contains filtered or unexported fields
}

The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate.

type CertificateType added in v1.20.0 

type CertificateType string
const (
	CertificateTypeAmplifyManaged CertificateType = "AMPLIFY_MANAGED"
	CertificateTypeCustom         CertificateType = "CUSTOM"
)

Enum values for CertificateType

func (CertificateType) Values added in v1.20.0 

func (CertificateType) Values() []CertificateType

Values returns all known values for CertificateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CustomRule 

type CustomRule struct {

	// The source pattern for a URL rewrite or redirect rule.
	//
	// This member is required.
	Source *string

	// The target pattern for a URL rewrite or redirect rule.
	//
	// This member is required.
	Target *string

	// The condition for a URL rewrite or redirect rule, such as a country code.
	Condition *string

	// The status code for a URL rewrite or redirect rule.
	//
	// 200 Represents a 200 rewrite rule.
	//
	// 301 Represents a 301 (moved permanently) redirect rule. This and all future
	// requests should be directed to the target URL.
	//
	// 302 Represents a 302 temporary redirect rule.
	//
	// 404 Represents a 404 redirect rule.
	//
	// 404-200 Represents a 404 rewrite rule.
	Status *string
	// contains filtered or unexported fields
}

Describes a custom rewrite or redirect rule.

type DependentServiceFailureException 

type DependentServiceFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An operation failed because a dependent service threw an exception.

func (*DependentServiceFailureException) Error 

func (e *DependentServiceFailureException) Error() string

func (*DependentServiceFailureException) ErrorCode 

func (e *DependentServiceFailureException) ErrorCode() string

func (*DependentServiceFailureException) ErrorFault 

func (e *DependentServiceFailureException) ErrorFault() smithy.ErrorFault

func (*DependentServiceFailureException) ErrorMessage 

func (e *DependentServiceFailureException) ErrorMessage() string

type DomainAssociation 

type DomainAssociation struct {

	//  The Amazon Resource Name (ARN) for the domain association.
	//
	// This member is required.
	DomainAssociationArn *string

	//  The name of the domain.
	//
	// This member is required.
	DomainName *string

	//  The current status of the domain association.
	//
	// This member is required.
	DomainStatus DomainStatus

	//  Enables the automated creation of subdomains for branches.
	//
	// This member is required.
	EnableAutoSubDomain *bool

	//  Additional information that describes why the domain association is in the
	// current state.
	//
	// This member is required.
	StatusReason *string

	//  The subdomains for the domain association.
	//
	// This member is required.
	SubDomains []SubDomain

	//  Sets branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns []string

	//  The required AWS Identity and Access Management (IAM) service role for the
	// Amazon Resource Name (ARN) for automatically creating subdomains.
	AutoSubDomainIAMRole *string

	// Describes the SSL/TLS certificate for the domain association. This can be your
	// own custom certificate or the default certificate that Amplify provisions for
	// you.
	//
	// If you are updating your domain to use a different certificate, certificate
	// points to the new certificate that is being created instead of the current
	// active certificate. Otherwise, certificate points to the current active
	// certificate.
	Certificate *Certificate

	//  The DNS record for certificate verification.
	CertificateVerificationDNSRecord *string

	// The status of the domain update operation that is currently in progress. The
	// following list describes the valid update states.
	//
	// REQUESTING_CERTIFICATE The certificate is in the process of being updated.
	//
	// PENDING_VERIFICATION Indicates that an Amplify managed certificate is in the
	// process of being verified. This occurs during the creation of a custom domain or
	// when a custom domain is updated to use a managed certificate.
	//
	// IMPORTING_CUSTOM_CERTIFICATE Indicates that an Amplify custom certificate is in
	// the process of being imported. This occurs during the creation of a custom
	// domain or when a custom domain is updated to use a custom certificate.
	//
	// PENDING_DEPLOYMENT Indicates that the subdomain or certificate changes are
	// being propagated.
	//
	// AWAITING_APP_CNAME Amplify is waiting for CNAME records corresponding to
	// subdomains to be propagated. If your custom domain is on Route 53, Amplify
	// handles this for you automatically. For more information about custom domains,
	// see [Setting up custom domains]in the Amplify Hosting User Guide.
	//
	// UPDATE_COMPLETE The certificate has been associated with a domain.
	//
	// UPDATE_FAILED The certificate has failed to be provisioned or associated, and
	// there is no existing active certificate to roll back to.
	//
	// [Setting up custom domains]: https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html
	UpdateStatus UpdateStatus
	// contains filtered or unexported fields
}

Describes the association between a custom domain and an Amplify app.

type DomainStatus 

type DomainStatus string
const (
	DomainStatusPendingVerification        DomainStatus = "PENDING_VERIFICATION"
	DomainStatusInProgress                 DomainStatus = "IN_PROGRESS"
	DomainStatusAvailable                  DomainStatus = "AVAILABLE"
	DomainStatusImportingCustomCertificate DomainStatus = "IMPORTING_CUSTOM_CERTIFICATE"
	DomainStatusPendingDeployment          DomainStatus = "PENDING_DEPLOYMENT"
	DomainStatusAwaitingAppCname           DomainStatus = "AWAITING_APP_CNAME"
	DomainStatusFailed                     DomainStatus = "FAILED"
	DomainStatusCreating                   DomainStatus = "CREATING"
	DomainStatusRequestingCertificate      DomainStatus = "REQUESTING_CERTIFICATE"
	DomainStatusUpdating                   DomainStatus = "UPDATING"
)

Enum values for DomainStatus

func (DomainStatus) Values added in v0.29.0 

func (DomainStatus) Values() []DomainStatus

Values returns all known values for DomainStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalFailureException 

type InternalFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service failed to perform an operation due to an internal issue.

func (*InternalFailureException) Error 

func (e *InternalFailureException) Error() string

func (*InternalFailureException) ErrorCode 

func (e *InternalFailureException) ErrorCode() string

func (*InternalFailureException) ErrorFault 

func (e *InternalFailureException) ErrorFault() smithy.ErrorFault

func (*InternalFailureException) ErrorMessage 

func (e *InternalFailureException) ErrorMessage() string

type Job 

type Job struct {

	//  The execution steps for an execution job, for an Amplify app.
	//
	// This member is required.
	Steps []Step

	//  Describes the summary for an execution job for an Amplify app.
	//
	// This member is required.
	Summary *JobSummary
	// contains filtered or unexported fields
}

Describes an execution job for an Amplify app.

type JobStatus 

type JobStatus string
const (
	JobStatusCreated      JobStatus = "CREATED"
	JobStatusPending      JobStatus = "PENDING"
	JobStatusProvisioning JobStatus = "PROVISIONING"
	JobStatusRunning      JobStatus = "RUNNING"
	JobStatusFailed       JobStatus = "FAILED"
	JobStatusSucceed      JobStatus = "SUCCEED"
	JobStatusCancelling   JobStatus = "CANCELLING"
	JobStatusCancelled    JobStatus = "CANCELLED"
)

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobSummary 

type JobSummary struct {

	//  The commit ID from a third-party repository provider for the job.
	//
	// This member is required.
	CommitId *string

	//  The commit message from a third-party repository provider for the job.
	//
	// This member is required.
	CommitMessage *string

	// The commit date and time for the job.
	//
	// This member is required.
	CommitTime *time.Time

	//  The Amazon Resource Name (ARN) for the job.
	//
	// This member is required.
	JobArn *string

	//  The unique ID for the job.
	//
	// This member is required.
	JobId *string

	//  The type for the job. If the value is RELEASE , the job was manually released
	// from its source by using the StartJob API. This value is available only for
	// apps that are connected to a repository.
	//
	// If the value is RETRY , the job was manually retried using the StartJob API. If
	// the value is WEB_HOOK , the job was automatically triggered by webhooks. If the
	// value is MANUAL , the job is for a manually deployed app. Manually deployed apps
	// are not connected to a Git repository.
	//
	// This member is required.
	JobType JobType

	//  The start date and time for the job.
	//
	// This member is required.
	StartTime *time.Time

	//  The current status for the job.
	//
	// This member is required.
	Status JobStatus

	//  The end date and time for the job.
	EndTime *time.Time

	// The source URL for the files to deploy. The source URL can be either an HTTP
	// GET URL that is publicly accessible and downloads a single .zip file, or an
	// Amazon S3 bucket and prefix.
	SourceUrl *string

	// The type of source specified by the sourceURL . If the value is ZIP , the source
	// is a .zip file. If the value is BUCKET_PREFIX , the source is an Amazon S3
	// bucket and prefix. If no value is specified, the default is ZIP .
	SourceUrlType SourceUrlType
	// contains filtered or unexported fields
}

Describes the summary for an execution job for an Amplify app.

type JobType 

type JobType string
const (
	JobTypeRelease JobType = "RELEASE"
	JobTypeRetry   JobType = "RETRY"
	JobTypeManual  JobType = "MANUAL"
	JobTypeWebHook JobType = "WEB_HOOK"
)

Enum values for JobType

func (JobType) Values added in v0.29.0 

func (JobType) Values() []JobType

Values returns all known values for JobType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource could not be created because service quotas were exceeded.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An entity was not found during an operation.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type Platform 

type Platform string
const (
	PlatformWeb        Platform = "WEB"
	PlatformWebDynamic Platform = "WEB_DYNAMIC"
	PlatformWebCompute Platform = "WEB_COMPUTE"
)

Enum values for Platform

func (Platform) Values added in v0.29.0 

func (Platform) Values() []Platform

Values returns all known values for Platform. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProductionBranch 

type ProductionBranch struct {

	// The branch name for the production branch.
	BranchName *string

	// The last deploy time of the production branch.
	LastDeployTime *time.Time

	// The status of the production branch.
	Status *string

	// The thumbnail URL for the production branch.
	ThumbnailUrl *string
	// contains filtered or unexported fields
}

Describes the information about a production branch for an Amplify app.

type RepositoryCloneMethod added in v1.11.0 

type RepositoryCloneMethod string
const (
	RepositoryCloneMethodSsh   RepositoryCloneMethod = "SSH"
	RepositoryCloneMethodToken RepositoryCloneMethod = "TOKEN"
	RepositoryCloneMethodSigv4 RepositoryCloneMethod = "SIGV4"
)

Enum values for RepositoryCloneMethod

func (RepositoryCloneMethod) Values added in v1.11.0 

func (RepositoryCloneMethod) Values() []RepositoryCloneMethod

Values returns all known values for RepositoryCloneMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code *string
	// contains filtered or unexported fields
}

An operation failed due to a non-existent resource.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type SourceUrlType added in v1.27.0 

type SourceUrlType string
const (
	SourceUrlTypeZip          SourceUrlType = "ZIP"
	SourceUrlTypeBucketPrefix SourceUrlType = "BUCKET_PREFIX"
)

Enum values for SourceUrlType

func (SourceUrlType) Values added in v1.27.0 

func (SourceUrlType) Values() []SourceUrlType

Values returns all known values for SourceUrlType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Stage 

type Stage string
const (
	StageProduction   Stage = "PRODUCTION"
	StageBeta         Stage = "BETA"
	StageDevelopment  Stage = "DEVELOPMENT"
	StageExperimental Stage = "EXPERIMENTAL"
	StagePullRequest  Stage = "PULL_REQUEST"
)

Enum values for Stage

func (Stage) Values added in v0.29.0 

func (Stage) Values() []Stage

Values returns all known values for Stage. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Step 

type Step struct {

	//  The end date and time of the execution step.
	//
	// This member is required.
	EndTime *time.Time

	//  The start date and time of the execution step.
	//
	// This member is required.
	StartTime *time.Time

	//  The status of the execution step.
	//
	// This member is required.
	Status JobStatus

	//  The name of the execution step.
	//
	// This member is required.
	StepName *string

	//  The URL to the artifact for the execution step.
	ArtifactsUrl *string

	//  The context for the current step. Includes a build image if the step is build.
	Context *string

	//  The URL to the logs for the execution step.
	LogUrl *string

	//  The list of screenshot URLs for the execution step, if relevant.
	Screenshots map[string]string

	//  The reason for the current step status.
	StatusReason *string

	//  The URL to the test artifact for the execution step.
	TestArtifactsUrl *string

	//  The URL to the test configuration for the execution step.
	TestConfigUrl *string
	// contains filtered or unexported fields
}

Describes an execution step, for an execution job, for an Amplify app.

type SubDomain 

type SubDomain struct {

	//  The DNS record for the subdomain.
	//
	// This member is required.
	DnsRecord *string

	//  Describes the settings for the subdomain.
	//
	// This member is required.
	SubDomainSetting *SubDomainSetting

	//  The verified status of the subdomain
	//
	// This member is required.
	Verified *bool
	// contains filtered or unexported fields
}

The subdomain for the domain association.

type SubDomainSetting 

type SubDomainSetting struct {

	//  The branch name setting for the subdomain.
	//
	// This member is required.
	BranchName *string

	//  The prefix setting for the subdomain.
	//
	// This member is required.
	Prefix *string
	// contains filtered or unexported fields
}

Describes the settings for the subdomain.

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An operation failed due to a lack of access.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UpdateStatus added in v1.20.0 

type UpdateStatus string
const (
	UpdateStatusRequestingCertificate      UpdateStatus = "REQUESTING_CERTIFICATE"
	UpdateStatusPendingVerification        UpdateStatus = "PENDING_VERIFICATION"
	UpdateStatusImportingCustomCertificate UpdateStatus = "IMPORTING_CUSTOM_CERTIFICATE"
	UpdateStatusPendingDeployment          UpdateStatus = "PENDING_DEPLOYMENT"
	UpdateStatusAwaitingAppCname           UpdateStatus = "AWAITING_APP_CNAME"
	UpdateStatusUpdateComplete             UpdateStatus = "UPDATE_COMPLETE"
	UpdateStatusUpdateFailed               UpdateStatus = "UPDATE_FAILED"
)

Enum values for UpdateStatus

func (UpdateStatus) Values added in v1.20.0 

func (UpdateStatus) Values() []UpdateStatus

Values returns all known values for UpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WafConfiguration added in v1.28.0 

type WafConfiguration struct {

	// The reason for the current status of the Firewall configuration.
	StatusReason *string

	// The status of the process to associate or disassociate a web ACL to an Amplify
	// app.
	WafStatus WafStatus

	// The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
	WebAclArn *string
	// contains filtered or unexported fields
}

Describes the Firewall configuration for a hosted Amplify application. Firewall support enables you to protect your web applications with a direct integration with WAF. For more information about using WAF protections for an Amplify application, see Firewall support for hosted sitesin the Amplify User Guide.

type WafStatus added in v1.28.0 

type WafStatus string
const (
	WafStatusAssociating          WafStatus = "ASSOCIATING"
	WafStatusAssociationFailed    WafStatus = "ASSOCIATION_FAILED"
	WafStatusAssociationSuccess   WafStatus = "ASSOCIATION_SUCCESS"
	WafStatusDisassociating       WafStatus = "DISASSOCIATING"
	WafStatusDisassociationFailed WafStatus = "DISASSOCIATION_FAILED"
)

Enum values for WafStatus

func (WafStatus) Values added in v1.28.0 

func (WafStatus) Values() []WafStatus

Values returns all known values for WafStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Webhook 

type Webhook struct {

	// The name for a branch that is part of an Amplify app.
	//
	// This member is required.
	BranchName *string

	// A timestamp of when Amplify created the webhook in your Git repository.
	//
	// This member is required.
	CreateTime *time.Time

	// The description for a webhook.
	//
	// This member is required.
	Description *string

	// A timestamp of when Amplify updated the webhook in your Git repository.
	//
	// This member is required.
	UpdateTime *time.Time

	// The Amazon Resource Name (ARN) for the webhook.
	//
	// This member is required.
	WebhookArn *string

	// The ID of the webhook.
	//
	// This member is required.
	WebhookId *string

	// The URL of the webhook.
	//
	// This member is required.
	WebhookUrl *string
	// contains filtered or unexported fields
}

Describes a webhook that connects repository events to an Amplify app.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.