amplifyuibuilder

package module
v1.12.1 Latest Latest
Warning

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

 Go to latest Published: Aug 1, 2023 License: Apache-2.0 Imports: 38 Imported by: 6

Documentation

Overview

Package amplifyuibuilder provides the API client, operations, and parameter types for AWS Amplify UI Builder.

The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources. You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction (https://docs.amplify.aws/console/adminui/intro) in the Amplify Docs. 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/) . For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html) .

Index

Constants

View Source 
const ServiceAPIVersion = "2021-08-11"
View Source 
const ServiceID = "AmplifyUIBuilder"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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

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

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

func WithEndpointResolverV2 added in v1.12.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

Types

type Client 

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

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

func New 

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

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

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) CreateComponent 

func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error)

Creates a new component for an Amplify app.

func (*Client) CreateForm added in v1.7.0 

func (c *Client) CreateForm(ctx context.Context, params *CreateFormInput, optFns ...func(*Options)) (*CreateFormOutput, error)

Creates a new form for an Amplify app.

func (*Client) CreateTheme 

func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optFns ...func(*Options)) (*CreateThemeOutput, error)

Creates a theme to apply to the components in an Amplify app.

func (*Client) DeleteComponent 

func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInput, optFns ...func(*Options)) (*DeleteComponentOutput, error)

Deletes a component from an Amplify app.

func (*Client) DeleteForm added in v1.7.0 

func (c *Client) DeleteForm(ctx context.Context, params *DeleteFormInput, optFns ...func(*Options)) (*DeleteFormOutput, error)

Deletes a form from an Amplify app.

func (*Client) DeleteTheme 

func (c *Client) DeleteTheme(ctx context.Context, params *DeleteThemeInput, optFns ...func(*Options)) (*DeleteThemeOutput, error)

Deletes a theme from an Amplify app.

func (*Client) ExchangeCodeForToken 

func (c *Client) ExchangeCodeForToken(ctx context.Context, params *ExchangeCodeForTokenInput, optFns ...func(*Options)) (*ExchangeCodeForTokenOutput, error)

Exchanges an access code for a token.

func (*Client) ExportComponents 

func (c *Client) ExportComponents(ctx context.Context, params *ExportComponentsInput, optFns ...func(*Options)) (*ExportComponentsOutput, error)

Exports component configurations to code that is ready to integrate into an Amplify app.

func (*Client) ExportForms added in v1.7.0 

func (c *Client) ExportForms(ctx context.Context, params *ExportFormsInput, optFns ...func(*Options)) (*ExportFormsOutput, error)

Exports form configurations to code that is ready to integrate into an Amplify app.

func (*Client) ExportThemes 

func (c *Client) ExportThemes(ctx context.Context, params *ExportThemesInput, optFns ...func(*Options)) (*ExportThemesOutput, error)

Exports theme configurations to code that is ready to integrate into an Amplify app.

func (*Client) GetCodegenJob added in v1.11.0 

func (c *Client) GetCodegenJob(ctx context.Context, params *GetCodegenJobInput, optFns ...func(*Options)) (*GetCodegenJobOutput, error)

Returns an existing code generation job.

func (*Client) GetComponent 

func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error)

Returns an existing component for an Amplify app.

func (*Client) GetForm added in v1.7.0 

func (c *Client) GetForm(ctx context.Context, params *GetFormInput, optFns ...func(*Options)) (*GetFormOutput, error)

Returns an existing form for an Amplify app.

func (*Client) GetMetadata added in v1.7.0 

func (c *Client) GetMetadata(ctx context.Context, params *GetMetadataInput, optFns ...func(*Options)) (*GetMetadataOutput, error)

Returns existing metadata for an Amplify app.

func (*Client) GetTheme 

func (c *Client) GetTheme(ctx context.Context, params *GetThemeInput, optFns ...func(*Options)) (*GetThemeOutput, error)

Returns an existing theme for an Amplify app.

func (*Client) ListCodegenJobs added in v1.11.0 

func (c *Client) ListCodegenJobs(ctx context.Context, params *ListCodegenJobsInput, optFns ...func(*Options)) (*ListCodegenJobsOutput, error)

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

func (*Client) ListComponents 

func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error)

Retrieves a list of components for a specified Amplify app and backend environment.

func (*Client) ListForms added in v1.7.0 

func (c *Client) ListForms(ctx context.Context, params *ListFormsInput, optFns ...func(*Options)) (*ListFormsOutput, error)

Retrieves a list of forms for a specified Amplify app and backend environment.

func (*Client) ListThemes 

func (c *Client) ListThemes(ctx context.Context, params *ListThemesInput, optFns ...func(*Options)) (*ListThemesOutput, error)

Retrieves a list of themes for a specified Amplify app and backend environment.

func (*Client) PutMetadataFlag added in v1.7.0 

func (c *Client) PutMetadataFlag(ctx context.Context, params *PutMetadataFlagInput, optFns ...func(*Options)) (*PutMetadataFlagOutput, error)

Stores the metadata information about a feature on a form.

func (*Client) RefreshToken 

func (c *Client) RefreshToken(ctx context.Context, params *RefreshTokenInput, optFns ...func(*Options)) (*RefreshTokenOutput, error)

Refreshes a previously issued access token that might have expired.

func (*Client) StartCodegenJob added in v1.11.0 

func (c *Client) StartCodegenJob(ctx context.Context, params *StartCodegenJobInput, optFns ...func(*Options)) (*StartCodegenJobOutput, error)

Starts a code generation job for a specified Amplify app and backend environment.

func (*Client) UpdateComponent 

func (c *Client) UpdateComponent(ctx context.Context, params *UpdateComponentInput, optFns ...func(*Options)) (*UpdateComponentOutput, error)

Updates an existing component.

func (*Client) UpdateForm added in v1.7.0 

func (c *Client) UpdateForm(ctx context.Context, params *UpdateFormInput, optFns ...func(*Options)) (*UpdateFormOutput, error)

Updates an existing form.

func (*Client) UpdateTheme 

func (c *Client) UpdateTheme(ctx context.Context, params *UpdateThemeInput, optFns ...func(*Options)) (*UpdateThemeOutput, error)

Updates an existing theme.

type CreateComponentInput 

type CreateComponentInput struct {

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

	// Represents the configuration of the component to create.
	//
	// This member is required.
	ComponentToCreate *types.CreateComponentData

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

	// The unique client token.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateComponentOutput 

type CreateComponentOutput struct {

	// Describes the configuration of the new component.
	Entity *types.Component

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

type CreateFormInput added in v1.7.0 

type CreateFormInput struct {

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

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

	// Represents the configuration of the form to create.
	//
	// This member is required.
	FormToCreate *types.CreateFormData

	// The unique client token.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateFormOutput added in v1.7.0 

type CreateFormOutput struct {

	// Describes the configuration of the new form.
	Entity *types.Form

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

type CreateThemeInput 

type CreateThemeInput struct {

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

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

	// Represents the configuration of the theme to create.
	//
	// This member is required.
	ThemeToCreate *types.CreateThemeData

	// The unique client token.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateThemeOutput 

type CreateThemeOutput struct {

	// Describes the configuration of the new theme.
	Entity *types.Theme

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

type DeleteComponentInput 

type DeleteComponentInput struct {

	// The unique ID of the Amplify app associated with the component to delete.
	//
	// This member is required.
	AppId *string

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

	// The unique ID of the component to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteComponentOutput 

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

type DeleteFormInput added in v1.7.0 

type DeleteFormInput struct {

	// The unique ID of the Amplify app associated with the form to delete.
	//
	// This member is required.
	AppId *string

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

	// The unique ID of the form to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteFormOutput added in v1.7.0 

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

type DeleteThemeInput 

type DeleteThemeInput struct {

	// The unique ID of the Amplify app associated with the theme to delete.
	//
	// This member is required.
	AppId *string

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

	// The unique ID of the theme to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteThemeOutput 

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

type EndpointParameters added in v1.12.0 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.12.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.12.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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

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

type EndpointResolverFunc 

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

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

func (EndpointResolverFunc) ResolveEndpoint 

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

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.12.0 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.12.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExchangeCodeForTokenInput 

type ExchangeCodeForTokenInput struct {

	// The third-party provider for the token. The only valid value is figma .
	//
	// This member is required.
	Provider types.TokenProviders

	// Describes the configuration of the request.
	//
	// This member is required.
	Request *types.ExchangeCodeForTokenRequestBody
	// contains filtered or unexported fields
}

type ExchangeCodeForTokenOutput 

type ExchangeCodeForTokenOutput struct {

	// The access token.
	//
	// This member is required.
	AccessToken *string

	// The date and time when the new access token expires.
	//
	// This member is required.
	ExpiresIn *int32

	// The token to use to refresh a previously issued access token that might have
	// expired.
	//
	// This member is required.
	RefreshToken *string

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

type ExportComponentsAPIClient added in v1.5.0 

type ExportComponentsAPIClient interface {
	ExportComponents(context.Context, *ExportComponentsInput, ...func(*Options)) (*ExportComponentsOutput, error)
}

ExportComponentsAPIClient is a client that implements the ExportComponents operation.

type ExportComponentsInput 

type ExportComponentsInput struct {

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

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

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ExportComponentsOutput 

type ExportComponentsOutput struct {

	// Represents the configuration of the exported components.
	//
	// This member is required.
	Entities []types.Component

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ExportComponentsPaginator added in v1.5.0 

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

ExportComponentsPaginator is a paginator for ExportComponents

func NewExportComponentsPaginator added in v1.5.0 

func NewExportComponentsPaginator(client ExportComponentsAPIClient, params *ExportComponentsInput, optFns ...func(*ExportComponentsPaginatorOptions)) *ExportComponentsPaginator

NewExportComponentsPaginator returns a new ExportComponentsPaginator

func (*ExportComponentsPaginator) HasMorePages added in v1.5.0 

func (p *ExportComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ExportComponentsPaginator) NextPage added in v1.5.0 

func (p *ExportComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ExportComponentsOutput, error)

NextPage retrieves the next ExportComponents page.

type ExportComponentsPaginatorOptions added in v1.5.0 

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

ExportComponentsPaginatorOptions is the paginator options for ExportComponents

type ExportFormsAPIClient added in v1.7.0 

type ExportFormsAPIClient interface {
	ExportForms(context.Context, *ExportFormsInput, ...func(*Options)) (*ExportFormsOutput, error)
}

ExportFormsAPIClient is a client that implements the ExportForms operation.

type ExportFormsInput added in v1.7.0 

type ExportFormsInput struct {

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

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

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ExportFormsOutput added in v1.7.0 

type ExportFormsOutput struct {

	// Represents the configuration of the exported forms.
	//
	// This member is required.
	Entities []types.Form

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ExportFormsPaginator added in v1.7.0 

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

ExportFormsPaginator is a paginator for ExportForms

func NewExportFormsPaginator added in v1.7.0 

func NewExportFormsPaginator(client ExportFormsAPIClient, params *ExportFormsInput, optFns ...func(*ExportFormsPaginatorOptions)) *ExportFormsPaginator

NewExportFormsPaginator returns a new ExportFormsPaginator

func (*ExportFormsPaginator) HasMorePages added in v1.7.0 

func (p *ExportFormsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ExportFormsPaginator) NextPage added in v1.7.0 

func (p *ExportFormsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ExportFormsOutput, error)

NextPage retrieves the next ExportForms page.

type ExportFormsPaginatorOptions added in v1.7.0 

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

ExportFormsPaginatorOptions is the paginator options for ExportForms

type ExportThemesAPIClient added in v1.5.0 

type ExportThemesAPIClient interface {
	ExportThemes(context.Context, *ExportThemesInput, ...func(*Options)) (*ExportThemesOutput, error)
}

ExportThemesAPIClient is a client that implements the ExportThemes operation.

type ExportThemesInput 

type ExportThemesInput struct {

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

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

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ExportThemesOutput 

type ExportThemesOutput struct {

	// Represents the configuration of the exported themes.
	//
	// This member is required.
	Entities []types.Theme

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ExportThemesPaginator added in v1.5.0 

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

ExportThemesPaginator is a paginator for ExportThemes

func NewExportThemesPaginator added in v1.5.0 

func NewExportThemesPaginator(client ExportThemesAPIClient, params *ExportThemesInput, optFns ...func(*ExportThemesPaginatorOptions)) *ExportThemesPaginator

NewExportThemesPaginator returns a new ExportThemesPaginator

func (*ExportThemesPaginator) HasMorePages added in v1.5.0 

func (p *ExportThemesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ExportThemesPaginator) NextPage added in v1.5.0 

func (p *ExportThemesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ExportThemesOutput, error)

NextPage retrieves the next ExportThemes page.

type ExportThemesPaginatorOptions added in v1.5.0 

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

ExportThemesPaginatorOptions is the paginator options for ExportThemes

type GetCodegenJobInput added in v1.11.0 

type GetCodegenJobInput struct {

	// The unique ID of the Amplify app associated with the code generation job.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment that is a part of the Amplify app
	// associated with the code generation job.
	//
	// This member is required.
	EnvironmentName *string

	// The unique ID of the code generation job.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetCodegenJobOutput added in v1.11.0 

type GetCodegenJobOutput struct {

	// The configuration settings for the code generation job.
	Job *types.CodegenJob

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

type GetComponentInput 

type GetComponentInput struct {

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

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

	// The unique ID of the component.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetComponentOutput 

type GetComponentOutput struct {

	// Represents the configuration settings for the component.
	Component *types.Component

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

type GetFormInput added in v1.7.0 

type GetFormInput struct {

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

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

	// The unique ID of the form.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetFormOutput added in v1.7.0 

type GetFormOutput struct {

	// Represents the configuration settings for the form.
	Form *types.Form

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

type GetMetadataInput added in v1.7.0 

type GetMetadataInput struct {

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

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

type GetMetadataOutput added in v1.7.0 

type GetMetadataOutput struct {

	// Represents the configuration settings for the features metadata.
	//
	// This member is required.
	Features map[string]string

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

type GetThemeInput 

type GetThemeInput struct {

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

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

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

type GetThemeOutput 

type GetThemeOutput struct {

	// Represents the configuration settings for the theme.
	Theme *types.Theme

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

type HTTPClient 

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

type HTTPSignerV4 

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

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListCodegenJobsAPIClient added in v1.11.0 

type ListCodegenJobsAPIClient interface {
	ListCodegenJobs(context.Context, *ListCodegenJobsInput, ...func(*Options)) (*ListCodegenJobsOutput, error)
}

ListCodegenJobsAPIClient is a client that implements the ListCodegenJobs operation.

type ListCodegenJobsInput added in v1.11.0 

type ListCodegenJobsInput struct {

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

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

	// The maximum number of jobs to retrieve.
	MaxResults *int32

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCodegenJobsOutput added in v1.11.0 

type ListCodegenJobsOutput struct {

	// The list of code generation jobs for the Amplify app.
	//
	// This member is required.
	Entities []types.CodegenJobSummary

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ListCodegenJobsPaginator added in v1.11.0 

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

ListCodegenJobsPaginator is a paginator for ListCodegenJobs

func NewListCodegenJobsPaginator added in v1.11.0 

func NewListCodegenJobsPaginator(client ListCodegenJobsAPIClient, params *ListCodegenJobsInput, optFns ...func(*ListCodegenJobsPaginatorOptions)) *ListCodegenJobsPaginator

NewListCodegenJobsPaginator returns a new ListCodegenJobsPaginator

func (*ListCodegenJobsPaginator) HasMorePages added in v1.11.0 

func (p *ListCodegenJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCodegenJobsPaginator) NextPage added in v1.11.0 

func (p *ListCodegenJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCodegenJobsOutput, error)

NextPage retrieves the next ListCodegenJobs page.

type ListCodegenJobsPaginatorOptions added in v1.11.0 

type ListCodegenJobsPaginatorOptions struct {
	// The maximum number of jobs to retrieve.
	Limit int32

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

ListCodegenJobsPaginatorOptions is the paginator options for ListCodegenJobs

type ListComponentsAPIClient 

type ListComponentsAPIClient interface {
	ListComponents(context.Context, *ListComponentsInput, ...func(*Options)) (*ListComponentsOutput, error)
}

ListComponentsAPIClient is a client that implements the ListComponents operation.

type ListComponentsInput 

type ListComponentsInput struct {

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

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

	// The maximum number of components to retrieve.
	MaxResults int32

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListComponentsOutput 

type ListComponentsOutput struct {

	// The list of components for the Amplify app.
	//
	// This member is required.
	Entities []types.ComponentSummary

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ListComponentsPaginator 

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

ListComponentsPaginator is a paginator for ListComponents

func NewListComponentsPaginator 

func NewListComponentsPaginator(client ListComponentsAPIClient, params *ListComponentsInput, optFns ...func(*ListComponentsPaginatorOptions)) *ListComponentsPaginator

NewListComponentsPaginator returns a new ListComponentsPaginator

func (*ListComponentsPaginator) HasMorePages 

func (p *ListComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListComponentsPaginator) NextPage 

func (p *ListComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListComponentsOutput, error)

NextPage retrieves the next ListComponents page.

type ListComponentsPaginatorOptions 

type ListComponentsPaginatorOptions struct {
	// The maximum number of components to retrieve.
	Limit int32

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

ListComponentsPaginatorOptions is the paginator options for ListComponents

type ListFormsAPIClient added in v1.7.0 

type ListFormsAPIClient interface {
	ListForms(context.Context, *ListFormsInput, ...func(*Options)) (*ListFormsOutput, error)
}

ListFormsAPIClient is a client that implements the ListForms operation.

type ListFormsInput added in v1.7.0 

type ListFormsInput struct {

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

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

	// The maximum number of forms to retrieve.
	MaxResults int32

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFormsOutput added in v1.7.0 

type ListFormsOutput struct {

	// The list of forms for the Amplify app.
	//
	// This member is required.
	Entities []types.FormSummary

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ListFormsPaginator added in v1.7.0 

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

ListFormsPaginator is a paginator for ListForms

func NewListFormsPaginator added in v1.7.0 

func NewListFormsPaginator(client ListFormsAPIClient, params *ListFormsInput, optFns ...func(*ListFormsPaginatorOptions)) *ListFormsPaginator

NewListFormsPaginator returns a new ListFormsPaginator

func (*ListFormsPaginator) HasMorePages added in v1.7.0 

func (p *ListFormsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFormsPaginator) NextPage added in v1.7.0 

func (p *ListFormsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFormsOutput, error)

NextPage retrieves the next ListForms page.

type ListFormsPaginatorOptions added in v1.7.0 

type ListFormsPaginatorOptions struct {
	// The maximum number of forms to retrieve.
	Limit int32

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

ListFormsPaginatorOptions is the paginator options for ListForms

type ListThemesAPIClient 

type ListThemesAPIClient interface {
	ListThemes(context.Context, *ListThemesInput, ...func(*Options)) (*ListThemesOutput, error)
}

ListThemesAPIClient is a client that implements the ListThemes operation.

type ListThemesInput 

type ListThemesInput struct {

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

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

	// The maximum number of theme results to return in the response.
	MaxResults int32

	// The token to request the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThemesOutput 

type ListThemesOutput struct {

	// The list of themes for the Amplify app.
	//
	// This member is required.
	Entities []types.ThemeSummary

	// The pagination token that's returned if more results are available.
	NextToken *string

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

type ListThemesPaginator 

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

ListThemesPaginator is a paginator for ListThemes

func NewListThemesPaginator 

func NewListThemesPaginator(client ListThemesAPIClient, params *ListThemesInput, optFns ...func(*ListThemesPaginatorOptions)) *ListThemesPaginator

NewListThemesPaginator returns a new ListThemesPaginator

func (*ListThemesPaginator) HasMorePages 

func (p *ListThemesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThemesPaginator) NextPage 

func (p *ListThemesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemesOutput, error)

NextPage retrieves the next ListThemes page.

type ListThemesPaginatorOptions 

type ListThemesPaginatorOptions struct {
	// The maximum number of theme results to return in the response.
	Limit int32

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

ListThemesPaginatorOptions is the paginator options for ListThemes

type Options 

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

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

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

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

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

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

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

type PutMetadataFlagInput added in v1.7.0 

type PutMetadataFlagInput struct {

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

	// The metadata information to store.
	//
	// This member is required.
	Body *types.PutMetadataFlagBody

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

	// The name of the feature associated with the metadata.
	//
	// This member is required.
	FeatureName *string
	// contains filtered or unexported fields
}

type PutMetadataFlagOutput added in v1.7.0 

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

type RefreshTokenInput 

type RefreshTokenInput struct {

	// The third-party provider for the token. The only valid value is figma .
	//
	// This member is required.
	Provider types.TokenProviders

	// Information about the refresh token request.
	//
	// This member is required.
	RefreshTokenBody *types.RefreshTokenRequestBody
	// contains filtered or unexported fields
}

type RefreshTokenOutput 

type RefreshTokenOutput struct {

	// The access token.
	//
	// This member is required.
	AccessToken *string

	// The date and time when the new access token expires.
	//
	// This member is required.
	ExpiresIn *int32

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartCodegenJobInput added in v1.11.0 

type StartCodegenJobInput struct {

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

	// The code generation job resource configuration.
	//
	// This member is required.
	CodegenJobToCreate *types.StartCodegenJobData

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

	// The idempotency token used to ensure that the code generation job request
	// completes only once.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartCodegenJobOutput added in v1.11.0 

type StartCodegenJobOutput struct {

	// The code generation job for a UI component that is associated with an Amplify
	// app.
	Entity *types.CodegenJob

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

type UpdateComponentInput 

type UpdateComponentInput struct {

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

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

	// The unique ID for the component.
	//
	// This member is required.
	Id *string

	// The configuration of the updated component.
	//
	// This member is required.
	UpdatedComponent *types.UpdateComponentData

	// The unique client token.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateComponentOutput 

type UpdateComponentOutput struct {

	// Describes the configuration of the updated component.
	Entity *types.Component

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

type UpdateFormInput added in v1.7.0 

type UpdateFormInput struct {

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

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

	// The unique ID for the form.
	//
	// This member is required.
	Id *string

	// The request accepts the following data in JSON format.
	//
	// This member is required.
	UpdatedForm *types.UpdateFormData

	// The unique client token.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateFormOutput added in v1.7.0 

type UpdateFormOutput struct {

	// Describes the configuration of the updated form.
	Entity *types.Form

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

type UpdateThemeInput 

type UpdateThemeInput struct {

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

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

	// The unique ID for the theme.
	//
	// This member is required.
	Id *string

	// The configuration of the updated theme.
	//
	// This member is required.
	UpdatedTheme *types.UpdateThemeData

	// The unique client token.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateThemeOutput 

type UpdateThemeOutput struct {

	// Describes the configuration of the updated theme.
	Entity *types.Theme

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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