amplify

package module
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: 42 Imported by: 22

Documentation

Overview

Package amplify provides the API client, operations, and parameter types for AWS Amplify.

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-07-25"
View Source 
const ServiceID = "Amplify"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.14.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.17.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.17.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.17.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.17.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Amplify.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateApp 

func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error)

Creates a new Amplify app.

func (*Client) CreateBackendEnvironment 

func (c *Client) CreateBackendEnvironment(ctx context.Context, params *CreateBackendEnvironmentInput, optFns ...func(*Options)) (*CreateBackendEnvironmentOutput, error)

Creates a new backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

func (*Client) CreateBranch 

func (c *Client) CreateBranch(ctx context.Context, params *CreateBranchInput, optFns ...func(*Options)) (*CreateBranchOutput, error)

Creates a new branch for an Amplify app.

func (*Client) CreateDeployment 

func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

func (*Client) CreateDomainAssociation 

func (c *Client) CreateDomainAssociation(ctx context.Context, params *CreateDomainAssociationInput, optFns ...func(*Options)) (*CreateDomainAssociationOutput, error)

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

func (*Client) CreateWebhook 

func (c *Client) CreateWebhook(ctx context.Context, params *CreateWebhookInput, optFns ...func(*Options)) (*CreateWebhookOutput, error)

Creates a new webhook on an Amplify app.

func (*Client) DeleteApp 

func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)

Deletes an existing Amplify app specified by an app ID.

func (*Client) DeleteBackendEnvironment 

func (c *Client) DeleteBackendEnvironment(ctx context.Context, params *DeleteBackendEnvironmentInput, optFns ...func(*Options)) (*DeleteBackendEnvironmentOutput, error)

Deletes a backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

func (*Client) DeleteBranch 

func (c *Client) DeleteBranch(ctx context.Context, params *DeleteBranchInput, optFns ...func(*Options)) (*DeleteBranchOutput, error)

Deletes a branch for an Amplify app.

func (*Client) DeleteDomainAssociation 

func (c *Client) DeleteDomainAssociation(ctx context.Context, params *DeleteDomainAssociationInput, optFns ...func(*Options)) (*DeleteDomainAssociationOutput, error)

Deletes a domain association for an Amplify app.

func (*Client) DeleteJob 

func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns ...func(*Options)) (*DeleteJobOutput, error)

Deletes a job for a branch of an Amplify app.

func (*Client) DeleteWebhook 

func (c *Client) DeleteWebhook(ctx context.Context, params *DeleteWebhookInput, optFns ...func(*Options)) (*DeleteWebhookOutput, error)

Deletes a webhook.

func (*Client) GenerateAccessLogs 

func (c *Client) GenerateAccessLogs(ctx context.Context, params *GenerateAccessLogsInput, optFns ...func(*Options)) (*GenerateAccessLogsOutput, error)

Returns the website access logs for a specific time range using a presigned URL.

func (*Client) GetApp 

func (c *Client) GetApp(ctx context.Context, params *GetAppInput, optFns ...func(*Options)) (*GetAppOutput, error)

Returns an existing Amplify app specified by an app ID.

func (*Client) GetArtifactUrl 

func (c *Client) GetArtifactUrl(ctx context.Context, params *GetArtifactUrlInput, optFns ...func(*Options)) (*GetArtifactUrlOutput, error)

Returns the artifact info that corresponds to an artifact id.

func (*Client) GetBackendEnvironment 

func (c *Client) GetBackendEnvironment(ctx context.Context, params *GetBackendEnvironmentInput, optFns ...func(*Options)) (*GetBackendEnvironmentOutput, error)

Returns a backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

func (*Client) GetBranch 

func (c *Client) GetBranch(ctx context.Context, params *GetBranchInput, optFns ...func(*Options)) (*GetBranchOutput, error)

Returns a branch for an Amplify app.

func (*Client) GetDomainAssociation 

func (c *Client) GetDomainAssociation(ctx context.Context, params *GetDomainAssociationInput, optFns ...func(*Options)) (*GetDomainAssociationOutput, error)

Returns the domain information for an Amplify app.

func (*Client) GetJob 

func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func(*Options)) (*GetJobOutput, error)

Returns a job for a branch of an Amplify app.

func (*Client) GetWebhook 

func (c *Client) GetWebhook(ctx context.Context, params *GetWebhookInput, optFns ...func(*Options)) (*GetWebhookOutput, error)

Returns the webhook information that corresponds to a specified webhook ID.

func (*Client) ListApps 

func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)

Returns a list of the existing Amplify apps.

func (*Client) ListArtifacts 

func (c *Client) ListArtifacts(ctx context.Context, params *ListArtifactsInput, optFns ...func(*Options)) (*ListArtifactsOutput, error)

Returns a list of artifacts for a specified app, branch, and job.

func (*Client) ListBackendEnvironments 

func (c *Client) ListBackendEnvironments(ctx context.Context, params *ListBackendEnvironmentsInput, optFns ...func(*Options)) (*ListBackendEnvironmentsOutput, error)

Lists the backend environments for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

func (*Client) ListBranches 

func (c *Client) ListBranches(ctx context.Context, params *ListBranchesInput, optFns ...func(*Options)) (*ListBranchesOutput, error)

Lists the branches of an Amplify app.

func (*Client) ListDomainAssociations 

func (c *Client) ListDomainAssociations(ctx context.Context, params *ListDomainAssociationsInput, optFns ...func(*Options)) (*ListDomainAssociationsOutput, error)

Returns the domain associations for an Amplify app.

func (*Client) ListJobs 

func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)

Lists the jobs for a branch of an Amplify app.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns a list of tags for a specified Amazon Resource Name (ARN).

func (*Client) ListWebhooks 

func (c *Client) ListWebhooks(ctx context.Context, params *ListWebhooksInput, optFns ...func(*Options)) (*ListWebhooksOutput, error)

Returns a list of webhooks for an Amplify app.

func (*Client) Options added in v1.18.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartDeployment 

func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error)

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

func (*Client) StartJob 

func (c *Client) StartJob(ctx context.Context, params *StartJobInput, optFns ...func(*Options)) (*StartJobOutput, error)

Starts a new job for a branch of an Amplify app.

func (*Client) StopJob 

func (c *Client) StopJob(ctx context.Context, params *StopJobInput, optFns ...func(*Options)) (*StopJobOutput, error)

Stops a job that is in progress for a branch of an Amplify app.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags the resource with a tag key and value.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Untags a resource with a specified Amazon Resource Name (ARN).

func (*Client) UpdateApp 

func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns ...func(*Options)) (*UpdateAppOutput, error)

Updates an existing Amplify app.

func (*Client) UpdateBranch 

func (c *Client) UpdateBranch(ctx context.Context, params *UpdateBranchInput, optFns ...func(*Options)) (*UpdateBranchOutput, error)

Updates a branch for an Amplify app.

func (*Client) UpdateDomainAssociation 

func (c *Client) UpdateDomainAssociation(ctx context.Context, params *UpdateDomainAssociationInput, optFns ...func(*Options)) (*UpdateDomainAssociationOutput, error)

Creates a new domain association for an Amplify app.

func (*Client) UpdateWebhook 

func (c *Client) UpdateWebhook(ctx context.Context, params *UpdateWebhookInput, optFns ...func(*Options)) (*UpdateWebhookOutput, error)

Updates a webhook.

type CreateAppInput 

type CreateAppInput struct {

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

	// The personal access token for a GitHub repository for an Amplify app. The
	// personal access token is used to authorize access to a GitHub repository using
	// the Amplify GitHub App. The token is not stored.
	//
	// Use accessToken for GitHub repositories only. To authorize access to a
	// repository provider such as Bitbucket or CodeCommit, use oauthToken .
	//
	// You must specify either accessToken or oauthToken when you create a new app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to
	// work with CI/CD. However, we strongly recommend that you migrate these apps to
	// use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App]in the Amplify User Guide .
	//
	// [Migrating an existing OAuth app to the Amplify GitHub App]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
	AccessToken *string

	// The automated branch creation configuration for an Amplify app.
	AutoBranchCreationConfig *types.AutoBranchCreationConfig

	// The automated branch creation glob patterns for an Amplify app.
	AutoBranchCreationPatterns []string

	// The credentials for basic authorization for 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) for an Amplify app.
	BuildSpec *string

	// The cache configuration for the Amplify app.
	CacheConfig *types.CacheConfig

	// The custom HTTP headers for an Amplify app.
	CustomHeaders *string

	// The custom rewrite and redirect rules for an Amplify app.
	CustomRules []types.CustomRule

	// The description of the Amplify app.
	Description *string

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

	// Enables basic authorization for an Amplify app. This will apply to all branches
	// that are part of this app.
	EnableBasicAuth *bool

	// Enables the auto building of branches for an Amplify app.
	EnableBranchAutoBuild *bool

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

	// The environment variables map for an 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
	EnvironmentVariables map[string]string

	// The AWS Identity and Access Management (IAM) service role for an Amplify app.
	IamServiceRoleArn *string

	// The OAuth token for a third-party source control system for an Amplify app. The
	// OAuth token is used to create a webhook and a read-only deploy key using SSH
	// cloning. The OAuth token is not stored.
	//
	// Use oauthToken for repository providers other than GitHub, such as Bitbucket or
	// CodeCommit. To authorize access to GitHub as your repository provider, use
	// accessToken .
	//
	// You must specify either oauthToken or accessToken when you create a new app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to
	// work with CI/CD. However, we strongly recommend that you migrate these apps to
	// use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App]in the Amplify User Guide .
	//
	// [Migrating an existing OAuth app to the Amplify GitHub App]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
	OauthToken *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 version 14 or later, you must
	// set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to
	// .next in the application's build settings. For an example of the build
	// specification settings, see [Amplify build settings for a Next.js 14 SSG application]in the Amplify Hosting User Guide.
	//
	// [Amplify build settings for a Next.js 14 SSG application]: https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14
	Platform types.Platform

	// The Git repository for the Amplify app.
	Repository *string

	// The tag for an Amplify app.
	Tags map[string]string
	// contains filtered or unexported fields
}

The request structure used to create apps in Amplify.

type CreateAppOutput 

type CreateAppOutput struct {

	// Represents the different branches of a repository for building, deploying, and
	// hosting an Amplify app.
	//
	// This member is required.
	App *types.App

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBackendEnvironmentInput 

type CreateBackendEnvironmentInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name for the backend environment.
	//
	// This member is required.
	EnvironmentName *string

	// The name of deployment artifacts.
	DeploymentArtifacts *string

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

The request structure for the backend environment create request.

type CreateBackendEnvironmentOutput 

type CreateBackendEnvironmentOutput struct {

	// Describes the backend environment for an Amplify app.
	//
	// This member is required.
	BackendEnvironment *types.BackendEnvironment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the create backend environment request.

type CreateBranchInput 

type CreateBranchInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

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

	// The backend for a Branch of an Amplify app. Use for a backend created from an
	// CloudFormation stack.
	//
	// This field 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 *types.Backend

	// The Amazon Resource Name (ARN) for a backend environment that is part of a Gen
	// 1 Amplify app.
	//
	// This field is available to Amplify Gen 1 apps only where the backend is created
	// using Amplify Studio or the Amplify command line interface (CLI).
	BackendEnvironmentArn *string

	//  The basic authorization credentials for the 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 branch.
	BuildSpec *string

	// The description for the branch.
	Description *string

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

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

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

	//  Enables notifications for the branch.
	EnableNotification *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 this branch.
	EnablePullRequestPreview *bool

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

	//  The framework for the branch.
	Framework *string

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

	// Describes the current stage for the branch.
	Stage types.Stage

	//  The tag for the branch.
	Tags map[string]string

	//  The content Time To Live (TTL) for the website in seconds.
	Ttl *string
	// contains filtered or unexported fields
}

The request structure for the create branch request.

type CreateBranchOutput 

type CreateBranchOutput struct {

	//  Describes the branch for an Amplify app, which maps to a third-party
	// repository branch.
	//
	// This member is required.
	Branch *types.Branch

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for create branch request.

type CreateDeploymentInput 

type CreateDeploymentInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	//  The name of the branch to use for the job.
	//
	// This member is required.
	BranchName *string

	//  An optional file map that contains the file name as the key and the file
	// content md5 hash as the value. If this argument is provided, the service will
	// generate a unique upload URL per file. Otherwise, the service will only generate
	// a single upload URL for the zipped files.
	FileMap map[string]string
	// contains filtered or unexported fields
}

The request structure for the create a new deployment request.

type CreateDeploymentOutput 

type CreateDeploymentOutput struct {

	//  When the fileMap argument is provided in the request, fileUploadUrls will
	// contain a map of file names to upload URLs.
	//
	// This member is required.
	FileUploadUrls map[string]string

	//  When the fileMap argument is not provided in the request, this zipUploadUrl is
	// returned.
	//
	// This member is required.
	ZipUploadUrl *string

	//  The job ID for this deployment. will supply to start deployment api.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the create a new deployment request.

type CreateDomainAssociationInput 

type CreateDomainAssociationInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

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

	//  The setting for the subdomain.
	//
	// This member is required.
	SubDomainSettings []types.SubDomainSetting

	//  Sets the 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

	// The type of SSL/TLS certificate to use for your custom domain. If you don't
	// specify a certificate type, Amplify uses the default certificate that it
	// provisions and manages for you.
	CertificateSettings *types.CertificateSettings

	//  Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain *bool
	// contains filtered or unexported fields
}

The request structure for the create domain association request.

type CreateDomainAssociationOutput 

type CreateDomainAssociationOutput struct {

	//  Describes the structure of a domain association, which associates a custom
	// domain with an Amplify app.
	//
	// This member is required.
	DomainAssociation *types.DomainAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the create domain association request.

type CreateWebhookInput 

type CreateWebhookInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

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

	// The description for a webhook.
	Description *string
	// contains filtered or unexported fields
}

The request structure for the create webhook request.

type CreateWebhookOutput 

type CreateWebhookOutput struct {

	// Describes a webhook that connects repository events to an Amplify app.
	//
	// This member is required.
	Webhook *types.Webhook

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the create webhook request.

type DeleteAppInput 

type DeleteAppInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

Describes the request structure for the delete app request.

type DeleteAppOutput 

type DeleteAppOutput struct {

	// Represents the different branches of a repository for building, deploying, and
	// hosting an Amplify app.
	//
	// This member is required.
	App *types.App

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the delete app request.

type DeleteBackendEnvironmentInput 

type DeleteBackendEnvironmentInput struct {

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

	// The name of a backend environment of an Amplify app.
	//
	// This member is required.
	EnvironmentName *string
	// contains filtered or unexported fields
}

The request structure for the delete backend environment request.

type DeleteBackendEnvironmentOutput 

type DeleteBackendEnvironmentOutput struct {

	// Describes the backend environment for an Amplify app.
	//
	// This member is required.
	BackendEnvironment *types.BackendEnvironment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure of the delete backend environment result.

type DeleteBranchInput 

type DeleteBranchInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch.
	//
	// This member is required.
	BranchName *string
	// contains filtered or unexported fields
}

The request structure for the delete branch request.

type DeleteBranchOutput 

type DeleteBranchOutput struct {

	// The branch for an Amplify app, which maps to a third-party repository branch.
	//
	// This member is required.
	Branch *types.Branch

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the delete branch request.

type DeleteDomainAssociationInput 

type DeleteDomainAssociationInput struct {

	//  The unique id for an Amplify app.
	//
	// This member is required.
	AppId *string

	//  The name of the domain.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

The request structure for the delete domain association request.

type DeleteDomainAssociationOutput 

type DeleteDomainAssociationOutput struct {

	// Describes the association between a custom domain and an Amplify app.
	//
	// This member is required.
	DomainAssociation *types.DomainAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteJobInput 

type DeleteJobInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch to use for the job.
	//
	// This member is required.
	BranchName *string

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

The request structure for the delete job request.

type DeleteJobOutput 

type DeleteJobOutput struct {

	//  Describes the summary for an execution job for an Amplify app.
	//
	// This member is required.
	JobSummary *types.JobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the delete job request.

type DeleteWebhookInput 

type DeleteWebhookInput struct {

	// The unique ID for a webhook.
	//
	// This member is required.
	WebhookId *string
	// contains filtered or unexported fields
}

The request structure for the delete webhook request.

type DeleteWebhookOutput 

type DeleteWebhookOutput struct {

	// Describes a webhook that connects repository events to an Amplify app.
	//
	// This member is required.
	Webhook *types.Webhook

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the delete webhook request.

type EndpointParameters added in v1.14.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.14.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.14.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.14.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.14.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GenerateAccessLogsInput 

type GenerateAccessLogsInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

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

	// The time at which the logs should end. The time range specified is inclusive of
	// the end time.
	EndTime *time.Time

	// The time at which the logs should start. The time range specified is inclusive
	// of the start time.
	StartTime *time.Time
	// contains filtered or unexported fields
}

The request structure for the generate access logs request.

type GenerateAccessLogsOutput 

type GenerateAccessLogsOutput struct {

	// The pre-signed URL for the requested access logs.
	LogUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the generate access logs request.

type GetAppInput 

type GetAppInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

The request structure for the get app request.

type GetAppOutput 

type GetAppOutput struct {

	// Represents the different branches of a repository for building, deploying, and
	// hosting an Amplify app.
	//
	// This member is required.
	App *types.App

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetArtifactUrlInput 

type GetArtifactUrlInput struct {

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

Returns the request structure for the get artifact request.

type GetArtifactUrlOutput 

type GetArtifactUrlOutput struct {

	// The unique ID for an artifact.
	//
	// This member is required.
	ArtifactId *string

	// The presigned URL for the artifact.
	//
	// This member is required.
	ArtifactUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Returns the result structure for the get artifact request.

type GetBackendEnvironmentInput 

type GetBackendEnvironmentInput struct {

	// The unique id for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name for the backend environment.
	//
	// This member is required.
	EnvironmentName *string
	// contains filtered or unexported fields
}

The request structure for the get backend environment request.

type GetBackendEnvironmentOutput 

type GetBackendEnvironmentOutput struct {

	// Describes the backend environment for an Amplify app.
	//
	// This member is required.
	BackendEnvironment *types.BackendEnvironment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the get backend environment result.

type GetBranchInput 

type GetBranchInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch.
	//
	// This member is required.
	BranchName *string
	// contains filtered or unexported fields
}

The request structure for the get branch request.

type GetBranchOutput 

type GetBranchOutput struct {

	//  The branch for an Amplify app, which maps to a third-party repository branch.
	//
	// This member is required.
	Branch *types.Branch

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDomainAssociationInput 

type GetDomainAssociationInput struct {

	//  The unique id for an Amplify app.
	//
	// This member is required.
	AppId *string

	//  The name of the domain.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

The request structure for the get domain association request.

type GetDomainAssociationOutput 

type GetDomainAssociationOutput struct {

	//  Describes the structure of a domain association, which associates a custom
	// domain with an Amplify app.
	//
	// This member is required.
	DomainAssociation *types.DomainAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the get domain association request.

type GetJobInput 

type GetJobInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch to use for the job.
	//
	// This member is required.
	BranchName *string

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

The request structure for the get job request.

type GetJobOutput 

type GetJobOutput struct {

	//  Describes an execution job for an Amplify app.
	//
	// This member is required.
	Job *types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWebhookInput 

type GetWebhookInput struct {

	// The unique ID for a webhook.
	//
	// This member is required.
	WebhookId *string
	// contains filtered or unexported fields
}

The request structure for the get webhook request.

type GetWebhookOutput 

type GetWebhookOutput struct {

	// Describes the structure of a webhook.
	//
	// This member is required.
	Webhook *types.Webhook

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the get webhook request.

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAppsAPIClient added in v1.16.0 

type ListAppsAPIClient interface {
	ListApps(context.Context, *ListAppsInput, ...func(*Options)) (*ListAppsOutput, error)
}

ListAppsAPIClient is a client that implements the ListApps operation.

type ListAppsInput 

type ListAppsInput struct {

	// The maximum number of records to list in a single response.
	MaxResults int32

	// A pagination token. If non-null, the pagination token is returned in a result.
	// Pass its value in another request to retrieve more entries.
	NextToken *string
	// contains filtered or unexported fields
}

The request structure for the list apps request.

type ListAppsOutput 

type ListAppsOutput struct {

	// A list of Amplify apps.
	//
	// This member is required.
	Apps []types.App

	// A pagination token. Set to null to start listing apps from start. If non-null,
	// the pagination token is returned in a result. Pass its value in here to list
	// more projects.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for an Amplify app list request.

type ListAppsPaginator added in v1.16.0 

type ListAppsPaginator struct {
	// contains filtered or unexported fields
}

ListAppsPaginator is a paginator for ListApps

func NewListAppsPaginator added in v1.16.0 

func NewListAppsPaginator(client ListAppsAPIClient, params *ListAppsInput, optFns ...func(*ListAppsPaginatorOptions)) *ListAppsPaginator

NewListAppsPaginator returns a new ListAppsPaginator

func (*ListAppsPaginator) HasMorePages added in v1.16.0 

func (p *ListAppsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppsPaginator) NextPage added in v1.16.0 

func (p *ListAppsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppsOutput, error)

NextPage retrieves the next ListApps page.

type ListAppsPaginatorOptions added in v1.16.0 

type ListAppsPaginatorOptions struct {
	// The maximum number of records to list in a single response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppsPaginatorOptions is the paginator options for ListApps

type ListArtifactsInput 

type ListArtifactsInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

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

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

	// The maximum number of records to list in a single response.
	MaxResults int32

	// A pagination token. Set to null to start listing artifacts from start. If a
	// non-null pagination token is returned in a result, pass its value in here to
	// list more artifacts.
	NextToken *string
	// contains filtered or unexported fields
}

Describes the request structure for the list artifacts request.

type ListArtifactsOutput 

type ListArtifactsOutput struct {

	// A list of artifacts.
	//
	// This member is required.
	Artifacts []types.Artifact

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the list artifacts request.

type ListBackendEnvironmentsInput 

type ListBackendEnvironmentsInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment
	EnvironmentName *string

	// The maximum number of records to list in a single response.
	MaxResults int32

	// A pagination token. Set to null to start listing backend environments from the
	// start. If a non-null pagination token is returned in a result, pass its value in
	// here to list more backend environments.
	NextToken *string
	// contains filtered or unexported fields
}

The request structure for the list backend environments request.

type ListBackendEnvironmentsOutput 

type ListBackendEnvironmentsOutput struct {

	// The list of backend environments for an Amplify app.
	//
	// This member is required.
	BackendEnvironments []types.BackendEnvironment

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the list backend environments result.

type ListBranchesAPIClient added in v1.16.0 

type ListBranchesAPIClient interface {
	ListBranches(context.Context, *ListBranchesInput, ...func(*Options)) (*ListBranchesOutput, error)
}

ListBranchesAPIClient is a client that implements the ListBranches operation.

type ListBranchesInput 

type ListBranchesInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	//  The maximum number of records to list in a single response.
	MaxResults int32

	// A pagination token. Set to null to start listing branches from the start. If a
	// non-null pagination token is returned in a result, pass its value in here to
	// list more branches.
	NextToken *string
	// contains filtered or unexported fields
}

The request structure for the list branches request.

type ListBranchesOutput 

type ListBranchesOutput struct {

	//  A list of branches for an Amplify app.
	//
	// This member is required.
	Branches []types.Branch

	//  A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the list branches request.

type ListBranchesPaginator added in v1.16.0 

type ListBranchesPaginator struct {
	// contains filtered or unexported fields
}

ListBranchesPaginator is a paginator for ListBranches

func NewListBranchesPaginator added in v1.16.0 

func NewListBranchesPaginator(client ListBranchesAPIClient, params *ListBranchesInput, optFns ...func(*ListBranchesPaginatorOptions)) *ListBranchesPaginator

NewListBranchesPaginator returns a new ListBranchesPaginator

func (*ListBranchesPaginator) HasMorePages added in v1.16.0 

func (p *ListBranchesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBranchesPaginator) NextPage added in v1.16.0 

func (p *ListBranchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBranchesOutput, error)

NextPage retrieves the next ListBranches page.

type ListBranchesPaginatorOptions added in v1.16.0 

type ListBranchesPaginatorOptions struct {
	//  The maximum number of records to list in a single response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBranchesPaginatorOptions is the paginator options for ListBranches

type ListDomainAssociationsAPIClient added in v1.16.0 

type ListDomainAssociationsAPIClient interface {
	ListDomainAssociations(context.Context, *ListDomainAssociationsInput, ...func(*Options)) (*ListDomainAssociationsOutput, error)
}

ListDomainAssociationsAPIClient is a client that implements the ListDomainAssociations operation.

type ListDomainAssociationsInput 

type ListDomainAssociationsInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	//  The maximum number of records to list in a single response.
	MaxResults int32

	//  A pagination token. Set to null to start listing apps from the start. If
	// non-null, a pagination token is returned in a result. Pass its value in here to
	// list more projects.
	NextToken *string
	// contains filtered or unexported fields
}

The request structure for the list domain associations request.

type ListDomainAssociationsOutput 

type ListDomainAssociationsOutput struct {

	//  A list of domain associations.
	//
	// This member is required.
	DomainAssociations []types.DomainAssociation

	//  A pagination token. If non-null, a pagination token is returned in a result.
	// Pass its value in another request to retrieve more entries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the list domain association request.

type ListDomainAssociationsPaginator added in v1.16.0 

type ListDomainAssociationsPaginator struct {
	// contains filtered or unexported fields
}

ListDomainAssociationsPaginator is a paginator for ListDomainAssociations

func NewListDomainAssociationsPaginator added in v1.16.0 

func NewListDomainAssociationsPaginator(client ListDomainAssociationsAPIClient, params *ListDomainAssociationsInput, optFns ...func(*ListDomainAssociationsPaginatorOptions)) *ListDomainAssociationsPaginator

NewListDomainAssociationsPaginator returns a new ListDomainAssociationsPaginator

func (*ListDomainAssociationsPaginator) HasMorePages added in v1.16.0 

func (p *ListDomainAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainAssociationsPaginator) NextPage added in v1.16.0 

func (p *ListDomainAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainAssociationsOutput, error)

NextPage retrieves the next ListDomainAssociations page.

type ListDomainAssociationsPaginatorOptions added in v1.16.0 

type ListDomainAssociationsPaginatorOptions struct {
	//  The maximum number of records to list in a single response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDomainAssociationsPaginatorOptions is the paginator options for ListDomainAssociations

type ListJobsAPIClient added in v1.16.0 

type ListJobsAPIClient interface {
	ListJobs(context.Context, *ListJobsInput, ...func(*Options)) (*ListJobsOutput, error)
}

ListJobsAPIClient is a client that implements the ListJobs operation.

type ListJobsInput 

type ListJobsInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch to use for the request.
	//
	// This member is required.
	BranchName *string

	// The maximum number of records to list in a single response.
	MaxResults int32

	// A pagination token. Set to null to start listing steps from the start. If a
	// non-null pagination token is returned in a result, pass its value in here to
	// list more steps.
	NextToken *string
	// contains filtered or unexported fields
}

The request structure for the list jobs request.

type ListJobsOutput 

type ListJobsOutput struct {

	// The result structure for the list job result request.
	//
	// This member is required.
	JobSummaries []types.JobSummary

	// A pagination token. If non-null the pagination token is returned in a result.
	// Pass its value in another request to retrieve more entries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The maximum number of records to list in a single response.

type ListJobsPaginator added in v1.16.0 

type ListJobsPaginator struct {
	// contains filtered or unexported fields
}

ListJobsPaginator is a paginator for ListJobs

func NewListJobsPaginator added in v1.16.0 

func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator

NewListJobsPaginator returns a new ListJobsPaginator

func (*ListJobsPaginator) HasMorePages added in v1.16.0 

func (p *ListJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobsPaginator) NextPage added in v1.16.0 

func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)

NextPage retrieves the next ListJobs page.

type ListJobsPaginatorOptions added in v1.16.0 

type ListJobsPaginatorOptions struct {
	// The maximum number of records to list in a single response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobsPaginatorOptions is the paginator options for ListJobs

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) to use to list tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

The request structure to use to list tags for a resource.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of tags for the specified The Amazon Resource Name (ARN).
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response for the list tags for resource request.

type ListWebhooksInput 

type ListWebhooksInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The maximum number of records to list in a single response.
	MaxResults int32

	// A pagination token. Set to null to start listing webhooks from the start. If
	// non-null,the pagination token is returned in a result. Pass its value in here to
	// list more webhooks.
	NextToken *string
	// contains filtered or unexported fields
}

The request structure for the list webhooks request.

type ListWebhooksOutput 

type ListWebhooksOutput struct {

	// A list of webhooks.
	//
	// This member is required.
	Webhooks []types.Webhook

	// A pagination token. If non-null, the pagination token is returned in a result.
	// Pass its value in another request to retrieve more entries.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the list webhooks request.

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.17.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartDeploymentInput 

type StartDeploymentInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch to use for the deployment job.
	//
	// This member is required.
	BranchName *string

	// The job ID for this deployment that is generated by the CreateDeployment
	// request.
	JobId *string

	// The source URL for the deployment that is used when calling StartDeployment
	// without CreateDeployment . 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 types.SourceUrlType
	// contains filtered or unexported fields
}

The request structure for the start a deployment request.

type StartDeploymentOutput 

type StartDeploymentOutput struct {

	// The summary for the job.
	//
	// This member is required.
	JobSummary *types.JobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the start a deployment request.

type StartJobInput 

type StartJobInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch to use for the job.
	//
	// This member is required.
	BranchName *string

	// Describes the type for the job. The job type RELEASE starts a new job with the
	// latest change from the specified branch. This value is available only for apps
	// that are connected to a repository.
	//
	// The job type RETRY retries an existing job. If the job type value is RETRY , the
	// jobId is also required.
	//
	// This member is required.
	JobType types.JobType

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

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

	//  The commit date and time for the job.
	CommitTime *time.Time

	// The unique ID for an existing job. This is required if the value of jobType is
	// RETRY .
	JobId *string

	// A descriptive reason for starting the job.
	JobReason *string
	// contains filtered or unexported fields
}

The request structure for the start job request.

type StartJobOutput 

type StartJobOutput struct {

	//  The summary for the job.
	//
	// This member is required.
	JobSummary *types.JobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the run job request.

type StopJobInput 

type StopJobInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch to use for the stop job request.
	//
	// This member is required.
	BranchName *string

	//  The unique id for the job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

The request structure for the stop job request.

type StopJobOutput 

type StopJobOutput struct {

	//  The summary for the job.
	//
	// This member is required.
	JobSummary *types.JobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the stop job request.

type TagResourceInput 

type TagResourceInput struct {

	//  The Amazon Resource Name (ARN) to use to tag a resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags used to tag the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

The request structure to tag a resource with a tag key and value.

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response for the tag resource request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) to use to untag a resource.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys to use to untag a resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

The request structure for the untag resource request.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response for the untag resource request.

type UpdateAppInput 

type UpdateAppInput struct {

	// The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The personal access token for a GitHub repository for an Amplify app. The
	// personal access token is used to authorize access to a GitHub repository using
	// the Amplify GitHub App. The token is not stored.
	//
	// Use accessToken for GitHub repositories only. To authorize access to a
	// repository provider such as Bitbucket or CodeCommit, use oauthToken .
	//
	// You must specify either accessToken or oauthToken when you update an app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to
	// work with CI/CD. However, we strongly recommend that you migrate these apps to
	// use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App]in the Amplify User Guide .
	//
	// [Migrating an existing OAuth app to the Amplify GitHub App]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
	AccessToken *string

	// The automated branch creation configuration for an Amplify app.
	AutoBranchCreationConfig *types.AutoBranchCreationConfig

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

	// The basic authorization credentials for 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) for an Amplify app.
	BuildSpec *string

	// The cache configuration for the Amplify app.
	CacheConfig *types.CacheConfig

	// The custom HTTP headers for an Amplify app.
	CustomHeaders *string

	// The custom redirect and rewrite rules for an Amplify app.
	CustomRules []types.CustomRule

	// The description for an Amplify app.
	Description *string

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

	// Enables basic authorization for an Amplify app.
	EnableBasicAuth *bool

	// Enables branch auto-building for an Amplify app.
	EnableBranchAutoBuild *bool

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

	// The environment variables for an Amplify app.
	EnvironmentVariables map[string]string

	// The AWS Identity and Access Management (IAM) service role for an Amplify app.
	IamServiceRoleArn *string

	// The name for an Amplify app.
	Name *string

	// The OAuth token for a third-party source control system for an Amplify app. The
	// OAuth token is used to create a webhook and a read-only deploy key using SSH
	// cloning. The OAuth token is not stored.
	//
	// Use oauthToken for repository providers other than GitHub, such as Bitbucket or
	// CodeCommit.
	//
	// To authorize access to GitHub as your repository provider, use accessToken .
	//
	// You must specify either oauthToken or accessToken when you update an app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to
	// work with CI/CD. However, we strongly recommend that you migrate these apps to
	// use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App]in the Amplify User Guide .
	//
	// [Migrating an existing OAuth app to the Amplify GitHub App]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
	OauthToken *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 version 14 or later, you must
	// set the platform type to WEB_COMPUTE .
	Platform types.Platform

	// The name of the Git repository for an Amplify app.
	Repository *string
	// contains filtered or unexported fields
}

The request structure for the update app request.

type UpdateAppOutput 

type UpdateAppOutput struct {

	// Represents the updated Amplify app.
	//
	// This member is required.
	App *types.App

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for an Amplify app update request.

type UpdateBranchInput 

type UpdateBranchInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

	// The name of the branch.
	//
	// This member is required.
	BranchName *string

	// The backend for a Branch of an Amplify app. Use for a backend created from an
	// CloudFormation stack.
	//
	// This field 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 *types.Backend

	// The Amazon Resource Name (ARN) for a backend environment that is part of a Gen
	// 1 Amplify app.
	//
	// This field is available to Amplify Gen 1 apps only where the backend is created
	// using Amplify Studio or the Amplify command line interface (CLI).
	BackendEnvironmentArn *string

	//  The basic authorization credentials for the 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 branch.
	BuildSpec *string

	//  The description for the branch.
	Description *string

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

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

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

	//  Enables notifications for the branch.
	EnableNotification *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 this branch.
	EnablePullRequestPreview *bool

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

	//  The framework for the branch.
	Framework *string

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

	//  Describes the current stage for the branch.
	Stage types.Stage

	//  The content Time to Live (TTL) for the website in seconds.
	Ttl *string
	// contains filtered or unexported fields
}

The request structure for the update branch request.

type UpdateBranchOutput 

type UpdateBranchOutput struct {

	//  The branch for an Amplify app, which maps to a third-party repository branch.
	//
	// This member is required.
	Branch *types.Branch

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the update branch request.

type UpdateDomainAssociationInput 

type UpdateDomainAssociationInput struct {

	//  The unique ID for an Amplify app.
	//
	// This member is required.
	AppId *string

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

	//  Sets the 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

	// The type of SSL/TLS certificate to use for your custom domain.
	CertificateSettings *types.CertificateSettings

	//  Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain *bool

	//  Describes the settings for the subdomain.
	SubDomainSettings []types.SubDomainSetting
	// contains filtered or unexported fields
}

The request structure for the update domain association request.

type UpdateDomainAssociationOutput 

type UpdateDomainAssociationOutput struct {

	//  Describes a domain association, which associates a custom domain with an
	// Amplify app.
	//
	// This member is required.
	DomainAssociation *types.DomainAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the update domain association request.

type UpdateWebhookInput 

type UpdateWebhookInput struct {

	// The unique ID for a webhook.
	//
	// This member is required.
	WebhookId *string

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

	// The description for a webhook.
	Description *string
	// contains filtered or unexported fields
}

The request structure for the update webhook request.

type UpdateWebhookOutput 

type UpdateWebhookOutput struct {

	// Describes a webhook that connects repository events to an Amplify app.
	//
	// This member is required.
	Webhook *types.Webhook

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result structure for the update webhook request.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.