types

package
v1.15.2 Latest Latest
Warning

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

 Go to latest Published: Nov 15, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionParameters added in v1.5.0 

type ActionParameters struct {

	// The HTML anchor link to the location to open. Specify this value for a
	// navigation action.
	Anchor *ComponentProperty

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

	// Specifies whether the user should be signed out globally. Specify this value
	// for an auth sign out action.
	Global *ComponentProperty

	// The unique ID of the component that the ActionParameters apply to.
	Id *ComponentProperty

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

	// A key-value pair that specifies the state property name and its initial value.
	State *MutationActionSetStateParameter

	// The element within the same component to modify when the action occurs.
	Target *ComponentProperty

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

	// The URL to the location to open. Specify this value for a navigation action.
	Url *ComponentProperty
	// 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.

type ApiConfiguration added in v1.12.0 

type ApiConfiguration interface {
	// contains filtered or unexported methods
}

Describes the API configuration for a code generation job.

The following types satisfy this interface: 

ApiConfigurationMemberDataStoreConfig
ApiConfigurationMemberGraphQLConfig
ApiConfigurationMemberNoApiConfig
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amplifyuibuilder/types"
)

func main() {
	var union types.ApiConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ApiConfigurationMemberDataStoreConfig:
		_ = v.Value // Value is types.DataStoreRenderConfig

	case *types.ApiConfigurationMemberGraphQLConfig:
		_ = v.Value // Value is types.GraphQLRenderConfig

	case *types.ApiConfigurationMemberNoApiConfig:
		_ = v.Value // Value is types.NoApiRenderConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ApiConfigurationMemberDataStoreConfig added in v1.12.0 

type ApiConfigurationMemberDataStoreConfig struct {
	Value DataStoreRenderConfig
	// contains filtered or unexported fields
}

The configuration for an application using DataStore APIs.

type ApiConfigurationMemberGraphQLConfig added in v1.12.0 

type ApiConfigurationMemberGraphQLConfig struct {
	Value GraphQLRenderConfig
	// contains filtered or unexported fields
}

The configuration for an application using GraphQL APIs.

type ApiConfigurationMemberNoApiConfig added in v1.12.0 

type ApiConfigurationMemberNoApiConfig struct {
	Value NoApiRenderConfig
	// contains filtered or unexported fields
}

The configuration for an application with no API being used.

type CodegenDependency added in v1.13.0 

type CodegenDependency struct {

	// Determines if the dependency package is using Semantic versioning. If set to
	// true, it indicates that the dependency package uses Semantic versioning.
	IsSemVer *bool

	// Name of the dependency package.
	Name *string

	// Indicates the reason to include the dependency package in your project code.
	Reason *string

	// Indicates the version of the supported dependency package.
	SupportedVersion *string
	// contains filtered or unexported fields
}

Dependency package that may be required for the project code to run.

type CodegenFeatureFlags added in v1.11.0 

type CodegenFeatureFlags struct {

	// Specifies whether a code generation job supports non models.
	IsNonModelSupported *bool

	// Specifes whether a code generation job supports data relationships.
	IsRelationshipSupported *bool
	// contains filtered or unexported fields
}

Describes the feature flags that you can specify for a code generation job.

type CodegenGenericDataEnum added in v1.11.0 

type CodegenGenericDataEnum struct {

	// The list of enum values in the generic data schema.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Describes the enums in a generic data schema.

type CodegenGenericDataField added in v1.11.0 

type CodegenGenericDataField struct {

	// The data type for the generic data field.
	//
	// This member is required.
	DataType CodegenGenericDataFieldDataType

	// The value of the data type for the generic data field.
	//
	// This member is required.
	DataTypeValue *string

	// Specifies whether the generic data field is an array.
	//
	// This member is required.
	IsArray *bool

	// Specifies whether the generic data field is read-only.
	//
	// This member is required.
	ReadOnly *bool

	// Specifies whether the generic data field is required.
	//
	// This member is required.
	Required *bool

	// The relationship of the generic data schema.
	Relationship *CodegenGenericDataRelationshipType
	// contains filtered or unexported fields
}

Describes a field in a generic data schema.

type CodegenGenericDataFieldDataType added in v1.11.0 

type CodegenGenericDataFieldDataType string
const (
	CodegenGenericDataFieldDataTypeId           CodegenGenericDataFieldDataType = "ID"
	CodegenGenericDataFieldDataTypeString       CodegenGenericDataFieldDataType = "String"
	CodegenGenericDataFieldDataTypeInt          CodegenGenericDataFieldDataType = "Int"
	CodegenGenericDataFieldDataTypeFloat        CodegenGenericDataFieldDataType = "Float"
	CodegenGenericDataFieldDataTypeAwsDate      CodegenGenericDataFieldDataType = "AWSDate"
	CodegenGenericDataFieldDataTypeAwsTime      CodegenGenericDataFieldDataType = "AWSTime"
	CodegenGenericDataFieldDataTypeAwsDateTime  CodegenGenericDataFieldDataType = "AWSDateTime"
	CodegenGenericDataFieldDataTypeAwsTimestamp CodegenGenericDataFieldDataType = "AWSTimestamp"
	CodegenGenericDataFieldDataTypeAwsEmail     CodegenGenericDataFieldDataType = "AWSEmail"
	CodegenGenericDataFieldDataTypeAwsUrl       CodegenGenericDataFieldDataType = "AWSURL"
	CodegenGenericDataFieldDataTypeAwsIpAddress CodegenGenericDataFieldDataType = "AWSIPAddress"
	CodegenGenericDataFieldDataTypeBoolean      CodegenGenericDataFieldDataType = "Boolean"
	CodegenGenericDataFieldDataTypeAwsJson      CodegenGenericDataFieldDataType = "AWSJSON"
	CodegenGenericDataFieldDataTypeAwsPhone     CodegenGenericDataFieldDataType = "AWSPhone"
	CodegenGenericDataFieldDataTypeEnum         CodegenGenericDataFieldDataType = "Enum"
	CodegenGenericDataFieldDataTypeModel        CodegenGenericDataFieldDataType = "Model"
	CodegenGenericDataFieldDataTypeNonModel     CodegenGenericDataFieldDataType = "NonModel"
)

Enum values for CodegenGenericDataFieldDataType

func (CodegenGenericDataFieldDataType) Values added in v1.11.0 

func (CodegenGenericDataFieldDataType) Values() []CodegenGenericDataFieldDataType

Values returns all known values for CodegenGenericDataFieldDataType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CodegenGenericDataModel added in v1.11.0 

type CodegenGenericDataModel struct {

	// The fields in the generic data model.
	//
	// This member is required.
	Fields map[string]CodegenGenericDataField

	// The primary keys of the generic data model.
	//
	// This member is required.
	PrimaryKeys []string

	// Specifies whether the generic data model is a join table.
	IsJoinTable *bool
	// contains filtered or unexported fields
}

Describes a model in a generic data schema.

type CodegenGenericDataNonModel added in v1.11.0 

type CodegenGenericDataNonModel struct {

	// The fields in a generic data schema non model.
	//
	// This member is required.
	Fields map[string]CodegenGenericDataField
	// contains filtered or unexported fields
}

Describes a non-model in a generic data schema.

type CodegenGenericDataRelationshipType added in v1.11.0 

type CodegenGenericDataRelationshipType struct {

	// The name of the related model in the data relationship.
	//
	// This member is required.
	RelatedModelName *string

	// The data relationship type.
	//
	// This member is required.
	Type GenericDataRelationshipType

	// The associated fields of the data relationship.
	AssociatedFields []string

	// The value of the belongsTo field on the related data model.
	BelongsToFieldOnRelatedModel *string

	// Specifies whether the relationship can unlink the associated model.
	CanUnlinkAssociatedModel *bool

	// Specifies whether the @index directive is supported for a hasMany data
	// relationship.
	IsHasManyIndex *bool

	// The name of the related join field in the data relationship.
	RelatedJoinFieldName *string

	// The name of the related join table in the data relationship.
	RelatedJoinTableName *string

	// The related model fields in the data relationship.
	RelatedModelFields []string
	// contains filtered or unexported fields
}

Describes the relationship between generic data models.

type CodegenJob added in v1.11.0 

type CodegenJob struct {

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

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

	// The unique ID for the code generation job.
	//
	// This member is required.
	Id *string

	// The CodegenJobAsset to use for the code generation job.
	Asset *CodegenJobAsset

	// Specifies whether to autogenerate forms in the code generation job.
	AutoGenerateForms *bool

	// The time that the code generation job was created.
	CreatedAt *time.Time

	// Lists the dependency packages that may be required for the project code to run.
	Dependencies []CodegenDependency

	// Describes the feature flags that you can specify for a code generation job.
	Features *CodegenFeatureFlags

	// Describes the data schema for a code generation job.
	GenericDataSchema *CodegenJobGenericDataSchema

	// The time that the code generation job was modified.
	ModifiedAt *time.Time

	// Describes the configuration information for rendering the UI component
	// associated with the code generation job.
	RenderConfig CodegenJobRenderConfig

	// The status of the code generation job.
	Status CodegenJobStatus

	// The customized status message for the code generation job.
	StatusMessage *string

	// One or more key-value pairs to use when tagging the code generation job.
	Tags map[string]string
	// contains filtered or unexported fields
}

Describes the configuration for a code generation job that is associated with an Amplify app.

type CodegenJobAsset added in v1.11.0 

type CodegenJobAsset struct {

	// The URL to use to access the asset.
	DownloadUrl *string
	// contains filtered or unexported fields
}

Describes an asset for a code generation job.

type CodegenJobGenericDataSchema added in v1.11.0 

type CodegenJobGenericDataSchema struct {

	// The type of the data source for the schema. Currently, the only valid value is
	// an Amplify DataStore .
	//
	// This member is required.
	DataSourceType CodegenJobGenericDataSourceType

	// The name of a CodegenGenericDataEnum .
	//
	// This member is required.
	Enums map[string]CodegenGenericDataEnum

	// The name of a CodegenGenericDataModel .
	//
	// This member is required.
	Models map[string]CodegenGenericDataModel

	// The name of a CodegenGenericDataNonModel .
	//
	// This member is required.
	NonModels map[string]CodegenGenericDataNonModel
	// contains filtered or unexported fields
}

Describes the data schema for a code generation job.

type CodegenJobGenericDataSourceType added in v1.11.0 

type CodegenJobGenericDataSourceType string
const (
	CodegenJobGenericDataSourceTypeDataStore CodegenJobGenericDataSourceType = "DataStore"
)

Enum values for CodegenJobGenericDataSourceType

func (CodegenJobGenericDataSourceType) Values added in v1.11.0 

func (CodegenJobGenericDataSourceType) Values() []CodegenJobGenericDataSourceType

Values returns all known values for CodegenJobGenericDataSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CodegenJobRenderConfig added in v1.11.0 

type CodegenJobRenderConfig interface {
	// contains filtered or unexported methods
}

Describes the configuration information for rendering the UI component associated with the code generation job.

The following types satisfy this interface: 

CodegenJobRenderConfigMemberReact
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amplifyuibuilder/types"
)

func main() {
	var union types.CodegenJobRenderConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CodegenJobRenderConfigMemberReact:
		_ = v.Value // Value is types.ReactStartCodegenJobData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type CodegenJobRenderConfigMemberReact added in v1.11.0 

type CodegenJobRenderConfigMemberReact struct {
	Value ReactStartCodegenJobData
	// contains filtered or unexported fields
}

The name of the ReactStartCodegenJobData object.

type CodegenJobStatus added in v1.11.0 

type CodegenJobStatus string
const (
	CodegenJobStatusInProgress CodegenJobStatus = "in_progress"
	CodegenJobStatusFailed     CodegenJobStatus = "failed"
	CodegenJobStatusSucceeded  CodegenJobStatus = "succeeded"
)

Enum values for CodegenJobStatus

func (CodegenJobStatus) Values added in v1.11.0 

func (CodegenJobStatus) Values() []CodegenJobStatus

Values returns all known values for CodegenJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CodegenJobSummary added in v1.11.0 

type CodegenJobSummary struct {

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

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

	// The unique ID for the code generation job summary.
	//
	// This member is required.
	Id *string

	// The time that the code generation job summary was created.
	CreatedAt *time.Time

	// The time that the code generation job summary was modified.
	ModifiedAt *time.Time
	// contains filtered or unexported fields
}

A summary of the basic information about the code generation job.

type Component 

type Component struct {

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

	// The information to connect a component's properties to data at runtime. You
	// can't specify tags as a valid property for bindingProperties .
	//
	// This member is required.
	BindingProperties map[string]ComponentBindingPropertiesValue

	// The type of the component. This can be an Amplify custom UI component or
	// another custom component.
	//
	// This member is required.
	ComponentType *string

	// The time that the component was created.
	//
	// This member is required.
	CreatedAt *time.Time

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

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

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

	// 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 .
	//
	// This member is required.
	Overrides map[string]map[string]string

	// Describes the component's properties. You can't specify tags as a valid
	// property for properties .
	//
	// This member is required.
	Properties map[string]ComponentProperty

	// A list of the component's variants. A variant is a unique style configuration
	// of a main component.
	//
	// This member is required.
	Variants []ComponentVariant

	// A list of the component's ComponentChild instances.
	Children []ComponentChild

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

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

	// The time that the component was modified.
	ModifiedAt *time.Time

	// The schema version of the component when it was imported.
	SchemaVersion *string

	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string

	// One or more key-value pairs to use when tagging the component.
	Tags map[string]string
	// 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 .

type ComponentBindingPropertiesValue 

type ComponentBindingPropertiesValue struct {

	// Describes the properties to customize with data at runtime.
	BindingProperties *ComponentBindingPropertiesValueProperties

	// The default value of the property.
	DefaultValue *string

	// The property 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.

type ComponentBindingPropertiesValueProperties 

type ComponentBindingPropertiesValueProperties struct {

	// An Amazon S3 bucket.
	Bucket *string

	// The default value to assign to the property.
	DefaultValue *string

	// The field to bind the data to.
	Field *string

	// The storage key for an Amazon S3 bucket.
	Key *string

	// An Amplify DataStore model.
	Model *string

	// A list of predicates for binding a component's properties to data.
	Predicates []Predicate

	// The name of a component slot.
	SlotName *string

	// An authenticated user attribute.
	UserAttribute *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.

type ComponentChild 

type ComponentChild struct {

	// The type of the child component.
	//
	// This member is required.
	ComponentType *string

	// The name of the child component.
	//
	// This member is required.
	Name *string

	// Describes the properties of the child component. You can't specify tags as a
	// valid property for properties .
	//
	// This member is required.
	Properties map[string]ComponentProperty

	// The list of ComponentChild instances for this component.
	Children []ComponentChild

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

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

A nested UI configuration within a parent Component .

type ComponentConditionProperty 

type ComponentConditionProperty struct {

	// The value to assign to the property if the condition is not met.
	Else *ComponentProperty

	// The name of a field. Specify this when the property is a data model.
	Field *string

	// The value of the property to evaluate.
	Operand *string

	// The type of the property to evaluate.
	OperandType *string

	// The operator to use to perform the evaluation, such as eq to represent equals.
	Operator *string

	// The name of the conditional property.
	Property *string

	// The value to assign to the property if the condition is met.
	Then *ComponentProperty
	// 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.

type ComponentDataConfiguration 

type ComponentDataConfiguration struct {

	// The name of the data model to use to bind data to a component.
	//
	// This member is required.
	Model *string

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

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

	// Describes how to sort the component's properties.
	Sort []SortProperty
	// contains filtered or unexported fields
}

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

type ComponentEvent added in v1.5.0 

type ComponentEvent struct {

	// The action to perform when a specific event is raised.
	Action *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

	// Describes information about the action.
	Parameters *ActionParameters
	// 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.

type ComponentProperty 

type ComponentProperty struct {

	// The information to bind the component property to data at runtime.
	BindingProperties *ComponentPropertyBindingProperties

	// The information to bind the component property to form data.
	Bindings map[string]FormBindingElement

	// The information to bind the component property to data at runtime. Use this for
	// collection components.
	CollectionBindingProperties *ComponentPropertyBindingProperties

	// The name of the component that is affected by an event.
	ComponentName *string

	// A list of component properties to concatenate to create the value to assign to
	// this component property.
	Concat []ComponentProperty

	// The conditional expression to use to assign a value to the component property.
	Condition *ComponentConditionProperty

	// Specifies whether the user configured the property in Amplify Studio after
	// importing it.
	Configured *bool

	// The default value to assign to the component property.
	DefaultValue *string

	// An event that occurs in your app. Use this for workflow data binding.
	Event *string

	// The default value assigned to the property when the component is imported into
	// an app.
	ImportedValue *string

	// The data model to use to assign a value to the component property.
	Model *string

	// The name of the component's property that is affected by an event.
	Property *string

	// The component type.
	Type *string

	// An authenticated user attribute to use to assign a value to the component
	// property.
	UserAttribute *string

	// The value to assign to the component property.
	Value *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.

type ComponentPropertyBindingProperties 

type ComponentPropertyBindingProperties struct {

	// The component property to bind to the data field.
	//
	// This member is required.
	Property *string

	// The data field to bind the property to.
	Field *string
	// 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.

type ComponentSummary 

type ComponentSummary struct {

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

	// The component type.
	//
	// This member is required.
	ComponentType *string

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

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

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

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

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

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

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

type CreateComponentData 

type CreateComponentData struct {

	// The data binding information for the component's properties.
	//
	// This member is required.
	BindingProperties map[string]ComponentBindingPropertiesValue

	// The component type. This can be an Amplify custom UI component or another
	// custom component.
	//
	// This member is required.
	ComponentType *string

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

	// Describes the component properties that can be overriden to customize an
	// instance of the component.
	//
	// This member is required.
	Overrides map[string]map[string]string

	// Describes the component's properties.
	//
	// This member is required.
	Properties map[string]ComponentProperty

	// A list of the unique variants of this component.
	//
	// This member is required.
	Variants []ComponentVariant

	// A list of child components that are instances of the main component.
	Children []ComponentChild

	// The data binding configuration for customizing a component's properties. Use
	// this for a collection component.
	CollectionProperties map[string]ComponentDataConfiguration

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

	// The schema version of the component when it was imported.
	SchemaVersion *string

	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string

	// One or more key-value pairs to use when tagging the component data.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type CreateFormData added in v1.7.0 

type CreateFormData struct {

	// The type of data source to use to create the form.
	//
	// This member is required.
	DataType *FormDataTypeConfig

	// The configuration information for the form's fields.
	//
	// This member is required.
	Fields map[string]FieldConfig

	// Specifies whether to perform a create or update action on the form.
	//
	// This member is required.
	FormActionType FormActionType

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

	// The schema version of the form.
	//
	// This member is required.
	SchemaVersion *string

	// The configuration information for the visual helper elements for the form.
	// These elements are not associated with any data.
	//
	// This member is required.
	SectionalElements map[string]SectionalElement

	// The configuration for the form's style.
	//
	// This member is required.
	Style *FormStyle

	// The FormCTA object that stores the call to action configuration for the form.
	Cta *FormCTA

	// Specifies an icon or decoration to display on the form.
	LabelDecorator LabelDecorator

	// One or more key-value pairs to use when tagging the form data.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type CreateThemeData 

type CreateThemeData struct {

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

	// A list of key-value pairs that defines the properties of the theme.
	//
	// This member is required.
	Values []ThemeValues

	// Describes the properties that can be overriden to customize an instance of the
	// theme.
	Overrides []ThemeValues

	// One or more key-value pairs to use when tagging the theme data.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type DataStoreRenderConfig added in v1.12.0 

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

Describes the DataStore configuration for an API for a code generation job.

type ExchangeCodeForTokenRequestBody 

type ExchangeCodeForTokenRequestBody struct {

	// The access code to send in the request.
	//
	// This member is required.
	Code *string

	// The location of the application that will receive the access code.
	//
	// This member is required.
	RedirectUri *string

	// The ID of the client to request the token from.
	ClientId *string
	// contains filtered or unexported fields
}

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

type FieldConfig added in v1.7.0 

type FieldConfig struct {

	// Specifies whether to hide a field.
	Excluded *bool

	// Describes the configuration for the default input value to display for a field.
	InputType *FieldInputConfig

	// The label for the field.
	Label *string

	// Specifies the field position.
	Position FieldPosition

	// The validations to perform on the value in the field.
	Validations []FieldValidationConfiguration
	// contains filtered or unexported fields
}

Describes the configuration information for a field in a table.

type FieldInputConfig added in v1.7.0 

type FieldInputConfig struct {

	// The input type for the field.
	//
	// This member is required.
	Type *string

	// Specifies whether a field has a default value.
	DefaultChecked *bool

	// The default country code for a phone number.
	DefaultCountryCode *string

	// The default value for the field.
	DefaultValue *string

	// The text to display to describe the field.
	DescriptiveText *string

	// The configuration for the file uploader field.
	FileUploaderConfig *FileUploaderFieldConfig

	// Specifies whether to render the field as an array. This property is ignored if
	// the dataSourceType for the form is a Data Store.
	IsArray *bool

	// The maximum value to display for the field.
	MaxValue *float32

	// The minimum value to display for the field.
	MinValue *float32

	// The name of the field.
	Name *string

	// The text to display as a placeholder for the field.
	Placeholder *string

	// Specifies a read only field.
	ReadOnly *bool

	// Specifies a field that requires input.
	Required *bool

	// The stepping increment for a numeric value in a field.
	Step *float32

	// The value for the field.
	Value *string

	// The information to use to customize the input fields with data at runtime.
	ValueMappings *ValueMappings
	// contains filtered or unexported fields
}

Describes the configuration for the default input values to display for a field.

type FieldPosition added in v1.7.0 

type FieldPosition interface {
	// contains filtered or unexported methods
}

Describes the field position.

The following types satisfy this interface: 

FieldPositionMemberBelow
FieldPositionMemberFixed
FieldPositionMemberRightOf
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amplifyuibuilder/types"
)

func main() {
	var union types.FieldPosition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FieldPositionMemberBelow:
		_ = v.Value // Value is string

	case *types.FieldPositionMemberFixed:
		_ = v.Value // Value is types.FixedPosition

	case *types.FieldPositionMemberRightOf:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FieldPositionMemberBelow added in v1.7.0 

type FieldPositionMemberBelow struct {
	Value string
	// contains filtered or unexported fields
}

The field position is below the field specified by the string.

type FieldPositionMemberFixed added in v1.7.0 

type FieldPositionMemberFixed struct {
	Value FixedPosition
	// contains filtered or unexported fields
}

The field position is fixed and doesn't change in relation to other fields.

type FieldPositionMemberRightOf added in v1.7.0 

type FieldPositionMemberRightOf struct {
	Value string
	// contains filtered or unexported fields
}

The field position is to the right of the field specified by the string.

type FieldValidationConfiguration added in v1.7.0 

type FieldValidationConfiguration struct {

	// The validation to perform on an object type.
	//
	// This member is required.
	Type *string

	// The validation to perform on a number value.
	NumValues []int32

	// The validation to perform on a string value.
	StrValues []string

	// The validation message to display.
	ValidationMessage *string
	// contains filtered or unexported fields
}

Describes the validation configuration for a field.

type FileUploaderFieldConfig added in v1.10.0 

type FileUploaderFieldConfig struct {

	// The file types that are allowed to be uploaded by the file uploader. Provide
	// this information in an array of strings specifying the valid file extensions.
	//
	// This member is required.
	AcceptedFileTypes []string

	// The access level to assign to the uploaded files in the Amazon S3 bucket where
	// they are stored. The valid values for this property are private , protected , or
	// public . For detailed information about the permissions associated with each
	// access level, see File access levels (https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/)
	// in the Amplify documentation.
	//
	// This member is required.
	AccessLevel StorageAccessLevel

	// Allows the file upload operation to be paused and resumed. The default value is
	// false . When isResumable is set to true , the file uploader uses a multipart
	// upload to break the files into chunks before upload. The progress of the upload
	// isn't continuous, because the file uploader uploads a chunk at a time.
	IsResumable *bool

	// Specifies the maximum number of files that can be selected to upload. The
	// default value is an unlimited number of files.
	MaxFileCount *int32

	// The maximum file size in bytes that the file uploader will accept. The default
	// value is an unlimited file size.
	MaxSize *int32

	// Specifies whether to display or hide the image preview after selecting a file
	// for upload. The default value is true to display the image preview.
	ShowThumbnails *bool
	// contains filtered or unexported fields
}

Describes the configuration for the file uploader field.

type FixedPosition added in v1.7.0 

type FixedPosition string
const (
	FixedPositionFirst FixedPosition = "first"
)

Enum values for FixedPosition

func (FixedPosition) Values added in v1.7.0 

func (FixedPosition) Values() []FixedPosition

Values returns all known values for FixedPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Form added in v1.7.0 

type Form struct {

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

	// The type of data source to use to create the form.
	//
	// This member is required.
	DataType *FormDataTypeConfig

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

	// Stores the information about the form's fields.
	//
	// This member is required.
	Fields map[string]FieldConfig

	// The operation to perform on the specified form.
	//
	// This member is required.
	FormActionType FormActionType

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

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

	// The schema version of the form when it was imported.
	//
	// This member is required.
	SchemaVersion *string

	// Stores the visual helper elements for the form that are not associated with any
	// data.
	//
	// This member is required.
	SectionalElements map[string]SectionalElement

	// Stores the configuration for the form's style.
	//
	// This member is required.
	Style *FormStyle

	// Stores the call to action configuration for the form.
	Cta *FormCTA

	// Specifies an icon or decoration to display on the form.
	LabelDecorator LabelDecorator

	// One or more key-value pairs to use when tagging the form.
	Tags map[string]string
	// contains filtered or unexported fields
}

Contains the configuration settings for a Form user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.

type FormActionType added in v1.7.0 

type FormActionType string
const (
	FormActionTypeCreate FormActionType = "create"
	FormActionTypeUpdate FormActionType = "update"
)

Enum values for FormActionType

func (FormActionType) Values added in v1.7.0 

func (FormActionType) Values() []FormActionType

Values returns all known values for FormActionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FormBindingElement 

type FormBindingElement struct {

	// The name of the component to retrieve a value from.
	//
	// This member is required.
	Element *string

	// The property to retrieve a value from.
	//
	// This member is required.
	Property *string
	// contains filtered or unexported fields
}

Describes how to bind a component property to form data.

type FormButton added in v1.7.0 

type FormButton struct {

	// Describes the button's properties.
	Children *string

	// Specifies whether the button is visible on the form.
	Excluded *bool

	// The position of the button.
	Position FieldPosition
	// contains filtered or unexported fields
}

Describes the configuration for a button UI element that is a part of a form.

type FormButtonsPosition added in v1.7.0 

type FormButtonsPosition string
const (
	FormButtonsPositionTop          FormButtonsPosition = "top"
	FormButtonsPositionBottom       FormButtonsPosition = "bottom"
	FormButtonsPositionTopAndBottom FormButtonsPosition = "top_and_bottom"
)

Enum values for FormButtonsPosition

func (FormButtonsPosition) Values added in v1.7.0 

func (FormButtonsPosition) Values() []FormButtonsPosition

Values returns all known values for FormButtonsPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FormCTA added in v1.7.0 

type FormCTA struct {

	// Displays a cancel button.
	Cancel *FormButton

	// Displays a clear button.
	Clear *FormButton

	// The position of the button.
	Position FormButtonsPosition

	// Displays a submit button.
	Submit *FormButton
	// contains filtered or unexported fields
}

Describes the call to action button configuration for the form.

type FormDataSourceType added in v1.7.0 

type FormDataSourceType string
const (
	// Will use a provided Amplify DataStore enabled API
	FormDataSourceTypeDatastore FormDataSourceType = "DataStore"
	// Will use passed in hooks to use when creating a form from scratch
	FormDataSourceTypeCustom FormDataSourceType = "Custom"
)

Enum values for FormDataSourceType

func (FormDataSourceType) Values added in v1.7.0 

func (FormDataSourceType) Values() []FormDataSourceType

Values returns all known values for FormDataSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FormDataTypeConfig added in v1.7.0 

type FormDataTypeConfig struct {

	// The data source type, either an Amplify DataStore model or a custom data type.
	//
	// This member is required.
	DataSourceType FormDataSourceType

	// The unique name of the data type you are using as the data source for the form.
	//
	// This member is required.
	DataTypeName *string
	// contains filtered or unexported fields
}

Describes the data type configuration for the data source associated with a form.

type FormInputBindingPropertiesValue added in v1.10.0 

type FormInputBindingPropertiesValue struct {

	// Describes the properties to customize with data at runtime.
	BindingProperties *FormInputBindingPropertiesValueProperties

	// The property type.
	Type *string
	// contains filtered or unexported fields
}

Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.

type FormInputBindingPropertiesValueProperties added in v1.10.0 

type FormInputBindingPropertiesValueProperties struct {

	// An Amplify DataStore model.
	Model *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 Amplify DataStore model.

type FormInputValueProperty added in v1.7.0 

type FormInputValueProperty struct {

	// The information to bind fields to data at runtime.
	BindingProperties *FormInputValuePropertyBindingProperties

	// A list of form properties to concatenate to create the value to assign to this
	// field property.
	Concat []FormInputValueProperty

	// The value to assign to the input field.
	Value *string
	// contains filtered or unexported fields
}

Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.

type FormInputValuePropertyBindingProperties added in v1.10.0 

type FormInputValuePropertyBindingProperties struct {

	// The form property to bind to the data field.
	//
	// This member is required.
	Property *string

	// The data field to bind the property to.
	Field *string
	// contains filtered or unexported fields
}

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

type FormStyle added in v1.7.0 

type FormStyle struct {

	// The spacing for the horizontal gap.
	HorizontalGap FormStyleConfig

	// The size of the outer padding for the form.
	OuterPadding FormStyleConfig

	// The spacing for the vertical gap.
	VerticalGap FormStyleConfig
	// contains filtered or unexported fields
}

Describes the configuration for the form's style.

type FormStyleConfig added in v1.7.0 

type FormStyleConfig interface {
	// contains filtered or unexported methods
}

Describes the configuration settings for the form's style properties.

The following types satisfy this interface: 

FormStyleConfigMemberTokenReference
FormStyleConfigMemberValue
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amplifyuibuilder/types"
)

func main() {
	var union types.FormStyleConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FormStyleConfigMemberTokenReference:
		_ = v.Value // Value is string

	case *types.FormStyleConfigMemberValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FormStyleConfigMemberTokenReference added in v1.7.0 

type FormStyleConfigMemberTokenReference struct {
	Value string
	// contains filtered or unexported fields
}

A reference to a design token to use to bind the form's style properties to an existing theme.

type FormStyleConfigMemberValue added in v1.7.0 

type FormStyleConfigMemberValue struct {
	Value string
	// contains filtered or unexported fields
}

The value of the style setting.

type FormSummary added in v1.7.0 

type FormSummary struct {

	// The unique ID for the app associated with the form summary.
	//
	// This member is required.
	AppId *string

	// The form's data source type.
	//
	// This member is required.
	DataType *FormDataTypeConfig

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

	// The type of operation to perform on the form.
	//
	// This member is required.
	FormActionType FormActionType

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

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

Describes the basic information about a form.

type GenericDataRelationshipType added in v1.11.0 

type GenericDataRelationshipType string
const (
	GenericDataRelationshipTypeHasMany   GenericDataRelationshipType = "HAS_MANY"
	GenericDataRelationshipTypeHasOne    GenericDataRelationshipType = "HAS_ONE"
	GenericDataRelationshipTypeBelongsTo GenericDataRelationshipType = "BELONGS_TO"
)

Enum values for GenericDataRelationshipType

func (GenericDataRelationshipType) Values added in v1.11.0 

func (GenericDataRelationshipType) Values() []GenericDataRelationshipType

Values returns all known values for GenericDataRelationshipType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GraphQLRenderConfig added in v1.12.0 

type GraphQLRenderConfig struct {

	// The path to the GraphQL fragments file, relative to the component output
	// directory.
	//
	// This member is required.
	FragmentsFilePath *string

	// The path to the GraphQL mutations file, relative to the component output
	// directory.
	//
	// This member is required.
	MutationsFilePath *string

	// The path to the GraphQL queries file, relative to the component output
	// directory.
	//
	// This member is required.
	QueriesFilePath *string

	// The path to the GraphQL subscriptions file, relative to the component output
	// directory.
	//
	// This member is required.
	SubscriptionsFilePath *string

	// The path to the GraphQL types file, relative to the component output directory.
	//
	// This member is required.
	TypesFilePath *string
	// contains filtered or unexported fields
}

Describes the GraphQL configuration for an API for a code generation job.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal error has occurred. Please retry your request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidParameterException 

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InvalidParameterException) Error 

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode 

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault 

func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterException) ErrorMessage 

func (e *InvalidParameterException) ErrorMessage() string

type JSModule added in v1.11.0 

type JSModule string
const (
	JSModuleEs2020 JSModule = "es2020"
	JSModuleEsnext JSModule = "esnext"
)

Enum values for JSModule

func (JSModule) Values added in v1.11.0 

func (JSModule) Values() []JSModule

Values returns all known values for JSModule. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JSScript added in v1.11.0 

type JSScript string
const (
	JSScriptJsx JSScript = "jsx"
	JSScriptTsx JSScript = "tsx"
	JSScriptJs  JSScript = "js"
)

Enum values for JSScript

func (JSScript) Values added in v1.11.0 

func (JSScript) Values() []JSScript

Values returns all known values for JSScript. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JSTarget added in v1.11.0 

type JSTarget string
const (
	JSTargetEs2015 JSTarget = "es2015"
	JSTargetEs2020 JSTarget = "es2020"
)

Enum values for JSTarget

func (JSTarget) Values added in v1.11.0 

func (JSTarget) Values() []JSTarget

Values returns all known values for JSTarget. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LabelDecorator added in v1.10.0 

type LabelDecorator string
const (
	LabelDecoratorRequired LabelDecorator = "required"
	LabelDecoratorOptional LabelDecorator = "optional"
	LabelDecoratorNone     LabelDecorator = "none"
)

Enum values for LabelDecorator

func (LabelDecorator) Values added in v1.10.0 

func (LabelDecorator) Values() []LabelDecorator

Values returns all known values for LabelDecorator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MutationActionSetStateParameter added in v1.5.0 

type MutationActionSetStateParameter struct {

	// The name of the component that is being modified.
	//
	// This member is required.
	ComponentName *string

	// The name of the component property to apply the state configuration to.
	//
	// This member is required.
	Property *string

	// The state configuration to assign to the property.
	//
	// This member is required.
	Set *ComponentProperty
	// contains filtered or unexported fields
}

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

type NoApiRenderConfig added in v1.12.0 

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

Describes the configuration for an application with no API being used.

type Predicate 

type Predicate struct {

	// A list of predicates to combine logically.
	And []Predicate

	// The field to query.
	Field *string

	// The value to use when performing the evaluation.
	Operand *string

	// The type of value to use when performing the evaluation.
	OperandType *string

	// The operator to use to perform the evaluation.
	Operator *string

	// A list of predicates to combine logically.
	Or []Predicate
	// 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.

type PutMetadataFlagBody added in v1.7.0 

type PutMetadataFlagBody struct {

	// The new information to store.
	//
	// This member is required.
	NewValue *string
	// contains filtered or unexported fields
}

Stores the metadata information about a feature on a form.

type ReactStartCodegenJobData added in v1.11.0 

type ReactStartCodegenJobData struct {

	// The API configuration for the code generation job.
	ApiConfiguration ApiConfiguration

	// Lists the dependency packages that may be required for the project code to run.
	Dependencies map[string]string

	// Specifies whether the code generation job should render inline source maps.
	InlineSourceMap bool

	// The JavaScript module type.
	Module JSModule

	// Specifies whether the code generation job should render type declaration files.
	RenderTypeDeclarations bool

	// The file type to use for a JavaScript project.
	Script JSScript

	// The ECMAScript specification to use.
	Target JSTarget
	// contains filtered or unexported fields
}

Describes the code generation job configuration for a React project.

type RefreshTokenRequestBody 

type RefreshTokenRequestBody struct {

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

	// The ID of the client to request the token from.
	ClientId *string
	// contains filtered or unexported fields
}

Describes a refresh token.

type ResourceConflictException 

type ResourceConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ResourceConflictException) Error 

func (e *ResourceConflictException) Error() string

func (*ResourceConflictException) ErrorCode 

func (e *ResourceConflictException) ErrorCode() string

func (*ResourceConflictException) ErrorFault 

func (e *ResourceConflictException) ErrorFault() smithy.ErrorFault

func (*ResourceConflictException) ErrorMessage 

func (e *ResourceConflictException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type SectionalElement added in v1.7.0 

type SectionalElement struct {

	// The type of sectional element. Valid values are Heading , Text , and Divider .
	//
	// This member is required.
	Type *string

	// Excludes a sectional element that was generated by default for a specified data
	// model.
	Excluded *bool

	// Specifies the size of the font for a Heading sectional element. Valid values
	// are 1 | 2 | 3 | 4 | 5 | 6 .
	Level *int32

	// Specifies the orientation for a Divider sectional element. Valid values are
	// horizontal or vertical .
	Orientation *string

	// Specifies the position of the text in a field for a Text sectional element.
	Position FieldPosition

	// The text for a Text sectional element.
	Text *string
	// contains filtered or unexported fields
}

Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *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) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SortDirection 

type SortDirection string

func (SortDirection) Values 

func (SortDirection) Values() []SortDirection

Values returns all known values for SortDirection. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SortProperty 

type SortProperty struct {

	// The direction of the sort, either ascending or descending.
	//
	// This member is required.
	Direction SortDirection

	// The field to perform the sort on.
	//
	// This member is required.
	Field *string
	// contains filtered or unexported fields
}

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

type StartCodegenJobData added in v1.11.0 

type StartCodegenJobData struct {

	// The code generation configuration for the codegen job.
	//
	// This member is required.
	RenderConfig CodegenJobRenderConfig

	// Specifies whether to autogenerate forms in the code generation job.
	AutoGenerateForms *bool

	// The feature flags for a code generation job.
	Features *CodegenFeatureFlags

	// The data schema to use for a code generation job.
	GenericDataSchema *CodegenJobGenericDataSchema

	// One or more key-value pairs to use when tagging the code generation job data.
	Tags map[string]string
	// contains filtered or unexported fields
}

The code generation job resource configuration.

type StorageAccessLevel added in v1.10.0 

type StorageAccessLevel string
const (
	StorageAccessLevelPublic    StorageAccessLevel = "public"
	StorageAccessLevelProtected StorageAccessLevel = "protected"
	StorageAccessLevelPrivate   StorageAccessLevel = "private"
)

Enum values for StorageAccessLevel

func (StorageAccessLevel) Values added in v1.10.0 

func (StorageAccessLevel) Values() []StorageAccessLevel

Values returns all known values for StorageAccessLevel. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Theme 

type Theme struct {

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

	// The time that the theme was created.
	//
	// This member is required.
	CreatedAt *time.Time

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

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

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

	// A list of key-value pairs that defines the properties of the theme.
	//
	// This member is required.
	Values []ThemeValues

	// The time that the theme was modified.
	ModifiedAt *time.Time

	// Describes the properties that can be overriden to customize a theme.
	Overrides []ThemeValues

	// One or more key-value pairs to use when tagging the theme.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type ThemeSummary 

type ThemeSummary struct {

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

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

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

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

Describes the basic information about a theme.

type ThemeValue 

type ThemeValue struct {

	// A list of key-value pairs that define the theme's properties.
	Children []ThemeValues

	// The value of a theme property.
	Value *string
	// contains filtered or unexported fields
}

Describes the configuration of a theme's properties.

type ThemeValues 

type ThemeValues struct {

	// The name of the property.
	Key *string

	// The value of the property.
	Value *ThemeValue
	// contains filtered or unexported fields
}

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

type ThrottlingException added in v1.11.0 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error added in v1.11.0 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode added in v1.11.0 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault added in v1.11.0 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage added in v1.11.0 

func (e *ThrottlingException) ErrorMessage() string

type TokenProviders 

type TokenProviders string
const (
	// The figma token provider.
	TokenProvidersFigma TokenProviders = "figma"
)

Enum values for TokenProviders

func (TokenProviders) Values 

func (TokenProviders) Values() []TokenProviders

Values returns all known values for TokenProviders. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnauthorizedException added in v1.7.0 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have permission to perform this operation.

func (*UnauthorizedException) Error added in v1.7.0 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode added in v1.7.0 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault added in v1.7.0 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage added in v1.7.0 

func (e *UnauthorizedException) ErrorMessage() string

type UnknownUnionMember added in v1.7.0 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdateComponentData 

type UpdateComponentData struct {

	// The data binding information for the component's properties.
	BindingProperties map[string]ComponentBindingPropertiesValue

	// The components that are instances of the main component.
	Children []ComponentChild

	// The configuration for binding a component's properties to a data model. Use
	// this for a collection component.
	CollectionProperties map[string]ComponentDataConfiguration

	// The type of the component. This can be an Amplify custom UI component or
	// another custom component.
	ComponentType *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

	// The unique ID of the component to update.
	Id *string

	// The name of the component to update.
	Name *string

	// Describes the properties that can be overriden to customize the component.
	Overrides map[string]map[string]string

	// Describes the component's properties.
	Properties map[string]ComponentProperty

	// The schema version of the component when it was imported.
	SchemaVersion *string

	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string

	// A list of the unique variants of the main component being updated.
	Variants []ComponentVariant
	// contains filtered or unexported fields
}

Updates and saves all of the information about a component, based on component ID.

type UpdateFormData added in v1.7.0 

type UpdateFormData struct {

	// The FormCTA object that stores the call to action configuration for the form.
	Cta *FormCTA

	// The type of data source to use to create the form.
	DataType *FormDataTypeConfig

	// The configuration information for the form's fields.
	Fields map[string]FieldConfig

	// Specifies whether to perform a create or update action on the form.
	FormActionType FormActionType

	// Specifies an icon or decoration to display on the form.
	LabelDecorator LabelDecorator

	// The name of the form.
	Name *string

	// The schema version of the form.
	SchemaVersion *string

	// The configuration information for the visual helper elements for the form.
	// These elements are not associated with any data.
	SectionalElements map[string]SectionalElement

	// The configuration for the form's style.
	Style *FormStyle
	// contains filtered or unexported fields
}

Updates and saves all of the information about a form, based on form ID.

type UpdateThemeData 

type UpdateThemeData struct {

	// A list of key-value pairs that define the theme's properties.
	//
	// This member is required.
	Values []ThemeValues

	// The unique ID of the theme to update.
	Id *string

	// The name of the theme to update.
	Name *string

	// Describes the properties that can be overriden to customize the theme.
	Overrides []ThemeValues
	// contains filtered or unexported fields
}

Saves the data binding information for a theme.

type ValueMapping added in v1.7.0 

type ValueMapping struct {

	// The complex object.
	//
	// This member is required.
	Value *FormInputValueProperty

	// The value to display for the complex object.
	DisplayValue *FormInputValueProperty
	// contains filtered or unexported fields
}

Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.

type ValueMappings added in v1.7.0 

type ValueMappings struct {

	// The value and display value pairs.
	//
	// This member is required.
	Values []ValueMapping

	// The information to bind fields to data at runtime.
	BindingProperties map[string]FormInputBindingPropertiesValue
	// contains filtered or unexported fields
}

Represents the data binding configuration for a value map.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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