amplifyuibuilder

package
v1.44.45 Latest Latest
Warning

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

Go to latest
Published: Jun 29, 2022 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package amplifyuibuilder provides the client and types for making API requests to 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).

See https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11 for more information on this service.

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

Using the Client

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

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

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

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

Index

Constants

View Source
const (
	// SortDirectionAsc is a SortDirection enum value
	SortDirectionAsc = "ASC"

	// SortDirectionDesc is a SortDirection enum value
	SortDirectionDesc = "DESC"
)
View Source
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal error has occurred. Please retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// An invalid or out-of-range value was supplied for the input parameter.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeResourceConflictException for service response error code
	// "ResourceConflictException".
	//
	// The resource specified in the request conflicts with an existing resource.
	ErrCodeResourceConflictException = "ResourceConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource does not exist, or access was denied.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You exceeded your service quota. Service quotas, also referred to as limits,
	// are the maximum number of service resources or operations for your Amazon
	// Web Services account.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"
)
View Source
const (
	ServiceName = "AmplifyUIBuilder" // Name of service.
	EndpointsID = "amplifyuibuilder" // ID to lookup a service endpoint with.
	ServiceID   = "AmplifyUIBuilder" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// TokenProvidersFigma is a TokenProviders enum value
	TokenProvidersFigma = "figma"
)

Variables

This section is empty.

Functions

func SortDirection_Values

func SortDirection_Values() []string

SortDirection_Values returns all elements of the SortDirection enum

func TokenProviders_Values

func TokenProviders_Values() []string

TokenProviders_Values returns all elements of the TokenProviders enum

Types

type ActionParameters added in v1.43.8

type ActionParameters struct {

	// The HTML anchor link to the location to open. Specify this value for a navigation
	// action.
	Anchor *ComponentProperty `locationName:"anchor" type:"structure"`

	// A dictionary of key-value pairs mapping Amplify Studio properties to fields
	// in a data model. Use when the action performs an operation on an Amplify
	// DataStore model.
	Fields map[string]*ComponentProperty `locationName:"fields" type:"map"`

	// Specifies whether the user should be signed out globally. Specify this value
	// for an auth sign out action.
	Global *ComponentProperty `locationName:"global" type:"structure"`

	// The unique ID of the component that the ActionParameters apply to.
	Id *ComponentProperty `locationName:"id" type:"structure"`

	// The name of the data model. Use when the action performs an operation on
	// an Amplify DataStore model.
	Model *string `locationName:"model" type:"string"`

	// A key-value pair that specifies the state property name and its initial value.
	State *MutationActionSetStateParameter `locationName:"state" type:"structure"`

	// The element within the same component to modify when the action occurs.
	Target *ComponentProperty `locationName:"target" type:"structure"`

	// The type of navigation action. Valid values are url and anchor. This value
	// is required for a navigation action.
	Type *ComponentProperty `locationName:"type" type:"structure"`

	// The URL to the location to open. Specify this value for a navigation action.
	Url *ComponentProperty `locationName:"url" type:"structure"`
	// contains filtered or unexported fields
}

Represents the event action configuration for an element of a Component or ComponentChild. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.

func (ActionParameters) GoString added in v1.43.8

func (s ActionParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionParameters) SetAnchor added in v1.43.8

SetAnchor sets the Anchor field's value.

func (*ActionParameters) SetFields added in v1.43.8

SetFields sets the Fields field's value.

func (*ActionParameters) SetGlobal added in v1.43.8

SetGlobal sets the Global field's value.

func (*ActionParameters) SetId added in v1.43.8

SetId sets the Id field's value.

func (*ActionParameters) SetModel added in v1.43.8

func (s *ActionParameters) SetModel(v string) *ActionParameters

SetModel sets the Model field's value.

func (*ActionParameters) SetState added in v1.43.8

SetState sets the State field's value.

func (*ActionParameters) SetTarget added in v1.43.8

SetTarget sets the Target field's value.

func (*ActionParameters) SetType added in v1.43.8

SetType sets the Type field's value.

func (*ActionParameters) SetUrl added in v1.43.8

SetUrl sets the Url field's value.

func (ActionParameters) String added in v1.43.8

func (s ActionParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionParameters) Validate added in v1.43.8

func (s *ActionParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AmplifyUIBuilder

type AmplifyUIBuilder struct {
	*client.Client
}

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

AmplifyUIBuilder 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 AmplifyUIBuilder client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

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

// Create a AmplifyUIBuilder client from just a session.
svc := amplifyuibuilder.New(mySession)

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

func (*AmplifyUIBuilder) CreateComponent

func (c *AmplifyUIBuilder) CreateComponent(input *CreateComponentInput) (*CreateComponentOutput, error)

CreateComponent API operation for AWS Amplify UI Builder.

Creates a new component for an Amplify app.

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

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

Returned Error Types:

  • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateComponent

func (*AmplifyUIBuilder) CreateComponentRequest

func (c *AmplifyUIBuilder) CreateComponentRequest(input *CreateComponentInput) (req *request.Request, output *CreateComponentOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateComponent

func (*AmplifyUIBuilder) CreateComponentWithContext

func (c *AmplifyUIBuilder) CreateComponentWithContext(ctx aws.Context, input *CreateComponentInput, opts ...request.Option) (*CreateComponentOutput, error)

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

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

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

func (*AmplifyUIBuilder) CreateTheme

func (c *AmplifyUIBuilder) CreateTheme(input *CreateThemeInput) (*CreateThemeOutput, error)

CreateTheme API operation for AWS Amplify UI Builder.

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

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

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

Returned Error Types:

  • ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateTheme

func (*AmplifyUIBuilder) CreateThemeRequest

func (c *AmplifyUIBuilder) CreateThemeRequest(input *CreateThemeInput) (req *request.Request, output *CreateThemeOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateTheme

func (*AmplifyUIBuilder) CreateThemeWithContext

func (c *AmplifyUIBuilder) CreateThemeWithContext(ctx aws.Context, input *CreateThemeInput, opts ...request.Option) (*CreateThemeOutput, error)

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

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

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

func (*AmplifyUIBuilder) DeleteComponent

func (c *AmplifyUIBuilder) DeleteComponent(input *DeleteComponentInput) (*DeleteComponentOutput, error)

DeleteComponent API operation for AWS Amplify UI Builder.

Deletes a component from an Amplify app.

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/DeleteComponent

func (*AmplifyUIBuilder) DeleteComponentRequest

func (c *AmplifyUIBuilder) DeleteComponentRequest(input *DeleteComponentInput) (req *request.Request, output *DeleteComponentOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/DeleteComponent

func (*AmplifyUIBuilder) DeleteComponentWithContext

func (c *AmplifyUIBuilder) DeleteComponentWithContext(ctx aws.Context, input *DeleteComponentInput, opts ...request.Option) (*DeleteComponentOutput, error)

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

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

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

func (*AmplifyUIBuilder) DeleteTheme

func (c *AmplifyUIBuilder) DeleteTheme(input *DeleteThemeInput) (*DeleteThemeOutput, error)

DeleteTheme API operation for AWS Amplify UI Builder.

Deletes a theme from an Amplify app.

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/DeleteTheme

func (*AmplifyUIBuilder) DeleteThemeRequest

func (c *AmplifyUIBuilder) DeleteThemeRequest(input *DeleteThemeInput) (req *request.Request, output *DeleteThemeOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/DeleteTheme

func (*AmplifyUIBuilder) DeleteThemeWithContext

func (c *AmplifyUIBuilder) DeleteThemeWithContext(ctx aws.Context, input *DeleteThemeInput, opts ...request.Option) (*DeleteThemeOutput, error)

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

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

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

func (*AmplifyUIBuilder) ExchangeCodeForToken

func (c *AmplifyUIBuilder) ExchangeCodeForToken(input *ExchangeCodeForTokenInput) (*ExchangeCodeForTokenOutput, error)

ExchangeCodeForToken API operation for AWS Amplify UI Builder.

Exchanges an access code for a token.

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

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

Returned Error Types:

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExchangeCodeForToken

func (*AmplifyUIBuilder) ExchangeCodeForTokenRequest

func (c *AmplifyUIBuilder) ExchangeCodeForTokenRequest(input *ExchangeCodeForTokenInput) (req *request.Request, output *ExchangeCodeForTokenOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExchangeCodeForToken

func (*AmplifyUIBuilder) ExchangeCodeForTokenWithContext

func (c *AmplifyUIBuilder) ExchangeCodeForTokenWithContext(ctx aws.Context, input *ExchangeCodeForTokenInput, opts ...request.Option) (*ExchangeCodeForTokenOutput, error)

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

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

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

func (*AmplifyUIBuilder) ExportComponents

func (c *AmplifyUIBuilder) ExportComponents(input *ExportComponentsInput) (*ExportComponentsOutput, error)

ExportComponents API operation for AWS Amplify UI Builder.

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

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportComponents

func (*AmplifyUIBuilder) ExportComponentsPages added in v1.43.8

func (c *AmplifyUIBuilder) ExportComponentsPages(input *ExportComponentsInput, fn func(*ExportComponentsOutput, bool) bool) error

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

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

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

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

func (*AmplifyUIBuilder) ExportComponentsPagesWithContext added in v1.43.8

func (c *AmplifyUIBuilder) ExportComponentsPagesWithContext(ctx aws.Context, input *ExportComponentsInput, fn func(*ExportComponentsOutput, bool) bool, opts ...request.Option) error

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

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

func (*AmplifyUIBuilder) ExportComponentsRequest

func (c *AmplifyUIBuilder) ExportComponentsRequest(input *ExportComponentsInput) (req *request.Request, output *ExportComponentsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportComponents

func (*AmplifyUIBuilder) ExportComponentsWithContext

func (c *AmplifyUIBuilder) ExportComponentsWithContext(ctx aws.Context, input *ExportComponentsInput, opts ...request.Option) (*ExportComponentsOutput, error)

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

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

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

func (*AmplifyUIBuilder) ExportThemes

func (c *AmplifyUIBuilder) ExportThemes(input *ExportThemesInput) (*ExportThemesOutput, error)

ExportThemes API operation for AWS Amplify UI Builder.

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

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportThemes

func (*AmplifyUIBuilder) ExportThemesPages added in v1.43.8

func (c *AmplifyUIBuilder) ExportThemesPages(input *ExportThemesInput, fn func(*ExportThemesOutput, bool) bool) error

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

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

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

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

func (*AmplifyUIBuilder) ExportThemesPagesWithContext added in v1.43.8

func (c *AmplifyUIBuilder) ExportThemesPagesWithContext(ctx aws.Context, input *ExportThemesInput, fn func(*ExportThemesOutput, bool) bool, opts ...request.Option) error

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

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

func (*AmplifyUIBuilder) ExportThemesRequest

func (c *AmplifyUIBuilder) ExportThemesRequest(input *ExportThemesInput) (req *request.Request, output *ExportThemesOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportThemes

func (*AmplifyUIBuilder) ExportThemesWithContext

func (c *AmplifyUIBuilder) ExportThemesWithContext(ctx aws.Context, input *ExportThemesInput, opts ...request.Option) (*ExportThemesOutput, error)

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

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

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

func (*AmplifyUIBuilder) GetComponent

func (c *AmplifyUIBuilder) GetComponent(input *GetComponentInput) (*GetComponentOutput, error)

GetComponent API operation for AWS Amplify UI Builder.

Returns an existing component for an Amplify app.

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetComponent

func (*AmplifyUIBuilder) GetComponentRequest

func (c *AmplifyUIBuilder) GetComponentRequest(input *GetComponentInput) (req *request.Request, output *GetComponentOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetComponent

func (*AmplifyUIBuilder) GetComponentWithContext

func (c *AmplifyUIBuilder) GetComponentWithContext(ctx aws.Context, input *GetComponentInput, opts ...request.Option) (*GetComponentOutput, error)

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

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

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

func (*AmplifyUIBuilder) GetTheme

func (c *AmplifyUIBuilder) GetTheme(input *GetThemeInput) (*GetThemeOutput, error)

GetTheme API operation for AWS Amplify UI Builder.

Returns an existing theme for an Amplify app.

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

  • ResourceNotFoundException The requested resource does not exist, or access was denied.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetTheme

func (*AmplifyUIBuilder) GetThemeRequest

func (c *AmplifyUIBuilder) GetThemeRequest(input *GetThemeInput) (req *request.Request, output *GetThemeOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetTheme

func (*AmplifyUIBuilder) GetThemeWithContext

func (c *AmplifyUIBuilder) GetThemeWithContext(ctx aws.Context, input *GetThemeInput, opts ...request.Option) (*GetThemeOutput, error)

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

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

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

func (*AmplifyUIBuilder) ListComponents

func (c *AmplifyUIBuilder) ListComponents(input *ListComponentsInput) (*ListComponentsOutput, error)

ListComponents API operation for AWS Amplify UI Builder.

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

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListComponents

func (*AmplifyUIBuilder) ListComponentsPages

func (c *AmplifyUIBuilder) ListComponentsPages(input *ListComponentsInput, fn func(*ListComponentsOutput, bool) bool) error

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

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

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

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

func (*AmplifyUIBuilder) ListComponentsPagesWithContext

func (c *AmplifyUIBuilder) ListComponentsPagesWithContext(ctx aws.Context, input *ListComponentsInput, fn func(*ListComponentsOutput, bool) bool, opts ...request.Option) error

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

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

func (*AmplifyUIBuilder) ListComponentsRequest

func (c *AmplifyUIBuilder) ListComponentsRequest(input *ListComponentsInput) (req *request.Request, output *ListComponentsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListComponents

func (*AmplifyUIBuilder) ListComponentsWithContext

func (c *AmplifyUIBuilder) ListComponentsWithContext(ctx aws.Context, input *ListComponentsInput, opts ...request.Option) (*ListComponentsOutput, error)

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

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

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

func (*AmplifyUIBuilder) ListThemes

func (c *AmplifyUIBuilder) ListThemes(input *ListThemesInput) (*ListThemesOutput, error)

ListThemes API operation for AWS Amplify UI Builder.

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

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

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

Returned Error Types:

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListThemes

func (*AmplifyUIBuilder) ListThemesPages

func (c *AmplifyUIBuilder) ListThemesPages(input *ListThemesInput, fn func(*ListThemesOutput, bool) bool) error

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

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

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

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

func (*AmplifyUIBuilder) ListThemesPagesWithContext

func (c *AmplifyUIBuilder) ListThemesPagesWithContext(ctx aws.Context, input *ListThemesInput, fn func(*ListThemesOutput, bool) bool, opts ...request.Option) error

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

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

func (*AmplifyUIBuilder) ListThemesRequest

func (c *AmplifyUIBuilder) ListThemesRequest(input *ListThemesInput) (req *request.Request, output *ListThemesOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListThemes

func (*AmplifyUIBuilder) ListThemesWithContext

func (c *AmplifyUIBuilder) ListThemesWithContext(ctx aws.Context, input *ListThemesInput, opts ...request.Option) (*ListThemesOutput, error)

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

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

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

func (*AmplifyUIBuilder) RefreshToken

func (c *AmplifyUIBuilder) RefreshToken(input *RefreshTokenInput) (*RefreshTokenOutput, error)

RefreshToken API operation for AWS Amplify UI Builder.

Refreshes a previously issued access token that might have expired.

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

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

Returned Error Types:

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/RefreshToken

func (*AmplifyUIBuilder) RefreshTokenRequest

func (c *AmplifyUIBuilder) RefreshTokenRequest(input *RefreshTokenInput) (req *request.Request, output *RefreshTokenOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/RefreshToken

func (*AmplifyUIBuilder) RefreshTokenWithContext

func (c *AmplifyUIBuilder) RefreshTokenWithContext(ctx aws.Context, input *RefreshTokenInput, opts ...request.Option) (*RefreshTokenOutput, error)

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

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

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

func (*AmplifyUIBuilder) UpdateComponent

func (c *AmplifyUIBuilder) UpdateComponent(input *UpdateComponentInput) (*UpdateComponentOutput, error)

UpdateComponent API operation for AWS Amplify UI Builder.

Updates an existing component.

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

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

Returned Error Types:

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateComponent

func (*AmplifyUIBuilder) UpdateComponentRequest

func (c *AmplifyUIBuilder) UpdateComponentRequest(input *UpdateComponentInput) (req *request.Request, output *UpdateComponentOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateComponent

func (*AmplifyUIBuilder) UpdateComponentWithContext

func (c *AmplifyUIBuilder) UpdateComponentWithContext(ctx aws.Context, input *UpdateComponentInput, opts ...request.Option) (*UpdateComponentOutput, error)

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

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

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

func (*AmplifyUIBuilder) UpdateTheme

func (c *AmplifyUIBuilder) UpdateTheme(input *UpdateThemeInput) (*UpdateThemeOutput, error)

UpdateTheme API operation for AWS Amplify UI Builder.

Updates an existing theme.

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

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

Returned Error Types:

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

  • InternalServerException An internal error has occurred. Please retry your request.

  • InvalidParameterException An invalid or out-of-range value was supplied for the input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateTheme

func (*AmplifyUIBuilder) UpdateThemeRequest

func (c *AmplifyUIBuilder) UpdateThemeRequest(input *UpdateThemeInput) (req *request.Request, output *UpdateThemeOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateTheme

func (*AmplifyUIBuilder) UpdateThemeWithContext

func (c *AmplifyUIBuilder) UpdateThemeWithContext(ctx aws.Context, input *UpdateThemeInput, opts ...request.Option) (*UpdateThemeOutput, error)

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

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

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

type Component

type Component struct {

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

	// The information to connect a component's properties to data at runtime. You
	// can't specify tags as a valid property for bindingProperties.
	//
	// BindingProperties is a required field
	BindingProperties map[string]*ComponentBindingPropertiesValue `locationName:"bindingProperties" type:"map" required:"true"`

	// A list of the component's ComponentChild instances.
	Children []*ComponentChild `locationName:"children" type:"list"`

	// The data binding configuration for the component's properties. Use this for
	// a collection component. You can't specify tags as a valid property for collectionProperties.
	CollectionProperties map[string]*ComponentDataConfiguration `locationName:"collectionProperties" type:"map"`

	// The type of the component. This can be an Amplify custom UI component or
	// another custom component.
	//
	// ComponentType is a required field
	ComponentType *string `locationName:"componentType" min:"1" type:"string" required:"true"`

	// The time that the component was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `locationName:"environmentName" type:"string" required:"true"`

	// Describes the events that can be raised on the component. Use for the workflow
	// feature in Amplify Studio that allows you to bind events and actions to components.
	Events map[string]*ComponentEvent `locationName:"events" type:"map"`

	// The unique ID of the component.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The time that the component was modified.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The name of the component.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Describes the component's properties that can be overriden in a customized
	// instance of the component. You can't specify tags as a valid property for
	// overrides.
	//
	// Overrides is a required field
	Overrides map[string]map[string]*string `locationName:"overrides" type:"map" required:"true"`

	// Describes the component's properties. You can't specify tags as a valid property
	// for properties.
	//
	// Properties is a required field
	Properties map[string]*ComponentProperty `locationName:"properties" type:"map" required:"true"`

	// The schema version of the component when it was imported.
	SchemaVersion *string `locationName:"schemaVersion" type:"string"`

	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string `locationName:"sourceId" type:"string"`

	// One or more key-value pairs to use when tagging the component.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of the component's variants. A variant is a unique style configuration
	// of a main component.
	//
	// Variants is a required field
	Variants []*ComponentVariant `locationName:"variants" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.

func (Component) GoString

func (s Component) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Component) SetAppId

func (s *Component) SetAppId(v string) *Component

SetAppId sets the AppId field's value.

func (*Component) SetBindingProperties

func (s *Component) SetBindingProperties(v map[string]*ComponentBindingPropertiesValue) *Component

SetBindingProperties sets the BindingProperties field's value.

func (*Component) SetChildren

func (s *Component) SetChildren(v []*ComponentChild) *Component

SetChildren sets the Children field's value.

func (*Component) SetCollectionProperties

func (s *Component) SetCollectionProperties(v map[string]*ComponentDataConfiguration) *Component

SetCollectionProperties sets the CollectionProperties field's value.

func (*Component) SetComponentType

func (s *Component) SetComponentType(v string) *Component

SetComponentType sets the ComponentType field's value.

func (*Component) SetCreatedAt

func (s *Component) SetCreatedAt(v time.Time) *Component

SetCreatedAt sets the CreatedAt field's value.

func (*Component) SetEnvironmentName

func (s *Component) SetEnvironmentName(v string) *Component

SetEnvironmentName sets the EnvironmentName field's value.

func (*Component) SetEvents added in v1.43.8

func (s *Component) SetEvents(v map[string]*ComponentEvent) *Component

SetEvents sets the Events field's value.

func (*Component) SetId

func (s *Component) SetId(v string) *Component

SetId sets the Id field's value.

func (*Component) SetModifiedAt

func (s *Component) SetModifiedAt(v time.Time) *Component

SetModifiedAt sets the ModifiedAt field's value.

func (*Component) SetName

func (s *Component) SetName(v string) *Component

SetName sets the Name field's value.

func (*Component) SetOverrides

func (s *Component) SetOverrides(v map[string]map[string]*string) *Component

SetOverrides sets the Overrides field's value.

func (*Component) SetProperties

func (s *Component) SetProperties(v map[string]*ComponentProperty) *Component

SetProperties sets the Properties field's value.

func (*Component) SetSchemaVersion added in v1.43.8

func (s *Component) SetSchemaVersion(v string) *Component

SetSchemaVersion sets the SchemaVersion field's value.

func (*Component) SetSourceId

func (s *Component) SetSourceId(v string) *Component

SetSourceId sets the SourceId field's value.

func (*Component) SetTags

func (s *Component) SetTags(v map[string]*string) *Component

SetTags sets the Tags field's value.

func (*Component) SetVariants

func (s *Component) SetVariants(v []*ComponentVariant) *Component

SetVariants sets the Variants field's value.

func (Component) String

func (s Component) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentBindingPropertiesValue

type ComponentBindingPropertiesValue struct {

	// Describes the properties to customize with data at runtime.
	BindingProperties *ComponentBindingPropertiesValueProperties `locationName:"bindingProperties" type:"structure"`

	// The default value of the property.
	DefaultValue *string `locationName:"defaultValue" type:"string"`

	// The property type.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.

func (ComponentBindingPropertiesValue) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentBindingPropertiesValue) SetBindingProperties

SetBindingProperties sets the BindingProperties field's value.

func (*ComponentBindingPropertiesValue) SetDefaultValue

SetDefaultValue sets the DefaultValue field's value.

func (*ComponentBindingPropertiesValue) SetType

SetType sets the Type field's value.

func (ComponentBindingPropertiesValue) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentBindingPropertiesValueProperties

type ComponentBindingPropertiesValueProperties struct {

	// An Amazon S3 bucket.
	Bucket *string `locationName:"bucket" type:"string"`

	// The default value to assign to the property.
	DefaultValue *string `locationName:"defaultValue" type:"string"`

	// The field to bind the data to.
	Field *string `locationName:"field" type:"string"`

	// The storage key for an Amazon S3 bucket.
	Key *string `locationName:"key" type:"string"`

	// An Amplify DataStore model.
	Model *string `locationName:"model" type:"string"`

	// A list of predicates for binding a component's properties to data.
	Predicates []*Predicate `locationName:"predicates" type:"list"`

	// An authenticated user attribute.
	UserAttribute *string `locationName:"userAttribute" type:"string"`
	// contains filtered or unexported fields
}

Represents the data binding configuration for a specific property using data stored in Amazon Web Services. For Amazon Web Services connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute.

func (ComponentBindingPropertiesValueProperties) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentBindingPropertiesValueProperties) SetBucket

SetBucket sets the Bucket field's value.

func (*ComponentBindingPropertiesValueProperties) SetDefaultValue

SetDefaultValue sets the DefaultValue field's value.

func (*ComponentBindingPropertiesValueProperties) SetField

SetField sets the Field field's value.

func (*ComponentBindingPropertiesValueProperties) SetKey

SetKey sets the Key field's value.

func (*ComponentBindingPropertiesValueProperties) SetModel

SetModel sets the Model field's value.

func (*ComponentBindingPropertiesValueProperties) SetPredicates

SetPredicates sets the Predicates field's value.

func (*ComponentBindingPropertiesValueProperties) SetUserAttribute

SetUserAttribute sets the UserAttribute field's value.

func (ComponentBindingPropertiesValueProperties) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentChild

type ComponentChild struct {

	// The list of ComponentChild instances for this component.
	Children []*ComponentChild `locationName:"children" type:"list"`

	// The type of the child component.
	//
	// ComponentType is a required field
	ComponentType *string `locationName:"componentType" type:"string" required:"true"`

	// Describes the events that can be raised on the child component. Use for the
	// workflow feature in Amplify Studio that allows you to bind events and actions
	// to components.
	Events map[string]*ComponentEvent `locationName:"events" type:"map"`

	// The name of the child component.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Describes the properties of the child component. You can't specify tags as
	// a valid property for properties.
	//
	// Properties is a required field
	Properties map[string]*ComponentProperty `locationName:"properties" type:"map" required:"true"`

	// The unique ID of the child component in its original source system, such
	// as Figma.
	SourceId *string `locationName:"sourceId" type:"string"`
	// contains filtered or unexported fields
}

A nested UI configuration within a parent Component.

func (ComponentChild) GoString

func (s ComponentChild) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentChild) SetChildren

func (s *ComponentChild) SetChildren(v []*ComponentChild) *ComponentChild

SetChildren sets the Children field's value.

func (*ComponentChild) SetComponentType

func (s *ComponentChild) SetComponentType(v string) *ComponentChild

SetComponentType sets the ComponentType field's value.

func (*ComponentChild) SetEvents added in v1.43.8

func (s *ComponentChild) SetEvents(v map[string]*ComponentEvent) *ComponentChild

SetEvents sets the Events field's value.

func (*ComponentChild) SetName

func (s *ComponentChild) SetName(v string) *ComponentChild

SetName sets the Name field's value.

func (*ComponentChild) SetProperties

func (s *ComponentChild) SetProperties(v map[string]*ComponentProperty) *ComponentChild

SetProperties sets the Properties field's value.

func (*ComponentChild) SetSourceId added in v1.43.37

func (s *ComponentChild) SetSourceId(v string) *ComponentChild

SetSourceId sets the SourceId field's value.

func (ComponentChild) String

func (s ComponentChild) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentChild) Validate

func (s *ComponentChild) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentConditionProperty

type ComponentConditionProperty struct {

	// The value to assign to the property if the condition is not met.
	Else *ComponentProperty `locationName:"else" type:"structure"`

	// The name of a field. Specify this when the property is a data model.
	Field *string `locationName:"field" type:"string"`

	// The value of the property to evaluate.
	Operand *string `locationName:"operand" type:"string"`

	// The type of the property to evaluate.
	OperandType *string `locationName:"operandType" type:"string"`

	// The operator to use to perform the evaluation, such as eq to represent equals.
	Operator *string `locationName:"operator" type:"string"`

	// The name of the conditional property.
	Property *string `locationName:"property" type:"string"`

	// The value to assign to the property if the condition is met.
	Then *ComponentProperty `locationName:"then" type:"structure"`
	// contains filtered or unexported fields
}

Represents a conditional expression to set a component property. Use ComponentConditionProperty to set a property to different values conditionally, based on the value of another property.

func (ComponentConditionProperty) GoString

func (s ComponentConditionProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentConditionProperty) SetElse

SetElse sets the Else field's value.

func (*ComponentConditionProperty) SetField

SetField sets the Field field's value.

func (*ComponentConditionProperty) SetOperand

SetOperand sets the Operand field's value.

func (*ComponentConditionProperty) SetOperandType added in v1.43.8

SetOperandType sets the OperandType field's value.

func (*ComponentConditionProperty) SetOperator

SetOperator sets the Operator field's value.

func (*ComponentConditionProperty) SetProperty

SetProperty sets the Property field's value.

func (*ComponentConditionProperty) SetThen

SetThen sets the Then field's value.

func (ComponentConditionProperty) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentConditionProperty) Validate

func (s *ComponentConditionProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentDataConfiguration

type ComponentDataConfiguration struct {

	// A list of IDs to use to bind data to a component. Use this property to bind
	// specifically chosen data, rather than data retrieved from a query.
	Identifiers []*string `locationName:"identifiers" type:"list"`

	// The name of the data model to use to bind data to a component.
	//
	// Model is a required field
	Model *string `locationName:"model" type:"string" required:"true"`

	// Represents the conditional logic to use when binding data to a component.
	// Use this property to retrieve only a subset of the data in a collection.
	Predicate *Predicate `locationName:"predicate" type:"structure"`

	// Describes how to sort the component's properties.
	Sort []*SortProperty `locationName:"sort" type:"list"`
	// contains filtered or unexported fields
}

Describes the configuration for binding a component's properties to data.

func (ComponentDataConfiguration) GoString

func (s ComponentDataConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentDataConfiguration) SetIdentifiers

SetIdentifiers sets the Identifiers field's value.

func (*ComponentDataConfiguration) SetModel

SetModel sets the Model field's value.

func (*ComponentDataConfiguration) SetPredicate

SetPredicate sets the Predicate field's value.

func (*ComponentDataConfiguration) SetSort

SetSort sets the Sort field's value.

func (ComponentDataConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentDataConfiguration) Validate

func (s *ComponentDataConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentEvent added in v1.43.8

type ComponentEvent struct {

	// The action to perform when a specific event is raised.
	Action *string `locationName:"action" type:"string"`

	// Binds an event to an action on a component. When you specify a bindingEvent,
	// the event is called when the action is performed.
	BindingEvent *string `locationName:"bindingEvent" type:"string"`

	// Describes information about the action.
	Parameters *ActionParameters `locationName:"parameters" type:"structure"`
	// contains filtered or unexported fields
}

Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild. A button click is an example of an event.

func (ComponentEvent) GoString added in v1.43.8

func (s ComponentEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentEvent) SetAction added in v1.43.8

func (s *ComponentEvent) SetAction(v string) *ComponentEvent

SetAction sets the Action field's value.

func (*ComponentEvent) SetBindingEvent added in v1.43.37

func (s *ComponentEvent) SetBindingEvent(v string) *ComponentEvent

SetBindingEvent sets the BindingEvent field's value.

func (*ComponentEvent) SetParameters added in v1.43.8

func (s *ComponentEvent) SetParameters(v *ActionParameters) *ComponentEvent

SetParameters sets the Parameters field's value.

func (ComponentEvent) String added in v1.43.8

func (s ComponentEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentEvent) Validate added in v1.43.8

func (s *ComponentEvent) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentProperty

type ComponentProperty struct {

	// The information to bind the component property to data at runtime.
	BindingProperties *ComponentPropertyBindingProperties `locationName:"bindingProperties" type:"structure"`

	// The information to bind the component property to form data.
	Bindings map[string]*FormBindingElement `locationName:"bindings" type:"map"`

	// The information to bind the component property to data at runtime. Use this
	// for collection components.
	CollectionBindingProperties *ComponentPropertyBindingProperties `locationName:"collectionBindingProperties" type:"structure"`

	// The name of the component that is affected by an event.
	ComponentName *string `locationName:"componentName" type:"string"`

	// A list of component properties to concatenate to create the value to assign
	// to this component property.
	Concat []*ComponentProperty `locationName:"concat" type:"list"`

	// The conditional expression to use to assign a value to the component property.
	Condition *ComponentConditionProperty `locationName:"condition" type:"structure"`

	// Specifies whether the user configured the property in Amplify Studio after
	// importing it.
	Configured *bool `locationName:"configured" type:"boolean"`

	// The default value to assign to the component property.
	DefaultValue *string `locationName:"defaultValue" type:"string"`

	// An event that occurs in your app. Use this for workflow data binding.
	Event *string `locationName:"event" type:"string"`

	// The default value assigned to the property when the component is imported
	// into an app.
	ImportedValue *string `locationName:"importedValue" type:"string"`

	// The data model to use to assign a value to the component property.
	Model *string `locationName:"model" type:"string"`

	// The name of the component's property that is affected by an event.
	Property *string `locationName:"property" type:"string"`

	// The component type.
	Type *string `locationName:"type" type:"string"`

	// An authenticated user attribute to use to assign a value to the component
	// property.
	UserAttribute *string `locationName:"userAttribute" type:"string"`

	// The value to assign to the component property.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.

func (ComponentProperty) GoString

func (s ComponentProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentProperty) SetBindingProperties

SetBindingProperties sets the BindingProperties field's value.

func (*ComponentProperty) SetBindings

SetBindings sets the Bindings field's value.

func (*ComponentProperty) SetCollectionBindingProperties

func (s *ComponentProperty) SetCollectionBindingProperties(v *ComponentPropertyBindingProperties) *ComponentProperty

SetCollectionBindingProperties sets the CollectionBindingProperties field's value.

func (*ComponentProperty) SetComponentName added in v1.43.8

func (s *ComponentProperty) SetComponentName(v string) *ComponentProperty

SetComponentName sets the ComponentName field's value.

func (*ComponentProperty) SetConcat

SetConcat sets the Concat field's value.

func (*ComponentProperty) SetCondition

SetCondition sets the Condition field's value.

func (*ComponentProperty) SetConfigured

func (s *ComponentProperty) SetConfigured(v bool) *ComponentProperty

SetConfigured sets the Configured field's value.

func (*ComponentProperty) SetDefaultValue

func (s *ComponentProperty) SetDefaultValue(v string) *ComponentProperty

SetDefaultValue sets the DefaultValue field's value.

func (*ComponentProperty) SetEvent

func (s *ComponentProperty) SetEvent(v string) *ComponentProperty

SetEvent sets the Event field's value.

func (*ComponentProperty) SetImportedValue

func (s *ComponentProperty) SetImportedValue(v string) *ComponentProperty

SetImportedValue sets the ImportedValue field's value.

func (*ComponentProperty) SetModel

func (s *ComponentProperty) SetModel(v string) *ComponentProperty

SetModel sets the Model field's value.

func (*ComponentProperty) SetProperty added in v1.43.8

func (s *ComponentProperty) SetProperty(v string) *ComponentProperty

SetProperty sets the Property field's value.

func (*ComponentProperty) SetType

SetType sets the Type field's value.

func (*ComponentProperty) SetUserAttribute

func (s *ComponentProperty) SetUserAttribute(v string) *ComponentProperty

SetUserAttribute sets the UserAttribute field's value.

func (*ComponentProperty) SetValue

func (s *ComponentProperty) SetValue(v string) *ComponentProperty

SetValue sets the Value field's value.

func (ComponentProperty) String

func (s ComponentProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentProperty) Validate

func (s *ComponentProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentPropertyBindingProperties

type ComponentPropertyBindingProperties struct {

	// The data field to bind the property to.
	Field *string `locationName:"field" type:"string"`

	// The component property to bind to the data field.
	//
	// Property is a required field
	Property *string `locationName:"property" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Associates a component property to a binding property. This enables exposed properties on the top level component to propagate data to the component's property values.

func (ComponentPropertyBindingProperties) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentPropertyBindingProperties) SetField

SetField sets the Field field's value.

func (*ComponentPropertyBindingProperties) SetProperty

SetProperty sets the Property field's value.

func (ComponentPropertyBindingProperties) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentPropertyBindingProperties) Validate

Validate inspects the fields of the type to determine if they are valid.

type ComponentSummary

type ComponentSummary struct {

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

	// The component type.
	//
	// ComponentType is a required field
	ComponentType *string `locationName:"componentType" min:"1" type:"string" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `locationName:"environmentName" type:"string" required:"true"`

	// The unique ID of the component.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the component.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of a component. This is a read-only data type that is returned by ListComponents.

func (ComponentSummary) GoString

func (s ComponentSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentSummary) SetAppId

func (s *ComponentSummary) SetAppId(v string) *ComponentSummary

SetAppId sets the AppId field's value.

func (*ComponentSummary) SetComponentType

func (s *ComponentSummary) SetComponentType(v string) *ComponentSummary

SetComponentType sets the ComponentType field's value.

func (*ComponentSummary) SetEnvironmentName

func (s *ComponentSummary) SetEnvironmentName(v string) *ComponentSummary

SetEnvironmentName sets the EnvironmentName field's value.

func (*ComponentSummary) SetId

SetId sets the Id field's value.

func (*ComponentSummary) SetName

func (s *ComponentSummary) SetName(v string) *ComponentSummary

SetName sets the Name field's value.

func (ComponentSummary) String

func (s ComponentSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentVariant

type ComponentVariant struct {

	// The properties of the component variant that can be overriden when customizing
	// an instance of the component. You can't specify tags as a valid property
	// for overrides.
	Overrides map[string]map[string]*string `locationName:"overrides" type:"map"`

	// The combination of variants that comprise this variant. You can't specify
	// tags as a valid property for variantValues.
	VariantValues map[string]*string `locationName:"variantValues" type:"map"`
	// contains filtered or unexported fields
}

Describes the style configuration of a unique variation of a main component.

func (ComponentVariant) GoString

func (s ComponentVariant) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentVariant) SetOverrides

func (s *ComponentVariant) SetOverrides(v map[string]map[string]*string) *ComponentVariant

SetOverrides sets the Overrides field's value.

func (*ComponentVariant) SetVariantValues

func (s *ComponentVariant) SetVariantValues(v map[string]*string) *ComponentVariant

SetVariantValues sets the VariantValues field's value.

func (ComponentVariant) String

func (s ComponentVariant) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateComponentData

type CreateComponentData struct {

	// The data binding information for the component's properties.
	//
	// BindingProperties is a required field
	BindingProperties map[string]*ComponentBindingPropertiesValue `locationName:"bindingProperties" type:"map" required:"true"`

	// A list of child components that are instances of the main component.
	Children []*ComponentChild `locationName:"children" type:"list"`

	// The data binding configuration for customizing a component's properties.
	// Use this for a collection component.
	CollectionProperties map[string]*ComponentDataConfiguration `locationName:"collectionProperties" type:"map"`

	// The component type. This can be an Amplify custom UI component or another
	// custom component.
	//
	// ComponentType is a required field
	ComponentType *string `locationName:"componentType" min:"1" type:"string" required:"true"`

	// The event configuration for the component. Use for the workflow feature in
	// Amplify Studio that allows you to bind events and actions to components.
	Events map[string]*ComponentEvent `locationName:"events" type:"map"`

	// The name of the component
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Describes the component properties that can be overriden to customize an
	// instance of the component.
	//
	// Overrides is a required field
	Overrides map[string]map[string]*string `locationName:"overrides" type:"map" required:"true"`

	// Describes the component's properties.
	//
	// Properties is a required field
	Properties map[string]*ComponentProperty `locationName:"properties" type:"map" required:"true"`

	// The schema version of the component when it was imported.
	SchemaVersion *string `locationName:"schemaVersion" type:"string"`

	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string `locationName:"sourceId" type:"string"`

	// One or more key-value pairs to use when tagging the component data.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of the unique variants of this component.
	//
	// Variants is a required field
	Variants []*ComponentVariant `locationName:"variants" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents all of the information that is required to create a component.

func (CreateComponentData) GoString

func (s CreateComponentData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentData) SetBindingProperties

SetBindingProperties sets the BindingProperties field's value.

func (*CreateComponentData) SetChildren

SetChildren sets the Children field's value.

func (*CreateComponentData) SetCollectionProperties

func (s *CreateComponentData) SetCollectionProperties(v map[string]*ComponentDataConfiguration) *CreateComponentData

SetCollectionProperties sets the CollectionProperties field's value.

func (*CreateComponentData) SetComponentType

func (s *CreateComponentData) SetComponentType(v string) *CreateComponentData

SetComponentType sets the ComponentType field's value.

func (*CreateComponentData) SetEvents added in v1.43.8

SetEvents sets the Events field's value.

func (*CreateComponentData) SetName

SetName sets the Name field's value.

func (*CreateComponentData) SetOverrides

func (s *CreateComponentData) SetOverrides(v map[string]map[string]*string) *CreateComponentData

SetOverrides sets the Overrides field's value.

func (*CreateComponentData) SetProperties

SetProperties sets the Properties field's value.

func (*CreateComponentData) SetSchemaVersion added in v1.43.8

func (s *CreateComponentData) SetSchemaVersion(v string) *CreateComponentData

SetSchemaVersion sets the SchemaVersion field's value.

func (*CreateComponentData) SetSourceId

func (s *CreateComponentData) SetSourceId(v string) *CreateComponentData

SetSourceId sets the SourceId field's value.

func (*CreateComponentData) SetTags

SetTags sets the Tags field's value.

func (*CreateComponentData) SetVariants

SetVariants sets the Variants field's value.

func (CreateComponentData) String

func (s CreateComponentData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentData) Validate

func (s *CreateComponentData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComponentInput

type CreateComponentInput struct {

	// The unique ID of the Amplify app to associate with the component.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The unique client token.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// Represents the configuration of the component to create.
	//
	// ComponentToCreate is a required field
	ComponentToCreate *CreateComponentData `locationName:"componentToCreate" type:"structure" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateComponentInput) GoString

func (s CreateComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentInput) SetAppId

SetAppId sets the AppId field's value.

func (*CreateComponentInput) SetClientToken

func (s *CreateComponentInput) SetClientToken(v string) *CreateComponentInput

SetClientToken sets the ClientToken field's value.

func (*CreateComponentInput) SetComponentToCreate

func (s *CreateComponentInput) SetComponentToCreate(v *CreateComponentData) *CreateComponentInput

SetComponentToCreate sets the ComponentToCreate field's value.

func (*CreateComponentInput) SetEnvironmentName

func (s *CreateComponentInput) SetEnvironmentName(v string) *CreateComponentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (CreateComponentInput) String

func (s CreateComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentInput) Validate

func (s *CreateComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComponentOutput

type CreateComponentOutput struct {

	// Describes the configuration of the new component.
	Entity *Component `locationName:"entity" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateComponentOutput) GoString

func (s CreateComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentOutput) SetEntity

SetEntity sets the Entity field's value.

func (CreateComponentOutput) String

func (s CreateComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateThemeData

type CreateThemeData struct {

	// The name of the theme.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Describes the properties that can be overriden to customize an instance of
	// the theme.
	Overrides []*ThemeValues `locationName:"overrides" type:"list"`

	// One or more key-value pairs to use when tagging the theme data.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of key-value pairs that defines the properties of the theme.
	//
	// Values is a required field
	Values []*ThemeValues `locationName:"values" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents all of the information that is required to create a theme.

func (CreateThemeData) GoString

func (s CreateThemeData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThemeData) SetName

func (s *CreateThemeData) SetName(v string) *CreateThemeData

SetName sets the Name field's value.

func (*CreateThemeData) SetOverrides

func (s *CreateThemeData) SetOverrides(v []*ThemeValues) *CreateThemeData

SetOverrides sets the Overrides field's value.

func (*CreateThemeData) SetTags

func (s *CreateThemeData) SetTags(v map[string]*string) *CreateThemeData

SetTags sets the Tags field's value.

func (*CreateThemeData) SetValues

func (s *CreateThemeData) SetValues(v []*ThemeValues) *CreateThemeData

SetValues sets the Values field's value.

func (CreateThemeData) String

func (s CreateThemeData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThemeData) Validate

func (s *CreateThemeData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateThemeInput

type CreateThemeInput struct {

	// The unique ID of the Amplify app associated with the theme.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The unique client token.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// Represents the configuration of the theme to create.
	//
	// ThemeToCreate is a required field
	ThemeToCreate *CreateThemeData `locationName:"themeToCreate" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateThemeInput) GoString

func (s CreateThemeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThemeInput) SetAppId

func (s *CreateThemeInput) SetAppId(v string) *CreateThemeInput

SetAppId sets the AppId field's value.

func (*CreateThemeInput) SetClientToken

func (s *CreateThemeInput) SetClientToken(v string) *CreateThemeInput

SetClientToken sets the ClientToken field's value.

func (*CreateThemeInput) SetEnvironmentName

func (s *CreateThemeInput) SetEnvironmentName(v string) *CreateThemeInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*CreateThemeInput) SetThemeToCreate

func (s *CreateThemeInput) SetThemeToCreate(v *CreateThemeData) *CreateThemeInput

SetThemeToCreate sets the ThemeToCreate field's value.

func (CreateThemeInput) String

func (s CreateThemeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThemeInput) Validate

func (s *CreateThemeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateThemeOutput

type CreateThemeOutput struct {

	// Describes the configuration of the new theme.
	Entity *Theme `locationName:"entity" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateThemeOutput) GoString

func (s CreateThemeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThemeOutput) SetEntity

func (s *CreateThemeOutput) SetEntity(v *Theme) *CreateThemeOutput

SetEntity sets the Entity field's value.

func (CreateThemeOutput) String

func (s CreateThemeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteComponentInput

type DeleteComponentInput struct {

	// The unique ID of the Amplify app associated with the component to delete.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The unique ID of the component to delete.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteComponentInput) GoString

func (s DeleteComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentInput) SetAppId

SetAppId sets the AppId field's value.

func (*DeleteComponentInput) SetEnvironmentName

func (s *DeleteComponentInput) SetEnvironmentName(v string) *DeleteComponentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*DeleteComponentInput) SetId

SetId sets the Id field's value.

func (DeleteComponentInput) String

func (s DeleteComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentInput) Validate

func (s *DeleteComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteComponentOutput

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

func (DeleteComponentOutput) GoString

func (s DeleteComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteComponentOutput) String

func (s DeleteComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteThemeInput

type DeleteThemeInput struct {

	// The unique ID of the Amplify app associated with the theme to delete.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The unique ID of the theme to delete.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteThemeInput) GoString

func (s DeleteThemeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThemeInput) SetAppId

func (s *DeleteThemeInput) SetAppId(v string) *DeleteThemeInput

SetAppId sets the AppId field's value.

func (*DeleteThemeInput) SetEnvironmentName

func (s *DeleteThemeInput) SetEnvironmentName(v string) *DeleteThemeInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*DeleteThemeInput) SetId

SetId sets the Id field's value.

func (DeleteThemeInput) String

func (s DeleteThemeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThemeInput) Validate

func (s *DeleteThemeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteThemeOutput

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

func (DeleteThemeOutput) GoString

func (s DeleteThemeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteThemeOutput) String

func (s DeleteThemeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExchangeCodeForTokenInput

type ExchangeCodeForTokenInput struct {

	// The third-party provider for the token. The only valid value is figma.
	//
	// Provider is a required field
	Provider *string `location:"uri" locationName:"provider" type:"string" required:"true" enum:"TokenProviders"`

	// Describes the configuration of the request.
	//
	// Request is a required field
	Request *ExchangeCodeForTokenRequestBody `locationName:"request" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ExchangeCodeForTokenInput) GoString

func (s ExchangeCodeForTokenInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExchangeCodeForTokenInput) SetProvider

SetProvider sets the Provider field's value.

func (*ExchangeCodeForTokenInput) SetRequest

SetRequest sets the Request field's value.

func (ExchangeCodeForTokenInput) String

func (s ExchangeCodeForTokenInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExchangeCodeForTokenInput) Validate

func (s *ExchangeCodeForTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExchangeCodeForTokenOutput

type ExchangeCodeForTokenOutput struct {

	// The access token.
	//
	// AccessToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExchangeCodeForTokenOutput's
	// String and GoString methods.
	//
	// AccessToken is a required field
	AccessToken *string `locationName:"accessToken" type:"string" required:"true" sensitive:"true"`

	// The date and time when the new access token expires.
	//
	// ExpiresIn is a required field
	ExpiresIn *int64 `locationName:"expiresIn" type:"integer" required:"true"`

	// The token to use to refresh a previously issued access token that might have
	// expired.
	//
	// RefreshToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExchangeCodeForTokenOutput's
	// String and GoString methods.
	//
	// RefreshToken is a required field
	RefreshToken *string `locationName:"refreshToken" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ExchangeCodeForTokenOutput) GoString

func (s ExchangeCodeForTokenOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExchangeCodeForTokenOutput) SetAccessToken

SetAccessToken sets the AccessToken field's value.

func (*ExchangeCodeForTokenOutput) SetExpiresIn

SetExpiresIn sets the ExpiresIn field's value.

func (*ExchangeCodeForTokenOutput) SetRefreshToken

SetRefreshToken sets the RefreshToken field's value.

func (ExchangeCodeForTokenOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExchangeCodeForTokenRequestBody

type ExchangeCodeForTokenRequestBody struct {

	// The access code to send in the request.
	//
	// Code is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ExchangeCodeForTokenRequestBody's
	// String and GoString methods.
	//
	// Code is a required field
	Code *string `locationName:"code" type:"string" required:"true" sensitive:"true"`

	// The location of the application that will receive the access code.
	//
	// RedirectUri is a required field
	RedirectUri *string `locationName:"redirectUri" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the configuration of a request to exchange an access code for a token.

func (ExchangeCodeForTokenRequestBody) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExchangeCodeForTokenRequestBody) SetCode

SetCode sets the Code field's value.

func (*ExchangeCodeForTokenRequestBody) SetRedirectUri

SetRedirectUri sets the RedirectUri field's value.

func (ExchangeCodeForTokenRequestBody) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExchangeCodeForTokenRequestBody) Validate

func (s *ExchangeCodeForTokenRequestBody) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportComponentsInput

type ExportComponentsInput struct {

	// The unique ID of the Amplify app to export components to.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The token to request the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ExportComponentsInput) GoString

func (s ExportComponentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportComponentsInput) SetAppId

SetAppId sets the AppId field's value.

func (*ExportComponentsInput) SetEnvironmentName

func (s *ExportComponentsInput) SetEnvironmentName(v string) *ExportComponentsInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*ExportComponentsInput) SetNextToken added in v1.43.8

SetNextToken sets the NextToken field's value.

func (ExportComponentsInput) String

func (s ExportComponentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportComponentsInput) Validate

func (s *ExportComponentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportComponentsOutput

type ExportComponentsOutput struct {

	// Represents the configuration of the exported components.
	//
	// Entities is a required field
	Entities []*Component `locationName:"entities" type:"list" required:"true"`

	// The pagination token that's included if more results are available.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ExportComponentsOutput) GoString

func (s ExportComponentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportComponentsOutput) SetEntities

SetEntities sets the Entities field's value.

func (*ExportComponentsOutput) SetNextToken added in v1.43.8

SetNextToken sets the NextToken field's value.

func (ExportComponentsOutput) String

func (s ExportComponentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportThemesInput

type ExportThemesInput struct {

	// The unique ID of the Amplify app to export the themes to.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The token to request the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ExportThemesInput) GoString

func (s ExportThemesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportThemesInput) SetAppId

func (s *ExportThemesInput) SetAppId(v string) *ExportThemesInput

SetAppId sets the AppId field's value.

func (*ExportThemesInput) SetEnvironmentName

func (s *ExportThemesInput) SetEnvironmentName(v string) *ExportThemesInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*ExportThemesInput) SetNextToken added in v1.43.8

func (s *ExportThemesInput) SetNextToken(v string) *ExportThemesInput

SetNextToken sets the NextToken field's value.

func (ExportThemesInput) String

func (s ExportThemesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportThemesInput) Validate

func (s *ExportThemesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportThemesOutput

type ExportThemesOutput struct {

	// Represents the configuration of the exported themes.
	//
	// Entities is a required field
	Entities []*Theme `locationName:"entities" type:"list" required:"true"`

	// The pagination token that's included if more results are available.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ExportThemesOutput) GoString

func (s ExportThemesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportThemesOutput) SetEntities

func (s *ExportThemesOutput) SetEntities(v []*Theme) *ExportThemesOutput

SetEntities sets the Entities field's value.

func (*ExportThemesOutput) SetNextToken added in v1.43.8

func (s *ExportThemesOutput) SetNextToken(v string) *ExportThemesOutput

SetNextToken sets the NextToken field's value.

func (ExportThemesOutput) String

func (s ExportThemesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FormBindingElement

type FormBindingElement struct {

	// The name of the component to retrieve a value from.
	//
	// Element is a required field
	Element *string `locationName:"element" type:"string" required:"true"`

	// The property to retrieve a value from.
	//
	// Property is a required field
	Property *string `locationName:"property" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes how to bind a component property to form data.

func (FormBindingElement) GoString

func (s FormBindingElement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FormBindingElement) SetElement

func (s *FormBindingElement) SetElement(v string) *FormBindingElement

SetElement sets the Element field's value.

func (*FormBindingElement) SetProperty

func (s *FormBindingElement) SetProperty(v string) *FormBindingElement

SetProperty sets the Property field's value.

func (FormBindingElement) String

func (s FormBindingElement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FormBindingElement) Validate

func (s *FormBindingElement) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetComponentInput

type GetComponentInput struct {

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

	// The name of the backend environment that is part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The unique ID of the component.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComponentInput) GoString

func (s GetComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentInput) SetAppId

func (s *GetComponentInput) SetAppId(v string) *GetComponentInput

SetAppId sets the AppId field's value.

func (*GetComponentInput) SetEnvironmentName

func (s *GetComponentInput) SetEnvironmentName(v string) *GetComponentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*GetComponentInput) SetId

SetId sets the Id field's value.

func (GetComponentInput) String

func (s GetComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentInput) Validate

func (s *GetComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetComponentOutput

type GetComponentOutput struct {

	// Represents the configuration settings for the component.
	Component *Component `locationName:"component" type:"structure"`
	// contains filtered or unexported fields
}

func (GetComponentOutput) GoString

func (s GetComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentOutput) SetComponent

func (s *GetComponentOutput) SetComponent(v *Component) *GetComponentOutput

SetComponent sets the Component field's value.

func (GetComponentOutput) String

func (s GetComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetThemeInput

type GetThemeInput struct {

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

	// The name of the backend environment that is part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The unique ID for the theme.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetThemeInput) GoString

func (s GetThemeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetThemeInput) SetAppId

func (s *GetThemeInput) SetAppId(v string) *GetThemeInput

SetAppId sets the AppId field's value.

func (*GetThemeInput) SetEnvironmentName

func (s *GetThemeInput) SetEnvironmentName(v string) *GetThemeInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*GetThemeInput) SetId

func (s *GetThemeInput) SetId(v string) *GetThemeInput

SetId sets the Id field's value.

func (GetThemeInput) String

func (s GetThemeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetThemeInput) Validate

func (s *GetThemeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetThemeOutput

type GetThemeOutput struct {

	// Represents the configuration settings for the theme.
	Theme *Theme `locationName:"theme" type:"structure"`
	// contains filtered or unexported fields
}

func (GetThemeOutput) GoString

func (s GetThemeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetThemeOutput) SetTheme

func (s *GetThemeOutput) SetTheme(v *Theme) *GetThemeOutput

SetTheme sets the Theme field's value.

func (GetThemeOutput) String

func (s GetThemeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal error has occurred. Please retry your request.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An invalid or out-of-range value was supplied for the input parameter.

func (*InvalidParameterException) Code

Code returns the exception type name.

func (*InvalidParameterException) Error

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListComponentsInput

type ListComponentsInput struct {

	// The unique ID for the Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The maximum number of components to retrieve.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListComponentsInput) GoString

func (s ListComponentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentsInput) SetAppId

SetAppId sets the AppId field's value.

func (*ListComponentsInput) SetEnvironmentName

func (s *ListComponentsInput) SetEnvironmentName(v string) *ListComponentsInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*ListComponentsInput) SetMaxResults

func (s *ListComponentsInput) SetMaxResults(v int64) *ListComponentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListComponentsInput) SetNextToken

func (s *ListComponentsInput) SetNextToken(v string) *ListComponentsInput

SetNextToken sets the NextToken field's value.

func (ListComponentsInput) String

func (s ListComponentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentsInput) Validate

func (s *ListComponentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComponentsOutput

type ListComponentsOutput struct {

	// The list of components for the Amplify app.
	//
	// Entities is a required field
	Entities []*ComponentSummary `locationName:"entities" type:"list" required:"true"`

	// The pagination token that's included if more results are available.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListComponentsOutput) GoString

func (s ListComponentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentsOutput) SetEntities

SetEntities sets the Entities field's value.

func (*ListComponentsOutput) SetNextToken

func (s *ListComponentsOutput) SetNextToken(v string) *ListComponentsOutput

SetNextToken sets the NextToken field's value.

func (ListComponentsOutput) String

func (s ListComponentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListThemesInput

type ListThemesInput struct {

	// The unique ID for the Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The maximum number of theme results to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListThemesInput) GoString

func (s ListThemesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThemesInput) SetAppId

func (s *ListThemesInput) SetAppId(v string) *ListThemesInput

SetAppId sets the AppId field's value.

func (*ListThemesInput) SetEnvironmentName

func (s *ListThemesInput) SetEnvironmentName(v string) *ListThemesInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*ListThemesInput) SetMaxResults

func (s *ListThemesInput) SetMaxResults(v int64) *ListThemesInput

SetMaxResults sets the MaxResults field's value.

func (*ListThemesInput) SetNextToken

func (s *ListThemesInput) SetNextToken(v string) *ListThemesInput

SetNextToken sets the NextToken field's value.

func (ListThemesInput) String

func (s ListThemesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThemesInput) Validate

func (s *ListThemesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListThemesOutput

type ListThemesOutput struct {

	// The list of themes for the Amplify app.
	//
	// Entities is a required field
	Entities []*ThemeSummary `locationName:"entities" type:"list" required:"true"`

	// The pagination token that's returned if more results are available.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListThemesOutput) GoString

func (s ListThemesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThemesOutput) SetEntities

func (s *ListThemesOutput) SetEntities(v []*ThemeSummary) *ListThemesOutput

SetEntities sets the Entities field's value.

func (*ListThemesOutput) SetNextToken

func (s *ListThemesOutput) SetNextToken(v string) *ListThemesOutput

SetNextToken sets the NextToken field's value.

func (ListThemesOutput) String

func (s ListThemesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MutationActionSetStateParameter added in v1.43.8

type MutationActionSetStateParameter struct {

	// The name of the component that is being modified.
	//
	// ComponentName is a required field
	ComponentName *string `locationName:"componentName" type:"string" required:"true"`

	// The name of the component property to apply the state configuration to.
	//
	// Property is a required field
	Property *string `locationName:"property" type:"string" required:"true"`

	// The state configuration to assign to the property.
	//
	// Set is a required field
	Set *ComponentProperty `locationName:"set" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the state configuration when an action modifies a property of another element within the same component.

func (MutationActionSetStateParameter) GoString added in v1.43.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MutationActionSetStateParameter) SetComponentName added in v1.43.8

SetComponentName sets the ComponentName field's value.

func (*MutationActionSetStateParameter) SetProperty added in v1.43.8

SetProperty sets the Property field's value.

func (*MutationActionSetStateParameter) SetSet added in v1.43.8

SetSet sets the Set field's value.

func (MutationActionSetStateParameter) String added in v1.43.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MutationActionSetStateParameter) Validate added in v1.43.8

func (s *MutationActionSetStateParameter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Predicate

type Predicate struct {

	// A list of predicates to combine logically.
	And []*Predicate `locationName:"and" type:"list"`

	// The field to query.
	Field *string `locationName:"field" type:"string"`

	// The value to use when performing the evaluation.
	Operand *string `locationName:"operand" type:"string"`

	// The operator to use to perform the evaluation.
	Operator *string `locationName:"operator" type:"string"`

	// A list of predicates to combine logically.
	Or []*Predicate `locationName:"or" type:"list"`
	// contains filtered or unexported fields
}

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

func (Predicate) GoString

func (s Predicate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Predicate) SetAnd

func (s *Predicate) SetAnd(v []*Predicate) *Predicate

SetAnd sets the And field's value.

func (*Predicate) SetField

func (s *Predicate) SetField(v string) *Predicate

SetField sets the Field field's value.

func (*Predicate) SetOperand

func (s *Predicate) SetOperand(v string) *Predicate

SetOperand sets the Operand field's value.

func (*Predicate) SetOperator

func (s *Predicate) SetOperator(v string) *Predicate

SetOperator sets the Operator field's value.

func (*Predicate) SetOr

func (s *Predicate) SetOr(v []*Predicate) *Predicate

SetOr sets the Or field's value.

func (Predicate) String

func (s Predicate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RefreshTokenInput

type RefreshTokenInput struct {

	// The third-party provider for the token. The only valid value is figma.
	//
	// Provider is a required field
	Provider *string `location:"uri" locationName:"provider" type:"string" required:"true" enum:"TokenProviders"`

	// Information about the refresh token request.
	//
	// RefreshTokenBody is a required field
	RefreshTokenBody *RefreshTokenRequestBody `locationName:"refreshTokenBody" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RefreshTokenInput) GoString

func (s RefreshTokenInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTokenInput) SetProvider

func (s *RefreshTokenInput) SetProvider(v string) *RefreshTokenInput

SetProvider sets the Provider field's value.

func (*RefreshTokenInput) SetRefreshTokenBody

func (s *RefreshTokenInput) SetRefreshTokenBody(v *RefreshTokenRequestBody) *RefreshTokenInput

SetRefreshTokenBody sets the RefreshTokenBody field's value.

func (RefreshTokenInput) String

func (s RefreshTokenInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTokenInput) Validate

func (s *RefreshTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RefreshTokenOutput

type RefreshTokenOutput struct {

	// The access token.
	//
	// AccessToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RefreshTokenOutput's
	// String and GoString methods.
	//
	// AccessToken is a required field
	AccessToken *string `locationName:"accessToken" type:"string" required:"true" sensitive:"true"`

	// The date and time when the new access token expires.
	//
	// ExpiresIn is a required field
	ExpiresIn *int64 `locationName:"expiresIn" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (RefreshTokenOutput) GoString

func (s RefreshTokenOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTokenOutput) SetAccessToken

func (s *RefreshTokenOutput) SetAccessToken(v string) *RefreshTokenOutput

SetAccessToken sets the AccessToken field's value.

func (*RefreshTokenOutput) SetExpiresIn

func (s *RefreshTokenOutput) SetExpiresIn(v int64) *RefreshTokenOutput

SetExpiresIn sets the ExpiresIn field's value.

func (RefreshTokenOutput) String

func (s RefreshTokenOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RefreshTokenRequestBody

type RefreshTokenRequestBody struct {

	// The token to use to refresh a previously issued access token that might have
	// expired.
	//
	// Token is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RefreshTokenRequestBody's
	// String and GoString methods.
	//
	// Token is a required field
	Token *string `locationName:"token" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Describes a refresh token.

func (RefreshTokenRequestBody) GoString

func (s RefreshTokenRequestBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTokenRequestBody) SetToken

SetToken sets the Token field's value.

func (RefreshTokenRequestBody) String

func (s RefreshTokenRequestBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshTokenRequestBody) Validate

func (s *RefreshTokenRequestBody) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceConflictException

type ResourceConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource specified in the request conflicts with an existing resource.

func (*ResourceConflictException) Code

Code returns the exception type name.

func (*ResourceConflictException) Error

func (s *ResourceConflictException) Error() string

func (ResourceConflictException) GoString

func (s ResourceConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceConflictException) Message

func (s *ResourceConflictException) Message() string

Message returns the exception's message.

func (*ResourceConflictException) OrigErr

func (s *ResourceConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceConflictException) RequestID

func (s *ResourceConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceConflictException) StatusCode

func (s *ResourceConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceConflictException) String

func (s ResourceConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource does not exist, or access was denied.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SortProperty

type SortProperty struct {

	// The direction of the sort, either ascending or descending.
	//
	// Direction is a required field
	Direction *string `locationName:"direction" type:"string" required:"true" enum:"SortDirection"`

	// The field to perform the sort on.
	//
	// Field is a required field
	Field *string `locationName:"field" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes how to sort the data that you bind to a component.

func (SortProperty) GoString

func (s SortProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SortProperty) SetDirection

func (s *SortProperty) SetDirection(v string) *SortProperty

SetDirection sets the Direction field's value.

func (*SortProperty) SetField

func (s *SortProperty) SetField(v string) *SortProperty

SetField sets the Field field's value.

func (SortProperty) String

func (s SortProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SortProperty) Validate

func (s *SortProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Theme

type Theme struct {

	// The unique ID for the Amplify app associated with the theme.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The time that the theme was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The name of the backend environment that is a part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `locationName:"environmentName" type:"string" required:"true"`

	// The ID for the theme.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The time that the theme was modified.
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The name of the theme.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Describes the properties that can be overriden to customize a theme.
	Overrides []*ThemeValues `locationName:"overrides" type:"list"`

	// One or more key-value pairs to use when tagging the theme.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of key-value pairs that defines the properties of the theme.
	//
	// Values is a required field
	Values []*ThemeValues `locationName:"values" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A theme is a collection of style settings that apply globally to the components associated with an Amplify application.

func (Theme) GoString

func (s Theme) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Theme) SetAppId

func (s *Theme) SetAppId(v string) *Theme

SetAppId sets the AppId field's value.

func (*Theme) SetCreatedAt

func (s *Theme) SetCreatedAt(v time.Time) *Theme

SetCreatedAt sets the CreatedAt field's value.

func (*Theme) SetEnvironmentName

func (s *Theme) SetEnvironmentName(v string) *Theme

SetEnvironmentName sets the EnvironmentName field's value.

func (*Theme) SetId

func (s *Theme) SetId(v string) *Theme

SetId sets the Id field's value.

func (*Theme) SetModifiedAt

func (s *Theme) SetModifiedAt(v time.Time) *Theme

SetModifiedAt sets the ModifiedAt field's value.

func (*Theme) SetName

func (s *Theme) SetName(v string) *Theme

SetName sets the Name field's value.

func (*Theme) SetOverrides

func (s *Theme) SetOverrides(v []*ThemeValues) *Theme

SetOverrides sets the Overrides field's value.

func (*Theme) SetTags

func (s *Theme) SetTags(v map[string]*string) *Theme

SetTags sets the Tags field's value.

func (*Theme) SetValues

func (s *Theme) SetValues(v []*ThemeValues) *Theme

SetValues sets the Values field's value.

func (Theme) String

func (s Theme) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThemeSummary

type ThemeSummary struct {

	// The unique ID for the app associated with the theme summary.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The name of the backend environment that is part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `locationName:"environmentName" type:"string" required:"true"`

	// The ID of the theme.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the theme.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the basic information about a theme.

func (ThemeSummary) GoString

func (s ThemeSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThemeSummary) SetAppId

func (s *ThemeSummary) SetAppId(v string) *ThemeSummary

SetAppId sets the AppId field's value.

func (*ThemeSummary) SetEnvironmentName

func (s *ThemeSummary) SetEnvironmentName(v string) *ThemeSummary

SetEnvironmentName sets the EnvironmentName field's value.

func (*ThemeSummary) SetId

func (s *ThemeSummary) SetId(v string) *ThemeSummary

SetId sets the Id field's value.

func (*ThemeSummary) SetName

func (s *ThemeSummary) SetName(v string) *ThemeSummary

SetName sets the Name field's value.

func (ThemeSummary) String

func (s ThemeSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThemeValue

type ThemeValue struct {

	// A list of key-value pairs that define the theme's properties.
	Children []*ThemeValues `locationName:"children" type:"list"`

	// The value of a theme property.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Describes the configuration of a theme's properties.

func (ThemeValue) GoString

func (s ThemeValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThemeValue) SetChildren

func (s *ThemeValue) SetChildren(v []*ThemeValues) *ThemeValue

SetChildren sets the Children field's value.

func (*ThemeValue) SetValue

func (s *ThemeValue) SetValue(v string) *ThemeValue

SetValue sets the Value field's value.

func (ThemeValue) String

func (s ThemeValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThemeValues

type ThemeValues struct {

	// The name of the property.
	Key *string `locationName:"key" type:"string"`

	// The value of the property.
	Value *ThemeValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

A key-value pair that defines a property of a theme.

func (ThemeValues) GoString

func (s ThemeValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThemeValues) SetKey

func (s *ThemeValues) SetKey(v string) *ThemeValues

SetKey sets the Key field's value.

func (*ThemeValues) SetValue

func (s *ThemeValues) SetValue(v *ThemeValue) *ThemeValues

SetValue sets the Value field's value.

func (ThemeValues) String

func (s ThemeValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateComponentData

type UpdateComponentData struct {

	// The data binding information for the component's properties.
	BindingProperties map[string]*ComponentBindingPropertiesValue `locationName:"bindingProperties" type:"map"`

	// The components that are instances of the main component.
	Children []*ComponentChild `locationName:"children" type:"list"`

	// The configuration for binding a component's properties to a data model. Use
	// this for a collection component.
	CollectionProperties map[string]*ComponentDataConfiguration `locationName:"collectionProperties" type:"map"`

	// The type of the component. This can be an Amplify custom UI component or
	// another custom component.
	ComponentType *string `locationName:"componentType" min:"1" type:"string"`

	// The event configuration for the component. Use for the workflow feature in
	// Amplify Studio that allows you to bind events and actions to components.
	Events map[string]*ComponentEvent `locationName:"events" type:"map"`

	// The unique ID of the component to update.
	Id *string `locationName:"id" type:"string"`

	// The name of the component to update.
	Name *string `locationName:"name" min:"1" type:"string"`

	// Describes the properties that can be overriden to customize the component.
	Overrides map[string]map[string]*string `locationName:"overrides" type:"map"`

	// Describes the component's properties.
	Properties map[string]*ComponentProperty `locationName:"properties" type:"map"`

	// The schema version of the component when it was imported.
	SchemaVersion *string `locationName:"schemaVersion" type:"string"`

	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string `locationName:"sourceId" type:"string"`

	// A list of the unique variants of the main component being updated.
	Variants []*ComponentVariant `locationName:"variants" type:"list"`
	// contains filtered or unexported fields
}

Updates and saves all of the information about a component, based on component ID.

func (UpdateComponentData) GoString

func (s UpdateComponentData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentData) SetBindingProperties

SetBindingProperties sets the BindingProperties field's value.

func (*UpdateComponentData) SetChildren

SetChildren sets the Children field's value.

func (*UpdateComponentData) SetCollectionProperties

func (s *UpdateComponentData) SetCollectionProperties(v map[string]*ComponentDataConfiguration) *UpdateComponentData

SetCollectionProperties sets the CollectionProperties field's value.

func (*UpdateComponentData) SetComponentType

func (s *UpdateComponentData) SetComponentType(v string) *UpdateComponentData

SetComponentType sets the ComponentType field's value.

func (*UpdateComponentData) SetEvents added in v1.43.8

SetEvents sets the Events field's value.

func (*UpdateComponentData) SetId

SetId sets the Id field's value.

func (*UpdateComponentData) SetName

SetName sets the Name field's value.

func (*UpdateComponentData) SetOverrides

func (s *UpdateComponentData) SetOverrides(v map[string]map[string]*string) *UpdateComponentData

SetOverrides sets the Overrides field's value.

func (*UpdateComponentData) SetProperties

SetProperties sets the Properties field's value.

func (*UpdateComponentData) SetSchemaVersion added in v1.43.8

func (s *UpdateComponentData) SetSchemaVersion(v string) *UpdateComponentData

SetSchemaVersion sets the SchemaVersion field's value.

func (*UpdateComponentData) SetSourceId

func (s *UpdateComponentData) SetSourceId(v string) *UpdateComponentData

SetSourceId sets the SourceId field's value.

func (*UpdateComponentData) SetVariants

SetVariants sets the Variants field's value.

func (UpdateComponentData) String

func (s UpdateComponentData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentData) Validate

func (s *UpdateComponentData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateComponentInput

type UpdateComponentInput struct {

	// The unique ID for the Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The unique client token.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of the backend environment that is part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The unique ID for the component.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`

	// The configuration of the updated component.
	//
	// UpdatedComponent is a required field
	UpdatedComponent *UpdateComponentData `locationName:"updatedComponent" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateComponentInput) GoString

func (s UpdateComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentInput) SetAppId

SetAppId sets the AppId field's value.

func (*UpdateComponentInput) SetClientToken

func (s *UpdateComponentInput) SetClientToken(v string) *UpdateComponentInput

SetClientToken sets the ClientToken field's value.

func (*UpdateComponentInput) SetEnvironmentName

func (s *UpdateComponentInput) SetEnvironmentName(v string) *UpdateComponentInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*UpdateComponentInput) SetId

SetId sets the Id field's value.

func (*UpdateComponentInput) SetUpdatedComponent

SetUpdatedComponent sets the UpdatedComponent field's value.

func (UpdateComponentInput) String

func (s UpdateComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentInput) Validate

func (s *UpdateComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateComponentOutput

type UpdateComponentOutput struct {

	// Describes the configuration of the updated component.
	Entity *Component `locationName:"entity" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateComponentOutput) GoString

func (s UpdateComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentOutput) SetEntity

SetEntity sets the Entity field's value.

func (UpdateComponentOutput) String

func (s UpdateComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateThemeData

type UpdateThemeData struct {

	// The unique ID of the theme to update.
	Id *string `locationName:"id" type:"string"`

	// The name of the theme to update.
	Name *string `locationName:"name" min:"1" type:"string"`

	// Describes the properties that can be overriden to customize the theme.
	Overrides []*ThemeValues `locationName:"overrides" type:"list"`

	// A list of key-value pairs that define the theme's properties.
	//
	// Values is a required field
	Values []*ThemeValues `locationName:"values" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Saves the data binding information for a theme.

func (UpdateThemeData) GoString

func (s UpdateThemeData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThemeData) SetId

func (s *UpdateThemeData) SetId(v string) *UpdateThemeData

SetId sets the Id field's value.

func (*UpdateThemeData) SetName

func (s *UpdateThemeData) SetName(v string) *UpdateThemeData

SetName sets the Name field's value.

func (*UpdateThemeData) SetOverrides

func (s *UpdateThemeData) SetOverrides(v []*ThemeValues) *UpdateThemeData

SetOverrides sets the Overrides field's value.

func (*UpdateThemeData) SetValues

func (s *UpdateThemeData) SetValues(v []*ThemeValues) *UpdateThemeData

SetValues sets the Values field's value.

func (UpdateThemeData) String

func (s UpdateThemeData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThemeData) Validate

func (s *UpdateThemeData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateThemeInput

type UpdateThemeInput struct {

	// The unique ID for the Amplify app.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// The unique client token.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of the backend environment that is part of the Amplify app.
	//
	// EnvironmentName is a required field
	EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"`

	// The unique ID for the theme.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"id" type:"string" required:"true"`

	// The configuration of the updated theme.
	//
	// UpdatedTheme is a required field
	UpdatedTheme *UpdateThemeData `locationName:"updatedTheme" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateThemeInput) GoString

func (s UpdateThemeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThemeInput) SetAppId

func (s *UpdateThemeInput) SetAppId(v string) *UpdateThemeInput

SetAppId sets the AppId field's value.

func (*UpdateThemeInput) SetClientToken

func (s *UpdateThemeInput) SetClientToken(v string) *UpdateThemeInput

SetClientToken sets the ClientToken field's value.

func (*UpdateThemeInput) SetEnvironmentName

func (s *UpdateThemeInput) SetEnvironmentName(v string) *UpdateThemeInput

SetEnvironmentName sets the EnvironmentName field's value.

func (*UpdateThemeInput) SetId

SetId sets the Id field's value.

func (*UpdateThemeInput) SetUpdatedTheme

func (s *UpdateThemeInput) SetUpdatedTheme(v *UpdateThemeData) *UpdateThemeInput

SetUpdatedTheme sets the UpdatedTheme field's value.

func (UpdateThemeInput) String

func (s UpdateThemeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThemeInput) Validate

func (s *UpdateThemeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateThemeOutput

type UpdateThemeOutput struct {

	// Describes the configuration of the updated theme.
	Entity *Theme `locationName:"entity" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateThemeOutput) GoString

func (s UpdateThemeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThemeOutput) SetEntity

func (s *UpdateThemeOutput) SetEntity(v *Theme) *UpdateThemeOutput

SetEntity sets the Entity field's value.

func (UpdateThemeOutput) String

func (s UpdateThemeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package amplifyuibuilderiface provides an interface to enable mocking the AWS Amplify UI Builder service client for testing your code.
Package amplifyuibuilderiface provides an interface to enable mocking the AWS Amplify UI Builder service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL