Serialized Form (AWS Java SDK for AWS Amplify UI Builder 1.12.433 API)

Package com.amazonaws.services.amplifyuibuilder.model
- Class com.amazonaws.services.amplifyuibuilder.model.ActionParameters extends Object implements Serializable
  - Serialized Fields
    - anchor
```
ComponentProperty anchor
```
      The HTML anchor link to the location to open. Specify this value for a navigation action.
    - fields
```
Map<K,V> fields
```
      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.
    - global
```
ComponentProperty global
```
      Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
    - id
```
ComponentProperty id
```
      The unique ID of the component that the ActionParameters apply to.
    - model
```
String model
```
      The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
    - state
```
MutationActionSetStateParameter state
```
      A key-value pair that specifies the state property name and its initial value.
    - target
```
ComponentProperty target
```
      The element within the same component to modify when the action occurs.
    - type
```
ComponentProperty type
```
      The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
    - url
```
ComponentProperty url
```
      The URL to the location to open. Specify this value for a navigation action.
- Class com.amazonaws.services.amplifyuibuilder.model.AWSAmplifyUIBuilderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplifyuibuilder.model.Component extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the component.
    - bindingProperties
```
Map<K,V> bindingProperties
```
      The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.
    - children
```
List<E> children
```
      A list of the component's ComponentChild instances.
    - collectionProperties
```
Map<K,V> collectionProperties
```
      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.
    - componentType
```
String componentType
```
      The type of the component. This can be an Amplify custom UI component or another custom component.
    - createdAt
```
Date createdAt
```
      The time that the component was created.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - events
```
Map<K,V> events
```
      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.
    - id
```
String id
```
      The unique ID of the component.
    - modifiedAt
```
Date modifiedAt
```
      The time that the component was modified.
    - name
```
String name
```
      The name of the component.
    - overrides
```
Map<K,V> overrides
```
      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.
    - properties
```
Map<K,V> properties
```
      Describes the component's properties. You can't specify tags as a valid property for properties.
    - schemaVersion
```
String schemaVersion
```
      The schema version of the component when it was imported.
    - sourceId
```
String sourceId
```
      The unique ID of the component in its original source system, such as Figma.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the component.
    - variants
```
List<E> variants
```
      A list of the component's variants. A variant is a unique style configuration of a main component.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValue extends Object implements Serializable
  - Serialized Fields
    - bindingProperties
```
ComponentBindingPropertiesValueProperties bindingProperties
```
      Describes the properties to customize with data at runtime.
    - defaultValue
```
String defaultValue
```
      The default value of the property.
    - type
```
String type
```
      The property type.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValueProperties extends Object implements Serializable
  - Serialized Fields
    - bucket
```
String bucket
```
      An Amazon S3 bucket.
    - defaultValue
```
String defaultValue
```
      The default value to assign to the property.
    - field
```
String field
```
      The field to bind the data to.
    - key
```
String key
```
      The storage key for an Amazon S3 bucket.
    - model
```
String model
```
      An Amplify DataStore model.
    - predicates
```
List<E> predicates
```
      A list of predicates for binding a component's properties to data.
    - slotName
```
String slotName
```
      The name of a component slot.
    - userAttribute
```
String userAttribute
```
      An authenticated user attribute.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentChild extends Object implements Serializable
  - Serialized Fields
    - children
```
List<E> children
```
      The list of ComponentChild instances for this component.
    - componentType
```
String componentType
```
      The type of the child component.
    - events
```
Map<K,V> events
```
      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.
    - name
```
String name
```
      The name of the child component.
    - properties
```
Map<K,V> properties
```
      Describes the properties of the child component. You can't specify tags as a valid property for properties.
    - sourceId
```
String sourceId
```
      The unique ID of the child component in its original source system, such as Figma.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentConditionProperty extends Object implements Serializable
  - Serialized Fields
    - elseValue
```
ComponentProperty elseValue
```
      The value to assign to the property if the condition is not met.
    - field
```
String field
```
      The name of a field. Specify this when the property is a data model.
    - operand
```
String operand
```
      The value of the property to evaluate.
    - operandType
```
String operandType
```
      The type of the property to evaluate.
    - operator
```
String operator
```
      The operator to use to perform the evaluation, such as eq to represent equals.
    - property
```
String property
```
      The name of the conditional property.
    - then
```
ComponentProperty then
```
      The value to assign to the property if the condition is met.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentDataConfiguration extends Object implements Serializable
  - Serialized Fields
    - identifiers
```
List<E> identifiers
```
      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.
    - model
```
String model
```
      The name of the data model to use to bind data to a component.
    - predicate
```
Predicate predicate
```
      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.
    - sort
```
List<E> sort
```
      Describes how to sort the component's properties.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentEvent extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action to perform when a specific event is raised.
    - bindingEvent
```
String bindingEvent
```
      Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.
    - parameters
```
ActionParameters parameters
```
      Describes information about the action.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentProperty extends Object implements Serializable
  - Serialized Fields
    - bindingProperties
```
ComponentPropertyBindingProperties bindingProperties
```
      The information to bind the component property to data at runtime.
    - bindings
```
Map<K,V> bindings
```
      The information to bind the component property to form data.
    - collectionBindingProperties
```
ComponentPropertyBindingProperties collectionBindingProperties
```
      The information to bind the component property to data at runtime. Use this for collection components.
    - componentName
```
String componentName
```
      The name of the component that is affected by an event.
    - concat
```
List<E> concat
```
      A list of component properties to concatenate to create the value to assign to this component property.
    - condition
```
ComponentConditionProperty condition
```
      The conditional expression to use to assign a value to the component property.
    - configured
```
Boolean configured
```
      Specifies whether the user configured the property in Amplify Studio after importing it.
    - defaultValue
```
String defaultValue
```
      The default value to assign to the component property.
    - event
```
String event
```
      An event that occurs in your app. Use this for workflow data binding.
    - importedValue
```
String importedValue
```
      The default value assigned to the property when the component is imported into an app.
    - model
```
String model
```
      The data model to use to assign a value to the component property.
    - property
```
String property
```
      The name of the component's property that is affected by an event.
    - type
```
String type
```
      The component type.
    - userAttribute
```
String userAttribute
```
      An authenticated user attribute to use to assign a value to the component property.
    - value
```
String value
```
      The value to assign to the component property.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentPropertyBindingProperties extends Object implements Serializable
  - Serialized Fields
    - field
```
String field
```
      The data field to bind the property to.
    - property
```
String property
```
      The component property to bind to the data field.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentSummary extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the component.
    - componentType
```
String componentType
```
      The component type.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the component.
    - name
```
String name
```
      The name of the component.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentVariant extends Object implements Serializable
  - Serialized Fields
    - overrides
```
Map<K,V> overrides
```
      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.
    - variantValues
```
Map<K,V> variantValues
```
      The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateComponentData extends Object implements Serializable
  - Serialized Fields
    - bindingProperties
```
Map<K,V> bindingProperties
```
      The data binding information for the component's properties.
    - children
```
List<E> children
```
      A list of child components that are instances of the main component.
    - collectionProperties
```
Map<K,V> collectionProperties
```
      The data binding configuration for customizing a component's properties. Use this for a collection component.
    - componentType
```
String componentType
```
      The component type. This can be an Amplify custom UI component or another custom component.
    - events
```
Map<K,V> events
```
      The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    - name
```
String name
```
      The name of the component
    - overrides
```
Map<K,V> overrides
```
      Describes the component properties that can be overriden to customize an instance of the component.
    - properties
```
Map<K,V> properties
```
      Describes the component's properties.
    - schemaVersion
```
String schemaVersion
```
      The schema version of the component when it was imported.
    - sourceId
```
String sourceId
```
      The unique ID of the component in its original source system, such as Figma.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the component data.
    - variants
```
List<E> variants
```
      A list of the unique variants of this component.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to associate with the component.
    - clientToken
```
String clientToken
```
      The unique client token.
    - componentToCreate
```
CreateComponentData componentToCreate
```
      Represents the configuration of the component to create.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entity
```
Component entity
```
      Describes the configuration of the new component.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateFormData extends Object implements Serializable
  - Serialized Fields
    - cta
```
FormCTA cta
```
      The FormCTA object that stores the call to action configuration for the form.
    - dataType
```
FormDataTypeConfig dataType
```
      The type of data source to use to create the form.
    - fields
```
Map<K,V> fields
```
      The configuration information for the form's fields.
    - formActionType
```
String formActionType
```
      Specifies whether to perform a create or update action on the form.
    - name
```
String name
```
      The name of the form.
    - schemaVersion
```
String schemaVersion
```
      The schema version of the form.
    - sectionalElements
```
Map<K,V> sectionalElements
```
      The configuration information for the visual helper elements for the form. These elements are not associated with any data.
    - style
```
FormStyle style
```
      The configuration for the form's style.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the form data.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateFormRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to associate with the form.
    - clientToken
```
String clientToken
```
      The unique client token.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - formToCreate
```
CreateFormData formToCreate
```
      Represents the configuration of the form to create.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateFormResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entity
```
Form entity
```
      Describes the configuration of the new form.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateThemeData extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the theme.
    - overrides
```
List<E> overrides
```
      Describes the properties that can be overriden to customize an instance of the theme.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the theme data.
    - values
```
List<E> values
```
      A list of key-value pairs that deﬁnes the properties of the theme.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateThemeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the theme.
    - clientToken
```
String clientToken
```
      The unique client token.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - themeToCreate
```
CreateThemeData themeToCreate
```
      Represents the configuration of the theme to create.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateThemeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entity
```
Theme entity
```
      Describes the configuration of the new theme.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the component to delete.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the component to delete.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteFormRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the form to delete.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the form to delete.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteFormResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteThemeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the theme to delete.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the theme to delete.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteThemeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.ExchangeCodeForTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - provider
```
String provider
```
      The third-party provider for the token. The only valid value is figma.
    - request
```
ExchangeCodeForTokenRequestBody request
```
      Describes the configuration of the request.
- Class com.amazonaws.services.amplifyuibuilder.model.ExchangeCodeForTokenRequestBody extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The access code to send in the request.
    - redirectUri
```
String redirectUri
```
      The location of the application that will receive the access code.
- Class com.amazonaws.services.amplifyuibuilder.model.ExchangeCodeForTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      The access token.
    - expiresIn
```
Integer expiresIn
```
      The date and time when the new access token expires.
    - refreshToken
```
String refreshToken
```
      The token to use to refresh a previously issued access token that might have expired.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportComponentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to export components to.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportComponentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Represents the configuration of the exported components.
    - nextToken
```
String nextToken
```
      The pagination token that's included if more results are available.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportFormsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to export forms to.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportFormsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Represents the configuration of the exported forms.
    - nextToken
```
String nextToken
```
      The pagination token that's included if more results are available.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportThemesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to export the themes to.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is part of the Amplify app.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportThemesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Represents the configuration of the exported themes.
    - nextToken
```
String nextToken
```
      The pagination token that's included if more results are available.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldConfig extends Object implements Serializable
  - Serialized Fields
    - excluded
```
Boolean excluded
```
      Specifies whether to hide a field.
    - inputType
```
FieldInputConfig inputType
```
      Describes the configuration for the default input value to display for a field.
    - label
```
String label
```
      The label for the field.
    - position
```
FieldPosition position
```
      Specifies the field position.
    - validations
```
List<E> validations
```
      The validations to perform on the value in the field.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldInputConfig extends Object implements Serializable
  - Serialized Fields
    - defaultChecked
```
Boolean defaultChecked
```
      Specifies whether a field has a default value.
    - defaultCountryCode
```
String defaultCountryCode
```
      The default country code for a phone number.
    - defaultValue
```
String defaultValue
```
      The default value for the field.
    - descriptiveText
```
String descriptiveText
```
      The text to display to describe the field.
    - isArray
```
Boolean isArray
```
      Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
    - maxValue
```
Float maxValue
```
      The maximum value to display for the field.
    - minValue
```
Float minValue
```
      The minimum value to display for the field.
    - name
```
String name
```
      The name of the field.
    - placeholder
```
String placeholder
```
      The text to display as a placeholder for the field.
    - readOnly
```
Boolean readOnly
```
      Specifies a read only field.
    - required
```
Boolean required
```
      Specifies a field that requires input.
    - step
```
Float step
```
      The stepping increment for a numeric value in a field.
    - type
```
String type
```
      The input type for the field.
    - value
```
String value
```
      The value for the field.
    - valueMappings
```
ValueMappings valueMappings
```
      The information to use to customize the input fields with data at runtime.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldPosition extends Object implements Serializable
  - Serialized Fields
    - below
```
String below
```
      The field position is below the field specified by the string.
    - fixed
```
String fixed
```
      The field position is fixed and doesn't change in relation to other fields.
    - rightOf
```
String rightOf
```
      The field position is to the right of the field specified by the string.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldValidationConfiguration extends Object implements Serializable
  - Serialized Fields
    - numValues
```
List<E> numValues
```
      The validation to perform on a number value.
    - strValues
```
List<E> strValues
```
      The validation to perform on a string value.
    - type
```
String type
```
      The validation to perform on an object type.

Serialized Form

Package com.amazonaws.services.amplifyuibuilder.model

Class com.amazonaws.services.amplifyuibuilder.model.ActionParameters extends Object implements Serializable

Serialized Fields

anchor

fields

global

id

model

state

target

type

url

Class com.amazonaws.services.amplifyuibuilder.model.AWSAmplifyUIBuilderException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.amplifyuibuilder.model.Component extends Object implements Serializable

Serialized Fields

appId

bindingProperties

children

collectionProperties

componentType

createdAt

environmentName

events

id

modifiedAt

name

overrides

properties

schemaVersion

sourceId

tags

variants

Class com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValue extends Object implements Serializable

Serialized Fields

bindingProperties

defaultValue

type

Class com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValueProperties extends Object implements Serializable

Serialized Fields

bucket

defaultValue

field

key

model

predicates

slotName

userAttribute

Class com.amazonaws.services.amplifyuibuilder.model.ComponentChild extends Object implements Serializable

Serialized Fields

children

componentType

events

name

properties

sourceId

Class com.amazonaws.services.amplifyuibuilder.model.ComponentConditionProperty extends Object implements Serializable

Serialized Fields

elseValue

field

operand

operandType

operator

property

then

Class com.amazonaws.services.amplifyuibuilder.model.ComponentDataConfiguration extends Object implements Serializable

Serialized Fields

identifiers

model

predicate

sort

Class com.amazonaws.services.amplifyuibuilder.model.ComponentEvent extends Object implements Serializable

Serialized Fields

action

bindingEvent

parameters

Class com.amazonaws.services.amplifyuibuilder.model.ComponentProperty extends Object implements Serializable

Serialized Fields

bindingProperties

bindings