Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS Amplify UI Builder can respond with.

Structs

ActionParameters

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.

CodegenDependency

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

CodegenFeatureFlags

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

CodegenGenericDataEnum

Describes the enums in a generic data schema.

CodegenGenericDataField

Describes a field in a generic data schema.

CodegenGenericDataModel

Describes a model in a generic data schema.

CodegenGenericDataNonModel

Describes a non-model in a generic data schema.

CodegenGenericDataRelationshipType

Describes the relationship between generic data models.

CodegenJob

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

CodegenJobAsset

Describes an asset for a code generation job.

CodegenJobGenericDataSchema

Describes the data schema for a code generation job.

CodegenJobSummary

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

Component

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.

ComponentBindingPropertiesValue

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.

ComponentBindingPropertiesValueProperties

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.

ComponentChild

A nested UI configuration within a parent Component.

ComponentConditionProperty

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.

ComponentDataConfiguration

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

ComponentEvent

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.

ComponentProperty

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

ComponentPropertyBindingProperties

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.

ComponentSummary

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

ComponentVariant

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

CreateComponentData

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

CreateFormData

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

CreateThemeData

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

DataStoreRenderConfig

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

ExchangeCodeForTokenRequestBody

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

FieldConfig

Describes the configuration information for a field in a table.

FieldInputConfig

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

FieldValidationConfiguration

Describes the validation configuration for a field.

FileUploaderFieldConfig

Describes the configuration for the file uploader field.

Form

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.

FormBindingElement

Describes how to bind a component property to form data.

FormButton

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

FormCta

Describes the call to action button configuration for the form.

FormDataTypeConfig

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

FormInputBindingPropertiesValue

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.

FormInputBindingPropertiesValueProperties

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.

FormInputValueProperty

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

FormInputValuePropertyBindingProperties

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.

FormStyle

Describes the configuration for the form's style.

FormSummary

Describes the basic information about a form.

GraphQlRenderConfig

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

MutationActionSetStateParameter

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

NoApiRenderConfig

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

Predicate

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

PutMetadataFlagBody

Stores the metadata information about a feature on a form.

ReactStartCodegenJobData

Describes the code generation job configuration for a React project.

RefreshTokenRequestBody

Describes a refresh token.

SectionalElement

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.

SortProperty

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

StartCodegenJobData

The code generation job resource configuration.

Theme

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

ThemeSummary

Describes the basic information about a theme.

ThemeValue

Describes the configuration of a theme's properties.

ThemeValues

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

UpdateComponentData

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

UpdateFormData

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

UpdateThemeData

Saves the data binding information for a theme.

ValueMapping

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

ValueMappings

Represents the data binding configuration for a value map.

Enums

ApiConfiguration

Describes the API configuration for a code generation job.

CodegenGenericDataFieldDataType

When writing a match expression against CodegenGenericDataFieldDataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CodegenJobGenericDataSourceType

When writing a match expression against CodegenJobGenericDataSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CodegenJobRenderConfig

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

CodegenJobStatus

When writing a match expression against CodegenJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FieldPosition

Describes the field position.

FixedPosition

When writing a match expression against FixedPosition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FormActionType

When writing a match expression against FormActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FormButtonsPosition

When writing a match expression against FormButtonsPosition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FormDataSourceType

When writing a match expression against FormDataSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FormStyleConfig

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

GenericDataRelationshipType

When writing a match expression against GenericDataRelationshipType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

JsModule

When writing a match expression against JsModule, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

JsScript

When writing a match expression against JsScript, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

JsTarget

When writing a match expression against JsTarget, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LabelDecorator

When writing a match expression against LabelDecorator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SortDirection

When writing a match expression against SortDirection, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StorageAccessLevel

When writing a match expression against StorageAccessLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TokenProviders

When writing a match expression against TokenProviders, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.