Documentation ¶
Overview ¶
Package amplify provides the client and types for making API requests to Amplify.
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console 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 use 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 Amplify client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/amplify/#New
Index ¶
- Constants
- type App
- type Artifact
- type AutoBranchCreationConfig
- type BackendEnvironment
- type Branch
- type Client
- func (c *Client) CreateAppRequest(input *CreateAppInput) CreateAppRequest
- func (c *Client) CreateBackendEnvironmentRequest(input *CreateBackendEnvironmentInput) CreateBackendEnvironmentRequest
- func (c *Client) CreateBranchRequest(input *CreateBranchInput) CreateBranchRequest
- func (c *Client) CreateDeploymentRequest(input *CreateDeploymentInput) CreateDeploymentRequest
- func (c *Client) CreateDomainAssociationRequest(input *CreateDomainAssociationInput) CreateDomainAssociationRequest
- func (c *Client) CreateWebhookRequest(input *CreateWebhookInput) CreateWebhookRequest
- func (c *Client) DeleteAppRequest(input *DeleteAppInput) DeleteAppRequest
- func (c *Client) DeleteBackendEnvironmentRequest(input *DeleteBackendEnvironmentInput) DeleteBackendEnvironmentRequest
- func (c *Client) DeleteBranchRequest(input *DeleteBranchInput) DeleteBranchRequest
- func (c *Client) DeleteDomainAssociationRequest(input *DeleteDomainAssociationInput) DeleteDomainAssociationRequest
- func (c *Client) DeleteJobRequest(input *DeleteJobInput) DeleteJobRequest
- func (c *Client) DeleteWebhookRequest(input *DeleteWebhookInput) DeleteWebhookRequest
- func (c *Client) GenerateAccessLogsRequest(input *GenerateAccessLogsInput) GenerateAccessLogsRequest
- func (c *Client) GetAppRequest(input *GetAppInput) GetAppRequest
- func (c *Client) GetArtifactUrlRequest(input *GetArtifactUrlInput) GetArtifactUrlRequest
- func (c *Client) GetBackendEnvironmentRequest(input *GetBackendEnvironmentInput) GetBackendEnvironmentRequest
- func (c *Client) GetBranchRequest(input *GetBranchInput) GetBranchRequest
- func (c *Client) GetDomainAssociationRequest(input *GetDomainAssociationInput) GetDomainAssociationRequest
- func (c *Client) GetJobRequest(input *GetJobInput) GetJobRequest
- func (c *Client) GetWebhookRequest(input *GetWebhookInput) GetWebhookRequest
- func (c *Client) ListAppsRequest(input *ListAppsInput) ListAppsRequest
- func (c *Client) ListArtifactsRequest(input *ListArtifactsInput) ListArtifactsRequest
- func (c *Client) ListBackendEnvironmentsRequest(input *ListBackendEnvironmentsInput) ListBackendEnvironmentsRequest
- func (c *Client) ListBranchesRequest(input *ListBranchesInput) ListBranchesRequest
- func (c *Client) ListDomainAssociationsRequest(input *ListDomainAssociationsInput) ListDomainAssociationsRequest
- func (c *Client) ListJobsRequest(input *ListJobsInput) ListJobsRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) ListWebhooksRequest(input *ListWebhooksInput) ListWebhooksRequest
- func (c *Client) StartDeploymentRequest(input *StartDeploymentInput) StartDeploymentRequest
- func (c *Client) StartJobRequest(input *StartJobInput) StartJobRequest
- func (c *Client) StopJobRequest(input *StopJobInput) StopJobRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateAppRequest(input *UpdateAppInput) UpdateAppRequest
- func (c *Client) UpdateBranchRequest(input *UpdateBranchInput) UpdateBranchRequest
- func (c *Client) UpdateDomainAssociationRequest(input *UpdateDomainAssociationInput) UpdateDomainAssociationRequest
- func (c *Client) UpdateWebhookRequest(input *UpdateWebhookInput) UpdateWebhookRequest
- type CreateAppInput
- type CreateAppOutput
- type CreateAppRequest
- type CreateAppResponse
- type CreateBackendEnvironmentInput
- type CreateBackendEnvironmentOutput
- type CreateBackendEnvironmentRequest
- type CreateBackendEnvironmentResponse
- type CreateBranchInput
- type CreateBranchOutput
- type CreateBranchRequest
- type CreateBranchResponse
- type CreateDeploymentInput
- type CreateDeploymentOutput
- type CreateDeploymentRequest
- type CreateDeploymentResponse
- type CreateDomainAssociationInput
- type CreateDomainAssociationOutput
- type CreateDomainAssociationRequest
- type CreateDomainAssociationResponse
- type CreateWebhookInput
- type CreateWebhookOutput
- type CreateWebhookRequest
- type CreateWebhookResponse
- type CustomRule
- type DeleteAppInput
- type DeleteAppOutput
- type DeleteAppRequest
- type DeleteAppResponse
- type DeleteBackendEnvironmentInput
- type DeleteBackendEnvironmentOutput
- type DeleteBackendEnvironmentRequest
- type DeleteBackendEnvironmentResponse
- type DeleteBranchInput
- type DeleteBranchOutput
- type DeleteBranchRequest
- type DeleteBranchResponse
- type DeleteDomainAssociationInput
- type DeleteDomainAssociationOutput
- type DeleteDomainAssociationRequest
- type DeleteDomainAssociationResponse
- type DeleteJobInput
- type DeleteJobOutput
- type DeleteJobRequest
- type DeleteJobResponse
- type DeleteWebhookInput
- type DeleteWebhookOutput
- type DeleteWebhookRequest
- type DeleteWebhookResponse
- type DomainAssociation
- type DomainStatus
- type GenerateAccessLogsInput
- type GenerateAccessLogsOutput
- type GenerateAccessLogsRequest
- type GenerateAccessLogsResponse
- type GetAppInput
- type GetAppOutput
- type GetAppRequest
- type GetAppResponse
- type GetArtifactUrlInput
- type GetArtifactUrlOutput
- type GetArtifactUrlRequest
- type GetArtifactUrlResponse
- type GetBackendEnvironmentInput
- type GetBackendEnvironmentOutput
- type GetBackendEnvironmentRequest
- type GetBackendEnvironmentResponse
- type GetBranchInput
- type GetBranchOutput
- type GetBranchRequest
- type GetBranchResponse
- type GetDomainAssociationInput
- type GetDomainAssociationOutput
- type GetDomainAssociationRequest
- type GetDomainAssociationResponse
- type GetJobInput
- type GetJobOutput
- type GetJobRequest
- type GetJobResponse
- type GetWebhookInput
- type GetWebhookOutput
- type GetWebhookRequest
- type GetWebhookResponse
- type Job
- type JobStatus
- type JobSummary
- type JobType
- type ListAppsInput
- type ListAppsOutput
- type ListAppsRequest
- type ListAppsResponse
- type ListArtifactsInput
- type ListArtifactsOutput
- type ListArtifactsRequest
- type ListArtifactsResponse
- type ListBackendEnvironmentsInput
- type ListBackendEnvironmentsOutput
- type ListBackendEnvironmentsRequest
- type ListBackendEnvironmentsResponse
- type ListBranchesInput
- type ListBranchesOutput
- type ListBranchesRequest
- type ListBranchesResponse
- type ListDomainAssociationsInput
- type ListDomainAssociationsOutput
- type ListDomainAssociationsRequest
- type ListDomainAssociationsResponse
- type ListJobsInput
- type ListJobsOutput
- type ListJobsRequest
- type ListJobsResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type ListWebhooksInput
- type ListWebhooksOutput
- type ListWebhooksRequest
- type ListWebhooksResponse
- type Platform
- type ProductionBranch
- type Stage
- type StartDeploymentInput
- type StartDeploymentOutput
- type StartDeploymentRequest
- type StartDeploymentResponse
- type StartJobInput
- type StartJobOutput
- type StartJobRequest
- type StartJobResponse
- type Step
- type StopJobInput
- type StopJobOutput
- type StopJobRequest
- type StopJobResponse
- type SubDomain
- type SubDomainSetting
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateAppInput
- type UpdateAppOutput
- type UpdateAppRequest
- type UpdateAppResponse
- type UpdateBranchInput
- type UpdateBranchOutput
- type UpdateBranchRequest
- type UpdateBranchResponse
- type UpdateDomainAssociationInput
- type UpdateDomainAssociationOutput
- type UpdateDomainAssociationRequest
- type UpdateDomainAssociationResponse
- type UpdateWebhookInput
- type UpdateWebhookOutput
- type UpdateWebhookRequest
- type UpdateWebhookResponse
- type Webhook
Constants ¶
const ( ServiceName = "Amplify" // Service's name ServiceID = "Amplify" // Service's identifier EndpointsID = "amplify" // Service's Endpoint identifier )
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" // "UnauthorizedException". // // An operation failed due to a lack of access. ErrCodeUnauthorizedException = "UnauthorizedException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct { // The Amazon Resource Name (ARN) of the Amplify app. // // 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. BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // Describes the content of the build specification (build spec) for the Amplify // app. BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` // 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 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. // // 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" min:"1" 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. // // Platform is a required field Platform Platform `locationName:"platform" type:"string" required:"true" enum:"true"` // Describes the information about a production branch of the Amplify app. ProductionBranch *ProductionBranch `locationName:"productionBranch" type:"structure"` // The repository for the Amplify app. // // Repository is a required field Repository *string `locationName:"repository" type:"string" required:"true"` // The tag for the Amplify app. Tags map[string]string `locationName:"tags" min:"1" 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) MarshalFields ¶
func (s App) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Artifact ¶ added in v0.13.0
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) MarshalFields ¶ added in v0.13.0
func (s Artifact) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type AutoBranchCreationConfig ¶ added in v0.10.0
type AutoBranchCreationConfig struct { // The basic authorization credentials for the autocreated branch. BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The build specification (build spec) for the autocreated branch. BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` // 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 pull request preview 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 Stage `locationName:"stage" type:"string" enum:"true"` // contains filtered or unexported fields }
Describes the automated branch creation configuration.
func (AutoBranchCreationConfig) MarshalFields ¶ added in v0.10.0
func (s AutoBranchCreationConfig) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AutoBranchCreationConfig) String ¶ added in v0.10.0
func (s AutoBranchCreationConfig) String() string
String returns the string representation
func (*AutoBranchCreationConfig) Validate ¶ added in v0.10.0
func (s *AutoBranchCreationConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BackendEnvironment ¶ added in v0.18.0
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" min:"1" 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 for an Amplify app.
func (BackendEnvironment) MarshalFields ¶ added in v0.18.0
func (s BackendEnvironment) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BackendEnvironment) String ¶ added in v0.18.0
func (s BackendEnvironment) String() string
String returns the string representation
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"` // The Amazon Resource Name (ARN) for a backend environment that is part of // an Amplify app. BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string"` // The basic authorization credentials for a branch of an Amplify app. 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 *string `locationName:"buildSpec" min:"1" type:"string"` // 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 pull request preview 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 Stage `locationName:"stage" type:"string" required:"true" enum:"true"` // The tag for the branch of an Amplify app. Tags map[string]string `locationName:"tags" min:"1" 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) MarshalFields ¶
func (s Branch) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Amplify. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := amplify.New(myConfig)
func (*Client) CreateAppRequest ¶ added in v0.9.0
func (c *Client) CreateAppRequest(input *CreateAppInput) CreateAppRequest
CreateAppRequest returns a request value for making API operation for AWS Amplify.
Creates a new Amplify app.
// Example sending a request using CreateAppRequest. req := client.CreateAppRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateApp
func (*Client) CreateBackendEnvironmentRequest ¶ added in v0.18.0
func (c *Client) CreateBackendEnvironmentRequest(input *CreateBackendEnvironmentInput) CreateBackendEnvironmentRequest
CreateBackendEnvironmentRequest returns a request value for making API operation for AWS Amplify.
Creates a new backend environment for an Amplify app.
// Example sending a request using CreateBackendEnvironmentRequest. req := client.CreateBackendEnvironmentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBackendEnvironment
func (*Client) CreateBranchRequest ¶ added in v0.9.0
func (c *Client) CreateBranchRequest(input *CreateBranchInput) CreateBranchRequest
CreateBranchRequest returns a request value for making API operation for AWS Amplify.
Creates a new branch for an Amplify app.
// Example sending a request using CreateBranchRequest. req := client.CreateBranchRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranch
func (*Client) CreateDeploymentRequest ¶ added in v0.10.0
func (c *Client) CreateDeploymentRequest(input *CreateDeploymentInput) CreateDeploymentRequest
CreateDeploymentRequest returns a request value for making API operation for AWS Amplify.
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
// Example sending a request using CreateDeploymentRequest. req := client.CreateDeploymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeployment
func (*Client) CreateDomainAssociationRequest ¶ added in v0.9.0
func (c *Client) CreateDomainAssociationRequest(input *CreateDomainAssociationInput) CreateDomainAssociationRequest
CreateDomainAssociationRequest returns a request value for making API operation for AWS Amplify.
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
// Example sending a request using CreateDomainAssociationRequest. req := client.CreateDomainAssociationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociation
func (*Client) CreateWebhookRequest ¶ added in v0.10.0
func (c *Client) CreateWebhookRequest(input *CreateWebhookInput) CreateWebhookRequest
CreateWebhookRequest returns a request value for making API operation for AWS Amplify.
Creates a new webhook on an Amplify app.
// Example sending a request using CreateWebhookRequest. req := client.CreateWebhookRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhook
func (*Client) DeleteAppRequest ¶ added in v0.9.0
func (c *Client) DeleteAppRequest(input *DeleteAppInput) DeleteAppRequest
DeleteAppRequest returns a request value for making API operation for AWS Amplify.
Deletes an existing Amplify app specified by an app ID.
// Example sending a request using DeleteAppRequest. req := client.DeleteAppRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteApp
func (*Client) DeleteBackendEnvironmentRequest ¶ added in v0.18.0
func (c *Client) DeleteBackendEnvironmentRequest(input *DeleteBackendEnvironmentInput) DeleteBackendEnvironmentRequest
DeleteBackendEnvironmentRequest returns a request value for making API operation for AWS Amplify.
Deletes a backend environment for an Amplify app.
// Example sending a request using DeleteBackendEnvironmentRequest. req := client.DeleteBackendEnvironmentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBackendEnvironment
func (*Client) DeleteBranchRequest ¶ added in v0.9.0
func (c *Client) DeleteBranchRequest(input *DeleteBranchInput) DeleteBranchRequest
DeleteBranchRequest returns a request value for making API operation for AWS Amplify.
Deletes a branch for an Amplify app.
// Example sending a request using DeleteBranchRequest. req := client.DeleteBranchRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranch
func (*Client) DeleteDomainAssociationRequest ¶ added in v0.9.0
func (c *Client) DeleteDomainAssociationRequest(input *DeleteDomainAssociationInput) DeleteDomainAssociationRequest
DeleteDomainAssociationRequest returns a request value for making API operation for AWS Amplify.
Deletes a domain association for an Amplify app.
// Example sending a request using DeleteDomainAssociationRequest. req := client.DeleteDomainAssociationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociation
func (*Client) DeleteJobRequest ¶ added in v0.9.0
func (c *Client) DeleteJobRequest(input *DeleteJobInput) DeleteJobRequest
DeleteJobRequest returns a request value for making API operation for AWS Amplify.
Deletes a job for a branch of an Amplify app.
// Example sending a request using DeleteJobRequest. req := client.DeleteJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJob
func (*Client) DeleteWebhookRequest ¶ added in v0.10.0
func (c *Client) DeleteWebhookRequest(input *DeleteWebhookInput) DeleteWebhookRequest
DeleteWebhookRequest returns a request value for making API operation for AWS Amplify.
Deletes a webhook.
// Example sending a request using DeleteWebhookRequest. req := client.DeleteWebhookRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhook
func (*Client) GenerateAccessLogsRequest ¶ added in v0.13.0
func (c *Client) GenerateAccessLogsRequest(input *GenerateAccessLogsInput) GenerateAccessLogsRequest
GenerateAccessLogsRequest returns a request value for making API operation for AWS Amplify.
Returns the website access logs for a specific time range using a presigned URL.
// Example sending a request using GenerateAccessLogsRequest. req := client.GenerateAccessLogsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GenerateAccessLogs
func (*Client) GetAppRequest ¶ added in v0.9.0
func (c *Client) GetAppRequest(input *GetAppInput) GetAppRequest
GetAppRequest returns a request value for making API operation for AWS Amplify.
Returns an existing Amplify app by appID.
// Example sending a request using GetAppRequest. req := client.GetAppRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetApp
func (*Client) GetArtifactUrlRequest ¶ added in v0.13.0
func (c *Client) GetArtifactUrlRequest(input *GetArtifactUrlInput) GetArtifactUrlRequest
GetArtifactUrlRequest returns a request value for making API operation for AWS Amplify.
Returns the artifact info that corresponds to an artifact id.
// Example sending a request using GetArtifactUrlRequest. req := client.GetArtifactUrlRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetArtifactUrl
func (*Client) GetBackendEnvironmentRequest ¶ added in v0.18.0
func (c *Client) GetBackendEnvironmentRequest(input *GetBackendEnvironmentInput) GetBackendEnvironmentRequest
GetBackendEnvironmentRequest returns a request value for making API operation for AWS Amplify.
Returns a backend environment for an Amplify app.
// Example sending a request using GetBackendEnvironmentRequest. req := client.GetBackendEnvironmentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBackendEnvironment
func (*Client) GetBranchRequest ¶ added in v0.9.0
func (c *Client) GetBranchRequest(input *GetBranchInput) GetBranchRequest
GetBranchRequest returns a request value for making API operation for AWS Amplify.
Returns a branch for an Amplify app.
// Example sending a request using GetBranchRequest. req := client.GetBranchRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranch
func (*Client) GetDomainAssociationRequest ¶ added in v0.9.0
func (c *Client) GetDomainAssociationRequest(input *GetDomainAssociationInput) GetDomainAssociationRequest
GetDomainAssociationRequest returns a request value for making API operation for AWS Amplify.
Returns the domain information for an Amplify app.
// Example sending a request using GetDomainAssociationRequest. req := client.GetDomainAssociationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociation
func (*Client) GetJobRequest ¶ added in v0.9.0
func (c *Client) GetJobRequest(input *GetJobInput) GetJobRequest
GetJobRequest returns a request value for making API operation for AWS Amplify.
Returns a job for a branch of an Amplify app.
// Example sending a request using GetJobRequest. req := client.GetJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJob
func (*Client) GetWebhookRequest ¶ added in v0.10.0
func (c *Client) GetWebhookRequest(input *GetWebhookInput) GetWebhookRequest
GetWebhookRequest returns a request value for making API operation for AWS Amplify.
Returns the webhook information that corresponds to a specified webhook ID.
// Example sending a request using GetWebhookRequest. req := client.GetWebhookRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhook
func (*Client) ListAppsRequest ¶ added in v0.9.0
func (c *Client) ListAppsRequest(input *ListAppsInput) ListAppsRequest
ListAppsRequest returns a request value for making API operation for AWS Amplify.
Returns a list of the existing Amplify apps.
// Example sending a request using ListAppsRequest. req := client.ListAppsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListApps
func (*Client) ListArtifactsRequest ¶ added in v0.13.0
func (c *Client) ListArtifactsRequest(input *ListArtifactsInput) ListArtifactsRequest
ListArtifactsRequest returns a request value for making API operation for AWS Amplify.
Returns a list of artifacts for a specified app, branch, and job.
// Example sending a request using ListArtifactsRequest. req := client.ListArtifactsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListArtifacts
func (*Client) ListBackendEnvironmentsRequest ¶ added in v0.18.0
func (c *Client) ListBackendEnvironmentsRequest(input *ListBackendEnvironmentsInput) ListBackendEnvironmentsRequest
ListBackendEnvironmentsRequest returns a request value for making API operation for AWS Amplify.
Lists the backend environments for an Amplify app.
// Example sending a request using ListBackendEnvironmentsRequest. req := client.ListBackendEnvironmentsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironments
func (*Client) ListBranchesRequest ¶ added in v0.9.0
func (c *Client) ListBranchesRequest(input *ListBranchesInput) ListBranchesRequest
ListBranchesRequest returns a request value for making API operation for AWS Amplify.
Lists the branches of an Amplify app.
// Example sending a request using ListBranchesRequest. req := client.ListBranchesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranches
func (*Client) ListDomainAssociationsRequest ¶ added in v0.9.0
func (c *Client) ListDomainAssociationsRequest(input *ListDomainAssociationsInput) ListDomainAssociationsRequest
ListDomainAssociationsRequest returns a request value for making API operation for AWS Amplify.
Returns the domain associations for an Amplify app.
// Example sending a request using ListDomainAssociationsRequest. req := client.ListDomainAssociationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociations
func (*Client) ListJobsRequest ¶ added in v0.9.0
func (c *Client) ListJobsRequest(input *ListJobsInput) ListJobsRequest
ListJobsRequest returns a request value for making API operation for AWS Amplify.
Lists the jobs for a branch of an Amplify app.
// Example sending a request using ListJobsRequest. req := client.ListJobsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobs
func (*Client) ListTagsForResourceRequest ¶ added in v0.10.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for AWS Amplify.
Returns a list of tags for a specified Amazon Resource Name (ARN).
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResource
func (*Client) ListWebhooksRequest ¶ added in v0.10.0
func (c *Client) ListWebhooksRequest(input *ListWebhooksInput) ListWebhooksRequest
ListWebhooksRequest returns a request value for making API operation for AWS Amplify.
Returns a list of webhooks for an Amplify app.
// Example sending a request using ListWebhooksRequest. req := client.ListWebhooksRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListWebhooks
func (*Client) StartDeploymentRequest ¶ added in v0.10.0
func (c *Client) StartDeploymentRequest(input *StartDeploymentInput) StartDeploymentRequest
StartDeploymentRequest returns a request value for making API operation for AWS Amplify.
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
// Example sending a request using StartDeploymentRequest. req := client.StartDeploymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeployment
func (*Client) StartJobRequest ¶ added in v0.9.0
func (c *Client) StartJobRequest(input *StartJobInput) StartJobRequest
StartJobRequest returns a request value for making API operation for AWS Amplify.
Starts a new job for a branch of an Amplify app.
// Example sending a request using StartJobRequest. req := client.StartJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJob
func (*Client) StopJobRequest ¶ added in v0.9.0
func (c *Client) StopJobRequest(input *StopJobInput) StopJobRequest
StopJobRequest returns a request value for making API operation for AWS Amplify.
Stops a job that is in progress for a branch of an Amplify app.
// Example sending a request using StopJobRequest. req := client.StopJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJob
func (*Client) TagResourceRequest ¶ added in v0.10.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for AWS Amplify.
Tags the resource with a tag key and value.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.10.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for AWS Amplify.
Untags a resource with a specified Amazon Resource Name (ARN).
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResource
func (*Client) UpdateAppRequest ¶ added in v0.9.0
func (c *Client) UpdateAppRequest(input *UpdateAppInput) UpdateAppRequest
UpdateAppRequest returns a request value for making API operation for AWS Amplify.
Updates an existing Amplify app.
// Example sending a request using UpdateAppRequest. req := client.UpdateAppRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateApp
func (*Client) UpdateBranchRequest ¶ added in v0.9.0
func (c *Client) UpdateBranchRequest(input *UpdateBranchInput) UpdateBranchRequest
UpdateBranchRequest returns a request value for making API operation for AWS Amplify.
Updates a branch for an Amplify app.
// Example sending a request using UpdateBranchRequest. req := client.UpdateBranchRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranch
func (*Client) UpdateDomainAssociationRequest ¶ added in v0.9.0
func (c *Client) UpdateDomainAssociationRequest(input *UpdateDomainAssociationInput) UpdateDomainAssociationRequest
UpdateDomainAssociationRequest returns a request value for making API operation for AWS Amplify.
Creates a new domain association for an Amplify app.
// Example sending a request using UpdateDomainAssociationRequest. req := client.UpdateDomainAssociationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociation
func (*Client) UpdateWebhookRequest ¶ added in v0.10.0
func (c *Client) UpdateWebhookRequest(input *UpdateWebhookInput) UpdateWebhookRequest
UpdateWebhookRequest returns a request value for making API operation for AWS Amplify.
Updates a webhook.
// Example sending a request using UpdateWebhookRequest. req := client.UpdateWebhookRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhook
type CreateAppInput ¶
type CreateAppInput struct { // The personal access token for a third-party source control system for an // Amplify app. The personal access token is used to create a webhook and a // read-only deploy key. The token is not stored. AccessToken *string `locationName:"accessToken" min:"1" type:"string" sensitive:"true"` // The automated branch creation configuration for the Amplify app. AutoBranchCreationConfig *AutoBranchCreationConfig `locationName:"autoBranchCreationConfig" type:"structure"` // The automated branch creation glob patterns for the Amplify app. AutoBranchCreationPatterns []string `locationName:"autoBranchCreationPatterns" type:"list"` // The credentials for basic authorization for an Amplify app. BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The build specification (build spec) for an Amplify app. BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` // The custom rewrite and redirect 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 the 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. 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" min:"1" type:"string"` // The name for 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. The // OAuth token is not stored. OauthToken *string `locationName:"oauthToken" type:"string" sensitive:"true"` // The platform or framework for an Amplify app. Platform Platform `locationName:"platform" type:"string" enum:"true"` // The repository for an Amplify app. Repository *string `locationName:"repository" type:"string"` // The tag for an Amplify app. Tags map[string]string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
The request structure used to create apps in Amplify.
func (CreateAppInput) MarshalFields ¶
func (s CreateAppInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateAppInput) String ¶
func (s CreateAppInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s CreateAppOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateAppOutput) String ¶
func (s CreateAppOutput) String() string
String returns the string representation
type CreateAppRequest ¶
type CreateAppRequest struct { *aws.Request Input *CreateAppInput Copy func(*CreateAppInput) CreateAppRequest }
CreateAppRequest is the request type for the CreateApp API operation.
func (CreateAppRequest) Send ¶
func (r CreateAppRequest) Send(ctx context.Context) (*CreateAppResponse, error)
Send marshals and sends the CreateApp API request.
type CreateAppResponse ¶ added in v0.9.0
type CreateAppResponse struct { *CreateAppOutput // contains filtered or unexported fields }
CreateAppResponse is the response type for the CreateApp API operation.
func (*CreateAppResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateAppResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateApp request.
type CreateBackendEnvironmentInput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s CreateBackendEnvironmentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateBackendEnvironmentInput) String ¶ added in v0.18.0
func (s CreateBackendEnvironmentInput) String() string
String returns the string representation
func (*CreateBackendEnvironmentInput) Validate ¶ added in v0.18.0
func (s *CreateBackendEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBackendEnvironmentOutput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s CreateBackendEnvironmentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateBackendEnvironmentOutput) String ¶ added in v0.18.0
func (s CreateBackendEnvironmentOutput) String() string
String returns the string representation
type CreateBackendEnvironmentRequest ¶ added in v0.18.0
type CreateBackendEnvironmentRequest struct { *aws.Request Input *CreateBackendEnvironmentInput Copy func(*CreateBackendEnvironmentInput) CreateBackendEnvironmentRequest }
CreateBackendEnvironmentRequest is the request type for the CreateBackendEnvironment API operation.
func (CreateBackendEnvironmentRequest) Send ¶ added in v0.18.0
func (r CreateBackendEnvironmentRequest) Send(ctx context.Context) (*CreateBackendEnvironmentResponse, error)
Send marshals and sends the CreateBackendEnvironment API request.
type CreateBackendEnvironmentResponse ¶ added in v0.18.0
type CreateBackendEnvironmentResponse struct { *CreateBackendEnvironmentOutput // contains filtered or unexported fields }
CreateBackendEnvironmentResponse is the response type for the CreateBackendEnvironment API operation.
func (*CreateBackendEnvironmentResponse) SDKResponseMetdata ¶ added in v0.18.0
func (r *CreateBackendEnvironmentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateBackendEnvironment request.
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 Amazon Resource Name (ARN) for a backend environment that is part of // an Amplify app. BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string"` // The basic authorization credentials for the branch. 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 *string `locationName:"buildSpec" min:"1" type:"string"` // 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 pull request preview 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 Stage `locationName:"stage" type:"string" enum:"true"` // The tag for the branch. Tags map[string]string `locationName:"tags" min:"1" 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) MarshalFields ¶
func (s CreateBranchInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateBranchInput) String ¶
func (s CreateBranchInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s CreateBranchOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateBranchOutput) String ¶
func (s CreateBranchOutput) String() string
String returns the string representation
type CreateBranchRequest ¶
type CreateBranchRequest struct { *aws.Request Input *CreateBranchInput Copy func(*CreateBranchInput) CreateBranchRequest }
CreateBranchRequest is the request type for the CreateBranch API operation.
func (CreateBranchRequest) Send ¶
func (r CreateBranchRequest) Send(ctx context.Context) (*CreateBranchResponse, error)
Send marshals and sends the CreateBranch API request.
type CreateBranchResponse ¶ added in v0.9.0
type CreateBranchResponse struct { *CreateBranchOutput // contains filtered or unexported fields }
CreateBranchResponse is the response type for the CreateBranch API operation.
func (*CreateBranchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateBranchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateBranch request.
type CreateDeploymentInput ¶ added in v0.10.0
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 for the branch, 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) MarshalFields ¶ added in v0.10.0
func (s CreateDeploymentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDeploymentInput) String ¶ added in v0.10.0
func (s CreateDeploymentInput) String() string
String returns the string representation
func (*CreateDeploymentInput) Validate ¶ added in v0.10.0
func (s *CreateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDeploymentOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s CreateDeploymentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDeploymentOutput) String ¶ added in v0.10.0
func (s CreateDeploymentOutput) String() string
String returns the string representation
type CreateDeploymentRequest ¶ added in v0.10.0
type CreateDeploymentRequest struct { *aws.Request Input *CreateDeploymentInput Copy func(*CreateDeploymentInput) CreateDeploymentRequest }
CreateDeploymentRequest is the request type for the CreateDeployment API operation.
func (CreateDeploymentRequest) Send ¶ added in v0.10.0
func (r CreateDeploymentRequest) Send(ctx context.Context) (*CreateDeploymentResponse, error)
Send marshals and sends the CreateDeployment API request.
type CreateDeploymentResponse ¶ added in v0.10.0
type CreateDeploymentResponse struct { *CreateDeploymentOutput // contains filtered or unexported fields }
CreateDeploymentResponse is the response type for the CreateDeployment API operation.
func (*CreateDeploymentResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *CreateDeploymentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDeployment request.
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 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) MarshalFields ¶
func (s CreateDomainAssociationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDomainAssociationInput) String ¶
func (s CreateDomainAssociationInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s CreateDomainAssociationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDomainAssociationOutput) String ¶
func (s CreateDomainAssociationOutput) String() string
String returns the string representation
type CreateDomainAssociationRequest ¶
type CreateDomainAssociationRequest struct { *aws.Request Input *CreateDomainAssociationInput Copy func(*CreateDomainAssociationInput) CreateDomainAssociationRequest }
CreateDomainAssociationRequest is the request type for the CreateDomainAssociation API operation.
func (CreateDomainAssociationRequest) Send ¶
func (r CreateDomainAssociationRequest) Send(ctx context.Context) (*CreateDomainAssociationResponse, error)
Send marshals and sends the CreateDomainAssociation API request.
type CreateDomainAssociationResponse ¶ added in v0.9.0
type CreateDomainAssociationResponse struct { *CreateDomainAssociationOutput // contains filtered or unexported fields }
CreateDomainAssociationResponse is the response type for the CreateDomainAssociation API operation.
func (*CreateDomainAssociationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateDomainAssociationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDomainAssociation request.
type CreateWebhookInput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s CreateWebhookInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateWebhookInput) String ¶ added in v0.10.0
func (s CreateWebhookInput) String() string
String returns the string representation
func (*CreateWebhookInput) Validate ¶ added in v0.10.0
func (s *CreateWebhookInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateWebhookOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s CreateWebhookOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateWebhookOutput) String ¶ added in v0.10.0
func (s CreateWebhookOutput) String() string
String returns the string representation
type CreateWebhookRequest ¶ added in v0.10.0
type CreateWebhookRequest struct { *aws.Request Input *CreateWebhookInput Copy func(*CreateWebhookInput) CreateWebhookRequest }
CreateWebhookRequest is the request type for the CreateWebhook API operation.
func (CreateWebhookRequest) Send ¶ added in v0.10.0
func (r CreateWebhookRequest) Send(ctx context.Context) (*CreateWebhookResponse, error)
Send marshals and sends the CreateWebhook API request.
type CreateWebhookResponse ¶ added in v0.10.0
type CreateWebhookResponse struct { *CreateWebhookOutput // contains filtered or unexported fields }
CreateWebhookResponse is the response type for the CreateWebhook API operation.
func (*CreateWebhookResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *CreateWebhookResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateWebhook request.
type CustomRule ¶
type CustomRule struct { // The condition for a URL rewrite or redirect rule, such as a country code. Condition *string `locationName:"condition" min:"1" 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. 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) MarshalFields ¶
func (s CustomRule) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CustomRule) String ¶
func (s CustomRule) String() string
String returns the string representation
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) MarshalFields ¶
func (s DeleteAppInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteAppInput) String ¶
func (s DeleteAppInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s DeleteAppOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteAppOutput) String ¶
func (s DeleteAppOutput) String() string
String returns the string representation
type DeleteAppRequest ¶
type DeleteAppRequest struct { *aws.Request Input *DeleteAppInput Copy func(*DeleteAppInput) DeleteAppRequest }
DeleteAppRequest is the request type for the DeleteApp API operation.
func (DeleteAppRequest) Send ¶
func (r DeleteAppRequest) Send(ctx context.Context) (*DeleteAppResponse, error)
Send marshals and sends the DeleteApp API request.
type DeleteAppResponse ¶ added in v0.9.0
type DeleteAppResponse struct { *DeleteAppOutput // contains filtered or unexported fields }
DeleteAppResponse is the response type for the DeleteApp API operation.
func (*DeleteAppResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteAppResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApp request.
type DeleteBackendEnvironmentInput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s DeleteBackendEnvironmentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteBackendEnvironmentInput) String ¶ added in v0.18.0
func (s DeleteBackendEnvironmentInput) String() string
String returns the string representation
func (*DeleteBackendEnvironmentInput) Validate ¶ added in v0.18.0
func (s *DeleteBackendEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackendEnvironmentOutput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s DeleteBackendEnvironmentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteBackendEnvironmentOutput) String ¶ added in v0.18.0
func (s DeleteBackendEnvironmentOutput) String() string
String returns the string representation
type DeleteBackendEnvironmentRequest ¶ added in v0.18.0
type DeleteBackendEnvironmentRequest struct { *aws.Request Input *DeleteBackendEnvironmentInput Copy func(*DeleteBackendEnvironmentInput) DeleteBackendEnvironmentRequest }
DeleteBackendEnvironmentRequest is the request type for the DeleteBackendEnvironment API operation.
func (DeleteBackendEnvironmentRequest) Send ¶ added in v0.18.0
func (r DeleteBackendEnvironmentRequest) Send(ctx context.Context) (*DeleteBackendEnvironmentResponse, error)
Send marshals and sends the DeleteBackendEnvironment API request.
type DeleteBackendEnvironmentResponse ¶ added in v0.18.0
type DeleteBackendEnvironmentResponse struct { *DeleteBackendEnvironmentOutput // contains filtered or unexported fields }
DeleteBackendEnvironmentResponse is the response type for the DeleteBackendEnvironment API operation.
func (*DeleteBackendEnvironmentResponse) SDKResponseMetdata ¶ added in v0.18.0
func (r *DeleteBackendEnvironmentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteBackendEnvironment request.
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 for 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) MarshalFields ¶
func (s DeleteBranchInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteBranchInput) String ¶
func (s DeleteBranchInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s DeleteBranchOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteBranchOutput) String ¶
func (s DeleteBranchOutput) String() string
String returns the string representation
type DeleteBranchRequest ¶
type DeleteBranchRequest struct { *aws.Request Input *DeleteBranchInput Copy func(*DeleteBranchInput) DeleteBranchRequest }
DeleteBranchRequest is the request type for the DeleteBranch API operation.
func (DeleteBranchRequest) Send ¶
func (r DeleteBranchRequest) Send(ctx context.Context) (*DeleteBranchResponse, error)
Send marshals and sends the DeleteBranch API request.
type DeleteBranchResponse ¶ added in v0.9.0
type DeleteBranchResponse struct { *DeleteBranchOutput // contains filtered or unexported fields }
DeleteBranchResponse is the response type for the DeleteBranch API operation.
func (*DeleteBranchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteBranchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteBranch request.
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) MarshalFields ¶
func (s DeleteDomainAssociationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDomainAssociationInput) String ¶
func (s DeleteDomainAssociationInput) String() string
String returns the string representation
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 a domain association that 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 }
func (DeleteDomainAssociationOutput) MarshalFields ¶
func (s DeleteDomainAssociationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDomainAssociationOutput) String ¶
func (s DeleteDomainAssociationOutput) String() string
String returns the string representation
type DeleteDomainAssociationRequest ¶
type DeleteDomainAssociationRequest struct { *aws.Request Input *DeleteDomainAssociationInput Copy func(*DeleteDomainAssociationInput) DeleteDomainAssociationRequest }
DeleteDomainAssociationRequest is the request type for the DeleteDomainAssociation API operation.
func (DeleteDomainAssociationRequest) Send ¶
func (r DeleteDomainAssociationRequest) Send(ctx context.Context) (*DeleteDomainAssociationResponse, error)
Send marshals and sends the DeleteDomainAssociation API request.
type DeleteDomainAssociationResponse ¶ added in v0.9.0
type DeleteDomainAssociationResponse struct { *DeleteDomainAssociationOutput // contains filtered or unexported fields }
DeleteDomainAssociationResponse is the response type for the DeleteDomainAssociation API operation.
func (*DeleteDomainAssociationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteDomainAssociationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteDomainAssociation request.
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 for the branch, 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) MarshalFields ¶
func (s DeleteJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteJobInput) String ¶
func (s DeleteJobInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s DeleteJobOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteJobOutput) String ¶
func (s DeleteJobOutput) String() string
String returns the string representation
type DeleteJobRequest ¶
type DeleteJobRequest struct { *aws.Request Input *DeleteJobInput Copy func(*DeleteJobInput) DeleteJobRequest }
DeleteJobRequest is the request type for the DeleteJob API operation.
func (DeleteJobRequest) Send ¶
func (r DeleteJobRequest) Send(ctx context.Context) (*DeleteJobResponse, error)
Send marshals and sends the DeleteJob API request.
type DeleteJobResponse ¶ added in v0.9.0
type DeleteJobResponse struct { *DeleteJobOutput // contains filtered or unexported fields }
DeleteJobResponse is the response type for the DeleteJob API operation.
func (*DeleteJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteJob request.
type DeleteWebhookInput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s DeleteWebhookInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteWebhookInput) String ¶ added in v0.10.0
func (s DeleteWebhookInput) String() string
String returns the string representation
func (*DeleteWebhookInput) Validate ¶ added in v0.10.0
func (s *DeleteWebhookInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteWebhookOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s DeleteWebhookOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteWebhookOutput) String ¶ added in v0.10.0
func (s DeleteWebhookOutput) String() string
String returns the string representation
type DeleteWebhookRequest ¶ added in v0.10.0
type DeleteWebhookRequest struct { *aws.Request Input *DeleteWebhookInput Copy func(*DeleteWebhookInput) DeleteWebhookRequest }
DeleteWebhookRequest is the request type for the DeleteWebhook API operation.
func (DeleteWebhookRequest) Send ¶ added in v0.10.0
func (r DeleteWebhookRequest) Send(ctx context.Context) (*DeleteWebhookResponse, error)
Send marshals and sends the DeleteWebhook API request.
type DeleteWebhookResponse ¶ added in v0.10.0
type DeleteWebhookResponse struct { *DeleteWebhookOutput // contains filtered or unexported fields }
DeleteWebhookResponse is the response type for the DeleteWebhook API operation.
func (*DeleteWebhookResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *DeleteWebhookResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteWebhook request.
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"` // 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 DomainStatus `locationName:"domainStatus" type:"string" required:"true" enum:"true"` // Enables the automated creation of subdomains for branches. // // EnableAutoSubDomain is a required field EnableAutoSubDomain *bool `locationName:"enableAutoSubDomain" type:"boolean" required:"true"` // The reason for the current status of the domain association. // // 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"` // contains filtered or unexported fields }
Describes a domain association that associates a custom domain with an Amplify app.
func (DomainAssociation) MarshalFields ¶
func (s DomainAssociation) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DomainAssociation) String ¶
func (s DomainAssociation) String() string
String returns the string representation
type DomainStatus ¶
type DomainStatus string
const ( DomainStatusPendingVerification DomainStatus = "PENDING_VERIFICATION" DomainStatusInProgress DomainStatus = "IN_PROGRESS" DomainStatusAvailable DomainStatus = "AVAILABLE" DomainStatusPendingDeployment DomainStatus = "PENDING_DEPLOYMENT" DomainStatusFailed DomainStatus = "FAILED" DomainStatusCreating DomainStatus = "CREATING" DomainStatusRequestingCertificate DomainStatus = "REQUESTING_CERTIFICATE" DomainStatusUpdating DomainStatus = "UPDATING" )
Enum values for DomainStatus
func (DomainStatus) MarshalValue ¶
func (enum DomainStatus) MarshalValue() (string, error)
func (DomainStatus) MarshalValueBuf ¶
func (enum DomainStatus) MarshalValueBuf(b []byte) ([]byte, error)
type GenerateAccessLogsInput ¶ added in v0.13.0
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) MarshalFields ¶ added in v0.13.0
func (s GenerateAccessLogsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GenerateAccessLogsInput) String ¶ added in v0.13.0
func (s GenerateAccessLogsInput) String() string
String returns the string representation
func (*GenerateAccessLogsInput) Validate ¶ added in v0.13.0
func (s *GenerateAccessLogsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GenerateAccessLogsOutput ¶ added in v0.13.0
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) MarshalFields ¶ added in v0.13.0
func (s GenerateAccessLogsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GenerateAccessLogsOutput) String ¶ added in v0.13.0
func (s GenerateAccessLogsOutput) String() string
String returns the string representation
type GenerateAccessLogsRequest ¶ added in v0.13.0
type GenerateAccessLogsRequest struct { *aws.Request Input *GenerateAccessLogsInput Copy func(*GenerateAccessLogsInput) GenerateAccessLogsRequest }
GenerateAccessLogsRequest is the request type for the GenerateAccessLogs API operation.
func (GenerateAccessLogsRequest) Send ¶ added in v0.13.0
func (r GenerateAccessLogsRequest) Send(ctx context.Context) (*GenerateAccessLogsResponse, error)
Send marshals and sends the GenerateAccessLogs API request.
type GenerateAccessLogsResponse ¶ added in v0.13.0
type GenerateAccessLogsResponse struct { *GenerateAccessLogsOutput // contains filtered or unexported fields }
GenerateAccessLogsResponse is the response type for the GenerateAccessLogs API operation.
func (*GenerateAccessLogsResponse) SDKResponseMetdata ¶ added in v0.13.0
func (r *GenerateAccessLogsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GenerateAccessLogs request.
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) MarshalFields ¶
func (s GetAppInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAppInput) String ¶
func (s GetAppInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s GetAppOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAppOutput) String ¶
func (s GetAppOutput) String() string
String returns the string representation
type GetAppRequest ¶
type GetAppRequest struct { *aws.Request Input *GetAppInput Copy func(*GetAppInput) GetAppRequest }
GetAppRequest is the request type for the GetApp API operation.
func (GetAppRequest) Send ¶
func (r GetAppRequest) Send(ctx context.Context) (*GetAppResponse, error)
Send marshals and sends the GetApp API request.
type GetAppResponse ¶ added in v0.9.0
type GetAppResponse struct { *GetAppOutput // contains filtered or unexported fields }
GetAppResponse is the response type for the GetApp API operation.
func (*GetAppResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetAppResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetApp request.
type GetArtifactUrlInput ¶ added in v0.13.0
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) MarshalFields ¶ added in v0.13.0
func (s GetArtifactUrlInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetArtifactUrlInput) String ¶ added in v0.13.0
func (s GetArtifactUrlInput) String() string
String returns the string representation
func (*GetArtifactUrlInput) Validate ¶ added in v0.13.0
func (s *GetArtifactUrlInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetArtifactUrlOutput ¶ added in v0.13.0
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) MarshalFields ¶ added in v0.13.0
func (s GetArtifactUrlOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetArtifactUrlOutput) String ¶ added in v0.13.0
func (s GetArtifactUrlOutput) String() string
String returns the string representation
type GetArtifactUrlRequest ¶ added in v0.13.0
type GetArtifactUrlRequest struct { *aws.Request Input *GetArtifactUrlInput Copy func(*GetArtifactUrlInput) GetArtifactUrlRequest }
GetArtifactUrlRequest is the request type for the GetArtifactUrl API operation.
func (GetArtifactUrlRequest) Send ¶ added in v0.13.0
func (r GetArtifactUrlRequest) Send(ctx context.Context) (*GetArtifactUrlResponse, error)
Send marshals and sends the GetArtifactUrl API request.
type GetArtifactUrlResponse ¶ added in v0.13.0
type GetArtifactUrlResponse struct { *GetArtifactUrlOutput // contains filtered or unexported fields }
GetArtifactUrlResponse is the response type for the GetArtifactUrl API operation.
func (*GetArtifactUrlResponse) SDKResponseMetdata ¶ added in v0.13.0
func (r *GetArtifactUrlResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetArtifactUrl request.
type GetBackendEnvironmentInput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s GetBackendEnvironmentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBackendEnvironmentInput) String ¶ added in v0.18.0
func (s GetBackendEnvironmentInput) String() string
String returns the string representation
func (*GetBackendEnvironmentInput) Validate ¶ added in v0.18.0
func (s *GetBackendEnvironmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBackendEnvironmentOutput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s GetBackendEnvironmentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBackendEnvironmentOutput) String ¶ added in v0.18.0
func (s GetBackendEnvironmentOutput) String() string
String returns the string representation
type GetBackendEnvironmentRequest ¶ added in v0.18.0
type GetBackendEnvironmentRequest struct { *aws.Request Input *GetBackendEnvironmentInput Copy func(*GetBackendEnvironmentInput) GetBackendEnvironmentRequest }
GetBackendEnvironmentRequest is the request type for the GetBackendEnvironment API operation.
func (GetBackendEnvironmentRequest) Send ¶ added in v0.18.0
func (r GetBackendEnvironmentRequest) Send(ctx context.Context) (*GetBackendEnvironmentResponse, error)
Send marshals and sends the GetBackendEnvironment API request.
type GetBackendEnvironmentResponse ¶ added in v0.18.0
type GetBackendEnvironmentResponse struct { *GetBackendEnvironmentOutput // contains filtered or unexported fields }
GetBackendEnvironmentResponse is the response type for the GetBackendEnvironment API operation.
func (*GetBackendEnvironmentResponse) SDKResponseMetdata ¶ added in v0.18.0
func (r *GetBackendEnvironmentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetBackendEnvironment request.
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 for 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) MarshalFields ¶
func (s GetBranchInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBranchInput) String ¶
func (s GetBranchInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s GetBranchOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBranchOutput) String ¶
func (s GetBranchOutput) String() string
String returns the string representation
type GetBranchRequest ¶
type GetBranchRequest struct { *aws.Request Input *GetBranchInput Copy func(*GetBranchInput) GetBranchRequest }
GetBranchRequest is the request type for the GetBranch API operation.
func (GetBranchRequest) Send ¶
func (r GetBranchRequest) Send(ctx context.Context) (*GetBranchResponse, error)
Send marshals and sends the GetBranch API request.
type GetBranchResponse ¶ added in v0.9.0
type GetBranchResponse struct { *GetBranchOutput // contains filtered or unexported fields }
GetBranchResponse is the response type for the GetBranch API operation.
func (*GetBranchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetBranchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetBranch request.
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) MarshalFields ¶
func (s GetDomainAssociationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDomainAssociationInput) String ¶
func (s GetDomainAssociationInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s GetDomainAssociationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDomainAssociationOutput) String ¶
func (s GetDomainAssociationOutput) String() string
String returns the string representation
type GetDomainAssociationRequest ¶
type GetDomainAssociationRequest struct { *aws.Request Input *GetDomainAssociationInput Copy func(*GetDomainAssociationInput) GetDomainAssociationRequest }
GetDomainAssociationRequest is the request type for the GetDomainAssociation API operation.
func (GetDomainAssociationRequest) Send ¶
func (r GetDomainAssociationRequest) Send(ctx context.Context) (*GetDomainAssociationResponse, error)
Send marshals and sends the GetDomainAssociation API request.
type GetDomainAssociationResponse ¶ added in v0.9.0
type GetDomainAssociationResponse struct { *GetDomainAssociationOutput // contains filtered or unexported fields }
GetDomainAssociationResponse is the response type for the GetDomainAssociation API operation.
func (*GetDomainAssociationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDomainAssociationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDomainAssociation request.
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 branch name 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) MarshalFields ¶
func (s GetJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetJobInput) String ¶
func (s GetJobInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s GetJobOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetJobOutput) String ¶
func (s GetJobOutput) String() string
String returns the string representation
type GetJobRequest ¶
type GetJobRequest struct { *aws.Request Input *GetJobInput Copy func(*GetJobInput) GetJobRequest }
GetJobRequest is the request type for the GetJob API operation.
func (GetJobRequest) Send ¶
func (r GetJobRequest) Send(ctx context.Context) (*GetJobResponse, error)
Send marshals and sends the GetJob API request.
type GetJobResponse ¶ added in v0.9.0
type GetJobResponse struct { *GetJobOutput // contains filtered or unexported fields }
GetJobResponse is the response type for the GetJob API operation.
func (*GetJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetJob request.
type GetWebhookInput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s GetWebhookInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetWebhookInput) String ¶ added in v0.10.0
func (s GetWebhookInput) String() string
String returns the string representation
func (*GetWebhookInput) Validate ¶ added in v0.10.0
func (s *GetWebhookInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetWebhookOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s GetWebhookOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetWebhookOutput) String ¶ added in v0.10.0
func (s GetWebhookOutput) String() string
String returns the string representation
type GetWebhookRequest ¶ added in v0.10.0
type GetWebhookRequest struct { *aws.Request Input *GetWebhookInput Copy func(*GetWebhookInput) GetWebhookRequest }
GetWebhookRequest is the request type for the GetWebhook API operation.
func (GetWebhookRequest) Send ¶ added in v0.10.0
func (r GetWebhookRequest) Send(ctx context.Context) (*GetWebhookResponse, error)
Send marshals and sends the GetWebhook API request.
type GetWebhookResponse ¶ added in v0.10.0
type GetWebhookResponse struct { *GetWebhookOutput // contains filtered or unexported fields }
GetWebhookResponse is the response type for the GetWebhook API operation.
func (*GetWebhookResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *GetWebhookResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetWebhook request.
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) MarshalFields ¶
func (s Job) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type JobStatus ¶
type JobStatus string
const ( JobStatusPending JobStatus = "PENDING" JobStatusProvisioning JobStatus = "PROVISIONING" JobStatusRunning JobStatus = "RUNNING" JobStatusFailed JobStatus = "FAILED" JobStatusSucceed JobStatus = "SUCCEED" JobStatusCancelling JobStatus = "CANCELLING" JobStatusCancelled JobStatus = "CANCELLED" )
Enum values for JobStatus
func (JobStatus) MarshalValue ¶
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 JobType `locationName:"jobType" type:"string" required:"true" enum:"true"` // 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 JobStatus `locationName:"status" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Describes the summary for an execution job for an Amplify app.
func (JobSummary) MarshalFields ¶
func (s JobSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (JobSummary) String ¶
func (s JobSummary) String() string
String returns the string representation
type JobType ¶
type JobType string
const ( JobTypeRelease JobType = "RELEASE" JobTypeRetry JobType = "RETRY" JobTypeManual JobType = "MANUAL" JobTypeWebHook JobType = "WEB_HOOK" )
Enum values for JobType
func (JobType) MarshalValue ¶
type ListAppsInput ¶
type ListAppsInput struct { // The maximum number of records to list in a single response. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" 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) MarshalFields ¶
func (s ListAppsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListAppsInput) String ¶
func (s ListAppsInput) String() string
String returns the string representation
func (*ListAppsInput) Validate ¶
func (s *ListAppsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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) MarshalFields ¶
func (s ListAppsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListAppsOutput) String ¶
func (s ListAppsOutput) String() string
String returns the string representation
type ListAppsRequest ¶
type ListAppsRequest struct { *aws.Request Input *ListAppsInput Copy func(*ListAppsInput) ListAppsRequest }
ListAppsRequest is the request type for the ListApps API operation.
func (ListAppsRequest) Send ¶
func (r ListAppsRequest) Send(ctx context.Context) (*ListAppsResponse, error)
Send marshals and sends the ListApps API request.
type ListAppsResponse ¶ added in v0.9.0
type ListAppsResponse struct { *ListAppsOutput // contains filtered or unexported fields }
ListAppsResponse is the response type for the ListApps API operation.
func (*ListAppsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListAppsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListApps request.
type ListArtifactsInput ¶ added in v0.13.0
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" min:"1" 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) MarshalFields ¶ added in v0.13.0
func (s ListArtifactsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListArtifactsInput) String ¶ added in v0.13.0
func (s ListArtifactsInput) String() string
String returns the string representation
func (*ListArtifactsInput) Validate ¶ added in v0.13.0
func (s *ListArtifactsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListArtifactsOutput ¶ added in v0.13.0
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) MarshalFields ¶ added in v0.13.0
func (s ListArtifactsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListArtifactsOutput) String ¶ added in v0.13.0
func (s ListArtifactsOutput) String() string
String returns the string representation
type ListArtifactsRequest ¶ added in v0.13.0
type ListArtifactsRequest struct { *aws.Request Input *ListArtifactsInput Copy func(*ListArtifactsInput) ListArtifactsRequest }
ListArtifactsRequest is the request type for the ListArtifacts API operation.
func (ListArtifactsRequest) Send ¶ added in v0.13.0
func (r ListArtifactsRequest) Send(ctx context.Context) (*ListArtifactsResponse, error)
Send marshals and sends the ListArtifacts API request.
type ListArtifactsResponse ¶ added in v0.13.0
type ListArtifactsResponse struct { *ListArtifactsOutput // contains filtered or unexported fields }
ListArtifactsResponse is the response type for the ListArtifacts API operation.
func (*ListArtifactsResponse) SDKResponseMetdata ¶ added in v0.13.0
func (r *ListArtifactsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListArtifacts request.
type ListBackendEnvironmentsInput ¶ added in v0.18.0
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" min:"1" 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) MarshalFields ¶ added in v0.18.0
func (s ListBackendEnvironmentsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListBackendEnvironmentsInput) String ¶ added in v0.18.0
func (s ListBackendEnvironmentsInput) String() string
String returns the string representation
func (*ListBackendEnvironmentsInput) Validate ¶ added in v0.18.0
func (s *ListBackendEnvironmentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListBackendEnvironmentsOutput ¶ added in v0.18.0
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) MarshalFields ¶ added in v0.18.0
func (s ListBackendEnvironmentsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListBackendEnvironmentsOutput) String ¶ added in v0.18.0
func (s ListBackendEnvironmentsOutput) String() string
String returns the string representation
type ListBackendEnvironmentsRequest ¶ added in v0.18.0
type ListBackendEnvironmentsRequest struct { *aws.Request Input *ListBackendEnvironmentsInput Copy func(*ListBackendEnvironmentsInput) ListBackendEnvironmentsRequest }
ListBackendEnvironmentsRequest is the request type for the ListBackendEnvironments API operation.
func (ListBackendEnvironmentsRequest) Send ¶ added in v0.18.0
func (r ListBackendEnvironmentsRequest) Send(ctx context.Context) (*ListBackendEnvironmentsResponse, error)
Send marshals and sends the ListBackendEnvironments API request.
type ListBackendEnvironmentsResponse ¶ added in v0.18.0
type ListBackendEnvironmentsResponse struct { *ListBackendEnvironmentsOutput // contains filtered or unexported fields }
ListBackendEnvironmentsResponse is the response type for the ListBackendEnvironments API operation.
func (*ListBackendEnvironmentsResponse) SDKResponseMetdata ¶ added in v0.18.0
func (r *ListBackendEnvironmentsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListBackendEnvironments request.
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" min:"1" 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) MarshalFields ¶
func (s ListBranchesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListBranchesInput) String ¶
func (s ListBranchesInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s ListBranchesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListBranchesOutput) String ¶
func (s ListBranchesOutput) String() string
String returns the string representation
type ListBranchesRequest ¶
type ListBranchesRequest struct { *aws.Request Input *ListBranchesInput Copy func(*ListBranchesInput) ListBranchesRequest }
ListBranchesRequest is the request type for the ListBranches API operation.
func (ListBranchesRequest) Send ¶
func (r ListBranchesRequest) Send(ctx context.Context) (*ListBranchesResponse, error)
Send marshals and sends the ListBranches API request.
type ListBranchesResponse ¶ added in v0.9.0
type ListBranchesResponse struct { *ListBranchesOutput // contains filtered or unexported fields }
ListBranchesResponse is the response type for the ListBranches API operation.
func (*ListBranchesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListBranchesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListBranches request.
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" min:"1" 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) MarshalFields ¶
func (s ListDomainAssociationsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListDomainAssociationsInput) String ¶
func (s ListDomainAssociationsInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s ListDomainAssociationsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListDomainAssociationsOutput) String ¶
func (s ListDomainAssociationsOutput) String() string
String returns the string representation
type ListDomainAssociationsRequest ¶
type ListDomainAssociationsRequest struct { *aws.Request Input *ListDomainAssociationsInput Copy func(*ListDomainAssociationsInput) ListDomainAssociationsRequest }
ListDomainAssociationsRequest is the request type for the ListDomainAssociations API operation.
func (ListDomainAssociationsRequest) Send ¶
func (r ListDomainAssociationsRequest) Send(ctx context.Context) (*ListDomainAssociationsResponse, error)
Send marshals and sends the ListDomainAssociations API request.
type ListDomainAssociationsResponse ¶ added in v0.9.0
type ListDomainAssociationsResponse struct { *ListDomainAssociationsOutput // contains filtered or unexported fields }
ListDomainAssociationsResponse is the response type for the ListDomainAssociations API operation.
func (*ListDomainAssociationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListDomainAssociationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListDomainAssociations request.
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 for a branch. // // 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" min:"1" 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) MarshalFields ¶
func (s ListJobsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJobsInput) String ¶
func (s ListJobsInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s ListJobsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJobsOutput) String ¶
func (s ListJobsOutput) String() string
String returns the string representation
type ListJobsRequest ¶
type ListJobsRequest struct { *aws.Request Input *ListJobsInput Copy func(*ListJobsInput) ListJobsRequest }
ListJobsRequest is the request type for the ListJobs API operation.
func (ListJobsRequest) Send ¶
func (r ListJobsRequest) Send(ctx context.Context) (*ListJobsResponse, error)
Send marshals and sends the ListJobs API request.
type ListJobsResponse ¶ added in v0.9.0
type ListJobsResponse struct { *ListJobsOutput // contains filtered or unexported fields }
ListJobsResponse is the response type for the ListJobs API operation.
func (*ListJobsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListJobsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListJobs request.
type ListTagsForResourceInput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceInput) String ¶ added in v0.10.0
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v0.10.0
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v0.10.0
type ListTagsForResourceOutput struct { // A list of tags for the specified The Amazon Resource Name (ARN). Tags map[string]string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
The response for the list tags for resource request.
func (ListTagsForResourceOutput) MarshalFields ¶ added in v0.10.0
func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceOutput) String ¶ added in v0.10.0
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶ added in v0.10.0
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶ added in v0.10.0
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.10.0
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type ListWebhooksInput ¶ added in v0.10.0
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" min:"1" 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) MarshalFields ¶ added in v0.10.0
func (s ListWebhooksInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListWebhooksInput) String ¶ added in v0.10.0
func (s ListWebhooksInput) String() string
String returns the string representation
func (*ListWebhooksInput) Validate ¶ added in v0.10.0
func (s *ListWebhooksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListWebhooksOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s ListWebhooksOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListWebhooksOutput) String ¶ added in v0.10.0
func (s ListWebhooksOutput) String() string
String returns the string representation
type ListWebhooksRequest ¶ added in v0.10.0
type ListWebhooksRequest struct { *aws.Request Input *ListWebhooksInput Copy func(*ListWebhooksInput) ListWebhooksRequest }
ListWebhooksRequest is the request type for the ListWebhooks API operation.
func (ListWebhooksRequest) Send ¶ added in v0.10.0
func (r ListWebhooksRequest) Send(ctx context.Context) (*ListWebhooksResponse, error)
Send marshals and sends the ListWebhooks API request.
type ListWebhooksResponse ¶ added in v0.10.0
type ListWebhooksResponse struct { *ListWebhooksOutput // contains filtered or unexported fields }
ListWebhooksResponse is the response type for the ListWebhooks API operation.
func (*ListWebhooksResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *ListWebhooksResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListWebhooks request.
type Platform ¶
type Platform string
const (
PlatformWeb Platform = "WEB"
)
Enum values for Platform
func (Platform) MarshalValue ¶
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) MarshalFields ¶
func (s ProductionBranch) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ProductionBranch) String ¶
func (s ProductionBranch) String() string
String returns the string representation
type Stage ¶
type Stage string
const ( StageProduction Stage = "PRODUCTION" StageBeta Stage = "BETA" StageDevelopment Stage = "DEVELOPMENT" StageExperimental Stage = "EXPERIMENTAL" StagePullRequest Stage = "PULL_REQUEST" )
Enum values for Stage
func (Stage) MarshalValue ¶
type StartDeploymentInput ¶ added in v0.10.0
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 for the branch, 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) MarshalFields ¶ added in v0.10.0
func (s StartDeploymentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartDeploymentInput) String ¶ added in v0.10.0
func (s StartDeploymentInput) String() string
String returns the string representation
func (*StartDeploymentInput) Validate ¶ added in v0.10.0
func (s *StartDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartDeploymentOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s StartDeploymentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartDeploymentOutput) String ¶ added in v0.10.0
func (s StartDeploymentOutput) String() string
String returns the string representation
type StartDeploymentRequest ¶ added in v0.10.0
type StartDeploymentRequest struct { *aws.Request Input *StartDeploymentInput Copy func(*StartDeploymentInput) StartDeploymentRequest }
StartDeploymentRequest is the request type for the StartDeployment API operation.
func (StartDeploymentRequest) Send ¶ added in v0.10.0
func (r StartDeploymentRequest) Send(ctx context.Context) (*StartDeploymentResponse, error)
Send marshals and sends the StartDeployment API request.
type StartDeploymentResponse ¶ added in v0.10.0
type StartDeploymentResponse struct { *StartDeploymentOutput // contains filtered or unexported fields }
StartDeploymentResponse is the response type for the StartDeployment API operation.
func (*StartDeploymentResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *StartDeploymentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartDeployment request.
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 branch name 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 this 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 JobType `locationName:"jobType" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The request structure for the start job request.
func (StartJobInput) MarshalFields ¶
func (s StartJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartJobInput) String ¶
func (s StartJobInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s StartJobOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartJobOutput) String ¶
func (s StartJobOutput) String() string
String returns the string representation
type StartJobRequest ¶
type StartJobRequest struct { *aws.Request Input *StartJobInput Copy func(*StartJobInput) StartJobRequest }
StartJobRequest is the request type for the StartJob API operation.
func (StartJobRequest) Send ¶
func (r StartJobRequest) Send(ctx context.Context) (*StartJobResponse, error)
Send marshals and sends the StartJob API request.
type StartJobResponse ¶ added in v0.9.0
type StartJobResponse struct { *StartJobOutput // contains filtered or unexported fields }
StartJobResponse is the response type for the StartJob API operation.
func (*StartJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StartJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartJob request.
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 JobStatus `locationName:"status" type:"string" required:"true" enum:"true"` // 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) MarshalFields ¶
func (s Step) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 for the branch, 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 stop job request.
func (StopJobInput) MarshalFields ¶
func (s StopJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StopJobInput) String ¶
func (s StopJobInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s StopJobOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StopJobOutput) String ¶
func (s StopJobOutput) String() string
String returns the string representation
type StopJobRequest ¶
type StopJobRequest struct { *aws.Request Input *StopJobInput Copy func(*StopJobInput) StopJobRequest }
StopJobRequest is the request type for the StopJob API operation.
func (StopJobRequest) Send ¶
func (r StopJobRequest) Send(ctx context.Context) (*StopJobResponse, error)
Send marshals and sends the StopJob API request.
type StopJobResponse ¶ added in v0.9.0
type StopJobResponse struct { *StopJobOutput // contains filtered or unexported fields }
StopJobResponse is the response type for the StopJob API operation.
func (*StopJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StopJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StopJob request.
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) MarshalFields ¶
func (s SubDomain) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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) MarshalFields ¶
func (s SubDomainSetting) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SubDomainSetting) String ¶
func (s SubDomainSetting) String() string
String returns the string representation
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 v0.10.0
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" min:"1" type:"map" required:"true"` // contains filtered or unexported fields }
The request structure to tag a resource with a tag key and value.
func (TagResourceInput) MarshalFields ¶ added in v0.10.0
func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceInput) String ¶ added in v0.10.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.10.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.10.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
The response for the tag resource request.
func (TagResourceOutput) MarshalFields ¶ added in v0.10.0
func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceOutput) String ¶ added in v0.10.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.10.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.10.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.10.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type UntagResourceInput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceInput) String ¶ added in v0.10.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.10.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.10.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
The response for the untag resource request.
func (UntagResourceOutput) MarshalFields ¶ added in v0.10.0
func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceOutput) String ¶ added in v0.10.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.10.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.10.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.10.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateAppInput ¶
type UpdateAppInput struct { // The personal access token for a third-party source control system for an // Amplify app. The token is used to create webhook and a read-only deploy key. // The token is not stored. 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 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 an Amplify app. BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The build specification (build spec) for an Amplify app. BuildSpec *string `locationName:"buildSpec" min:"1" 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 the 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" min:"1" 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 token is used to create a webhook and a read-only deploy key. The OAuth // token is not stored. OauthToken *string `locationName:"oauthToken" type:"string" sensitive:"true"` // The platform for an Amplify app. Platform Platform `locationName:"platform" type:"string" enum:"true"` // The name of the 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) MarshalFields ¶
func (s UpdateAppInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAppInput) String ¶
func (s UpdateAppInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s UpdateAppOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAppOutput) String ¶
func (s UpdateAppOutput) String() string
String returns the string representation
type UpdateAppRequest ¶
type UpdateAppRequest struct { *aws.Request Input *UpdateAppInput Copy func(*UpdateAppInput) UpdateAppRequest }
UpdateAppRequest is the request type for the UpdateApp API operation.
func (UpdateAppRequest) Send ¶
func (r UpdateAppRequest) Send(ctx context.Context) (*UpdateAppResponse, error)
Send marshals and sends the UpdateApp API request.
type UpdateAppResponse ¶ added in v0.9.0
type UpdateAppResponse struct { *UpdateAppOutput // contains filtered or unexported fields }
UpdateAppResponse is the response type for the UpdateApp API operation.
func (*UpdateAppResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateAppResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateApp request.
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 Amazon Resource Name (ARN) for a backend environment that is part of // an Amplify app. BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string"` // The basic authorization credentials for the branch. BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The name for 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 *string `locationName:"buildSpec" min:"1" type:"string"` // 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 pull request preview 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 Stage `locationName:"stage" type:"string" enum:"true"` // 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) MarshalFields ¶
func (s UpdateBranchInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateBranchInput) String ¶
func (s UpdateBranchInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s UpdateBranchOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateBranchOutput) String ¶
func (s UpdateBranchOutput) String() string
String returns the string representation
type UpdateBranchRequest ¶
type UpdateBranchRequest struct { *aws.Request Input *UpdateBranchInput Copy func(*UpdateBranchInput) UpdateBranchRequest }
UpdateBranchRequest is the request type for the UpdateBranch API operation.
func (UpdateBranchRequest) Send ¶
func (r UpdateBranchRequest) Send(ctx context.Context) (*UpdateBranchResponse, error)
Send marshals and sends the UpdateBranch API request.
type UpdateBranchResponse ¶ added in v0.9.0
type UpdateBranchResponse struct { *UpdateBranchOutput // contains filtered or unexported fields }
UpdateBranchResponse is the response type for the UpdateBranch API operation.
func (*UpdateBranchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateBranchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateBranch request.
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 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 is a required field SubDomainSettings []SubDomainSetting `locationName:"subDomainSettings" type:"list" required:"true"` // contains filtered or unexported fields }
The request structure for the update domain association request.
func (UpdateDomainAssociationInput) MarshalFields ¶
func (s UpdateDomainAssociationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDomainAssociationInput) String ¶
func (s UpdateDomainAssociationInput) String() string
String returns the string representation
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) MarshalFields ¶
func (s UpdateDomainAssociationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDomainAssociationOutput) String ¶
func (s UpdateDomainAssociationOutput) String() string
String returns the string representation
type UpdateDomainAssociationRequest ¶
type UpdateDomainAssociationRequest struct { *aws.Request Input *UpdateDomainAssociationInput Copy func(*UpdateDomainAssociationInput) UpdateDomainAssociationRequest }
UpdateDomainAssociationRequest is the request type for the UpdateDomainAssociation API operation.
func (UpdateDomainAssociationRequest) Send ¶
func (r UpdateDomainAssociationRequest) Send(ctx context.Context) (*UpdateDomainAssociationResponse, error)
Send marshals and sends the UpdateDomainAssociation API request.
type UpdateDomainAssociationResponse ¶ added in v0.9.0
type UpdateDomainAssociationResponse struct { *UpdateDomainAssociationOutput // contains filtered or unexported fields }
UpdateDomainAssociationResponse is the response type for the UpdateDomainAssociation API operation.
func (*UpdateDomainAssociationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateDomainAssociationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateDomainAssociation request.
type UpdateWebhookInput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s UpdateWebhookInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateWebhookInput) String ¶ added in v0.10.0
func (s UpdateWebhookInput) String() string
String returns the string representation
func (*UpdateWebhookInput) Validate ¶ added in v0.10.0
func (s *UpdateWebhookInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateWebhookOutput ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s UpdateWebhookOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateWebhookOutput) String ¶ added in v0.10.0
func (s UpdateWebhookOutput) String() string
String returns the string representation
type UpdateWebhookRequest ¶ added in v0.10.0
type UpdateWebhookRequest struct { *aws.Request Input *UpdateWebhookInput Copy func(*UpdateWebhookInput) UpdateWebhookRequest }
UpdateWebhookRequest is the request type for the UpdateWebhook API operation.
func (UpdateWebhookRequest) Send ¶ added in v0.10.0
func (r UpdateWebhookRequest) Send(ctx context.Context) (*UpdateWebhookResponse, error)
Send marshals and sends the UpdateWebhook API request.
type UpdateWebhookResponse ¶ added in v0.10.0
type UpdateWebhookResponse struct { *UpdateWebhookOutput // contains filtered or unexported fields }
UpdateWebhookResponse is the response type for the UpdateWebhook API operation.
func (*UpdateWebhookResponse) SDKResponseMetdata ¶ added in v0.10.0
func (r *UpdateWebhookResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateWebhook request.
type Webhook ¶ added in v0.10.0
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) MarshalFields ¶ added in v0.10.0
func (s Webhook) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateApp.go
- api_op_CreateBackendEnvironment.go
- api_op_CreateBranch.go
- api_op_CreateDeployment.go
- api_op_CreateDomainAssociation.go
- api_op_CreateWebhook.go
- api_op_DeleteApp.go
- api_op_DeleteBackendEnvironment.go
- api_op_DeleteBranch.go
- api_op_DeleteDomainAssociation.go
- api_op_DeleteJob.go
- api_op_DeleteWebhook.go
- api_op_GenerateAccessLogs.go
- api_op_GetApp.go
- api_op_GetArtifactUrl.go
- api_op_GetBackendEnvironment.go
- api_op_GetBranch.go
- api_op_GetDomainAssociation.go
- api_op_GetJob.go
- api_op_GetWebhook.go
- api_op_ListApps.go
- api_op_ListArtifacts.go
- api_op_ListBackendEnvironments.go
- api_op_ListBranches.go
- api_op_ListDomainAssociations.go
- api_op_ListJobs.go
- api_op_ListTagsForResource.go
- api_op_ListWebhooks.go
- api_op_StartDeployment.go
- api_op_StartJob.go
- api_op_StopJob.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateApp.go
- api_op_UpdateBranch.go
- api_op_UpdateDomainAssociation.go
- api_op_UpdateWebhook.go
- api_types.go
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. |