amplify

package
v1.54.9 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2024 License: Apache-2.0 Imports: 10 Imported by: 44

Documentation

Overview

Package amplify provides the client and types for making API requests to 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 (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html). The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. (https://docs.amplify.aws/)

See https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25 for more information on this service.

See amplify package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/amplify/

Using the Client

To contact AWS Amplify with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Amplify client Amplify for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/amplify/#New

Index

Constants

View Source 
const (
	// CertificateTypeAmplifyManaged is a CertificateType enum value
	CertificateTypeAmplifyManaged = "AMPLIFY_MANAGED"

	// CertificateTypeCustom is a CertificateType enum value
	CertificateTypeCustom = "CUSTOM"
)
View Source 
const (
	// DomainStatusPendingVerification is a DomainStatus enum value
	DomainStatusPendingVerification = "PENDING_VERIFICATION"

	// DomainStatusInProgress is a DomainStatus enum value
	DomainStatusInProgress = "IN_PROGRESS"

	// DomainStatusAvailable is a DomainStatus enum value
	DomainStatusAvailable = "AVAILABLE"

	// DomainStatusImportingCustomCertificate is a DomainStatus enum value
	DomainStatusImportingCustomCertificate = "IMPORTING_CUSTOM_CERTIFICATE"

	// DomainStatusPendingDeployment is a DomainStatus enum value
	DomainStatusPendingDeployment = "PENDING_DEPLOYMENT"

	// DomainStatusAwaitingAppCname is a DomainStatus enum value
	DomainStatusAwaitingAppCname = "AWAITING_APP_CNAME"

	// DomainStatusFailed is a DomainStatus enum value
	DomainStatusFailed = "FAILED"

	// DomainStatusCreating is a DomainStatus enum value
	DomainStatusCreating = "CREATING"

	// DomainStatusRequestingCertificate is a DomainStatus enum value
	DomainStatusRequestingCertificate = "REQUESTING_CERTIFICATE"

	// DomainStatusUpdating is a DomainStatus enum value
	DomainStatusUpdating = "UPDATING"
)
View Source 
const (
	// JobStatusPending is a JobStatus enum value
	JobStatusPending = "PENDING"

	// JobStatusProvisioning is a JobStatus enum value
	JobStatusProvisioning = "PROVISIONING"

	// JobStatusRunning is a JobStatus enum value
	JobStatusRunning = "RUNNING"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"

	// JobStatusSucceed is a JobStatus enum value
	JobStatusSucceed = "SUCCEED"

	// JobStatusCancelling is a JobStatus enum value
	JobStatusCancelling = "CANCELLING"

	// JobStatusCancelled is a JobStatus enum value
	JobStatusCancelled = "CANCELLED"
)
View Source 
const (
	// JobTypeRelease is a JobType enum value
	JobTypeRelease = "RELEASE"

	// JobTypeRetry is a JobType enum value
	JobTypeRetry = "RETRY"

	// JobTypeManual is a JobType enum value
	JobTypeManual = "MANUAL"

	// JobTypeWebHook is a JobType enum value
	JobTypeWebHook = "WEB_HOOK"
)
View Source 
const (
	// PlatformWeb is a Platform enum value
	PlatformWeb = "WEB"

	// PlatformWebDynamic is a Platform enum value
	PlatformWebDynamic = "WEB_DYNAMIC"

	// PlatformWebCompute is a Platform enum value
	PlatformWebCompute = "WEB_COMPUTE"
)
View Source 
const (
	// RepositoryCloneMethodSsh is a RepositoryCloneMethod enum value
	RepositoryCloneMethodSsh = "SSH"

	// RepositoryCloneMethodToken is a RepositoryCloneMethod enum value
	RepositoryCloneMethodToken = "TOKEN"

	// RepositoryCloneMethodSigv4 is a RepositoryCloneMethod enum value
	RepositoryCloneMethodSigv4 = "SIGV4"
)
View Source 
const (
	// StageProduction is a Stage enum value
	StageProduction = "PRODUCTION"

	// StageBeta is a Stage enum value
	StageBeta = "BETA"

	// StageDevelopment is a Stage enum value
	StageDevelopment = "DEVELOPMENT"

	// StageExperimental is a Stage enum value
	StageExperimental = "EXPERIMENTAL"

	// StagePullRequest is a Stage enum value
	StagePullRequest = "PULL_REQUEST"
)
View Source 
const (
	// UpdateStatusRequestingCertificate is a UpdateStatus enum value
	UpdateStatusRequestingCertificate = "REQUESTING_CERTIFICATE"

	// UpdateStatusPendingVerification is a UpdateStatus enum value
	UpdateStatusPendingVerification = "PENDING_VERIFICATION"

	// UpdateStatusImportingCustomCertificate is a UpdateStatus enum value
	UpdateStatusImportingCustomCertificate = "IMPORTING_CUSTOM_CERTIFICATE"

	// UpdateStatusPendingDeployment is a UpdateStatus enum value
	UpdateStatusPendingDeployment = "PENDING_DEPLOYMENT"

	// UpdateStatusAwaitingAppCname is a UpdateStatus enum value
	UpdateStatusAwaitingAppCname = "AWAITING_APP_CNAME"

	// UpdateStatusUpdateComplete is a UpdateStatus enum value
	UpdateStatusUpdateComplete = "UPDATE_COMPLETE"

	// UpdateStatusUpdateFailed is a UpdateStatus enum value
	UpdateStatusUpdateFailed = "UPDATE_FAILED"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// A request contains unexpected data.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeDependentServiceFailureException for service response error code
	// "DependentServiceFailureException".
	//
	// An operation failed because a dependent service threw an exception.
	ErrCodeDependentServiceFailureException = "DependentServiceFailureException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// The service failed to perform an operation due to an internal issue.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A resource could not be created because service quotas were exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// An entity was not found during an operation.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// An operation failed due to a non-existent resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// An operation failed due to a lack of access.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source 
const (
	ServiceName = "Amplify" // Name of service.
	EndpointsID = "amplify" // ID to lookup a service endpoint with.
	ServiceID   = "Amplify" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func CertificateType_Values added in v1.50.21 

func CertificateType_Values() []string

CertificateType_Values returns all elements of the CertificateType enum

func DomainStatus_Values added in v1.34.3 

func DomainStatus_Values() []string

DomainStatus_Values returns all elements of the DomainStatus enum

func JobStatus_Values added in v1.34.3 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func JobType_Values added in v1.34.3 

func JobType_Values() []string

JobType_Values returns all elements of the JobType enum

func Platform_Values added in v1.34.3 

func Platform_Values() []string

Platform_Values returns all elements of the Platform enum

func RepositoryCloneMethod_Values added in v1.43.8 

func RepositoryCloneMethod_Values() []string

RepositoryCloneMethod_Values returns all elements of the RepositoryCloneMethod enum

func Stage_Values added in v1.34.3 

func Stage_Values() []string

Stage_Values returns all elements of the Stage enum

func UpdateStatus_Values added in v1.50.21 

func UpdateStatus_Values() []string

UpdateStatus_Values returns all elements of the UpdateStatus enum

Types

type Amplify 

type Amplify struct {
	*client.Client
}

Amplify provides the API operation methods for making requests to AWS Amplify. See this package's package overview docs for details on the service.

Amplify methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Amplify

New creates a new instance of the Amplify client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Amplify client from just a session.
svc := amplify.New(mySession)

// Create a Amplify client with additional configuration
svc := amplify.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Amplify) CreateApp 

func (c *Amplify) CreateApp(input *CreateAppInput) (*CreateAppOutput, error)

CreateApp API operation for AWS Amplify.

Creates a new Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation CreateApp for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateApp

func (*Amplify) CreateAppRequest 

func (c *Amplify) CreateAppRequest(input *CreateAppInput) (req *request.Request, output *CreateAppOutput)

CreateAppRequest generates a "aws/request.Request" representing the client's request for the CreateApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateApp for more information on using the CreateApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAppRequest method.
req, resp := client.CreateAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateApp

func (*Amplify) CreateAppWithContext 

func (c *Amplify) CreateAppWithContext(ctx aws.Context, input *CreateAppInput, opts ...request.Option) (*CreateAppOutput, error)

CreateAppWithContext is the same as CreateApp with the addition of the ability to pass a context and additional request options.

See CreateApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) CreateBackendEnvironment added in v1.25.40 

func (c *Amplify) CreateBackendEnvironment(input *CreateBackendEnvironmentInput) (*CreateBackendEnvironmentOutput, error)

CreateBackendEnvironment API operation for AWS Amplify.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation CreateBackendEnvironment for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBackendEnvironment

func (*Amplify) CreateBackendEnvironmentRequest added in v1.25.40 

func (c *Amplify) CreateBackendEnvironmentRequest(input *CreateBackendEnvironmentInput) (req *request.Request, output *CreateBackendEnvironmentOutput)

CreateBackendEnvironmentRequest generates a "aws/request.Request" representing the client's request for the CreateBackendEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBackendEnvironment for more information on using the CreateBackendEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBackendEnvironmentRequest method.
req, resp := client.CreateBackendEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBackendEnvironment

func (*Amplify) CreateBackendEnvironmentWithContext added in v1.25.40 

func (c *Amplify) CreateBackendEnvironmentWithContext(ctx aws.Context, input *CreateBackendEnvironmentInput, opts ...request.Option) (*CreateBackendEnvironmentOutput, error)

CreateBackendEnvironmentWithContext is the same as CreateBackendEnvironment with the addition of the ability to pass a context and additional request options.

See CreateBackendEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) CreateBranch 

func (c *Amplify) CreateBranch(input *CreateBranchInput) (*CreateBranchOutput, error)

CreateBranch API operation for AWS Amplify.

Creates a new branch for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation CreateBranch for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranch

func (*Amplify) CreateBranchRequest 

func (c *Amplify) CreateBranchRequest(input *CreateBranchInput) (req *request.Request, output *CreateBranchOutput)

CreateBranchRequest generates a "aws/request.Request" representing the client's request for the CreateBranch operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBranch for more information on using the CreateBranch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBranchRequest method.
req, resp := client.CreateBranchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranch

func (*Amplify) CreateBranchWithContext 

func (c *Amplify) CreateBranchWithContext(ctx aws.Context, input *CreateBranchInput, opts ...request.Option) (*CreateBranchOutput, error)

CreateBranchWithContext is the same as CreateBranch with the addition of the ability to pass a context and additional request options.

See CreateBranch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) CreateDeployment added in v1.20.17 

func (c *Amplify) CreateDeployment(input *CreateDeploymentInput) (*CreateDeploymentOutput, error)

CreateDeployment API operation for AWS Amplify.

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation CreateDeployment for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeployment

func (*Amplify) CreateDeploymentRequest added in v1.20.17 

func (c *Amplify) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *CreateDeploymentOutput)

CreateDeploymentRequest generates a "aws/request.Request" representing the client's request for the CreateDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDeployment for more information on using the CreateDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDeploymentRequest method.
req, resp := client.CreateDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeployment

func (*Amplify) CreateDeploymentWithContext added in v1.20.17 

func (c *Amplify) CreateDeploymentWithContext(ctx aws.Context, input *CreateDeploymentInput, opts ...request.Option) (*CreateDeploymentOutput, error)

CreateDeploymentWithContext is the same as CreateDeployment with the addition of the ability to pass a context and additional request options.

See CreateDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) CreateDomainAssociation 

func (c *Amplify) CreateDomainAssociation(input *CreateDomainAssociationInput) (*CreateDomainAssociationOutput, error)

CreateDomainAssociation API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation CreateDomainAssociation for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociation

func (*Amplify) CreateDomainAssociationRequest 

func (c *Amplify) CreateDomainAssociationRequest(input *CreateDomainAssociationInput) (req *request.Request, output *CreateDomainAssociationOutput)

CreateDomainAssociationRequest generates a "aws/request.Request" representing the client's request for the CreateDomainAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomainAssociation for more information on using the CreateDomainAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDomainAssociationRequest method.
req, resp := client.CreateDomainAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociation

func (*Amplify) CreateDomainAssociationWithContext 

func (c *Amplify) CreateDomainAssociationWithContext(ctx aws.Context, input *CreateDomainAssociationInput, opts ...request.Option) (*CreateDomainAssociationOutput, error)

CreateDomainAssociationWithContext is the same as CreateDomainAssociation with the addition of the ability to pass a context and additional request options.

See CreateDomainAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) CreateWebhook added in v1.20.17 

func (c *Amplify) CreateWebhook(input *CreateWebhookInput) (*CreateWebhookOutput, error)

CreateWebhook API operation for AWS Amplify.

Creates a new webhook on an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation CreateWebhook for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhook

func (*Amplify) CreateWebhookRequest added in v1.20.17 

func (c *Amplify) CreateWebhookRequest(input *CreateWebhookInput) (req *request.Request, output *CreateWebhookOutput)

CreateWebhookRequest generates a "aws/request.Request" representing the client's request for the CreateWebhook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWebhook for more information on using the CreateWebhook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWebhookRequest method.
req, resp := client.CreateWebhookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhook

func (*Amplify) CreateWebhookWithContext added in v1.20.17 

func (c *Amplify) CreateWebhookWithContext(ctx aws.Context, input *CreateWebhookInput, opts ...request.Option) (*CreateWebhookOutput, error)

CreateWebhookWithContext is the same as CreateWebhook with the addition of the ability to pass a context and additional request options.

See CreateWebhook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) DeleteApp 

func (c *Amplify) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error)

DeleteApp API operation for AWS Amplify.

Deletes an existing Amplify app specified by an app ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation DeleteApp for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • NotFoundException An entity was not found during an operation.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteApp

func (*Amplify) DeleteAppRequest 

func (c *Amplify) DeleteAppRequest(input *DeleteAppInput) (req *request.Request, output *DeleteAppOutput)

DeleteAppRequest generates a "aws/request.Request" representing the client's request for the DeleteApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApp for more information on using the DeleteApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAppRequest method.
req, resp := client.DeleteAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteApp

func (*Amplify) DeleteAppWithContext 

func (c *Amplify) DeleteAppWithContext(ctx aws.Context, input *DeleteAppInput, opts ...request.Option) (*DeleteAppOutput, error)

DeleteAppWithContext is the same as DeleteApp with the addition of the ability to pass a context and additional request options.

See DeleteApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) DeleteBackendEnvironment added in v1.25.40 

func (c *Amplify) DeleteBackendEnvironment(input *DeleteBackendEnvironmentInput) (*DeleteBackendEnvironmentOutput, error)

DeleteBackendEnvironment API operation for AWS Amplify.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation DeleteBackendEnvironment for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBackendEnvironment

func (*Amplify) DeleteBackendEnvironmentRequest added in v1.25.40 

func (c *Amplify) DeleteBackendEnvironmentRequest(input *DeleteBackendEnvironmentInput) (req *request.Request, output *DeleteBackendEnvironmentOutput)

DeleteBackendEnvironmentRequest generates a "aws/request.Request" representing the client's request for the DeleteBackendEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackendEnvironment for more information on using the DeleteBackendEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBackendEnvironmentRequest method.
req, resp := client.DeleteBackendEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBackendEnvironment

func (*Amplify) DeleteBackendEnvironmentWithContext added in v1.25.40 

func (c *Amplify) DeleteBackendEnvironmentWithContext(ctx aws.Context, input *DeleteBackendEnvironmentInput, opts ...request.Option) (*DeleteBackendEnvironmentOutput, error)

DeleteBackendEnvironmentWithContext is the same as DeleteBackendEnvironment with the addition of the ability to pass a context and additional request options.

See DeleteBackendEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) DeleteBranch 

func (c *Amplify) DeleteBranch(input *DeleteBranchInput) (*DeleteBranchOutput, error)

DeleteBranch API operation for AWS Amplify.

Deletes a branch for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation DeleteBranch for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranch

func (*Amplify) DeleteBranchRequest 

func (c *Amplify) DeleteBranchRequest(input *DeleteBranchInput) (req *request.Request, output *DeleteBranchOutput)

DeleteBranchRequest generates a "aws/request.Request" representing the client's request for the DeleteBranch operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBranch for more information on using the DeleteBranch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBranchRequest method.
req, resp := client.DeleteBranchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranch

func (*Amplify) DeleteBranchWithContext 

func (c *Amplify) DeleteBranchWithContext(ctx aws.Context, input *DeleteBranchInput, opts ...request.Option) (*DeleteBranchOutput, error)

DeleteBranchWithContext is the same as DeleteBranch with the addition of the ability to pass a context and additional request options.

See DeleteBranch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) DeleteDomainAssociation 

func (c *Amplify) DeleteDomainAssociation(input *DeleteDomainAssociationInput) (*DeleteDomainAssociationOutput, error)

DeleteDomainAssociation API operation for AWS Amplify.

Deletes a domain association for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation DeleteDomainAssociation for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociation

func (*Amplify) DeleteDomainAssociationRequest 

func (c *Amplify) DeleteDomainAssociationRequest(input *DeleteDomainAssociationInput) (req *request.Request, output *DeleteDomainAssociationOutput)

DeleteDomainAssociationRequest generates a "aws/request.Request" representing the client's request for the DeleteDomainAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomainAssociation for more information on using the DeleteDomainAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDomainAssociationRequest method.
req, resp := client.DeleteDomainAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociation

func (*Amplify) DeleteDomainAssociationWithContext 

func (c *Amplify) DeleteDomainAssociationWithContext(ctx aws.Context, input *DeleteDomainAssociationInput, opts ...request.Option) (*DeleteDomainAssociationOutput, error)

DeleteDomainAssociationWithContext is the same as DeleteDomainAssociation with the addition of the ability to pass a context and additional request options.

See DeleteDomainAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) DeleteJob 

func (c *Amplify) DeleteJob(input *DeleteJobInput) (*DeleteJobOutput, error)

DeleteJob API operation for AWS Amplify.

Deletes a job for a branch of an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation DeleteJob for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJob

func (*Amplify) DeleteJobRequest 

func (c *Amplify) DeleteJobRequest(input *DeleteJobInput) (req *request.Request, output *DeleteJobOutput)

DeleteJobRequest generates a "aws/request.Request" representing the client's request for the DeleteJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteJob for more information on using the DeleteJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteJobRequest method.
req, resp := client.DeleteJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJob

func (*Amplify) DeleteJobWithContext 

func (c *Amplify) DeleteJobWithContext(ctx aws.Context, input *DeleteJobInput, opts ...request.Option) (*DeleteJobOutput, error)

DeleteJobWithContext is the same as DeleteJob with the addition of the ability to pass a context and additional request options.

See DeleteJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) DeleteWebhook added in v1.20.17 

func (c *Amplify) DeleteWebhook(input *DeleteWebhookInput) (*DeleteWebhookOutput, error)

DeleteWebhook API operation for AWS Amplify.

Deletes a webhook.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation DeleteWebhook for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhook

func (*Amplify) DeleteWebhookRequest added in v1.20.17 

func (c *Amplify) DeleteWebhookRequest(input *DeleteWebhookInput) (req *request.Request, output *DeleteWebhookOutput)

DeleteWebhookRequest generates a "aws/request.Request" representing the client's request for the DeleteWebhook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWebhook for more information on using the DeleteWebhook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWebhookRequest method.
req, resp := client.DeleteWebhookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhook

func (*Amplify) DeleteWebhookWithContext added in v1.20.17 

func (c *Amplify) DeleteWebhookWithContext(ctx aws.Context, input *DeleteWebhookInput, opts ...request.Option) (*DeleteWebhookOutput, error)

DeleteWebhookWithContext is the same as DeleteWebhook with the addition of the ability to pass a context and additional request options.

See DeleteWebhook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GenerateAccessLogs added in v1.25.1 

func (c *Amplify) GenerateAccessLogs(input *GenerateAccessLogsInput) (*GenerateAccessLogsOutput, error)

GenerateAccessLogs API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GenerateAccessLogs for usage and error information.

Returned Error Types:

  • NotFoundException An entity was not found during an operation.

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GenerateAccessLogs

func (*Amplify) GenerateAccessLogsRequest added in v1.25.1 

func (c *Amplify) GenerateAccessLogsRequest(input *GenerateAccessLogsInput) (req *request.Request, output *GenerateAccessLogsOutput)

GenerateAccessLogsRequest generates a "aws/request.Request" representing the client's request for the GenerateAccessLogs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GenerateAccessLogs for more information on using the GenerateAccessLogs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GenerateAccessLogsRequest method.
req, resp := client.GenerateAccessLogsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GenerateAccessLogs

func (*Amplify) GenerateAccessLogsWithContext added in v1.25.1 

func (c *Amplify) GenerateAccessLogsWithContext(ctx aws.Context, input *GenerateAccessLogsInput, opts ...request.Option) (*GenerateAccessLogsOutput, error)

GenerateAccessLogsWithContext is the same as GenerateAccessLogs with the addition of the ability to pass a context and additional request options.

See GenerateAccessLogs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetApp 

func (c *Amplify) GetApp(input *GetAppInput) (*GetAppOutput, error)

GetApp API operation for AWS Amplify.

Returns an existing Amplify app specified by an app ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetApp for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • NotFoundException An entity was not found during an operation.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetApp

func (*Amplify) GetAppRequest 

func (c *Amplify) GetAppRequest(input *GetAppInput) (req *request.Request, output *GetAppOutput)

GetAppRequest generates a "aws/request.Request" representing the client's request for the GetApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApp for more information on using the GetApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAppRequest method.
req, resp := client.GetAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetApp

func (*Amplify) GetAppWithContext 

func (c *Amplify) GetAppWithContext(ctx aws.Context, input *GetAppInput, opts ...request.Option) (*GetAppOutput, error)

GetAppWithContext is the same as GetApp with the addition of the ability to pass a context and additional request options.

See GetApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetArtifactUrl added in v1.25.1 

func (c *Amplify) GetArtifactUrl(input *GetArtifactUrlInput) (*GetArtifactUrlOutput, error)

GetArtifactUrl API operation for AWS Amplify.

Returns the artifact info that corresponds to an artifact id.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetArtifactUrl for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetArtifactUrl

func (*Amplify) GetArtifactUrlRequest added in v1.25.1 

func (c *Amplify) GetArtifactUrlRequest(input *GetArtifactUrlInput) (req *request.Request, output *GetArtifactUrlOutput)

GetArtifactUrlRequest generates a "aws/request.Request" representing the client's request for the GetArtifactUrl operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetArtifactUrl for more information on using the GetArtifactUrl API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetArtifactUrlRequest method.
req, resp := client.GetArtifactUrlRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetArtifactUrl

func (*Amplify) GetArtifactUrlWithContext added in v1.25.1 

func (c *Amplify) GetArtifactUrlWithContext(ctx aws.Context, input *GetArtifactUrlInput, opts ...request.Option) (*GetArtifactUrlOutput, error)

GetArtifactUrlWithContext is the same as GetArtifactUrl with the addition of the ability to pass a context and additional request options.

See GetArtifactUrl for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetBackendEnvironment added in v1.25.40 

func (c *Amplify) GetBackendEnvironment(input *GetBackendEnvironmentInput) (*GetBackendEnvironmentOutput, error)

GetBackendEnvironment API operation for AWS Amplify.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetBackendEnvironment for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBackendEnvironment

func (*Amplify) GetBackendEnvironmentRequest added in v1.25.40 

func (c *Amplify) GetBackendEnvironmentRequest(input *GetBackendEnvironmentInput) (req *request.Request, output *GetBackendEnvironmentOutput)

GetBackendEnvironmentRequest generates a "aws/request.Request" representing the client's request for the GetBackendEnvironment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackendEnvironment for more information on using the GetBackendEnvironment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBackendEnvironmentRequest method.
req, resp := client.GetBackendEnvironmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBackendEnvironment

func (*Amplify) GetBackendEnvironmentWithContext added in v1.25.40 

func (c *Amplify) GetBackendEnvironmentWithContext(ctx aws.Context, input *GetBackendEnvironmentInput, opts ...request.Option) (*GetBackendEnvironmentOutput, error)

GetBackendEnvironmentWithContext is the same as GetBackendEnvironment with the addition of the ability to pass a context and additional request options.

See GetBackendEnvironment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetBranch 

func (c *Amplify) GetBranch(input *GetBranchInput) (*GetBranchOutput, error)

GetBranch API operation for AWS Amplify.

Returns a branch for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetBranch for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranch

func (*Amplify) GetBranchRequest 

func (c *Amplify) GetBranchRequest(input *GetBranchInput) (req *request.Request, output *GetBranchOutput)

GetBranchRequest generates a "aws/request.Request" representing the client's request for the GetBranch operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBranch for more information on using the GetBranch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBranchRequest method.
req, resp := client.GetBranchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranch

func (*Amplify) GetBranchWithContext 

func (c *Amplify) GetBranchWithContext(ctx aws.Context, input *GetBranchInput, opts ...request.Option) (*GetBranchOutput, error)

GetBranchWithContext is the same as GetBranch with the addition of the ability to pass a context and additional request options.

See GetBranch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetDomainAssociation 

func (c *Amplify) GetDomainAssociation(input *GetDomainAssociationInput) (*GetDomainAssociationOutput, error)

GetDomainAssociation API operation for AWS Amplify.

Returns the domain information for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetDomainAssociation for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociation

func (*Amplify) GetDomainAssociationRequest 

func (c *Amplify) GetDomainAssociationRequest(input *GetDomainAssociationInput) (req *request.Request, output *GetDomainAssociationOutput)

GetDomainAssociationRequest generates a "aws/request.Request" representing the client's request for the GetDomainAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomainAssociation for more information on using the GetDomainAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDomainAssociationRequest method.
req, resp := client.GetDomainAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociation

func (*Amplify) GetDomainAssociationWithContext 

func (c *Amplify) GetDomainAssociationWithContext(ctx aws.Context, input *GetDomainAssociationInput, opts ...request.Option) (*GetDomainAssociationOutput, error)

GetDomainAssociationWithContext is the same as GetDomainAssociation with the addition of the ability to pass a context and additional request options.

See GetDomainAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetJob 

func (c *Amplify) GetJob(input *GetJobInput) (*GetJobOutput, error)

GetJob API operation for AWS Amplify.

Returns a job for a branch of an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetJob for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJob

func (*Amplify) GetJobRequest 

func (c *Amplify) GetJobRequest(input *GetJobInput) (req *request.Request, output *GetJobOutput)

GetJobRequest generates a "aws/request.Request" representing the client's request for the GetJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJob for more information on using the GetJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetJobRequest method.
req, resp := client.GetJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJob

func (*Amplify) GetJobWithContext 

func (c *Amplify) GetJobWithContext(ctx aws.Context, input *GetJobInput, opts ...request.Option) (*GetJobOutput, error)

GetJobWithContext is the same as GetJob with the addition of the ability to pass a context and additional request options.

See GetJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) GetWebhook added in v1.20.17 

func (c *Amplify) GetWebhook(input *GetWebhookInput) (*GetWebhookOutput, error)

GetWebhook API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation GetWebhook for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhook

func (*Amplify) GetWebhookRequest added in v1.20.17 

func (c *Amplify) GetWebhookRequest(input *GetWebhookInput) (req *request.Request, output *GetWebhookOutput)

GetWebhookRequest generates a "aws/request.Request" representing the client's request for the GetWebhook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWebhook for more information on using the GetWebhook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetWebhookRequest method.
req, resp := client.GetWebhookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhook

func (*Amplify) GetWebhookWithContext added in v1.20.17 

func (c *Amplify) GetWebhookWithContext(ctx aws.Context, input *GetWebhookInput, opts ...request.Option) (*GetWebhookOutput, error)

GetWebhookWithContext is the same as GetWebhook with the addition of the ability to pass a context and additional request options.

See GetWebhook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListApps 

func (c *Amplify) ListApps(input *ListAppsInput) (*ListAppsOutput, error)

ListApps API operation for AWS Amplify.

Returns a list of the existing Amplify apps.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListApps for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListApps

func (*Amplify) ListAppsPages added in v1.47.0 

func (c *Amplify) ListAppsPages(input *ListAppsInput, fn func(*ListAppsOutput, bool) bool) error

ListAppsPages iterates over the pages of a ListApps operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListApps method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListApps operation.
pageNum := 0
err := client.ListAppsPages(params,
    func(page *amplify.ListAppsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Amplify) ListAppsPagesWithContext added in v1.47.0 

func (c *Amplify) ListAppsPagesWithContext(ctx aws.Context, input *ListAppsInput, fn func(*ListAppsOutput, bool) bool, opts ...request.Option) error

ListAppsPagesWithContext same as ListAppsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListAppsRequest 

func (c *Amplify) ListAppsRequest(input *ListAppsInput) (req *request.Request, output *ListAppsOutput)

ListAppsRequest generates a "aws/request.Request" representing the client's request for the ListApps operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListApps for more information on using the ListApps API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAppsRequest method.
req, resp := client.ListAppsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListApps

func (*Amplify) ListAppsWithContext 

func (c *Amplify) ListAppsWithContext(ctx aws.Context, input *ListAppsInput, opts ...request.Option) (*ListAppsOutput, error)

ListAppsWithContext is the same as ListApps with the addition of the ability to pass a context and additional request options.

See ListApps for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListArtifacts added in v1.25.1 

func (c *Amplify) ListArtifacts(input *ListArtifactsInput) (*ListArtifactsOutput, error)

ListArtifacts API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListArtifacts for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListArtifacts

func (*Amplify) ListArtifactsRequest added in v1.25.1 

func (c *Amplify) ListArtifactsRequest(input *ListArtifactsInput) (req *request.Request, output *ListArtifactsOutput)

ListArtifactsRequest generates a "aws/request.Request" representing the client's request for the ListArtifacts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListArtifacts for more information on using the ListArtifacts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListArtifactsRequest method.
req, resp := client.ListArtifactsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListArtifacts

func (*Amplify) ListArtifactsWithContext added in v1.25.1 

func (c *Amplify) ListArtifactsWithContext(ctx aws.Context, input *ListArtifactsInput, opts ...request.Option) (*ListArtifactsOutput, error)

ListArtifactsWithContext is the same as ListArtifacts with the addition of the ability to pass a context and additional request options.

See ListArtifacts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListBackendEnvironments added in v1.25.40 

func (c *Amplify) ListBackendEnvironments(input *ListBackendEnvironmentsInput) (*ListBackendEnvironmentsOutput, error)

ListBackendEnvironments API operation for AWS Amplify.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListBackendEnvironments for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironments

func (*Amplify) ListBackendEnvironmentsRequest added in v1.25.40 

func (c *Amplify) ListBackendEnvironmentsRequest(input *ListBackendEnvironmentsInput) (req *request.Request, output *ListBackendEnvironmentsOutput)

ListBackendEnvironmentsRequest generates a "aws/request.Request" representing the client's request for the ListBackendEnvironments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackendEnvironments for more information on using the ListBackendEnvironments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListBackendEnvironmentsRequest method.
req, resp := client.ListBackendEnvironmentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironments

func (*Amplify) ListBackendEnvironmentsWithContext added in v1.25.40 

func (c *Amplify) ListBackendEnvironmentsWithContext(ctx aws.Context, input *ListBackendEnvironmentsInput, opts ...request.Option) (*ListBackendEnvironmentsOutput, error)

ListBackendEnvironmentsWithContext is the same as ListBackendEnvironments with the addition of the ability to pass a context and additional request options.

See ListBackendEnvironments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListBranches 

func (c *Amplify) ListBranches(input *ListBranchesInput) (*ListBranchesOutput, error)

ListBranches API operation for AWS Amplify.

Lists the branches of an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListBranches for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranches

func (*Amplify) ListBranchesPages added in v1.47.0 

func (c *Amplify) ListBranchesPages(input *ListBranchesInput, fn func(*ListBranchesOutput, bool) bool) error

ListBranchesPages iterates over the pages of a ListBranches operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBranches method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListBranches operation.
pageNum := 0
err := client.ListBranchesPages(params,
    func(page *amplify.ListBranchesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Amplify) ListBranchesPagesWithContext added in v1.47.0 

func (c *Amplify) ListBranchesPagesWithContext(ctx aws.Context, input *ListBranchesInput, fn func(*ListBranchesOutput, bool) bool, opts ...request.Option) error

ListBranchesPagesWithContext same as ListBranchesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListBranchesRequest 

func (c *Amplify) ListBranchesRequest(input *ListBranchesInput) (req *request.Request, output *ListBranchesOutput)

ListBranchesRequest generates a "aws/request.Request" representing the client's request for the ListBranches operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBranches for more information on using the ListBranches API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListBranchesRequest method.
req, resp := client.ListBranchesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranches

func (*Amplify) ListBranchesWithContext 

func (c *Amplify) ListBranchesWithContext(ctx aws.Context, input *ListBranchesInput, opts ...request.Option) (*ListBranchesOutput, error)

ListBranchesWithContext is the same as ListBranches with the addition of the ability to pass a context and additional request options.

See ListBranches for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListDomainAssociations 

func (c *Amplify) ListDomainAssociations(input *ListDomainAssociationsInput) (*ListDomainAssociationsOutput, error)

ListDomainAssociations API operation for AWS Amplify.

Returns the domain associations for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListDomainAssociations for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociations

func (*Amplify) ListDomainAssociationsPages added in v1.47.0 

func (c *Amplify) ListDomainAssociationsPages(input *ListDomainAssociationsInput, fn func(*ListDomainAssociationsOutput, bool) bool) error

ListDomainAssociationsPages iterates over the pages of a ListDomainAssociations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDomainAssociations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDomainAssociations operation.
pageNum := 0
err := client.ListDomainAssociationsPages(params,
    func(page *amplify.ListDomainAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Amplify) ListDomainAssociationsPagesWithContext added in v1.47.0 

func (c *Amplify) ListDomainAssociationsPagesWithContext(ctx aws.Context, input *ListDomainAssociationsInput, fn func(*ListDomainAssociationsOutput, bool) bool, opts ...request.Option) error

ListDomainAssociationsPagesWithContext same as ListDomainAssociationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListDomainAssociationsRequest 

func (c *Amplify) ListDomainAssociationsRequest(input *ListDomainAssociationsInput) (req *request.Request, output *ListDomainAssociationsOutput)

ListDomainAssociationsRequest generates a "aws/request.Request" representing the client's request for the ListDomainAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDomainAssociations for more information on using the ListDomainAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDomainAssociationsRequest method.
req, resp := client.ListDomainAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociations

func (*Amplify) ListDomainAssociationsWithContext 

func (c *Amplify) ListDomainAssociationsWithContext(ctx aws.Context, input *ListDomainAssociationsInput, opts ...request.Option) (*ListDomainAssociationsOutput, error)

ListDomainAssociationsWithContext is the same as ListDomainAssociations with the addition of the ability to pass a context and additional request options.

See ListDomainAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListJobs 

func (c *Amplify) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)

ListJobs API operation for AWS Amplify.

Lists the jobs for a branch of an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListJobs for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobs

func (*Amplify) ListJobsPages added in v1.47.0 

func (c *Amplify) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error

ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListJobs operation.
pageNum := 0
err := client.ListJobsPages(params,
    func(page *amplify.ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Amplify) ListJobsPagesWithContext added in v1.47.0 

func (c *Amplify) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error

ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListJobsRequest 

func (c *Amplify) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)

ListJobsRequest generates a "aws/request.Request" representing the client's request for the ListJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJobs for more information on using the ListJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListJobsRequest method.
req, resp := client.ListJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobs

func (*Amplify) ListJobsWithContext 

func (c *Amplify) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)

ListJobsWithContext is the same as ListJobs with the addition of the ability to pass a context and additional request options.

See ListJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListTagsForResource added in v1.20.17 

func (c *Amplify) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

  • BadRequestException A request contains unexpected data.

  • ResourceNotFoundException An operation failed due to a non-existent resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResource

func (*Amplify) ListTagsForResourceRequest added in v1.20.17 

func (c *Amplify) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResource

func (*Amplify) ListTagsForResourceWithContext added in v1.20.17 

func (c *Amplify) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) ListWebhooks added in v1.20.17 

func (c *Amplify) ListWebhooks(input *ListWebhooksInput) (*ListWebhooksOutput, error)

ListWebhooks API operation for AWS Amplify.

Returns a list of webhooks for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation ListWebhooks for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListWebhooks

func (*Amplify) ListWebhooksRequest added in v1.20.17 

func (c *Amplify) ListWebhooksRequest(input *ListWebhooksInput) (req *request.Request, output *ListWebhooksOutput)

ListWebhooksRequest generates a "aws/request.Request" representing the client's request for the ListWebhooks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWebhooks for more information on using the ListWebhooks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWebhooksRequest method.
req, resp := client.ListWebhooksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListWebhooks

func (*Amplify) ListWebhooksWithContext added in v1.20.17 

func (c *Amplify) ListWebhooksWithContext(ctx aws.Context, input *ListWebhooksInput, opts ...request.Option) (*ListWebhooksOutput, error)

ListWebhooksWithContext is the same as ListWebhooks with the addition of the ability to pass a context and additional request options.

See ListWebhooks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) StartDeployment added in v1.20.17 

func (c *Amplify) StartDeployment(input *StartDeploymentInput) (*StartDeploymentOutput, error)

StartDeployment API operation for AWS Amplify.

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation StartDeployment for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeployment

func (*Amplify) StartDeploymentRequest added in v1.20.17 

func (c *Amplify) StartDeploymentRequest(input *StartDeploymentInput) (req *request.Request, output *StartDeploymentOutput)

StartDeploymentRequest generates a "aws/request.Request" representing the client's request for the StartDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDeployment for more information on using the StartDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartDeploymentRequest method.
req, resp := client.StartDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeployment

func (*Amplify) StartDeploymentWithContext added in v1.20.17 

func (c *Amplify) StartDeploymentWithContext(ctx aws.Context, input *StartDeploymentInput, opts ...request.Option) (*StartDeploymentOutput, error)

StartDeploymentWithContext is the same as StartDeployment with the addition of the ability to pass a context and additional request options.

See StartDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) StartJob 

func (c *Amplify) StartJob(input *StartJobInput) (*StartJobOutput, error)

StartJob API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation StartJob for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJob

func (*Amplify) StartJobRequest 

func (c *Amplify) StartJobRequest(input *StartJobInput) (req *request.Request, output *StartJobOutput)

StartJobRequest generates a "aws/request.Request" representing the client's request for the StartJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartJob for more information on using the StartJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartJobRequest method.
req, resp := client.StartJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJob

func (*Amplify) StartJobWithContext 

func (c *Amplify) StartJobWithContext(ctx aws.Context, input *StartJobInput, opts ...request.Option) (*StartJobOutput, error)

StartJobWithContext is the same as StartJob with the addition of the ability to pass a context and additional request options.

See StartJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) StopJob 

func (c *Amplify) StopJob(input *StopJobInput) (*StopJobOutput, error)

StopJob API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation StopJob for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

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

  • NotFoundException An entity was not found during an operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJob

func (*Amplify) StopJobRequest 

func (c *Amplify) StopJobRequest(input *StopJobInput) (req *request.Request, output *StopJobOutput)

StopJobRequest generates a "aws/request.Request" representing the client's request for the StopJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopJob for more information on using the StopJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopJobRequest method.
req, resp := client.StopJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJob

func (*Amplify) StopJobWithContext 

func (c *Amplify) StopJobWithContext(ctx aws.Context, input *StopJobInput, opts ...request.Option) (*StopJobOutput, error)

StopJobWithContext is the same as StopJob with the addition of the ability to pass a context and additional request options.

See StopJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) TagResource added in v1.20.17 

func (c *Amplify) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Amplify.

Tags the resource with a tag key and value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation TagResource for usage and error information.

Returned Error Types:

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

  • BadRequestException A request contains unexpected data.

  • ResourceNotFoundException An operation failed due to a non-existent resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResource

func (*Amplify) TagResourceRequest added in v1.20.17 

func (c *Amplify) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResource

func (*Amplify) TagResourceWithContext added in v1.20.17 

func (c *Amplify) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) UntagResource added in v1.20.17 

func (c *Amplify) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Amplify.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation UntagResource for usage and error information.

Returned Error Types:

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

  • BadRequestException A request contains unexpected data.

  • ResourceNotFoundException An operation failed due to a non-existent resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResource

func (*Amplify) UntagResourceRequest added in v1.20.17 

func (c *Amplify) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResource

func (*Amplify) UntagResourceWithContext added in v1.20.17 

func (c *Amplify) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) UpdateApp 

func (c *Amplify) UpdateApp(input *UpdateAppInput) (*UpdateAppOutput, error)

UpdateApp API operation for AWS Amplify.

Updates an existing Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation UpdateApp for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • NotFoundException An entity was not found during an operation.

  • UnauthorizedException An operation failed due to a lack of access.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateApp

func (*Amplify) UpdateAppRequest 

func (c *Amplify) UpdateAppRequest(input *UpdateAppInput) (req *request.Request, output *UpdateAppOutput)

UpdateAppRequest generates a "aws/request.Request" representing the client's request for the UpdateApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateApp for more information on using the UpdateApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAppRequest method.
req, resp := client.UpdateAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateApp

func (*Amplify) UpdateAppWithContext 

func (c *Amplify) UpdateAppWithContext(ctx aws.Context, input *UpdateAppInput, opts ...request.Option) (*UpdateAppOutput, error)

UpdateAppWithContext is the same as UpdateApp with the addition of the ability to pass a context and additional request options.

See UpdateApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) UpdateBranch 

func (c *Amplify) UpdateBranch(input *UpdateBranchInput) (*UpdateBranchOutput, error)

UpdateBranch API operation for AWS Amplify.

Updates a branch for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation UpdateBranch for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranch

func (*Amplify) UpdateBranchRequest 

func (c *Amplify) UpdateBranchRequest(input *UpdateBranchInput) (req *request.Request, output *UpdateBranchOutput)

UpdateBranchRequest generates a "aws/request.Request" representing the client's request for the UpdateBranch operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBranch for more information on using the UpdateBranch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateBranchRequest method.
req, resp := client.UpdateBranchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranch

func (*Amplify) UpdateBranchWithContext 

func (c *Amplify) UpdateBranchWithContext(ctx aws.Context, input *UpdateBranchInput, opts ...request.Option) (*UpdateBranchOutput, error)

UpdateBranchWithContext is the same as UpdateBranch with the addition of the ability to pass a context and additional request options.

See UpdateBranch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) UpdateDomainAssociation 

func (c *Amplify) UpdateDomainAssociation(input *UpdateDomainAssociationInput) (*UpdateDomainAssociationOutput, error)

UpdateDomainAssociation API operation for AWS Amplify.

Creates a new domain association for an Amplify app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation UpdateDomainAssociation for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociation

func (*Amplify) UpdateDomainAssociationRequest 

func (c *Amplify) UpdateDomainAssociationRequest(input *UpdateDomainAssociationInput) (req *request.Request, output *UpdateDomainAssociationOutput)

UpdateDomainAssociationRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDomainAssociation for more information on using the UpdateDomainAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDomainAssociationRequest method.
req, resp := client.UpdateDomainAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociation

func (*Amplify) UpdateDomainAssociationWithContext 

func (c *Amplify) UpdateDomainAssociationWithContext(ctx aws.Context, input *UpdateDomainAssociationInput, opts ...request.Option) (*UpdateDomainAssociationOutput, error)

UpdateDomainAssociationWithContext is the same as UpdateDomainAssociation with the addition of the ability to pass a context and additional request options.

See UpdateDomainAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Amplify) UpdateWebhook added in v1.20.17 

func (c *Amplify) UpdateWebhook(input *UpdateWebhookInput) (*UpdateWebhookOutput, error)

UpdateWebhook API operation for AWS Amplify.

Updates a webhook.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Amplify's API operation UpdateWebhook for usage and error information.

Returned Error Types:

  • BadRequestException A request contains unexpected data.

  • UnauthorizedException An operation failed due to a lack of access.

  • NotFoundException An entity was not found during an operation.

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

  • DependentServiceFailureException An operation failed because a dependent service threw an exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhook

func (*Amplify) UpdateWebhookRequest added in v1.20.17 

func (c *Amplify) UpdateWebhookRequest(input *UpdateWebhookInput) (req *request.Request, output *UpdateWebhookOutput)

UpdateWebhookRequest generates a "aws/request.Request" representing the client's request for the UpdateWebhook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWebhook for more information on using the UpdateWebhook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWebhookRequest method.
req, resp := client.UpdateWebhookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhook

func (*Amplify) UpdateWebhookWithContext added in v1.20.17 

func (c *Amplify) UpdateWebhookWithContext(ctx aws.Context, input *UpdateWebhookInput, opts ...request.Option) (*UpdateWebhookOutput, error)

UpdateWebhookWithContext is the same as UpdateWebhook with the addition of the ability to pass a context and additional request options.

See UpdateWebhook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type App 

type App struct {

	// The Amazon Resource Name (ARN) of the Amplify app.
	//
	// AppArn is a required field
	AppArn *string `locationName:"appArn" type:"string" required:"true"`

	// The unique ID of the Amplify app.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" min:"1" type:"string" required:"true"`

	// Describes the automated branch creation configuration for the Amplify app.
	AutoBranchCreationConfig *AutoBranchCreationConfig `locationName:"autoBranchCreationConfig" type:"structure"`

	// Describes the automated branch creation glob patterns for the Amplify app.
	AutoBranchCreationPatterns []*string `locationName:"autoBranchCreationPatterns" type:"list"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by App's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// Describes the content of the build specification (build spec) for the Amplify
	// app.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by App's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// Creates a date and time for the Amplify app.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"`

	// Describes the custom HTTP headers for the Amplify app.
	CustomHeaders *string `locationName:"customHeaders" type:"string"`

	// Describes the custom redirect and rewrite rules for the Amplify app.
	CustomRules []*CustomRule `locationName:"customRules" type:"list"`

	// The default domain for the Amplify app.
	//
	// DefaultDomain is a required field
	DefaultDomain *string `locationName:"defaultDomain" min:"1" type:"string" required:"true"`

	// The description for the Amplify app.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// Enables automated branch creation for the Amplify app.
	EnableAutoBranchCreation *bool `locationName:"enableAutoBranchCreation" type:"boolean"`

	// Enables basic authorization for the Amplify app's branches.
	//
	// EnableBasicAuth is a required field
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean" required:"true"`

	// Enables the auto-building of branches for the Amplify app.
	//
	// EnableBranchAutoBuild is a required field
	EnableBranchAutoBuild *bool `locationName:"enableBranchAutoBuild" type:"boolean" required:"true"`

	// Automatically disconnect a branch in the Amplify console when you delete
	// a branch from your Git repository.
	EnableBranchAutoDeletion *bool `locationName:"enableBranchAutoDeletion" type:"boolean"`

	// 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 (https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html)
	// in the Amplify Hosting User Guide.
	//
	// EnvironmentVariables is a required field
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map" required:"true"`

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

	// The name for the Amplify app.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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.
	//
	// Platform is a required field
	Platform *string `locationName:"platform" type:"string" required:"true" enum:"Platform"`

	// Describes the information about a production branch of the Amplify app.
	ProductionBranch *ProductionBranch `locationName:"productionBranch" type:"structure"`

	// The Git repository for the Amplify app.
	//
	// Repository is a required field
	Repository *string `locationName:"repository" type:"string" required:"true"`

	//
	// 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 *string `locationName:"repositoryCloneMethod" type:"string" enum:"RepositoryCloneMethod"`

	// The tag for the Amplify app.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Updates the date and time for the Amplify app.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

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

func (App) GoString 

func (s App) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*App) SetAppArn 

func (s *App) SetAppArn(v string) *App

SetAppArn sets the AppArn field's value.

func (*App) SetAppId 

func (s *App) SetAppId(v string) *App

SetAppId sets the AppId field's value.

func (*App) SetAutoBranchCreationConfig added in v1.20.17 

func (s *App) SetAutoBranchCreationConfig(v *AutoBranchCreationConfig) *App

SetAutoBranchCreationConfig sets the AutoBranchCreationConfig field's value.

func (*App) SetAutoBranchCreationPatterns added in v1.20.17 

func (s *App) SetAutoBranchCreationPatterns(v []*string) *App

SetAutoBranchCreationPatterns sets the AutoBranchCreationPatterns field's value.

func (*App) SetBasicAuthCredentials 

func (s *App) SetBasicAuthCredentials(v string) *App

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*App) SetBuildSpec 

func (s *App) SetBuildSpec(v string) *App

SetBuildSpec sets the BuildSpec field's value.

func (*App) SetCreateTime 

func (s *App) SetCreateTime(v time.Time) *App

SetCreateTime sets the CreateTime field's value.

func (*App) SetCustomHeaders added in v1.35.26 

func (s *App) SetCustomHeaders(v string) *App

SetCustomHeaders sets the CustomHeaders field's value.

func (*App) SetCustomRules 

func (s *App) SetCustomRules(v []*CustomRule) *App

SetCustomRules sets the CustomRules field's value.

func (*App) SetDefaultDomain 

func (s *App) SetDefaultDomain(v string) *App

SetDefaultDomain sets the DefaultDomain field's value.

func (*App) SetDescription 

func (s *App) SetDescription(v string) *App

SetDescription sets the Description field's value.

func (*App) SetEnableAutoBranchCreation added in v1.20.17 

func (s *App) SetEnableAutoBranchCreation(v bool) *App

SetEnableAutoBranchCreation sets the EnableAutoBranchCreation field's value.

func (*App) SetEnableBasicAuth 

func (s *App) SetEnableBasicAuth(v bool) *App

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*App) SetEnableBranchAutoBuild 

func (s *App) SetEnableBranchAutoBuild(v bool) *App

SetEnableBranchAutoBuild sets the EnableBranchAutoBuild field's value.

func (*App) SetEnableBranchAutoDeletion added in v1.32.9 

func (s *App) SetEnableBranchAutoDeletion(v bool) *App

SetEnableBranchAutoDeletion sets the EnableBranchAutoDeletion field's value.

func (*App) SetEnvironmentVariables 

func (s *App) SetEnvironmentVariables(v map[string]*string) *App

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*App) SetIamServiceRoleArn 

func (s *App) SetIamServiceRoleArn(v string) *App

SetIamServiceRoleArn sets the IamServiceRoleArn field's value.

func (*App) SetName 

func (s *App) SetName(v string) *App

SetName sets the Name field's value.

func (*App) SetPlatform 

func (s *App) SetPlatform(v string) *App

SetPlatform sets the Platform field's value.

func (*App) SetProductionBranch 

func (s *App) SetProductionBranch(v *ProductionBranch) *App

SetProductionBranch sets the ProductionBranch field's value.

func (*App) SetRepository 

func (s *App) SetRepository(v string) *App

SetRepository sets the Repository field's value.

func (*App) SetRepositoryCloneMethod added in v1.43.8 

func (s *App) SetRepositoryCloneMethod(v string) *App

SetRepositoryCloneMethod sets the RepositoryCloneMethod field's value.

func (*App) SetTags 

func (s *App) SetTags(v map[string]*string) *App

SetTags sets the Tags field's value.

func (*App) SetUpdateTime 

func (s *App) SetUpdateTime(v time.Time) *App

SetUpdateTime sets the UpdateTime field's value.

func (App) String 

func (s App) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Artifact added in v1.25.1 

type Artifact struct {

	// The file name for the artifact.
	//
	// ArtifactFileName is a required field
	ArtifactFileName *string `locationName:"artifactFileName" type:"string" required:"true"`

	// The unique ID for the artifact.
	//
	// ArtifactId is a required field
	ArtifactId *string `locationName:"artifactId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an artifact.

func (Artifact) GoString added in v1.25.1 

func (s Artifact) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Artifact) SetArtifactFileName added in v1.25.1 

func (s *Artifact) SetArtifactFileName(v string) *Artifact

SetArtifactFileName sets the ArtifactFileName field's value.

func (*Artifact) SetArtifactId added in v1.25.1 

func (s *Artifact) SetArtifactId(v string) *Artifact

SetArtifactId sets the ArtifactId field's value.

func (Artifact) String added in v1.25.1 

func (s Artifact) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoBranchCreationConfig added in v1.20.17 

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AutoBranchCreationConfig's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// The build specification (build spec) for the autocreated branch.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AutoBranchCreationConfig's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// Enables auto building for the autocreated branch.
	EnableAutoBuild *bool `locationName:"enableAutoBuild" type:"boolean"`

	// Enables basic authorization for the autocreated branch.
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean"`

	// 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 `locationName:"enablePerformanceMode" type:"boolean"`

	// Enables pull request previews for the autocreated branch.
	EnablePullRequestPreview *bool `locationName:"enablePullRequestPreview" type:"boolean"`

	// The environment variables for the autocreated branch.
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"`

	// The framework for the autocreated branch.
	Framework *string `locationName:"framework" type:"string"`

	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string `locationName:"pullRequestEnvironmentName" type:"string"`

	// Describes the current stage for the autocreated branch.
	Stage *string `locationName:"stage" type:"string" enum:"Stage"`
	// contains filtered or unexported fields
}

Describes the automated branch creation configuration.

func (AutoBranchCreationConfig) GoString added in v1.20.17 

func (s AutoBranchCreationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoBranchCreationConfig) SetBasicAuthCredentials added in v1.20.17 

func (s *AutoBranchCreationConfig) SetBasicAuthCredentials(v string) *AutoBranchCreationConfig

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*AutoBranchCreationConfig) SetBuildSpec added in v1.20.17 

func (s *AutoBranchCreationConfig) SetBuildSpec(v string) *AutoBranchCreationConfig

SetBuildSpec sets the BuildSpec field's value.

func (*AutoBranchCreationConfig) SetEnableAutoBuild added in v1.20.17 

func (s *AutoBranchCreationConfig) SetEnableAutoBuild(v bool) *AutoBranchCreationConfig

SetEnableAutoBuild sets the EnableAutoBuild field's value.

func (*AutoBranchCreationConfig) SetEnableBasicAuth added in v1.20.17 

func (s *AutoBranchCreationConfig) SetEnableBasicAuth(v bool) *AutoBranchCreationConfig

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*AutoBranchCreationConfig) SetEnablePerformanceMode added in v1.35.7 

func (s *AutoBranchCreationConfig) SetEnablePerformanceMode(v bool) *AutoBranchCreationConfig

SetEnablePerformanceMode sets the EnablePerformanceMode field's value.

func (*AutoBranchCreationConfig) SetEnablePullRequestPreview added in v1.25.1 

func (s *AutoBranchCreationConfig) SetEnablePullRequestPreview(v bool) *AutoBranchCreationConfig

SetEnablePullRequestPreview sets the EnablePullRequestPreview field's value.

func (*AutoBranchCreationConfig) SetEnvironmentVariables added in v1.20.17 

func (s *AutoBranchCreationConfig) SetEnvironmentVariables(v map[string]*string) *AutoBranchCreationConfig

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*AutoBranchCreationConfig) SetFramework added in v1.20.17 

func (s *AutoBranchCreationConfig) SetFramework(v string) *AutoBranchCreationConfig

SetFramework sets the Framework field's value.

func (*AutoBranchCreationConfig) SetPullRequestEnvironmentName added in v1.25.24 

func (s *AutoBranchCreationConfig) SetPullRequestEnvironmentName(v string) *AutoBranchCreationConfig

SetPullRequestEnvironmentName sets the PullRequestEnvironmentName field's value.

func (*AutoBranchCreationConfig) SetStage added in v1.20.17 

func (s *AutoBranchCreationConfig) SetStage(v string) *AutoBranchCreationConfig

SetStage sets the Stage field's value.

func (AutoBranchCreationConfig) String added in v1.20.17 

func (s AutoBranchCreationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoBranchCreationConfig) Validate added in v1.20.17 

func (s *AutoBranchCreationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Backend added in v1.47.0 

type Backend struct {

	// The Amazon Resource Name (ARN) for the CloudFormation stack.
	StackArn *string `locationName:"stackArn" min:"20" type:"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.

func (Backend) GoString added in v1.47.0 

func (s Backend) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Backend) SetStackArn added in v1.47.0 

func (s *Backend) SetStackArn(v string) *Backend

SetStackArn sets the StackArn field's value.

func (Backend) String added in v1.47.0 

func (s Backend) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Backend) Validate added in v1.47.0 

func (s *Backend) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BackendEnvironment added in v1.25.40 

type BackendEnvironment struct {

	// The Amazon Resource Name (ARN) for a backend environment that is part of
	// an Amplify app.
	//
	// BackendEnvironmentArn is a required field
	BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" type:"string" required:"true"`

	// The creation date and time for a backend environment that is part of an Amplify
	// app.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"`

	// The name of deployment artifacts.
	DeploymentArtifacts *string `locationName:"deploymentArtifacts" min:"1" type:"string"`

	// The name for a backend environment that is part of an Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `locationName:"environmentName" min:"1" type:"string" required:"true"`

	// The AWS CloudFormation stack name of a backend environment.
	StackName *string `locationName:"stackName" min:"1" type:"string"`

	// The last updated date and time for a backend environment that is part of
	// an Amplify app.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"`
	// 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).

func (BackendEnvironment) GoString added in v1.25.40 

func (s BackendEnvironment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackendEnvironment) SetBackendEnvironmentArn added in v1.25.40 

func (s *BackendEnvironment) SetBackendEnvironmentArn(v string) *BackendEnvironment

SetBackendEnvironmentArn sets the BackendEnvironmentArn field's value.

func (*BackendEnvironment) SetCreateTime added in v1.25.40 

func (s *BackendEnvironment) SetCreateTime(v time.Time) *BackendEnvironment

SetCreateTime sets the CreateTime field's value.

func (*BackendEnvironment) SetDeploymentArtifacts added in v1.25.40 

func (s *BackendEnvironment) SetDeploymentArtifacts(v string) *BackendEnvironment

SetDeploymentArtifacts sets the DeploymentArtifacts field's value.

func (*BackendEnvironment) SetEnvironmentName added in v1.25.40 

func (s *BackendEnvironment) SetEnvironmentName(v string) *BackendEnvironment

SetEnvironmentName sets the EnvironmentName field's value.

func (*BackendEnvironment) SetStackName added in v1.25.40 

func (s *BackendEnvironment) SetStackName(v string) *BackendEnvironment

SetStackName sets the StackName field's value.

func (*BackendEnvironment) SetUpdateTime added in v1.25.40 

func (s *BackendEnvironment) SetUpdateTime(v time.Time) *BackendEnvironment

SetUpdateTime sets the UpdateTime field's value.

func (BackendEnvironment) String added in v1.25.40 

func (s BackendEnvironment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequestException added in v1.28.0 

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A request contains unexpected data.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Branch 

type Branch struct {

	// The ID of the active job for a branch of an Amplify app.
	//
	// ActiveJobId is a required field
	ActiveJobId *string `locationName:"activeJobId" type:"string" required:"true"`

	// A list of custom resources that are linked to this branch.
	AssociatedResources []*string `locationName:"associatedResources" type:"list"`

	// 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 `locationName:"backend" type:"structure"`

	// 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 `locationName:"backendEnvironmentArn" type:"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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Branch's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
	//
	// BranchArn is a required field
	BranchArn *string `locationName:"branchArn" type:"string" required:"true"`

	// The name for the branch that is part of an Amplify app.
	//
	// BranchName is a required field
	BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`

	// The build specification (build spec) content for the branch of an Amplify
	// app.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Branch's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// The creation date and time for a branch that is part of an Amplify app.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"`

	// The custom domains for a branch of an Amplify app.
	//
	// CustomDomains is a required field
	CustomDomains []*string `locationName:"customDomains" type:"list" required:"true"`

	// The description for the branch that is part of an Amplify app.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// The destination branch if the branch is a pull request branch.
	DestinationBranch *string `locationName:"destinationBranch" min:"1" type:"string"`

	// The display name for the branch. This is used as the default domain prefix.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" type:"string" required:"true"`

	// Enables auto-building on push for a branch of an Amplify app.
	//
	// EnableAutoBuild is a required field
	EnableAutoBuild *bool `locationName:"enableAutoBuild" type:"boolean" required:"true"`

	// Enables basic authorization for a branch of an Amplify app.
	//
	// EnableBasicAuth is a required field
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean" required:"true"`

	// Enables notifications for a branch that is part of an Amplify app.
	//
	// EnableNotification is a required field
	EnableNotification *bool `locationName:"enableNotification" type:"boolean" required:"true"`

	// 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 `locationName:"enablePerformanceMode" type:"boolean"`

	// Enables pull request previews for the branch.
	//
	// EnablePullRequestPreview is a required field
	EnablePullRequestPreview *bool `locationName:"enablePullRequestPreview" type:"boolean" required:"true"`

	// The environment variables specific to a branch of an Amplify app.
	//
	// EnvironmentVariables is a required field
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map" required:"true"`

	// The framework for a branch of an Amplify app.
	//
	// Framework is a required field
	Framework *string `locationName:"framework" type:"string" required:"true"`

	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string `locationName:"pullRequestEnvironmentName" type:"string"`

	// The source branch if the branch is a pull request branch.
	SourceBranch *string `locationName:"sourceBranch" min:"1" type:"string"`

	// The current stage for the branch that is part of an Amplify app.
	//
	// Stage is a required field
	Stage *string `locationName:"stage" type:"string" required:"true" enum:"Stage"`

	// The tag for the branch of an Amplify app.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The thumbnail URL for the branch of an Amplify app.
	ThumbnailUrl *string `locationName:"thumbnailUrl" min:"1" type:"string"`

	// The total number of jobs that are part of an Amplify app.
	//
	// TotalNumberOfJobs is a required field
	TotalNumberOfJobs *string `locationName:"totalNumberOfJobs" type:"string" required:"true"`

	// The content Time to Live (TTL) for the website in seconds.
	//
	// Ttl is a required field
	Ttl *string `locationName:"ttl" type:"string" required:"true"`

	// The last updated date and time for a branch that is part of an Amplify app.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

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

func (Branch) GoString 

func (s Branch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Branch) SetActiveJobId 

func (s *Branch) SetActiveJobId(v string) *Branch

SetActiveJobId sets the ActiveJobId field's value.

func (*Branch) SetAssociatedResources added in v1.20.17 

func (s *Branch) SetAssociatedResources(v []*string) *Branch

SetAssociatedResources sets the AssociatedResources field's value.

func (*Branch) SetBackend added in v1.47.0 

func (s *Branch) SetBackend(v *Backend) *Branch

SetBackend sets the Backend field's value.

func (*Branch) SetBackendEnvironmentArn added in v1.25.24 

func (s *Branch) SetBackendEnvironmentArn(v string) *Branch

SetBackendEnvironmentArn sets the BackendEnvironmentArn field's value.

func (*Branch) SetBasicAuthCredentials 

func (s *Branch) SetBasicAuthCredentials(v string) *Branch

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*Branch) SetBranchArn 

func (s *Branch) SetBranchArn(v string) *Branch

SetBranchArn sets the BranchArn field's value.

func (*Branch) SetBranchName 

func (s *Branch) SetBranchName(v string) *Branch

SetBranchName sets the BranchName field's value.

func (*Branch) SetBuildSpec 

func (s *Branch) SetBuildSpec(v string) *Branch

SetBuildSpec sets the BuildSpec field's value.

func (*Branch) SetCreateTime 

func (s *Branch) SetCreateTime(v time.Time) *Branch

SetCreateTime sets the CreateTime field's value.

func (*Branch) SetCustomDomains 

func (s *Branch) SetCustomDomains(v []*string) *Branch

SetCustomDomains sets the CustomDomains field's value.

func (*Branch) SetDescription 

func (s *Branch) SetDescription(v string) *Branch

SetDescription sets the Description field's value.

func (*Branch) SetDestinationBranch added in v1.25.1 

func (s *Branch) SetDestinationBranch(v string) *Branch

SetDestinationBranch sets the DestinationBranch field's value.

func (*Branch) SetDisplayName 

func (s *Branch) SetDisplayName(v string) *Branch

SetDisplayName sets the DisplayName field's value.

func (*Branch) SetEnableAutoBuild 

func (s *Branch) SetEnableAutoBuild(v bool) *Branch

SetEnableAutoBuild sets the EnableAutoBuild field's value.

func (*Branch) SetEnableBasicAuth 

func (s *Branch) SetEnableBasicAuth(v bool) *Branch

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*Branch) SetEnableNotification 

func (s *Branch) SetEnableNotification(v bool) *Branch

SetEnableNotification sets the EnableNotification field's value.

func (*Branch) SetEnablePerformanceMode added in v1.35.7 

func (s *Branch) SetEnablePerformanceMode(v bool) *Branch

SetEnablePerformanceMode sets the EnablePerformanceMode field's value.

func (*Branch) SetEnablePullRequestPreview added in v1.25.1 

func (s *Branch) SetEnablePullRequestPreview(v bool) *Branch

SetEnablePullRequestPreview sets the EnablePullRequestPreview field's value.

func (*Branch) SetEnvironmentVariables 

func (s *Branch) SetEnvironmentVariables(v map[string]*string) *Branch

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*Branch) SetFramework 

func (s *Branch) SetFramework(v string) *Branch

SetFramework sets the Framework field's value.

func (*Branch) SetPullRequestEnvironmentName added in v1.25.24 

func (s *Branch) SetPullRequestEnvironmentName(v string) *Branch

SetPullRequestEnvironmentName sets the PullRequestEnvironmentName field's value.

func (*Branch) SetSourceBranch added in v1.25.1 

func (s *Branch) SetSourceBranch(v string) *Branch

SetSourceBranch sets the SourceBranch field's value.

func (*Branch) SetStage 

func (s *Branch) SetStage(v string) *Branch

SetStage sets the Stage field's value.

func (*Branch) SetTags 

func (s *Branch) SetTags(v map[string]*string) *Branch

SetTags sets the Tags field's value.

func (*Branch) SetThumbnailUrl 

func (s *Branch) SetThumbnailUrl(v string) *Branch

SetThumbnailUrl sets the ThumbnailUrl field's value.

func (*Branch) SetTotalNumberOfJobs 

func (s *Branch) SetTotalNumberOfJobs(v string) *Branch

SetTotalNumberOfJobs sets the TotalNumberOfJobs field's value.

func (*Branch) SetTtl 

func (s *Branch) SetTtl(v string) *Branch

SetTtl sets the Ttl field's value.

func (*Branch) SetUpdateTime 

func (s *Branch) SetUpdateTime(v time.Time) *Branch

SetUpdateTime sets the UpdateTime field's value.

func (Branch) String 

func (s Branch) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Certificate added in v1.50.21 

type Certificate struct {

	// The DNS record for certificate verification.
	CertificateVerificationDNSRecord *string `locationName:"certificateVerificationDNSRecord" type:"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 `locationName:"customCertificateArn" type:"string"`

	// 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 (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
	// in the ACM User guide .
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CertificateType"`
	// 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.

func (Certificate) GoString added in v1.50.21 

func (s Certificate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Certificate) SetCertificateVerificationDNSRecord added in v1.50.21 

func (s *Certificate) SetCertificateVerificationDNSRecord(v string) *Certificate

SetCertificateVerificationDNSRecord sets the CertificateVerificationDNSRecord field's value.

func (*Certificate) SetCustomCertificateArn added in v1.50.21 

func (s *Certificate) SetCustomCertificateArn(v string) *Certificate

SetCustomCertificateArn sets the CustomCertificateArn field's value.

func (*Certificate) SetType added in v1.50.21 

func (s *Certificate) SetType(v string) *Certificate

SetType sets the Type field's value.

func (Certificate) String added in v1.50.21 

func (s Certificate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateSettings added in v1.50.21 

type CertificateSettings struct {

	// 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 `locationName:"customCertificateArn" type:"string"`

	// 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 (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
	// in the ACM User guide.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CertificateType"`
	// 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.

func (CertificateSettings) GoString added in v1.50.21 

func (s CertificateSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateSettings) SetCustomCertificateArn added in v1.50.21 

func (s *CertificateSettings) SetCustomCertificateArn(v string) *CertificateSettings

SetCustomCertificateArn sets the CustomCertificateArn field's value.

func (*CertificateSettings) SetType added in v1.50.21 

func (s *CertificateSettings) SetType(v string) *CertificateSettings

SetType sets the Type field's value.

func (CertificateSettings) String added in v1.50.21 

func (s CertificateSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateSettings) Validate added in v1.50.21 

func (s *CertificateSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAppInput 

type CreateAppInput struct {

	// 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 (https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth)
	// in the Amplify User Guide .
	//
	// AccessToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInput's
	// String and GoString methods.
	AccessToken *string `locationName:"accessToken" min:"1" type:"string" sensitive:"true"`

	// The automated branch creation configuration for an Amplify app.
	AutoBranchCreationConfig *AutoBranchCreationConfig `locationName:"autoBranchCreationConfig" type:"structure"`

	// The automated branch creation glob patterns for an Amplify app.
	AutoBranchCreationPatterns []*string `locationName:"autoBranchCreationPatterns" type:"list"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInput's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// The build specification (build spec) for an Amplify app.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInput's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// The custom HTTP headers for an Amplify app.
	CustomHeaders *string `locationName:"customHeaders" type:"string"`

	// The custom rewrite and redirect rules for an Amplify app.
	CustomRules []*CustomRule `locationName:"customRules" type:"list"`

	// The description of the Amplify app.
	Description *string `locationName:"description" type:"string"`

	// Enables automated branch creation for an Amplify app.
	EnableAutoBranchCreation *bool `locationName:"enableAutoBranchCreation" type:"boolean"`

	// Enables basic authorization for an Amplify app. This will apply to all branches
	// that are part of this app.
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean"`

	// Enables the auto building of branches for an Amplify app.
	EnableBranchAutoBuild *bool `locationName:"enableBranchAutoBuild" type:"boolean"`

	// Automatically disconnects a branch in the Amplify console when you delete
	// a branch from your Git repository.
	EnableBranchAutoDeletion *bool `locationName:"enableBranchAutoDeletion" type:"boolean"`

	// 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 (https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html)
	// in the Amplify Hosting User Guide.
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"`

	// The AWS Identity and Access Management (IAM) service role for an Amplify
	// app.
	IamServiceRoleArn *string `locationName:"iamServiceRoleArn" type:"string"`

	// The name of the Amplify app.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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 (https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth)
	// in the Amplify User Guide .
	//
	// OauthToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInput's
	// String and GoString methods.
	OauthToken *string `locationName:"oauthToken" type:"string" sensitive:"true"`

	// 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.
	Platform *string `locationName:"platform" type:"string" enum:"Platform"`

	// The Git repository for the Amplify app.
	Repository *string `locationName:"repository" type:"string"`

	// The tag for an Amplify app.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The request structure used to create apps in Amplify.

func (CreateAppInput) GoString 

func (s CreateAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInput) SetAccessToken added in v1.20.17 

func (s *CreateAppInput) SetAccessToken(v string) *CreateAppInput

SetAccessToken sets the AccessToken field's value.

func (*CreateAppInput) SetAutoBranchCreationConfig added in v1.20.17 

func (s *CreateAppInput) SetAutoBranchCreationConfig(v *AutoBranchCreationConfig) *CreateAppInput

SetAutoBranchCreationConfig sets the AutoBranchCreationConfig field's value.

func (*CreateAppInput) SetAutoBranchCreationPatterns added in v1.20.17 

func (s *CreateAppInput) SetAutoBranchCreationPatterns(v []*string) *CreateAppInput

SetAutoBranchCreationPatterns sets the AutoBranchCreationPatterns field's value.

func (*CreateAppInput) SetBasicAuthCredentials 

func (s *CreateAppInput) SetBasicAuthCredentials(v string) *CreateAppInput

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*CreateAppInput) SetBuildSpec 

func (s *CreateAppInput) SetBuildSpec(v string) *CreateAppInput

SetBuildSpec sets the BuildSpec field's value.

func (*CreateAppInput) SetCustomHeaders added in v1.35.26 

func (s *CreateAppInput) SetCustomHeaders(v string) *CreateAppInput

SetCustomHeaders sets the CustomHeaders field's value.

func (*CreateAppInput) SetCustomRules 

func (s *CreateAppInput) SetCustomRules(v []*CustomRule) *CreateAppInput

SetCustomRules sets the CustomRules field's value.

func (*CreateAppInput) SetDescription 

func (s *CreateAppInput) SetDescription(v string) *CreateAppInput

SetDescription sets the Description field's value.

func (*CreateAppInput) SetEnableAutoBranchCreation added in v1.20.17 

func (s *CreateAppInput) SetEnableAutoBranchCreation(v bool) *CreateAppInput

SetEnableAutoBranchCreation sets the EnableAutoBranchCreation field's value.

func (*CreateAppInput) SetEnableBasicAuth 

func (s *CreateAppInput) SetEnableBasicAuth(v bool) *CreateAppInput

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*CreateAppInput) SetEnableBranchAutoBuild 

func (s *CreateAppInput) SetEnableBranchAutoBuild(v bool) *CreateAppInput

SetEnableBranchAutoBuild sets the EnableBranchAutoBuild field's value.

func (*CreateAppInput) SetEnableBranchAutoDeletion added in v1.32.9 

func (s *CreateAppInput) SetEnableBranchAutoDeletion(v bool) *CreateAppInput

SetEnableBranchAutoDeletion sets the EnableBranchAutoDeletion field's value.

func (*CreateAppInput) SetEnvironmentVariables 

func (s *CreateAppInput) SetEnvironmentVariables(v map[string]*string) *CreateAppInput

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*CreateAppInput) SetIamServiceRoleArn 

func (s *CreateAppInput) SetIamServiceRoleArn(v string) *CreateAppInput

SetIamServiceRoleArn sets the IamServiceRoleArn field's value.

func (*CreateAppInput) SetName 

func (s *CreateAppInput) SetName(v string) *CreateAppInput

SetName sets the Name field's value.

func (*CreateAppInput) SetOauthToken 

func (s *CreateAppInput) SetOauthToken(v string) *CreateAppInput

SetOauthToken sets the OauthToken field's value.

func (*CreateAppInput) SetPlatform 

func (s *CreateAppInput) SetPlatform(v string) *CreateAppInput

SetPlatform sets the Platform field's value.

func (*CreateAppInput) SetRepository 

func (s *CreateAppInput) SetRepository(v string) *CreateAppInput

SetRepository sets the Repository field's value.

func (*CreateAppInput) SetTags 

func (s *CreateAppInput) SetTags(v map[string]*string) *CreateAppInput

SetTags sets the Tags field's value.

func (CreateAppInput) String 

func (s CreateAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInput) Validate 

func (s *CreateAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAppOutput 

type CreateAppOutput struct {

	// Represents the different branches of a repository for building, deploying,
	// and hosting an Amplify app.
	//
	// App is a required field
	App *App `locationName:"app" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAppOutput) GoString 

func (s CreateAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppOutput) SetApp 

func (s *CreateAppOutput) SetApp(v *App) *CreateAppOutput

SetApp sets the App field's value.

func (CreateAppOutput) String 

func (s CreateAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBackendEnvironmentInput added in v1.25.40 

type CreateBackendEnvironmentInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of deployment artifacts.
	DeploymentArtifacts *string `locationName:"deploymentArtifacts" min:"1" type:"string"`

	// The name for the backend environment.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `locationName:"environmentName" min:"1" type:"string" required:"true"`

	// The AWS CloudFormation stack name of a backend environment.
	StackName *string `locationName:"stackName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the backend environment create request.

func (CreateBackendEnvironmentInput) GoString added in v1.25.40 

func (s CreateBackendEnvironmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBackendEnvironmentInput) SetAppId added in v1.25.40 

func (s *CreateBackendEnvironmentInput) SetAppId(v string) *CreateBackendEnvironmentInput

SetAppId sets the AppId field's value.

func (*CreateBackendEnvironmentInput) SetDeploymentArtifacts added in v1.25.40 

func (s *CreateBackendEnvironmentInput) SetDeploymentArtifacts(v string) *CreateBackendEnvironmentInput

SetDeploymentArtifacts sets the DeploymentArtifacts field's value.

func (*CreateBackendEnvironmentInput) SetEnvironmentName added in v1.25.40 

func (s *CreateBackendEnvironmentInput) SetEnvironmentName(v string) *CreateBackendEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*CreateBackendEnvironmentInput) SetStackName added in v1.25.40 

func (s *CreateBackendEnvironmentInput) SetStackName(v string) *CreateBackendEnvironmentInput

SetStackName sets the StackName field's value.

func (CreateBackendEnvironmentInput) String added in v1.25.40 

func (s CreateBackendEnvironmentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBackendEnvironmentInput) Validate added in v1.25.40 

func (s *CreateBackendEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackendEnvironmentOutput added in v1.25.40 

type CreateBackendEnvironmentOutput struct {

	// Describes the backend environment for an Amplify app.
	//
	// BackendEnvironment is a required field
	BackendEnvironment *BackendEnvironment `locationName:"backendEnvironment" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the create backend environment request.

func (CreateBackendEnvironmentOutput) GoString added in v1.25.40 

func (s CreateBackendEnvironmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBackendEnvironmentOutput) SetBackendEnvironment added in v1.25.40 

func (s *CreateBackendEnvironmentOutput) SetBackendEnvironment(v *BackendEnvironment) *CreateBackendEnvironmentOutput

SetBackendEnvironment sets the BackendEnvironment field's value.

func (CreateBackendEnvironmentOutput) String added in v1.25.40 

func (s CreateBackendEnvironmentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBranchInput 

type CreateBranchInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// 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 *Backend `locationName:"backend" type:"structure"`

	// 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 `locationName:"backendEnvironmentArn" type:"string"`

	// The basic authorization credentials for the branch. You must base64-encode
	// the authorization credentials and provide them in the format user:password.
	//
	// BasicAuthCredentials is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateBranchInput's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// The name for the branch.
	//
	// BranchName is a required field
	BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`

	// The build specification (build spec) for the branch.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateBranchInput's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// The description for the branch.
	Description *string `locationName:"description" type:"string"`

	// The display name for a branch. This is used as the default domain prefix.
	DisplayName *string `locationName:"displayName" type:"string"`

	// Enables auto building for the branch.
	EnableAutoBuild *bool `locationName:"enableAutoBuild" type:"boolean"`

	// Enables basic authorization for the branch.
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean"`

	// Enables notifications for the branch.
	EnableNotification *bool `locationName:"enableNotification" type:"boolean"`

	// 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 `locationName:"enablePerformanceMode" type:"boolean"`

	// Enables pull request previews for this branch.
	EnablePullRequestPreview *bool `locationName:"enablePullRequestPreview" type:"boolean"`

	// The environment variables for the branch.
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"`

	// The framework for the branch.
	Framework *string `locationName:"framework" type:"string"`

	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string `locationName:"pullRequestEnvironmentName" type:"string"`

	// Describes the current stage for the branch.
	Stage *string `locationName:"stage" type:"string" enum:"Stage"`

	// The tag for the branch.
	Tags map[string]*string `locationName:"tags" type:"map"`

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

The request structure for the create branch request.

func (CreateBranchInput) GoString 

func (s CreateBranchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBranchInput) SetAppId 

func (s *CreateBranchInput) SetAppId(v string) *CreateBranchInput

SetAppId sets the AppId field's value.

func (*CreateBranchInput) SetBackend added in v1.47.0 

func (s *CreateBranchInput) SetBackend(v *Backend) *CreateBranchInput

SetBackend sets the Backend field's value.

func (*CreateBranchInput) SetBackendEnvironmentArn added in v1.25.24 

func (s *CreateBranchInput) SetBackendEnvironmentArn(v string) *CreateBranchInput

SetBackendEnvironmentArn sets the BackendEnvironmentArn field's value.

func (*CreateBranchInput) SetBasicAuthCredentials 

func (s *CreateBranchInput) SetBasicAuthCredentials(v string) *CreateBranchInput

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*CreateBranchInput) SetBranchName 

func (s *CreateBranchInput) SetBranchName(v string) *CreateBranchInput

SetBranchName sets the BranchName field's value.

func (*CreateBranchInput) SetBuildSpec 

func (s *CreateBranchInput) SetBuildSpec(v string) *CreateBranchInput

SetBuildSpec sets the BuildSpec field's value.

func (*CreateBranchInput) SetDescription 

func (s *CreateBranchInput) SetDescription(v string) *CreateBranchInput

SetDescription sets the Description field's value.

func (*CreateBranchInput) SetDisplayName added in v1.20.17 

func (s *CreateBranchInput) SetDisplayName(v string) *CreateBranchInput

SetDisplayName sets the DisplayName field's value.

func (*CreateBranchInput) SetEnableAutoBuild 

func (s *CreateBranchInput) SetEnableAutoBuild(v bool) *CreateBranchInput

SetEnableAutoBuild sets the EnableAutoBuild field's value.

func (*CreateBranchInput) SetEnableBasicAuth 

func (s *CreateBranchInput) SetEnableBasicAuth(v bool) *CreateBranchInput

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*CreateBranchInput) SetEnableNotification 

func (s *CreateBranchInput) SetEnableNotification(v bool) *CreateBranchInput

SetEnableNotification sets the EnableNotification field's value.

func (*CreateBranchInput) SetEnablePerformanceMode added in v1.35.7 

func (s *CreateBranchInput) SetEnablePerformanceMode(v bool) *CreateBranchInput

SetEnablePerformanceMode sets the EnablePerformanceMode field's value.

func (*CreateBranchInput) SetEnablePullRequestPreview added in v1.25.1 

func (s *CreateBranchInput) SetEnablePullRequestPreview(v bool) *CreateBranchInput

SetEnablePullRequestPreview sets the EnablePullRequestPreview field's value.

func (*CreateBranchInput) SetEnvironmentVariables 

func (s *CreateBranchInput) SetEnvironmentVariables(v map[string]*string) *CreateBranchInput

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*CreateBranchInput) SetFramework 

func (s *CreateBranchInput) SetFramework(v string) *CreateBranchInput

SetFramework sets the Framework field's value.

func (*CreateBranchInput) SetPullRequestEnvironmentName added in v1.25.24 

func (s *CreateBranchInput) SetPullRequestEnvironmentName(v string) *CreateBranchInput

SetPullRequestEnvironmentName sets the PullRequestEnvironmentName field's value.

func (*CreateBranchInput) SetStage 

func (s *CreateBranchInput) SetStage(v string) *CreateBranchInput

SetStage sets the Stage field's value.

func (*CreateBranchInput) SetTags 

func (s *CreateBranchInput) SetTags(v map[string]*string) *CreateBranchInput

SetTags sets the Tags field's value.

func (*CreateBranchInput) SetTtl 

func (s *CreateBranchInput) SetTtl(v string) *CreateBranchInput

SetTtl sets the Ttl field's value.

func (CreateBranchInput) String 

func (s CreateBranchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBranchInput) Validate 

func (s *CreateBranchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBranchOutput 

type CreateBranchOutput struct {

	// Describes the branch for an Amplify app, which maps to a third-party repository
	// branch.
	//
	// Branch is a required field
	Branch *Branch `locationName:"branch" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for create branch request.

func (CreateBranchOutput) GoString 

func (s CreateBranchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBranchOutput) SetBranch 

func (s *CreateBranchOutput) SetBranch(v *Branch) *CreateBranchOutput

SetBranch sets the Branch field's value.

func (CreateBranchOutput) String 

func (s CreateBranchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDeploymentInput added in v1.20.17 

type CreateDeploymentInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the job.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// 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 `locationName:"fileMap" type:"map"`
	// contains filtered or unexported fields
}

The request structure for the create a new deployment request.

func (CreateDeploymentInput) GoString added in v1.20.17 

func (s CreateDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentInput) SetAppId added in v1.20.17 

func (s *CreateDeploymentInput) SetAppId(v string) *CreateDeploymentInput

SetAppId sets the AppId field's value.

func (*CreateDeploymentInput) SetBranchName added in v1.20.17 

func (s *CreateDeploymentInput) SetBranchName(v string) *CreateDeploymentInput

SetBranchName sets the BranchName field's value.

func (*CreateDeploymentInput) SetFileMap added in v1.20.17 

func (s *CreateDeploymentInput) SetFileMap(v map[string]*string) *CreateDeploymentInput

SetFileMap sets the FileMap field's value.

func (CreateDeploymentInput) String added in v1.20.17 

func (s CreateDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentInput) Validate added in v1.20.17 

func (s *CreateDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDeploymentOutput added in v1.20.17 

type CreateDeploymentOutput struct {

	// When the fileMap argument is provided in the request, fileUploadUrls will
	// contain a map of file names to upload URLs.
	//
	// FileUploadUrls is a required field
	FileUploadUrls map[string]*string `locationName:"fileUploadUrls" type:"map" required:"true"`

	// The job ID for this deployment. will supply to start deployment api.
	JobId *string `locationName:"jobId" type:"string"`

	// When the fileMap argument is not provided in the request, this zipUploadUrl
	// is returned.
	//
	// ZipUploadUrl is a required field
	ZipUploadUrl *string `locationName:"zipUploadUrl" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the create a new deployment request.

func (CreateDeploymentOutput) GoString added in v1.20.17 

func (s CreateDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentOutput) SetFileUploadUrls added in v1.20.17 

func (s *CreateDeploymentOutput) SetFileUploadUrls(v map[string]*string) *CreateDeploymentOutput

SetFileUploadUrls sets the FileUploadUrls field's value.

func (*CreateDeploymentOutput) SetJobId added in v1.20.17 

func (s *CreateDeploymentOutput) SetJobId(v string) *CreateDeploymentOutput

SetJobId sets the JobId field's value.

func (*CreateDeploymentOutput) SetZipUploadUrl added in v1.20.17 

func (s *CreateDeploymentOutput) SetZipUploadUrl(v string) *CreateDeploymentOutput

SetZipUploadUrl sets the ZipUploadUrl field's value.

func (CreateDeploymentOutput) String added in v1.20.17 

func (s CreateDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDomainAssociationInput 

type CreateDomainAssociationInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// Sets the branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns []*string `locationName:"autoSubDomainCreationPatterns" type:"list"`

	// The required AWS Identity and Access Management (IAM) service role for the
	// Amazon Resource Name (ARN) for automatically creating subdomains.
	AutoSubDomainIAMRole *string `locationName:"autoSubDomainIAMRole" type:"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 *CertificateSettings `locationName:"certificateSettings" type:"structure"`

	// The domain name for the domain association.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`

	// Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain *bool `locationName:"enableAutoSubDomain" type:"boolean"`

	// The setting for the subdomain.
	//
	// SubDomainSettings is a required field
	SubDomainSettings []*SubDomainSetting `locationName:"subDomainSettings" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the create domain association request.

func (CreateDomainAssociationInput) GoString 

func (s CreateDomainAssociationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainAssociationInput) SetAppId 

func (s *CreateDomainAssociationInput) SetAppId(v string) *CreateDomainAssociationInput

SetAppId sets the AppId field's value.

func (*CreateDomainAssociationInput) SetAutoSubDomainCreationPatterns added in v1.32.9 

func (s *CreateDomainAssociationInput) SetAutoSubDomainCreationPatterns(v []*string) *CreateDomainAssociationInput

SetAutoSubDomainCreationPatterns sets the AutoSubDomainCreationPatterns field's value.

func (*CreateDomainAssociationInput) SetAutoSubDomainIAMRole added in v1.32.9 

func (s *CreateDomainAssociationInput) SetAutoSubDomainIAMRole(v string) *CreateDomainAssociationInput

SetAutoSubDomainIAMRole sets the AutoSubDomainIAMRole field's value.

func (*CreateDomainAssociationInput) SetCertificateSettings added in v1.50.21 

func (s *CreateDomainAssociationInput) SetCertificateSettings(v *CertificateSettings) *CreateDomainAssociationInput

SetCertificateSettings sets the CertificateSettings field's value.

func (*CreateDomainAssociationInput) SetDomainName 

func (s *CreateDomainAssociationInput) SetDomainName(v string) *CreateDomainAssociationInput

SetDomainName sets the DomainName field's value.

func (*CreateDomainAssociationInput) SetEnableAutoSubDomain 

func (s *CreateDomainAssociationInput) SetEnableAutoSubDomain(v bool) *CreateDomainAssociationInput

SetEnableAutoSubDomain sets the EnableAutoSubDomain field's value.

func (*CreateDomainAssociationInput) SetSubDomainSettings 

func (s *CreateDomainAssociationInput) SetSubDomainSettings(v []*SubDomainSetting) *CreateDomainAssociationInput

SetSubDomainSettings sets the SubDomainSettings field's value.

func (CreateDomainAssociationInput) String 

func (s CreateDomainAssociationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainAssociationInput) Validate 

func (s *CreateDomainAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDomainAssociationOutput 

type CreateDomainAssociationOutput struct {

	// Describes the structure of a domain association, which associates a custom
	// domain with an Amplify app.
	//
	// DomainAssociation is a required field
	DomainAssociation *DomainAssociation `locationName:"domainAssociation" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the create domain association request.

func (CreateDomainAssociationOutput) GoString 

func (s CreateDomainAssociationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainAssociationOutput) SetDomainAssociation 

func (s *CreateDomainAssociationOutput) SetDomainAssociation(v *DomainAssociation) *CreateDomainAssociationOutput

SetDomainAssociation sets the DomainAssociation field's value.

func (CreateDomainAssociationOutput) String 

func (s CreateDomainAssociationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWebhookInput added in v1.20.17 

type CreateWebhookInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name for a branch that is part of an Amplify app.
	//
	// BranchName is a required field
	BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`

	// The description for a webhook.
	Description *string `locationName:"description" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the create webhook request.

func (CreateWebhookInput) GoString added in v1.20.17 

func (s CreateWebhookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWebhookInput) SetAppId added in v1.20.17 

func (s *CreateWebhookInput) SetAppId(v string) *CreateWebhookInput

SetAppId sets the AppId field's value.

func (*CreateWebhookInput) SetBranchName added in v1.20.17 

func (s *CreateWebhookInput) SetBranchName(v string) *CreateWebhookInput

SetBranchName sets the BranchName field's value.

func (*CreateWebhookInput) SetDescription added in v1.20.17 

func (s *CreateWebhookInput) SetDescription(v string) *CreateWebhookInput

SetDescription sets the Description field's value.

func (CreateWebhookInput) String added in v1.20.17 

func (s CreateWebhookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWebhookInput) Validate added in v1.20.17 

func (s *CreateWebhookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWebhookOutput added in v1.20.17 

type CreateWebhookOutput struct {

	// Describes a webhook that connects repository events to an Amplify app.
	//
	// Webhook is a required field
	Webhook *Webhook `locationName:"webhook" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the create webhook request.

func (CreateWebhookOutput) GoString added in v1.20.17 

func (s CreateWebhookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWebhookOutput) SetWebhook added in v1.20.17 

func (s *CreateWebhookOutput) SetWebhook(v *Webhook) *CreateWebhookOutput

SetWebhook sets the Webhook field's value.

func (CreateWebhookOutput) String added in v1.20.17 

func (s CreateWebhookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomRule 

type CustomRule struct {

	// The condition for a URL rewrite or redirect rule, such as a country code.
	Condition *string `locationName:"condition" type:"string"`

	// The source pattern for a URL rewrite or redirect rule.
	//
	// Source is a required field
	Source *string `locationName:"source" min:"1" type:"string" required:"true"`

	// 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 `locationName:"status" min:"3" type:"string"`

	// The target pattern for a URL rewrite or redirect rule.
	//
	// Target is a required field
	Target *string `locationName:"target" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a custom rewrite or redirect rule.

func (CustomRule) GoString 

func (s CustomRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomRule) SetCondition 

func (s *CustomRule) SetCondition(v string) *CustomRule

SetCondition sets the Condition field's value.

func (*CustomRule) SetSource 

func (s *CustomRule) SetSource(v string) *CustomRule

SetSource sets the Source field's value.

func (*CustomRule) SetStatus 

func (s *CustomRule) SetStatus(v string) *CustomRule

SetStatus sets the Status field's value.

func (*CustomRule) SetTarget 

func (s *CustomRule) SetTarget(v string) *CustomRule

SetTarget sets the Target field's value.

func (CustomRule) String 

func (s CustomRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomRule) Validate 

func (s *CustomRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAppInput 

type DeleteAppInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the request structure for the delete app request.

func (DeleteAppInput) GoString 

func (s DeleteAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInput) SetAppId 

func (s *DeleteAppInput) SetAppId(v string) *DeleteAppInput

SetAppId sets the AppId field's value.

func (DeleteAppInput) String 

func (s DeleteAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInput) Validate 

func (s *DeleteAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAppOutput 

type DeleteAppOutput struct {

	// Represents the different branches of a repository for building, deploying,
	// and hosting an Amplify app.
	//
	// App is a required field
	App *App `locationName:"app" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the delete app request.

func (DeleteAppOutput) GoString 

func (s DeleteAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppOutput) SetApp 

func (s *DeleteAppOutput) SetApp(v *App) *DeleteAppOutput

SetApp sets the App field's value.

func (DeleteAppOutput) String 

func (s DeleteAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBackendEnvironmentInput added in v1.25.40 

type DeleteBackendEnvironmentInput struct {

	// The unique ID of an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of a backend environment of an Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the delete backend environment request.

func (DeleteBackendEnvironmentInput) GoString added in v1.25.40 

func (s DeleteBackendEnvironmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackendEnvironmentInput) SetAppId added in v1.25.40 

func (s *DeleteBackendEnvironmentInput) SetAppId(v string) *DeleteBackendEnvironmentInput

SetAppId sets the AppId field's value.

func (*DeleteBackendEnvironmentInput) SetEnvironmentName added in v1.25.40 

func (s *DeleteBackendEnvironmentInput) SetEnvironmentName(v string) *DeleteBackendEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (DeleteBackendEnvironmentInput) String added in v1.25.40 

func (s DeleteBackendEnvironmentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackendEnvironmentInput) Validate added in v1.25.40 

func (s *DeleteBackendEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackendEnvironmentOutput added in v1.25.40 

type DeleteBackendEnvironmentOutput struct {

	// Describes the backend environment for an Amplify app.
	//
	// BackendEnvironment is a required field
	BackendEnvironment *BackendEnvironment `locationName:"backendEnvironment" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure of the delete backend environment result.

func (DeleteBackendEnvironmentOutput) GoString added in v1.25.40 

func (s DeleteBackendEnvironmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackendEnvironmentOutput) SetBackendEnvironment added in v1.25.40 

func (s *DeleteBackendEnvironmentOutput) SetBackendEnvironment(v *BackendEnvironment) *DeleteBackendEnvironmentOutput

SetBackendEnvironment sets the BackendEnvironment field's value.

func (DeleteBackendEnvironmentOutput) String added in v1.25.40 

func (s DeleteBackendEnvironmentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBranchInput 

type DeleteBranchInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the delete branch request.

func (DeleteBranchInput) GoString 

func (s DeleteBranchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBranchInput) SetAppId 

func (s *DeleteBranchInput) SetAppId(v string) *DeleteBranchInput

SetAppId sets the AppId field's value.

func (*DeleteBranchInput) SetBranchName 

func (s *DeleteBranchInput) SetBranchName(v string) *DeleteBranchInput

SetBranchName sets the BranchName field's value.

func (DeleteBranchInput) String 

func (s DeleteBranchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBranchInput) Validate 

func (s *DeleteBranchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBranchOutput 

type DeleteBranchOutput struct {

	// The branch for an Amplify app, which maps to a third-party repository branch.
	//
	// Branch is a required field
	Branch *Branch `locationName:"branch" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the delete branch request.

func (DeleteBranchOutput) GoString 

func (s DeleteBranchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBranchOutput) SetBranch 

func (s *DeleteBranchOutput) SetBranch(v *Branch) *DeleteBranchOutput

SetBranch sets the Branch field's value.

func (DeleteBranchOutput) String 

func (s DeleteBranchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDomainAssociationInput 

type DeleteDomainAssociationInput struct {

	// The unique id for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the domain.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the delete domain association request.

func (DeleteDomainAssociationInput) GoString 

func (s DeleteDomainAssociationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainAssociationInput) SetAppId 

func (s *DeleteDomainAssociationInput) SetAppId(v string) *DeleteDomainAssociationInput

SetAppId sets the AppId field's value.

func (*DeleteDomainAssociationInput) SetDomainName 

func (s *DeleteDomainAssociationInput) SetDomainName(v string) *DeleteDomainAssociationInput

SetDomainName sets the DomainName field's value.

func (DeleteDomainAssociationInput) String 

func (s DeleteDomainAssociationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainAssociationInput) Validate 

func (s *DeleteDomainAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDomainAssociationOutput 

type DeleteDomainAssociationOutput struct {

	// Describes the association between a custom domain and an Amplify app.
	//
	// DomainAssociation is a required field
	DomainAssociation *DomainAssociation `locationName:"domainAssociation" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDomainAssociationOutput) GoString 

func (s DeleteDomainAssociationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainAssociationOutput) SetDomainAssociation 

func (s *DeleteDomainAssociationOutput) SetDomainAssociation(v *DomainAssociation) *DeleteDomainAssociationOutput

SetDomainAssociation sets the DomainAssociation field's value.

func (DeleteDomainAssociationOutput) String 

func (s DeleteDomainAssociationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteJobInput 

type DeleteJobInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the job.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The unique ID for the job.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the delete job request.

func (DeleteJobInput) GoString 

func (s DeleteJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJobInput) SetAppId 

func (s *DeleteJobInput) SetAppId(v string) *DeleteJobInput

SetAppId sets the AppId field's value.

func (*DeleteJobInput) SetBranchName 

func (s *DeleteJobInput) SetBranchName(v string) *DeleteJobInput

SetBranchName sets the BranchName field's value.

func (*DeleteJobInput) SetJobId 

func (s *DeleteJobInput) SetJobId(v string) *DeleteJobInput

SetJobId sets the JobId field's value.

func (DeleteJobInput) String 

func (s DeleteJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJobInput) Validate 

func (s *DeleteJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteJobOutput 

type DeleteJobOutput struct {

	// Describes the summary for an execution job for an Amplify app.
	//
	// JobSummary is a required field
	JobSummary *JobSummary `locationName:"jobSummary" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the delete job request.

func (DeleteJobOutput) GoString 

func (s DeleteJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJobOutput) SetJobSummary 

func (s *DeleteJobOutput) SetJobSummary(v *JobSummary) *DeleteJobOutput

SetJobSummary sets the JobSummary field's value.

func (DeleteJobOutput) String 

func (s DeleteJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWebhookInput added in v1.20.17 

type DeleteWebhookInput struct {

	// The unique ID for a webhook.
	//
	// WebhookId is a required field
	WebhookId *string `location:"uri" locationName:"webhookId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the delete webhook request.

func (DeleteWebhookInput) GoString added in v1.20.17 

func (s DeleteWebhookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWebhookInput) SetWebhookId added in v1.20.17 

func (s *DeleteWebhookInput) SetWebhookId(v string) *DeleteWebhookInput

SetWebhookId sets the WebhookId field's value.

func (DeleteWebhookInput) String added in v1.20.17 

func (s DeleteWebhookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWebhookInput) Validate added in v1.20.17 

func (s *DeleteWebhookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWebhookOutput added in v1.20.17 

type DeleteWebhookOutput struct {

	// Describes a webhook that connects repository events to an Amplify app.
	//
	// Webhook is a required field
	Webhook *Webhook `locationName:"webhook" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the delete webhook request.

func (DeleteWebhookOutput) GoString added in v1.20.17 

func (s DeleteWebhookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWebhookOutput) SetWebhook added in v1.20.17 

func (s *DeleteWebhookOutput) SetWebhook(v *Webhook) *DeleteWebhookOutput

SetWebhook sets the Webhook field's value.

func (DeleteWebhookOutput) String added in v1.20.17 

func (s DeleteWebhookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DependentServiceFailureException added in v1.28.0 

type DependentServiceFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An operation failed because a dependent service threw an exception.

func (*DependentServiceFailureException) Code added in v1.28.0 

func (s *DependentServiceFailureException) Code() string

Code returns the exception type name.

func (*DependentServiceFailureException) Error added in v1.28.0 

func (s *DependentServiceFailureException) Error() string

func (DependentServiceFailureException) GoString added in v1.28.0 

func (s DependentServiceFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependentServiceFailureException) Message added in v1.28.0 

func (s *DependentServiceFailureException) Message() string

Message returns the exception's message.

func (*DependentServiceFailureException) OrigErr added in v1.28.0 

func (s *DependentServiceFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependentServiceFailureException) RequestID added in v1.28.0 

func (s *DependentServiceFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependentServiceFailureException) StatusCode added in v1.28.0 

func (s *DependentServiceFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependentServiceFailureException) String added in v1.28.0 

func (s DependentServiceFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainAssociation 

type DomainAssociation struct {

	// Sets branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns []*string `locationName:"autoSubDomainCreationPatterns" type:"list"`

	// The required AWS Identity and Access Management (IAM) service role for the
	// Amazon Resource Name (ARN) for automatically creating subdomains.
	AutoSubDomainIAMRole *string `locationName:"autoSubDomainIAMRole" type:"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 `locationName:"certificate" type:"structure"`

	// The DNS record for certificate verification.
	CertificateVerificationDNSRecord *string `locationName:"certificateVerificationDNSRecord" type:"string"`

	// The Amazon Resource Name (ARN) for the domain association.
	//
	// DomainAssociationArn is a required field
	DomainAssociationArn *string `locationName:"domainAssociationArn" type:"string" required:"true"`

	// The name of the domain.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`

	// The current status of the domain association.
	//
	// DomainStatus is a required field
	DomainStatus *string `locationName:"domainStatus" type:"string" required:"true" enum:"DomainStatus"`

	// Enables the automated creation of subdomains for branches.
	//
	// EnableAutoSubDomain is a required field
	EnableAutoSubDomain *bool `locationName:"enableAutoSubDomain" type:"boolean" required:"true"`

	// Additional information that describes why the domain association is in the
	// current state.
	//
	// StatusReason is a required field
	StatusReason *string `locationName:"statusReason" type:"string" required:"true"`

	// The subdomains for the domain association.
	//
	// SubDomains is a required field
	SubDomains []*SubDomain `locationName:"subDomains" type:"list" required:"true"`

	// 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
	// (https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html)
	// 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.
	UpdateStatus *string `locationName:"updateStatus" type:"string" enum:"UpdateStatus"`
	// contains filtered or unexported fields
}

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

func (DomainAssociation) GoString 

func (s DomainAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainAssociation) SetAutoSubDomainCreationPatterns added in v1.32.9 

func (s *DomainAssociation) SetAutoSubDomainCreationPatterns(v []*string) *DomainAssociation

SetAutoSubDomainCreationPatterns sets the AutoSubDomainCreationPatterns field's value.

func (*DomainAssociation) SetAutoSubDomainIAMRole added in v1.32.9 

func (s *DomainAssociation) SetAutoSubDomainIAMRole(v string) *DomainAssociation

SetAutoSubDomainIAMRole sets the AutoSubDomainIAMRole field's value.

func (*DomainAssociation) SetCertificate added in v1.50.21 

func (s *DomainAssociation) SetCertificate(v *Certificate) *DomainAssociation

SetCertificate sets the Certificate field's value.

func (*DomainAssociation) SetCertificateVerificationDNSRecord 

func (s *DomainAssociation) SetCertificateVerificationDNSRecord(v string) *DomainAssociation

SetCertificateVerificationDNSRecord sets the CertificateVerificationDNSRecord field's value.

func (*DomainAssociation) SetDomainAssociationArn 

func (s *DomainAssociation) SetDomainAssociationArn(v string) *DomainAssociation

SetDomainAssociationArn sets the DomainAssociationArn field's value.

func (*DomainAssociation) SetDomainName 

func (s *DomainAssociation) SetDomainName(v string) *DomainAssociation

SetDomainName sets the DomainName field's value.

func (*DomainAssociation) SetDomainStatus 

func (s *DomainAssociation) SetDomainStatus(v string) *DomainAssociation

SetDomainStatus sets the DomainStatus field's value.

func (*DomainAssociation) SetEnableAutoSubDomain 

func (s *DomainAssociation) SetEnableAutoSubDomain(v bool) *DomainAssociation

SetEnableAutoSubDomain sets the EnableAutoSubDomain field's value.

func (*DomainAssociation) SetStatusReason 

func (s *DomainAssociation) SetStatusReason(v string) *DomainAssociation

SetStatusReason sets the StatusReason field's value.

func (*DomainAssociation) SetSubDomains 

func (s *DomainAssociation) SetSubDomains(v []*SubDomain) *DomainAssociation

SetSubDomains sets the SubDomains field's value.

func (*DomainAssociation) SetUpdateStatus added in v1.50.21 

func (s *DomainAssociation) SetUpdateStatus(v string) *DomainAssociation

SetUpdateStatus sets the UpdateStatus field's value.

func (DomainAssociation) String 

func (s DomainAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GenerateAccessLogsInput added in v1.25.1 

type GenerateAccessLogsInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the domain.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`

	// The time at which the logs should end. The time range specified is inclusive
	// of the end time.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The time at which the logs should start. The time range specified is inclusive
	// of the start time.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`
	// contains filtered or unexported fields
}

The request structure for the generate access logs request.

func (GenerateAccessLogsInput) GoString added in v1.25.1 

func (s GenerateAccessLogsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerateAccessLogsInput) SetAppId added in v1.25.1 

func (s *GenerateAccessLogsInput) SetAppId(v string) *GenerateAccessLogsInput

SetAppId sets the AppId field's value.

func (*GenerateAccessLogsInput) SetDomainName added in v1.25.1 

func (s *GenerateAccessLogsInput) SetDomainName(v string) *GenerateAccessLogsInput

SetDomainName sets the DomainName field's value.

func (*GenerateAccessLogsInput) SetEndTime added in v1.25.1 

func (s *GenerateAccessLogsInput) SetEndTime(v time.Time) *GenerateAccessLogsInput

SetEndTime sets the EndTime field's value.

func (*GenerateAccessLogsInput) SetStartTime added in v1.25.1 

func (s *GenerateAccessLogsInput) SetStartTime(v time.Time) *GenerateAccessLogsInput

SetStartTime sets the StartTime field's value.

func (GenerateAccessLogsInput) String added in v1.25.1 

func (s GenerateAccessLogsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerateAccessLogsInput) Validate added in v1.25.1 

func (s *GenerateAccessLogsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerateAccessLogsOutput added in v1.25.1 

type GenerateAccessLogsOutput struct {

	// The pre-signed URL for the requested access logs.
	LogUrl *string `locationName:"logUrl" type:"string"`
	// contains filtered or unexported fields
}

The result structure for the generate access logs request.

func (GenerateAccessLogsOutput) GoString added in v1.25.1 

func (s GenerateAccessLogsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerateAccessLogsOutput) SetLogUrl added in v1.25.1 

func (s *GenerateAccessLogsOutput) SetLogUrl(v string) *GenerateAccessLogsOutput

SetLogUrl sets the LogUrl field's value.

func (GenerateAccessLogsOutput) String added in v1.25.1 

func (s GenerateAccessLogsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAppInput 

type GetAppInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the get app request.

func (GetAppInput) GoString 

func (s GetAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppInput) SetAppId 

func (s *GetAppInput) SetAppId(v string) *GetAppInput

SetAppId sets the AppId field's value.

func (GetAppInput) String 

func (s GetAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppInput) Validate 

func (s *GetAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAppOutput 

type GetAppOutput struct {

	// Represents the different branches of a repository for building, deploying,
	// and hosting an Amplify app.
	//
	// App is a required field
	App *App `locationName:"app" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppOutput) GoString 

func (s GetAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppOutput) SetApp 

func (s *GetAppOutput) SetApp(v *App) *GetAppOutput

SetApp sets the App field's value.

func (GetAppOutput) String 

func (s GetAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetArtifactUrlInput added in v1.25.1 

type GetArtifactUrlInput struct {

	// The unique ID for an artifact.
	//
	// ArtifactId is a required field
	ArtifactId *string `location:"uri" locationName:"artifactId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Returns the request structure for the get artifact request.

func (GetArtifactUrlInput) GoString added in v1.25.1 

func (s GetArtifactUrlInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetArtifactUrlInput) SetArtifactId added in v1.25.1 

func (s *GetArtifactUrlInput) SetArtifactId(v string) *GetArtifactUrlInput

SetArtifactId sets the ArtifactId field's value.

func (GetArtifactUrlInput) String added in v1.25.1 

func (s GetArtifactUrlInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetArtifactUrlInput) Validate added in v1.25.1 

func (s *GetArtifactUrlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetArtifactUrlOutput added in v1.25.1 

type GetArtifactUrlOutput struct {

	// The unique ID for an artifact.
	//
	// ArtifactId is a required field
	ArtifactId *string `locationName:"artifactId" type:"string" required:"true"`

	// The presigned URL for the artifact.
	//
	// ArtifactUrl is a required field
	ArtifactUrl *string `locationName:"artifactUrl" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Returns the result structure for the get artifact request.

func (GetArtifactUrlOutput) GoString added in v1.25.1 

func (s GetArtifactUrlOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetArtifactUrlOutput) SetArtifactId added in v1.25.1 

func (s *GetArtifactUrlOutput) SetArtifactId(v string) *GetArtifactUrlOutput

SetArtifactId sets the ArtifactId field's value.

func (*GetArtifactUrlOutput) SetArtifactUrl added in v1.25.1 

func (s *GetArtifactUrlOutput) SetArtifactUrl(v string) *GetArtifactUrlOutput

SetArtifactUrl sets the ArtifactUrl field's value.

func (GetArtifactUrlOutput) String added in v1.25.1 

func (s GetArtifactUrlOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBackendEnvironmentInput added in v1.25.40 

type GetBackendEnvironmentInput struct {

	// The unique id for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name for the backend environment.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the get backend environment request.

func (GetBackendEnvironmentInput) GoString added in v1.25.40 

func (s GetBackendEnvironmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackendEnvironmentInput) SetAppId added in v1.25.40 

func (s *GetBackendEnvironmentInput) SetAppId(v string) *GetBackendEnvironmentInput

SetAppId sets the AppId field's value.

func (*GetBackendEnvironmentInput) SetEnvironmentName added in v1.25.40 

func (s *GetBackendEnvironmentInput) SetEnvironmentName(v string) *GetBackendEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (GetBackendEnvironmentInput) String added in v1.25.40 

func (s GetBackendEnvironmentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackendEnvironmentInput) Validate added in v1.25.40 

func (s *GetBackendEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBackendEnvironmentOutput added in v1.25.40 

type GetBackendEnvironmentOutput struct {

	// Describes the backend environment for an Amplify app.
	//
	// BackendEnvironment is a required field
	BackendEnvironment *BackendEnvironment `locationName:"backendEnvironment" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the get backend environment result.

func (GetBackendEnvironmentOutput) GoString added in v1.25.40 

func (s GetBackendEnvironmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackendEnvironmentOutput) SetBackendEnvironment added in v1.25.40 

func (s *GetBackendEnvironmentOutput) SetBackendEnvironment(v *BackendEnvironment) *GetBackendEnvironmentOutput

SetBackendEnvironment sets the BackendEnvironment field's value.

func (GetBackendEnvironmentOutput) String added in v1.25.40 

func (s GetBackendEnvironmentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBranchInput 

type GetBranchInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the get branch request.

func (GetBranchInput) GoString 

func (s GetBranchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBranchInput) SetAppId 

func (s *GetBranchInput) SetAppId(v string) *GetBranchInput

SetAppId sets the AppId field's value.

func (*GetBranchInput) SetBranchName 

func (s *GetBranchInput) SetBranchName(v string) *GetBranchInput

SetBranchName sets the BranchName field's value.

func (GetBranchInput) String 

func (s GetBranchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBranchInput) Validate 

func (s *GetBranchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBranchOutput 

type GetBranchOutput struct {

	// The branch for an Amplify app, which maps to a third-party repository branch.
	//
	// Branch is a required field
	Branch *Branch `locationName:"branch" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetBranchOutput) GoString 

func (s GetBranchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBranchOutput) SetBranch 

func (s *GetBranchOutput) SetBranch(v *Branch) *GetBranchOutput

SetBranch sets the Branch field's value.

func (GetBranchOutput) String 

func (s GetBranchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDomainAssociationInput 

type GetDomainAssociationInput struct {

	// The unique id for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the domain.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the get domain association request.

func (GetDomainAssociationInput) GoString 

func (s GetDomainAssociationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainAssociationInput) SetAppId 

func (s *GetDomainAssociationInput) SetAppId(v string) *GetDomainAssociationInput

SetAppId sets the AppId field's value.

func (*GetDomainAssociationInput) SetDomainName 

func (s *GetDomainAssociationInput) SetDomainName(v string) *GetDomainAssociationInput

SetDomainName sets the DomainName field's value.

func (GetDomainAssociationInput) String 

func (s GetDomainAssociationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainAssociationInput) Validate 

func (s *GetDomainAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDomainAssociationOutput 

type GetDomainAssociationOutput struct {

	// Describes the structure of a domain association, which associates a custom
	// domain with an Amplify app.
	//
	// DomainAssociation is a required field
	DomainAssociation *DomainAssociation `locationName:"domainAssociation" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the get domain association request.

func (GetDomainAssociationOutput) GoString 

func (s GetDomainAssociationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainAssociationOutput) SetDomainAssociation 

func (s *GetDomainAssociationOutput) SetDomainAssociation(v *DomainAssociation) *GetDomainAssociationOutput

SetDomainAssociation sets the DomainAssociation field's value.

func (GetDomainAssociationOutput) String 

func (s GetDomainAssociationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetJobInput 

type GetJobInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the job.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The unique ID for the job.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the get job request.

func (GetJobInput) GoString 

func (s GetJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobInput) SetAppId 

func (s *GetJobInput) SetAppId(v string) *GetJobInput

SetAppId sets the AppId field's value.

func (*GetJobInput) SetBranchName 

func (s *GetJobInput) SetBranchName(v string) *GetJobInput

SetBranchName sets the BranchName field's value.

func (*GetJobInput) SetJobId 

func (s *GetJobInput) SetJobId(v string) *GetJobInput

SetJobId sets the JobId field's value.

func (GetJobInput) String 

func (s GetJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobInput) Validate 

func (s *GetJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetJobOutput 

type GetJobOutput struct {

	// Describes an execution job for an Amplify app.
	//
	// Job is a required field
	Job *Job `locationName:"job" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJobOutput) GoString 

func (s GetJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJobOutput) SetJob 

func (s *GetJobOutput) SetJob(v *Job) *GetJobOutput

SetJob sets the Job field's value.

func (GetJobOutput) String 

func (s GetJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetWebhookInput added in v1.20.17 

type GetWebhookInput struct {

	// The unique ID for a webhook.
	//
	// WebhookId is a required field
	WebhookId *string `location:"uri" locationName:"webhookId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the get webhook request.

func (GetWebhookInput) GoString added in v1.20.17 

func (s GetWebhookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWebhookInput) SetWebhookId added in v1.20.17 

func (s *GetWebhookInput) SetWebhookId(v string) *GetWebhookInput

SetWebhookId sets the WebhookId field's value.

func (GetWebhookInput) String added in v1.20.17 

func (s GetWebhookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWebhookInput) Validate added in v1.20.17 

func (s *GetWebhookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetWebhookOutput added in v1.20.17 

type GetWebhookOutput struct {

	// Describes the structure of a webhook.
	//
	// Webhook is a required field
	Webhook *Webhook `locationName:"webhook" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the get webhook request.

func (GetWebhookOutput) GoString added in v1.20.17 

func (s GetWebhookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWebhookOutput) SetWebhook added in v1.20.17 

func (s *GetWebhookOutput) SetWebhook(v *Webhook) *GetWebhookOutput

SetWebhook sets the Webhook field's value.

func (GetWebhookOutput) String added in v1.20.17 

func (s GetWebhookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException added in v1.28.0 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalFailureException) Code added in v1.28.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.28.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.28.0 

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) Message added in v1.28.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.28.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String added in v1.28.0 

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Job 

type Job struct {

	// The execution steps for an execution job, for an Amplify app.
	//
	// Steps is a required field
	Steps []*Step `locationName:"steps" type:"list" required:"true"`

	// Describes the summary for an execution job for an Amplify app.
	//
	// Summary is a required field
	Summary *JobSummary `locationName:"summary" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Describes an execution job for an Amplify app.

func (Job) GoString 

func (s Job) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Job) SetSteps 

func (s *Job) SetSteps(v []*Step) *Job

SetSteps sets the Steps field's value.

func (*Job) SetSummary 

func (s *Job) SetSummary(v *JobSummary) *Job

SetSummary sets the Summary field's value.

func (Job) String 

func (s Job) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobSummary 

type JobSummary struct {

	// The commit ID from a third-party repository provider for the job.
	//
	// CommitId is a required field
	CommitId *string `locationName:"commitId" type:"string" required:"true"`

	// The commit message from a third-party repository provider for the job.
	//
	// CommitMessage is a required field
	CommitMessage *string `locationName:"commitMessage" type:"string" required:"true"`

	// The commit date and time for the job.
	//
	// CommitTime is a required field
	CommitTime *time.Time `locationName:"commitTime" type:"timestamp" required:"true"`

	// The end date and time for the job.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) for the job.
	//
	// JobArn is a required field
	JobArn *string `locationName:"jobArn" type:"string" required:"true"`

	// The unique ID for the job.
	//
	// JobId is a required field
	JobId *string `locationName:"jobId" type:"string" required:"true"`

	// The type for the job. If the value is RELEASE, the job was manually released
	// from its source by using the StartJob API. 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.
	//
	// JobType is a required field
	JobType *string `locationName:"jobType" type:"string" required:"true" enum:"JobType"`

	// The start date and time for the job.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// The current status for the job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"`
	// contains filtered or unexported fields
}

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

func (JobSummary) GoString 

func (s JobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobSummary) SetCommitId 

func (s *JobSummary) SetCommitId(v string) *JobSummary

SetCommitId sets the CommitId field's value.

func (*JobSummary) SetCommitMessage 

func (s *JobSummary) SetCommitMessage(v string) *JobSummary

SetCommitMessage sets the CommitMessage field's value.

func (*JobSummary) SetCommitTime 

func (s *JobSummary) SetCommitTime(v time.Time) *JobSummary

SetCommitTime sets the CommitTime field's value.

func (*JobSummary) SetEndTime 

func (s *JobSummary) SetEndTime(v time.Time) *JobSummary

SetEndTime sets the EndTime field's value.

func (*JobSummary) SetJobArn 

func (s *JobSummary) SetJobArn(v string) *JobSummary

SetJobArn sets the JobArn field's value.

func (*JobSummary) SetJobId 

func (s *JobSummary) SetJobId(v string) *JobSummary

SetJobId sets the JobId field's value.

func (*JobSummary) SetJobType 

func (s *JobSummary) SetJobType(v string) *JobSummary

SetJobType sets the JobType field's value.

func (*JobSummary) SetStartTime 

func (s *JobSummary) SetStartTime(v time.Time) *JobSummary

SetStartTime sets the StartTime field's value.

func (*JobSummary) SetStatus 

func (s *JobSummary) SetStatus(v string) *JobSummary

SetStatus sets the Status field's value.

func (JobSummary) String 

func (s JobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppsInput 

type ListAppsInput struct {

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the list apps request.

func (ListAppsInput) GoString 

func (s ListAppsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppsInput) SetMaxResults 

func (s *ListAppsInput) SetMaxResults(v int64) *ListAppsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAppsInput) SetNextToken 

func (s *ListAppsInput) SetNextToken(v string) *ListAppsInput

SetNextToken sets the NextToken field's value.

func (ListAppsInput) String 

func (s ListAppsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppsOutput 

type ListAppsOutput struct {

	// A list of Amplify apps.
	//
	// Apps is a required field
	Apps []*App `locationName:"apps" type:"list" required:"true"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result structure for an Amplify app list request.

func (ListAppsOutput) GoString 

func (s ListAppsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppsOutput) SetApps 

func (s *ListAppsOutput) SetApps(v []*App) *ListAppsOutput

SetApps sets the Apps field's value.

func (*ListAppsOutput) SetNextToken 

func (s *ListAppsOutput) SetNextToken(v string) *ListAppsOutput

SetNextToken sets the NextToken field's value.

func (ListAppsOutput) String 

func (s ListAppsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListArtifactsInput added in v1.25.1 

type ListArtifactsInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of a branch that is part of an Amplify app.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The unique ID for a job.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Describes the request structure for the list artifacts request.

func (ListArtifactsInput) GoString added in v1.25.1 

func (s ListArtifactsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListArtifactsInput) SetAppId added in v1.25.1 

func (s *ListArtifactsInput) SetAppId(v string) *ListArtifactsInput

SetAppId sets the AppId field's value.

func (*ListArtifactsInput) SetBranchName added in v1.25.1 

func (s *ListArtifactsInput) SetBranchName(v string) *ListArtifactsInput

SetBranchName sets the BranchName field's value.

func (*ListArtifactsInput) SetJobId added in v1.25.1 

func (s *ListArtifactsInput) SetJobId(v string) *ListArtifactsInput

SetJobId sets the JobId field's value.

func (*ListArtifactsInput) SetMaxResults added in v1.25.1 

func (s *ListArtifactsInput) SetMaxResults(v int64) *ListArtifactsInput

SetMaxResults sets the MaxResults field's value.

func (*ListArtifactsInput) SetNextToken added in v1.25.1 

func (s *ListArtifactsInput) SetNextToken(v string) *ListArtifactsInput

SetNextToken sets the NextToken field's value.

func (ListArtifactsInput) String added in v1.25.1 

func (s ListArtifactsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListArtifactsInput) Validate added in v1.25.1 

func (s *ListArtifactsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListArtifactsOutput added in v1.25.1 

type ListArtifactsOutput struct {

	// A list of artifacts.
	//
	// Artifacts is a required field
	Artifacts []*Artifact `locationName:"artifacts" type:"list" required:"true"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result structure for the list artifacts request.

func (ListArtifactsOutput) GoString added in v1.25.1 

func (s ListArtifactsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListArtifactsOutput) SetArtifacts added in v1.25.1 

func (s *ListArtifactsOutput) SetArtifacts(v []*Artifact) *ListArtifactsOutput

SetArtifacts sets the Artifacts field's value.

func (*ListArtifactsOutput) SetNextToken added in v1.25.1 

func (s *ListArtifactsOutput) SetNextToken(v string) *ListArtifactsOutput

SetNextToken sets the NextToken field's value.

func (ListArtifactsOutput) String added in v1.25.1 

func (s ListArtifactsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListBackendEnvironmentsInput added in v1.25.40 

type ListBackendEnvironmentsInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the backend environment
	EnvironmentName *string `location:"querystring" locationName:"environmentName" min:"1" type:"string"`

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the list backend environments request.

func (ListBackendEnvironmentsInput) GoString added in v1.25.40 

func (s ListBackendEnvironmentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBackendEnvironmentsInput) SetAppId added in v1.25.40 

func (s *ListBackendEnvironmentsInput) SetAppId(v string) *ListBackendEnvironmentsInput

SetAppId sets the AppId field's value.

func (*ListBackendEnvironmentsInput) SetEnvironmentName added in v1.25.40 

func (s *ListBackendEnvironmentsInput) SetEnvironmentName(v string) *ListBackendEnvironmentsInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*ListBackendEnvironmentsInput) SetMaxResults added in v1.25.40 

func (s *ListBackendEnvironmentsInput) SetMaxResults(v int64) *ListBackendEnvironmentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListBackendEnvironmentsInput) SetNextToken added in v1.25.40 

func (s *ListBackendEnvironmentsInput) SetNextToken(v string) *ListBackendEnvironmentsInput

SetNextToken sets the NextToken field's value.

func (ListBackendEnvironmentsInput) String added in v1.25.40 

func (s ListBackendEnvironmentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBackendEnvironmentsInput) Validate added in v1.25.40 

func (s *ListBackendEnvironmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackendEnvironmentsOutput added in v1.25.40 

type ListBackendEnvironmentsOutput struct {

	// The list of backend environments for an Amplify app.
	//
	// BackendEnvironments is a required field
	BackendEnvironments []*BackendEnvironment `locationName:"backendEnvironments" type:"list" required:"true"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result structure for the list backend environments result.

func (ListBackendEnvironmentsOutput) GoString added in v1.25.40 

func (s ListBackendEnvironmentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBackendEnvironmentsOutput) SetBackendEnvironments added in v1.25.40 

func (s *ListBackendEnvironmentsOutput) SetBackendEnvironments(v []*BackendEnvironment) *ListBackendEnvironmentsOutput

SetBackendEnvironments sets the BackendEnvironments field's value.

func (*ListBackendEnvironmentsOutput) SetNextToken added in v1.25.40 

func (s *ListBackendEnvironmentsOutput) SetNextToken(v string) *ListBackendEnvironmentsOutput

SetNextToken sets the NextToken field's value.

func (ListBackendEnvironmentsOutput) String added in v1.25.40 

func (s ListBackendEnvironmentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListBranchesInput 

type ListBranchesInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the list branches request.

func (ListBranchesInput) GoString 

func (s ListBranchesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBranchesInput) SetAppId 

func (s *ListBranchesInput) SetAppId(v string) *ListBranchesInput

SetAppId sets the AppId field's value.

func (*ListBranchesInput) SetMaxResults 

func (s *ListBranchesInput) SetMaxResults(v int64) *ListBranchesInput

SetMaxResults sets the MaxResults field's value.

func (*ListBranchesInput) SetNextToken 

func (s *ListBranchesInput) SetNextToken(v string) *ListBranchesInput

SetNextToken sets the NextToken field's value.

func (ListBranchesInput) String 

func (s ListBranchesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBranchesInput) Validate 

func (s *ListBranchesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBranchesOutput 

type ListBranchesOutput struct {

	// A list of branches for an Amplify app.
	//
	// Branches is a required field
	Branches []*Branch `locationName:"branches" type:"list" required:"true"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result structure for the list branches request.

func (ListBranchesOutput) GoString 

func (s ListBranchesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBranchesOutput) SetBranches 

func (s *ListBranchesOutput) SetBranches(v []*Branch) *ListBranchesOutput

SetBranches sets the Branches field's value.

func (*ListBranchesOutput) SetNextToken 

func (s *ListBranchesOutput) SetNextToken(v string) *ListBranchesOutput

SetNextToken sets the NextToken field's value.

func (ListBranchesOutput) String 

func (s ListBranchesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainAssociationsInput 

type ListDomainAssociationsInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the list domain associations request.

func (ListDomainAssociationsInput) GoString 

func (s ListDomainAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainAssociationsInput) SetAppId 

func (s *ListDomainAssociationsInput) SetAppId(v string) *ListDomainAssociationsInput

SetAppId sets the AppId field's value.

func (*ListDomainAssociationsInput) SetMaxResults 

func (s *ListDomainAssociationsInput) SetMaxResults(v int64) *ListDomainAssociationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDomainAssociationsInput) SetNextToken 

func (s *ListDomainAssociationsInput) SetNextToken(v string) *ListDomainAssociationsInput

SetNextToken sets the NextToken field's value.

func (ListDomainAssociationsInput) String 

func (s ListDomainAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainAssociationsInput) Validate 

func (s *ListDomainAssociationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDomainAssociationsOutput 

type ListDomainAssociationsOutput struct {

	// A list of domain associations.
	//
	// DomainAssociations is a required field
	DomainAssociations []*DomainAssociation `locationName:"domainAssociations" type:"list" required:"true"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result structure for the list domain association request.

func (ListDomainAssociationsOutput) GoString 

func (s ListDomainAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainAssociationsOutput) SetDomainAssociations 

func (s *ListDomainAssociationsOutput) SetDomainAssociations(v []*DomainAssociation) *ListDomainAssociationsOutput

SetDomainAssociations sets the DomainAssociations field's value.

func (*ListDomainAssociationsOutput) SetNextToken 

func (s *ListDomainAssociationsOutput) SetNextToken(v string) *ListDomainAssociationsOutput

SetNextToken sets the NextToken field's value.

func (ListDomainAssociationsOutput) String 

func (s ListDomainAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListJobsInput 

type ListJobsInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the request.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the list jobs request.

func (ListJobsInput) GoString 

func (s ListJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobsInput) SetAppId 

func (s *ListJobsInput) SetAppId(v string) *ListJobsInput

SetAppId sets the AppId field's value.

func (*ListJobsInput) SetBranchName 

func (s *ListJobsInput) SetBranchName(v string) *ListJobsInput

SetBranchName sets the BranchName field's value.

func (*ListJobsInput) SetMaxResults 

func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetNextToken 

func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput

SetNextToken sets the NextToken field's value.

func (ListJobsInput) String 

func (s ListJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobsInput) Validate 

func (s *ListJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJobsOutput 

type ListJobsOutput struct {

	// The result structure for the list job result request.
	//
	// JobSummaries is a required field
	JobSummaries []*JobSummary `locationName:"jobSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

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

func (ListJobsOutput) GoString 

func (s ListJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJobsOutput) SetJobSummaries 

func (s *ListJobsOutput) SetJobSummaries(v []*JobSummary) *ListJobsOutput

SetJobSummaries sets the JobSummaries field's value.

func (*ListJobsOutput) SetNextToken 

func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput

SetNextToken sets the NextToken field's value.

func (ListJobsOutput) String 

func (s ListJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.20.17 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) to use to list tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (ListTagsForResourceInput) GoString added in v1.20.17 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.20.17 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.20.17 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.20.17 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.20.17 

type ListTagsForResourceOutput struct {

	// A list of tags for the specified The Amazon Resource Name (ARN).
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The response for the list tags for resource request.

func (ListTagsForResourceOutput) GoString added in v1.20.17 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.20.17 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.20.17 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWebhooksInput added in v1.20.17 

type ListWebhooksInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the list webhooks request.

func (ListWebhooksInput) GoString added in v1.20.17 

func (s ListWebhooksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWebhooksInput) SetAppId added in v1.20.17 

func (s *ListWebhooksInput) SetAppId(v string) *ListWebhooksInput

SetAppId sets the AppId field's value.

func (*ListWebhooksInput) SetMaxResults added in v1.20.17 

func (s *ListWebhooksInput) SetMaxResults(v int64) *ListWebhooksInput

SetMaxResults sets the MaxResults field's value.

func (*ListWebhooksInput) SetNextToken added in v1.20.17 

func (s *ListWebhooksInput) SetNextToken(v string) *ListWebhooksInput

SetNextToken sets the NextToken field's value.

func (ListWebhooksInput) String added in v1.20.17 

func (s ListWebhooksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWebhooksInput) Validate added in v1.20.17 

func (s *ListWebhooksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWebhooksOutput added in v1.20.17 

type ListWebhooksOutput struct {

	// 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 `locationName:"nextToken" type:"string"`

	// A list of webhooks.
	//
	// Webhooks is a required field
	Webhooks []*Webhook `locationName:"webhooks" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the list webhooks request.

func (ListWebhooksOutput) GoString added in v1.20.17 

func (s ListWebhooksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWebhooksOutput) SetNextToken added in v1.20.17 

func (s *ListWebhooksOutput) SetNextToken(v string) *ListWebhooksOutput

SetNextToken sets the NextToken field's value.

func (*ListWebhooksOutput) SetWebhooks added in v1.20.17 

func (s *ListWebhooksOutput) SetWebhooks(v []*Webhook) *ListWebhooksOutput

SetWebhooks sets the Webhooks field's value.

func (ListWebhooksOutput) String added in v1.20.17 

func (s ListWebhooksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An entity was not found during an operation.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProductionBranch 

type ProductionBranch struct {

	// The branch name for the production branch.
	BranchName *string `locationName:"branchName" min:"1" type:"string"`

	// The last deploy time of the production branch.
	LastDeployTime *time.Time `locationName:"lastDeployTime" type:"timestamp"`

	// The status of the production branch.
	Status *string `locationName:"status" min:"3" type:"string"`

	// The thumbnail URL for the production branch.
	ThumbnailUrl *string `locationName:"thumbnailUrl" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (ProductionBranch) GoString 

func (s ProductionBranch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProductionBranch) SetBranchName 

func (s *ProductionBranch) SetBranchName(v string) *ProductionBranch

SetBranchName sets the BranchName field's value.

func (*ProductionBranch) SetLastDeployTime 

func (s *ProductionBranch) SetLastDeployTime(v time.Time) *ProductionBranch

SetLastDeployTime sets the LastDeployTime field's value.

func (*ProductionBranch) SetStatus 

func (s *ProductionBranch) SetStatus(v string) *ProductionBranch

SetStatus sets the Status field's value.

func (*ProductionBranch) SetThumbnailUrl 

func (s *ProductionBranch) SetThumbnailUrl(v string) *ProductionBranch

SetThumbnailUrl sets the ThumbnailUrl field's value.

func (ProductionBranch) String 

func (s ProductionBranch) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An operation failed due to a non-existent resource.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDeploymentInput added in v1.20.17 

type StartDeploymentInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the job.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The job ID for this deployment, generated by the create deployment request.
	JobId *string `locationName:"jobId" type:"string"`

	// The source URL for this deployment, used when calling start deployment without
	// create deployment. The source URL can be any HTTP GET URL that is publicly
	// accessible and downloads a single .zip file.
	SourceUrl *string `locationName:"sourceUrl" type:"string"`
	// contains filtered or unexported fields
}

The request structure for the start a deployment request.

func (StartDeploymentInput) GoString added in v1.20.17 

func (s StartDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDeploymentInput) SetAppId added in v1.20.17 

func (s *StartDeploymentInput) SetAppId(v string) *StartDeploymentInput

SetAppId sets the AppId field's value.

func (*StartDeploymentInput) SetBranchName added in v1.20.17 

func (s *StartDeploymentInput) SetBranchName(v string) *StartDeploymentInput

SetBranchName sets the BranchName field's value.

func (*StartDeploymentInput) SetJobId added in v1.20.17 

func (s *StartDeploymentInput) SetJobId(v string) *StartDeploymentInput

SetJobId sets the JobId field's value.

func (*StartDeploymentInput) SetSourceUrl added in v1.20.17 

func (s *StartDeploymentInput) SetSourceUrl(v string) *StartDeploymentInput

SetSourceUrl sets the SourceUrl field's value.

func (StartDeploymentInput) String added in v1.20.17 

func (s StartDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDeploymentInput) Validate added in v1.20.17 

func (s *StartDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDeploymentOutput added in v1.20.17 

type StartDeploymentOutput struct {

	// The summary for the job.
	//
	// JobSummary is a required field
	JobSummary *JobSummary `locationName:"jobSummary" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the start a deployment request.

func (StartDeploymentOutput) GoString added in v1.20.17 

func (s StartDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDeploymentOutput) SetJobSummary added in v1.20.17 

func (s *StartDeploymentOutput) SetJobSummary(v *JobSummary) *StartDeploymentOutput

SetJobSummary sets the JobSummary field's value.

func (StartDeploymentOutput) String added in v1.20.17 

func (s StartDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartJobInput 

type StartJobInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the job.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The commit ID from a third-party repository provider for the job.
	CommitId *string `locationName:"commitId" type:"string"`

	// The commit message from a third-party repository provider for the job.
	CommitMessage *string `locationName:"commitMessage" type:"string"`

	// The commit date and time for the job.
	CommitTime *time.Time `locationName:"commitTime" type:"timestamp"`

	// The unique ID for an existing job. This is required if the value of jobType
	// is RETRY.
	JobId *string `locationName:"jobId" type:"string"`

	// A descriptive reason for starting the job.
	JobReason *string `locationName:"jobReason" type:"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.
	//
	// JobType is a required field
	JobType *string `locationName:"jobType" type:"string" required:"true" enum:"JobType"`
	// contains filtered or unexported fields
}

The request structure for the start job request.

func (StartJobInput) GoString 

func (s StartJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartJobInput) SetAppId 

func (s *StartJobInput) SetAppId(v string) *StartJobInput

SetAppId sets the AppId field's value.

func (*StartJobInput) SetBranchName 

func (s *StartJobInput) SetBranchName(v string) *StartJobInput

SetBranchName sets the BranchName field's value.

func (*StartJobInput) SetCommitId 

func (s *StartJobInput) SetCommitId(v string) *StartJobInput

SetCommitId sets the CommitId field's value.

func (*StartJobInput) SetCommitMessage 

func (s *StartJobInput) SetCommitMessage(v string) *StartJobInput

SetCommitMessage sets the CommitMessage field's value.

func (*StartJobInput) SetCommitTime 

func (s *StartJobInput) SetCommitTime(v time.Time) *StartJobInput

SetCommitTime sets the CommitTime field's value.

func (*StartJobInput) SetJobId 

func (s *StartJobInput) SetJobId(v string) *StartJobInput

SetJobId sets the JobId field's value.

func (*StartJobInput) SetJobReason 

func (s *StartJobInput) SetJobReason(v string) *StartJobInput

SetJobReason sets the JobReason field's value.

func (*StartJobInput) SetJobType 

func (s *StartJobInput) SetJobType(v string) *StartJobInput

SetJobType sets the JobType field's value.

func (StartJobInput) String 

func (s StartJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartJobInput) Validate 

func (s *StartJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartJobOutput 

type StartJobOutput struct {

	// The summary for the job.
	//
	// JobSummary is a required field
	JobSummary *JobSummary `locationName:"jobSummary" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the run job request.

func (StartJobOutput) GoString 

func (s StartJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartJobOutput) SetJobSummary 

func (s *StartJobOutput) SetJobSummary(v *JobSummary) *StartJobOutput

SetJobSummary sets the JobSummary field's value.

func (StartJobOutput) String 

func (s StartJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Step 

type Step struct {

	// The URL to the artifact for the execution step.
	ArtifactsUrl *string `locationName:"artifactsUrl" type:"string"`

	// The context for the current step. Includes a build image if the step is build.
	Context *string `locationName:"context" type:"string"`

	// The end date and time of the execution step.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The URL to the logs for the execution step.
	LogUrl *string `locationName:"logUrl" type:"string"`

	// The list of screenshot URLs for the execution step, if relevant.
	Screenshots map[string]*string `locationName:"screenshots" type:"map"`

	// The start date and time of the execution step.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// The status of the execution step.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"`

	// The reason for the current step status.
	StatusReason *string `locationName:"statusReason" type:"string"`

	// The name of the execution step.
	//
	// StepName is a required field
	StepName *string `locationName:"stepName" type:"string" required:"true"`

	// The URL to the test artifact for the execution step.
	TestArtifactsUrl *string `locationName:"testArtifactsUrl" type:"string"`

	// The URL to the test configuration for the execution step.
	TestConfigUrl *string `locationName:"testConfigUrl" type:"string"`
	// contains filtered or unexported fields
}

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

func (Step) GoString 

func (s Step) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Step) SetArtifactsUrl 

func (s *Step) SetArtifactsUrl(v string) *Step

SetArtifactsUrl sets the ArtifactsUrl field's value.

func (*Step) SetContext added in v1.20.17 

func (s *Step) SetContext(v string) *Step

SetContext sets the Context field's value.

func (*Step) SetEndTime 

func (s *Step) SetEndTime(v time.Time) *Step

SetEndTime sets the EndTime field's value.

func (*Step) SetLogUrl 

func (s *Step) SetLogUrl(v string) *Step

SetLogUrl sets the LogUrl field's value.

func (*Step) SetScreenshots 

func (s *Step) SetScreenshots(v map[string]*string) *Step

SetScreenshots sets the Screenshots field's value.

func (*Step) SetStartTime 

func (s *Step) SetStartTime(v time.Time) *Step

SetStartTime sets the StartTime field's value.

func (*Step) SetStatus 

func (s *Step) SetStatus(v string) *Step

SetStatus sets the Status field's value.

func (*Step) SetStatusReason added in v1.20.17 

func (s *Step) SetStatusReason(v string) *Step

SetStatusReason sets the StatusReason field's value.

func (*Step) SetStepName 

func (s *Step) SetStepName(v string) *Step

SetStepName sets the StepName field's value.

func (*Step) SetTestArtifactsUrl added in v1.25.1 

func (s *Step) SetTestArtifactsUrl(v string) *Step

SetTestArtifactsUrl sets the TestArtifactsUrl field's value.

func (*Step) SetTestConfigUrl added in v1.25.1 

func (s *Step) SetTestConfigUrl(v string) *Step

SetTestConfigUrl sets the TestConfigUrl field's value.

func (Step) String 

func (s Step) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopJobInput 

type StopJobInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The name of the branch to use for the stop job request.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The unique id for the job.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the stop job request.

func (StopJobInput) GoString 

func (s StopJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopJobInput) SetAppId 

func (s *StopJobInput) SetAppId(v string) *StopJobInput

SetAppId sets the AppId field's value.

func (*StopJobInput) SetBranchName 

func (s *StopJobInput) SetBranchName(v string) *StopJobInput

SetBranchName sets the BranchName field's value.

func (*StopJobInput) SetJobId 

func (s *StopJobInput) SetJobId(v string) *StopJobInput

SetJobId sets the JobId field's value.

func (StopJobInput) String 

func (s StopJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopJobInput) Validate 

func (s *StopJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopJobOutput 

type StopJobOutput struct {

	// The summary for the job.
	//
	// JobSummary is a required field
	JobSummary *JobSummary `locationName:"jobSummary" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the stop job request.

func (StopJobOutput) GoString 

func (s StopJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopJobOutput) SetJobSummary 

func (s *StopJobOutput) SetJobSummary(v *JobSummary) *StopJobOutput

SetJobSummary sets the JobSummary field's value.

func (StopJobOutput) String 

func (s StopJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubDomain 

type SubDomain struct {

	// The DNS record for the subdomain.
	//
	// DnsRecord is a required field
	DnsRecord *string `locationName:"dnsRecord" type:"string" required:"true"`

	// Describes the settings for the subdomain.
	//
	// SubDomainSetting is a required field
	SubDomainSetting *SubDomainSetting `locationName:"subDomainSetting" type:"structure" required:"true"`

	// The verified status of the subdomain
	//
	// Verified is a required field
	Verified *bool `locationName:"verified" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The subdomain for the domain association.

func (SubDomain) GoString 

func (s SubDomain) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubDomain) SetDnsRecord 

func (s *SubDomain) SetDnsRecord(v string) *SubDomain

SetDnsRecord sets the DnsRecord field's value.

func (*SubDomain) SetSubDomainSetting 

func (s *SubDomain) SetSubDomainSetting(v *SubDomainSetting) *SubDomain

SetSubDomainSetting sets the SubDomainSetting field's value.

func (*SubDomain) SetVerified 

func (s *SubDomain) SetVerified(v bool) *SubDomain

SetVerified sets the Verified field's value.

func (SubDomain) String 

func (s SubDomain) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubDomainSetting 

type SubDomainSetting struct {

	// The branch name setting for the subdomain.
	//
	// BranchName is a required field
	BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`

	// The prefix setting for the subdomain.
	//
	// Prefix is a required field
	Prefix *string `locationName:"prefix" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the settings for the subdomain.

func (SubDomainSetting) GoString 

func (s SubDomainSetting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubDomainSetting) SetBranchName 

func (s *SubDomainSetting) SetBranchName(v string) *SubDomainSetting

SetBranchName sets the BranchName field's value.

func (*SubDomainSetting) SetPrefix 

func (s *SubDomainSetting) SetPrefix(v string) *SubDomainSetting

SetPrefix sets the Prefix field's value.

func (SubDomainSetting) String 

func (s SubDomainSetting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubDomainSetting) Validate 

func (s *SubDomainSetting) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.20.17 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) to use to tag a resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tags used to tag the resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

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

func (TagResourceInput) GoString added in v1.20.17 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.20.17 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.20.17 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.20.17 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.20.17 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.20.17 

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

The response for the tag resource request.

func (TagResourceOutput) GoString added in v1.20.17 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.20.17 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedException added in v1.28.0 

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An operation failed due to a lack of access.

func (*UnauthorizedException) Code added in v1.28.0 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedException) Message added in v1.28.0 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0 

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String added in v1.28.0 

func (s UnauthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.20.17 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) to use to untag a resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tag keys to use to untag a resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the untag resource request.

func (UntagResourceInput) GoString added in v1.20.17 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.20.17 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.20.17 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.20.17 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.20.17 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.20.17 

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

The response for the untag resource request.

func (UntagResourceOutput) GoString added in v1.20.17 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.20.17 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAppInput 

type UpdateAppInput struct {

	// 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 (https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth)
	// in the Amplify User Guide .
	//
	// AccessToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInput's
	// String and GoString methods.
	AccessToken *string `locationName:"accessToken" min:"1" type:"string" sensitive:"true"`

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// The automated branch creation configuration for an Amplify app.
	AutoBranchCreationConfig *AutoBranchCreationConfig `locationName:"autoBranchCreationConfig" type:"structure"`

	// Describes the automated branch creation glob patterns for an Amplify app.
	AutoBranchCreationPatterns []*string `locationName:"autoBranchCreationPatterns" type:"list"`

	// The basic authorization credentials for an Amplify app. You must base64-encode
	// the authorization credentials and provide them in the format user:password.
	//
	// BasicAuthCredentials is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInput's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// The build specification (build spec) for an Amplify app.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInput's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// The custom HTTP headers for an Amplify app.
	CustomHeaders *string `locationName:"customHeaders" type:"string"`

	// The custom redirect and rewrite rules for an Amplify app.
	CustomRules []*CustomRule `locationName:"customRules" type:"list"`

	// The description for an Amplify app.
	Description *string `locationName:"description" type:"string"`

	// Enables automated branch creation for an Amplify app.
	EnableAutoBranchCreation *bool `locationName:"enableAutoBranchCreation" type:"boolean"`

	// Enables basic authorization for an Amplify app.
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean"`

	// Enables branch auto-building for an Amplify app.
	EnableBranchAutoBuild *bool `locationName:"enableBranchAutoBuild" type:"boolean"`

	// Automatically disconnects a branch in the Amplify console when you delete
	// a branch from your Git repository.
	EnableBranchAutoDeletion *bool `locationName:"enableBranchAutoDeletion" type:"boolean"`

	// The environment variables for an Amplify app.
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"`

	// The AWS Identity and Access Management (IAM) service role for an Amplify
	// app.
	IamServiceRoleArn *string `locationName:"iamServiceRoleArn" type:"string"`

	// The name for an Amplify app.
	Name *string `locationName:"name" min:"1" type:"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 (https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth)
	// in the Amplify User Guide .
	//
	// OauthToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInput's
	// String and GoString methods.
	OauthToken *string `locationName:"oauthToken" type:"string" sensitive:"true"`

	// 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.
	Platform *string `locationName:"platform" type:"string" enum:"Platform"`

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

The request structure for the update app request.

func (UpdateAppInput) GoString 

func (s UpdateAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInput) SetAccessToken added in v1.25.1 

func (s *UpdateAppInput) SetAccessToken(v string) *UpdateAppInput

SetAccessToken sets the AccessToken field's value.

func (*UpdateAppInput) SetAppId 

func (s *UpdateAppInput) SetAppId(v string) *UpdateAppInput

SetAppId sets the AppId field's value.

func (*UpdateAppInput) SetAutoBranchCreationConfig added in v1.20.17 

func (s *UpdateAppInput) SetAutoBranchCreationConfig(v *AutoBranchCreationConfig) *UpdateAppInput

SetAutoBranchCreationConfig sets the AutoBranchCreationConfig field's value.

func (*UpdateAppInput) SetAutoBranchCreationPatterns added in v1.20.17 

func (s *UpdateAppInput) SetAutoBranchCreationPatterns(v []*string) *UpdateAppInput

SetAutoBranchCreationPatterns sets the AutoBranchCreationPatterns field's value.

func (*UpdateAppInput) SetBasicAuthCredentials 

func (s *UpdateAppInput) SetBasicAuthCredentials(v string) *UpdateAppInput

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*UpdateAppInput) SetBuildSpec 

func (s *UpdateAppInput) SetBuildSpec(v string) *UpdateAppInput

SetBuildSpec sets the BuildSpec field's value.

func (*UpdateAppInput) SetCustomHeaders added in v1.35.26 

func (s *UpdateAppInput) SetCustomHeaders(v string) *UpdateAppInput

SetCustomHeaders sets the CustomHeaders field's value.

func (*UpdateAppInput) SetCustomRules 

func (s *UpdateAppInput) SetCustomRules(v []*CustomRule) *UpdateAppInput

SetCustomRules sets the CustomRules field's value.

func (*UpdateAppInput) SetDescription 

func (s *UpdateAppInput) SetDescription(v string) *UpdateAppInput

SetDescription sets the Description field's value.

func (*UpdateAppInput) SetEnableAutoBranchCreation added in v1.20.17 

func (s *UpdateAppInput) SetEnableAutoBranchCreation(v bool) *UpdateAppInput

SetEnableAutoBranchCreation sets the EnableAutoBranchCreation field's value.

func (*UpdateAppInput) SetEnableBasicAuth 

func (s *UpdateAppInput) SetEnableBasicAuth(v bool) *UpdateAppInput

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*UpdateAppInput) SetEnableBranchAutoBuild 

func (s *UpdateAppInput) SetEnableBranchAutoBuild(v bool) *UpdateAppInput

SetEnableBranchAutoBuild sets the EnableBranchAutoBuild field's value.

func (*UpdateAppInput) SetEnableBranchAutoDeletion added in v1.32.9 

func (s *UpdateAppInput) SetEnableBranchAutoDeletion(v bool) *UpdateAppInput

SetEnableBranchAutoDeletion sets the EnableBranchAutoDeletion field's value.

func (*UpdateAppInput) SetEnvironmentVariables 

func (s *UpdateAppInput) SetEnvironmentVariables(v map[string]*string) *UpdateAppInput

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*UpdateAppInput) SetIamServiceRoleArn 

func (s *UpdateAppInput) SetIamServiceRoleArn(v string) *UpdateAppInput

SetIamServiceRoleArn sets the IamServiceRoleArn field's value.

func (*UpdateAppInput) SetName 

func (s *UpdateAppInput) SetName(v string) *UpdateAppInput

SetName sets the Name field's value.

func (*UpdateAppInput) SetOauthToken added in v1.25.1 

func (s *UpdateAppInput) SetOauthToken(v string) *UpdateAppInput

SetOauthToken sets the OauthToken field's value.

func (*UpdateAppInput) SetPlatform 

func (s *UpdateAppInput) SetPlatform(v string) *UpdateAppInput

SetPlatform sets the Platform field's value.

func (*UpdateAppInput) SetRepository added in v1.25.1 

func (s *UpdateAppInput) SetRepository(v string) *UpdateAppInput

SetRepository sets the Repository field's value.

func (UpdateAppInput) String 

func (s UpdateAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInput) Validate 

func (s *UpdateAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAppOutput 

type UpdateAppOutput struct {

	// Represents the updated Amplify app.
	//
	// App is a required field
	App *App `locationName:"app" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for an Amplify app update request.

func (UpdateAppOutput) GoString 

func (s UpdateAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppOutput) SetApp 

func (s *UpdateAppOutput) SetApp(v *App) *UpdateAppOutput

SetApp sets the App field's value.

func (UpdateAppOutput) String 

func (s UpdateAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBranchInput 

type UpdateBranchInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// 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 *Backend `locationName:"backend" type:"structure"`

	// 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 `locationName:"backendEnvironmentArn" type:"string"`

	// The basic authorization credentials for the branch. You must base64-encode
	// the authorization credentials and provide them in the format user:password.
	//
	// BasicAuthCredentials is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateBranchInput's
	// String and GoString methods.
	BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"`

	// The name of the branch.
	//
	// BranchName is a required field
	BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"`

	// The build specification (build spec) for the branch.
	//
	// BuildSpec is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateBranchInput's
	// String and GoString methods.
	BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"`

	// The description for the branch.
	Description *string `locationName:"description" type:"string"`

	// The display name for a branch. This is used as the default domain prefix.
	DisplayName *string `locationName:"displayName" type:"string"`

	// Enables auto building for the branch.
	EnableAutoBuild *bool `locationName:"enableAutoBuild" type:"boolean"`

	// Enables basic authorization for the branch.
	EnableBasicAuth *bool `locationName:"enableBasicAuth" type:"boolean"`

	// Enables notifications for the branch.
	EnableNotification *bool `locationName:"enableNotification" type:"boolean"`

	// 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 `locationName:"enablePerformanceMode" type:"boolean"`

	// Enables pull request previews for this branch.
	EnablePullRequestPreview *bool `locationName:"enablePullRequestPreview" type:"boolean"`

	// The environment variables for the branch.
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"`

	// The framework for the branch.
	Framework *string `locationName:"framework" type:"string"`

	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string `locationName:"pullRequestEnvironmentName" type:"string"`

	// Describes the current stage for the branch.
	Stage *string `locationName:"stage" type:"string" enum:"Stage"`

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

The request structure for the update branch request.

func (UpdateBranchInput) GoString 

func (s UpdateBranchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBranchInput) SetAppId 

func (s *UpdateBranchInput) SetAppId(v string) *UpdateBranchInput

SetAppId sets the AppId field's value.

func (*UpdateBranchInput) SetBackend added in v1.47.0 

func (s *UpdateBranchInput) SetBackend(v *Backend) *UpdateBranchInput

SetBackend sets the Backend field's value.

func (*UpdateBranchInput) SetBackendEnvironmentArn added in v1.25.24 

func (s *UpdateBranchInput) SetBackendEnvironmentArn(v string) *UpdateBranchInput

SetBackendEnvironmentArn sets the BackendEnvironmentArn field's value.

func (*UpdateBranchInput) SetBasicAuthCredentials 

func (s *UpdateBranchInput) SetBasicAuthCredentials(v string) *UpdateBranchInput

SetBasicAuthCredentials sets the BasicAuthCredentials field's value.

func (*UpdateBranchInput) SetBranchName 

func (s *UpdateBranchInput) SetBranchName(v string) *UpdateBranchInput

SetBranchName sets the BranchName field's value.

func (*UpdateBranchInput) SetBuildSpec 

func (s *UpdateBranchInput) SetBuildSpec(v string) *UpdateBranchInput

SetBuildSpec sets the BuildSpec field's value.

func (*UpdateBranchInput) SetDescription 

func (s *UpdateBranchInput) SetDescription(v string) *UpdateBranchInput

SetDescription sets the Description field's value.

func (*UpdateBranchInput) SetDisplayName added in v1.20.17 

func (s *UpdateBranchInput) SetDisplayName(v string) *UpdateBranchInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateBranchInput) SetEnableAutoBuild 

func (s *UpdateBranchInput) SetEnableAutoBuild(v bool) *UpdateBranchInput

SetEnableAutoBuild sets the EnableAutoBuild field's value.

func (*UpdateBranchInput) SetEnableBasicAuth 

func (s *UpdateBranchInput) SetEnableBasicAuth(v bool) *UpdateBranchInput

SetEnableBasicAuth sets the EnableBasicAuth field's value.

func (*UpdateBranchInput) SetEnableNotification 

func (s *UpdateBranchInput) SetEnableNotification(v bool) *UpdateBranchInput

SetEnableNotification sets the EnableNotification field's value.

func (*UpdateBranchInput) SetEnablePerformanceMode added in v1.35.7 

func (s *UpdateBranchInput) SetEnablePerformanceMode(v bool) *UpdateBranchInput

SetEnablePerformanceMode sets the EnablePerformanceMode field's value.

func (*UpdateBranchInput) SetEnablePullRequestPreview added in v1.25.1 

func (s *UpdateBranchInput) SetEnablePullRequestPreview(v bool) *UpdateBranchInput

SetEnablePullRequestPreview sets the EnablePullRequestPreview field's value.

func (*UpdateBranchInput) SetEnvironmentVariables 

func (s *UpdateBranchInput) SetEnvironmentVariables(v map[string]*string) *UpdateBranchInput

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*UpdateBranchInput) SetFramework 

func (s *UpdateBranchInput) SetFramework(v string) *UpdateBranchInput

SetFramework sets the Framework field's value.

func (*UpdateBranchInput) SetPullRequestEnvironmentName added in v1.25.24 

func (s *UpdateBranchInput) SetPullRequestEnvironmentName(v string) *UpdateBranchInput

SetPullRequestEnvironmentName sets the PullRequestEnvironmentName field's value.

func (*UpdateBranchInput) SetStage 

func (s *UpdateBranchInput) SetStage(v string) *UpdateBranchInput

SetStage sets the Stage field's value.

func (*UpdateBranchInput) SetTtl 

func (s *UpdateBranchInput) SetTtl(v string) *UpdateBranchInput

SetTtl sets the Ttl field's value.

func (UpdateBranchInput) String 

func (s UpdateBranchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBranchInput) Validate 

func (s *UpdateBranchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBranchOutput 

type UpdateBranchOutput struct {

	// The branch for an Amplify app, which maps to a third-party repository branch.
	//
	// Branch is a required field
	Branch *Branch `locationName:"branch" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the update branch request.

func (UpdateBranchOutput) GoString 

func (s UpdateBranchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBranchOutput) SetBranch 

func (s *UpdateBranchOutput) SetBranch(v *Branch) *UpdateBranchOutput

SetBranch sets the Branch field's value.

func (UpdateBranchOutput) String 

func (s UpdateBranchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDomainAssociationInput 

type UpdateDomainAssociationInput struct {

	// The unique ID for an Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" min:"1" type:"string" required:"true"`

	// Sets the branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns []*string `locationName:"autoSubDomainCreationPatterns" type:"list"`

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

	// The type of SSL/TLS certificate to use for your custom domain.
	CertificateSettings *CertificateSettings `locationName:"certificateSettings" type:"structure"`

	// The name of the domain.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domainName" type:"string" required:"true"`

	// Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain *bool `locationName:"enableAutoSubDomain" type:"boolean"`

	// Describes the settings for the subdomain.
	SubDomainSettings []*SubDomainSetting `locationName:"subDomainSettings" type:"list"`
	// contains filtered or unexported fields
}

The request structure for the update domain association request.

func (UpdateDomainAssociationInput) GoString 

func (s UpdateDomainAssociationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainAssociationInput) SetAppId 

func (s *UpdateDomainAssociationInput) SetAppId(v string) *UpdateDomainAssociationInput

SetAppId sets the AppId field's value.

func (*UpdateDomainAssociationInput) SetAutoSubDomainCreationPatterns added in v1.32.9 

func (s *UpdateDomainAssociationInput) SetAutoSubDomainCreationPatterns(v []*string) *UpdateDomainAssociationInput

SetAutoSubDomainCreationPatterns sets the AutoSubDomainCreationPatterns field's value.

func (*UpdateDomainAssociationInput) SetAutoSubDomainIAMRole added in v1.32.9 

func (s *UpdateDomainAssociationInput) SetAutoSubDomainIAMRole(v string) *UpdateDomainAssociationInput

SetAutoSubDomainIAMRole sets the AutoSubDomainIAMRole field's value.

func (*UpdateDomainAssociationInput) SetCertificateSettings added in v1.50.21 

func (s *UpdateDomainAssociationInput) SetCertificateSettings(v *CertificateSettings) *UpdateDomainAssociationInput

SetCertificateSettings sets the CertificateSettings field's value.

func (*UpdateDomainAssociationInput) SetDomainName 

func (s *UpdateDomainAssociationInput) SetDomainName(v string) *UpdateDomainAssociationInput

SetDomainName sets the DomainName field's value.

func (*UpdateDomainAssociationInput) SetEnableAutoSubDomain 

func (s *UpdateDomainAssociationInput) SetEnableAutoSubDomain(v bool) *UpdateDomainAssociationInput

SetEnableAutoSubDomain sets the EnableAutoSubDomain field's value.

func (*UpdateDomainAssociationInput) SetSubDomainSettings 

func (s *UpdateDomainAssociationInput) SetSubDomainSettings(v []*SubDomainSetting) *UpdateDomainAssociationInput

SetSubDomainSettings sets the SubDomainSettings field's value.

func (UpdateDomainAssociationInput) String 

func (s UpdateDomainAssociationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainAssociationInput) Validate 

func (s *UpdateDomainAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDomainAssociationOutput 

type UpdateDomainAssociationOutput struct {

	// Describes a domain association, which associates a custom domain with an
	// Amplify app.
	//
	// DomainAssociation is a required field
	DomainAssociation *DomainAssociation `locationName:"domainAssociation" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the update domain association request.

func (UpdateDomainAssociationOutput) GoString 

func (s UpdateDomainAssociationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainAssociationOutput) SetDomainAssociation 

func (s *UpdateDomainAssociationOutput) SetDomainAssociation(v *DomainAssociation) *UpdateDomainAssociationOutput

SetDomainAssociation sets the DomainAssociation field's value.

func (UpdateDomainAssociationOutput) String 

func (s UpdateDomainAssociationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWebhookInput added in v1.20.17 

type UpdateWebhookInput struct {

	// The name for a branch that is part of an Amplify app.
	BranchName *string `locationName:"branchName" min:"1" type:"string"`

	// The description for a webhook.
	Description *string `locationName:"description" type:"string"`

	// The unique ID for a webhook.
	//
	// WebhookId is a required field
	WebhookId *string `location:"uri" locationName:"webhookId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request structure for the update webhook request.

func (UpdateWebhookInput) GoString added in v1.20.17 

func (s UpdateWebhookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWebhookInput) SetBranchName added in v1.20.17 

func (s *UpdateWebhookInput) SetBranchName(v string) *UpdateWebhookInput

SetBranchName sets the BranchName field's value.

func (*UpdateWebhookInput) SetDescription added in v1.20.17 

func (s *UpdateWebhookInput) SetDescription(v string) *UpdateWebhookInput

SetDescription sets the Description field's value.

func (*UpdateWebhookInput) SetWebhookId added in v1.20.17 

func (s *UpdateWebhookInput) SetWebhookId(v string) *UpdateWebhookInput

SetWebhookId sets the WebhookId field's value.

func (UpdateWebhookInput) String added in v1.20.17 

func (s UpdateWebhookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWebhookInput) Validate added in v1.20.17 

func (s *UpdateWebhookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWebhookOutput added in v1.20.17 

type UpdateWebhookOutput struct {

	// Describes a webhook that connects repository events to an Amplify app.
	//
	// Webhook is a required field
	Webhook *Webhook `locationName:"webhook" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result structure for the update webhook request.

func (UpdateWebhookOutput) GoString added in v1.20.17 

func (s UpdateWebhookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWebhookOutput) SetWebhook added in v1.20.17 

func (s *UpdateWebhookOutput) SetWebhook(v *Webhook) *UpdateWebhookOutput

SetWebhook sets the Webhook field's value.

func (UpdateWebhookOutput) String added in v1.20.17 

func (s UpdateWebhookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Webhook added in v1.20.17 

type Webhook struct {

	// The name for a branch that is part of an Amplify app.
	//
	// BranchName is a required field
	BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`

	// The create date and time for a webhook.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"`

	// The description for a webhook.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// Updates the date and time for a webhook.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) for the webhook.
	//
	// WebhookArn is a required field
	WebhookArn *string `locationName:"webhookArn" type:"string" required:"true"`

	// The ID of the webhook.
	//
	// WebhookId is a required field
	WebhookId *string `locationName:"webhookId" type:"string" required:"true"`

	// The URL of the webhook.
	//
	// WebhookUrl is a required field
	WebhookUrl *string `locationName:"webhookUrl" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Webhook) GoString added in v1.20.17 

func (s Webhook) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Webhook) SetBranchName added in v1.20.17 

func (s *Webhook) SetBranchName(v string) *Webhook

SetBranchName sets the BranchName field's value.

func (*Webhook) SetCreateTime added in v1.20.17 

func (s *Webhook) SetCreateTime(v time.Time) *Webhook

SetCreateTime sets the CreateTime field's value.

func (*Webhook) SetDescription added in v1.20.17 

func (s *Webhook) SetDescription(v string) *Webhook

SetDescription sets the Description field's value.

func (*Webhook) SetUpdateTime added in v1.20.17 

func (s *Webhook) SetUpdateTime(v time.Time) *Webhook

SetUpdateTime sets the UpdateTime field's value.

func (*Webhook) SetWebhookArn added in v1.20.17 

func (s *Webhook) SetWebhookArn(v string) *Webhook

SetWebhookArn sets the WebhookArn field's value.

func (*Webhook) SetWebhookId added in v1.20.17 

func (s *Webhook) SetWebhookId(v string) *Webhook

SetWebhookId sets the WebhookId field's value.

func (*Webhook) SetWebhookUrl added in v1.20.17 

func (s *Webhook) SetWebhookUrl(v string) *Webhook

SetWebhookUrl sets the WebhookUrl field's value.

func (Webhook) String added in v1.20.17 

func (s Webhook) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package amplifyiface provides an interface to enable mocking the AWS Amplify service client for testing your code.
 Package amplifyiface provides an interface to enable mocking the AWS Amplify service client for testing your code.

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.