| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AmplifyUiBuilder.Types
Contents
- Service Configuration
- Errors
- FixedPosition
- FormActionType
- FormButtonsPosition
- FormDataSourceType
- SortDirection
- TokenProviders
- ActionParameters
- Component
- ComponentBindingPropertiesValue
- ComponentBindingPropertiesValueProperties
- ComponentChild
- ComponentConditionProperty
- ComponentDataConfiguration
- ComponentEvent
- ComponentProperty
- ComponentPropertyBindingProperties
- ComponentSummary
- ComponentVariant
- CreateComponentData
- CreateFormData
- CreateThemeData
- ExchangeCodeForTokenRequestBody
- FieldConfig
- FieldInputConfig
- FieldPosition
- FieldValidationConfiguration
- Form
- FormBindingElement
- FormButton
- FormCTA
- FormDataTypeConfig
- FormInputValueProperty
- FormStyle
- FormStyleConfig
- FormSummary
- MutationActionSetStateParameter
- Predicate
- PutMetadataFlagBody
- RefreshTokenRequestBody
- SectionalElement
- SortProperty
- Theme
- ThemeSummary
- ThemeValue
- ThemeValues
- UpdateComponentData
- UpdateFormData
- UpdateThemeData
- ValueMapping
- ValueMappings
Description
Synopsis
- defaultService :: Service
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _ResourceConflictException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- newtype FixedPosition where
- FixedPosition' { }
- pattern FixedPosition_First :: FixedPosition
- newtype FormActionType where
- FormActionType' { }
- pattern FormActionType_Create :: FormActionType
- pattern FormActionType_Update :: FormActionType
- newtype FormButtonsPosition where
- newtype FormDataSourceType where
- newtype SortDirection where
- SortDirection' { }
- pattern SortDirection_ASC :: SortDirection
- pattern SortDirection_DESC :: SortDirection
- newtype TokenProviders where
- TokenProviders' { }
- pattern TokenProviders_Figma :: TokenProviders
- data ActionParameters = ActionParameters' {
- anchor :: Maybe ComponentProperty
- fields :: Maybe (HashMap Text ComponentProperty)
- global :: Maybe ComponentProperty
- id :: Maybe ComponentProperty
- model :: Maybe Text
- state :: Maybe MutationActionSetStateParameter
- target :: Maybe ComponentProperty
- type' :: Maybe ComponentProperty
- url :: Maybe ComponentProperty
- newActionParameters :: ActionParameters
- actionParameters_anchor :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_fields :: Lens' ActionParameters (Maybe (HashMap Text ComponentProperty))
- actionParameters_global :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_id :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_model :: Lens' ActionParameters (Maybe Text)
- actionParameters_state :: Lens' ActionParameters (Maybe MutationActionSetStateParameter)
- actionParameters_target :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_type :: Lens' ActionParameters (Maybe ComponentProperty)
- actionParameters_url :: Lens' ActionParameters (Maybe ComponentProperty)
- data Component = Component' {
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- events :: Maybe (HashMap Text ComponentEvent)
- modifiedAt :: Maybe ISO8601
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- appId :: Text
- bindingProperties :: HashMap Text ComponentBindingPropertiesValue
- componentType :: Text
- createdAt :: ISO8601
- environmentName :: Text
- id :: Text
- name :: Text
- overrides :: HashMap Text (HashMap Text Text)
- properties :: HashMap Text ComponentProperty
- variants :: [ComponentVariant]
- newComponent :: Text -> Text -> UTCTime -> Text -> Text -> Text -> Component
- component_children :: Lens' Component (Maybe [ComponentChild])
- component_collectionProperties :: Lens' Component (Maybe (HashMap Text ComponentDataConfiguration))
- component_events :: Lens' Component (Maybe (HashMap Text ComponentEvent))
- component_modifiedAt :: Lens' Component (Maybe UTCTime)
- component_schemaVersion :: Lens' Component (Maybe Text)
- component_sourceId :: Lens' Component (Maybe Text)
- component_tags :: Lens' Component (Maybe (HashMap Text Text))
- component_appId :: Lens' Component Text
- component_bindingProperties :: Lens' Component (HashMap Text ComponentBindingPropertiesValue)
- component_componentType :: Lens' Component Text
- component_createdAt :: Lens' Component UTCTime
- component_environmentName :: Lens' Component Text
- component_id :: Lens' Component Text
- component_name :: Lens' Component Text
- component_overrides :: Lens' Component (HashMap Text (HashMap Text Text))
- component_properties :: Lens' Component (HashMap Text ComponentProperty)
- component_variants :: Lens' Component [ComponentVariant]
- data ComponentBindingPropertiesValue = ComponentBindingPropertiesValue' {}
- newComponentBindingPropertiesValue :: ComponentBindingPropertiesValue
- componentBindingPropertiesValue_bindingProperties :: Lens' ComponentBindingPropertiesValue (Maybe ComponentBindingPropertiesValueProperties)
- componentBindingPropertiesValue_defaultValue :: Lens' ComponentBindingPropertiesValue (Maybe Text)
- componentBindingPropertiesValue_type :: Lens' ComponentBindingPropertiesValue (Maybe Text)
- data ComponentBindingPropertiesValueProperties = ComponentBindingPropertiesValueProperties' {}
- newComponentBindingPropertiesValueProperties :: ComponentBindingPropertiesValueProperties
- componentBindingPropertiesValueProperties_bucket :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- componentBindingPropertiesValueProperties_defaultValue :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- componentBindingPropertiesValueProperties_field :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- componentBindingPropertiesValueProperties_key :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- componentBindingPropertiesValueProperties_model :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- componentBindingPropertiesValueProperties_predicates :: Lens' ComponentBindingPropertiesValueProperties (Maybe [Predicate])
- componentBindingPropertiesValueProperties_slotName :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- componentBindingPropertiesValueProperties_userAttribute :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text)
- data ComponentChild = ComponentChild' {}
- newComponentChild :: Text -> Text -> ComponentChild
- componentChild_children :: Lens' ComponentChild (Maybe [ComponentChild])
- componentChild_events :: Lens' ComponentChild (Maybe (HashMap Text ComponentEvent))
- componentChild_sourceId :: Lens' ComponentChild (Maybe Text)
- componentChild_componentType :: Lens' ComponentChild Text
- componentChild_name :: Lens' ComponentChild Text
- componentChild_properties :: Lens' ComponentChild (HashMap Text ComponentProperty)
- data ComponentConditionProperty = ComponentConditionProperty' {}
- newComponentConditionProperty :: ComponentConditionProperty
- componentConditionProperty_else :: Lens' ComponentConditionProperty (Maybe ComponentProperty)
- componentConditionProperty_field :: Lens' ComponentConditionProperty (Maybe Text)
- componentConditionProperty_operand :: Lens' ComponentConditionProperty (Maybe Text)
- componentConditionProperty_operandType :: Lens' ComponentConditionProperty (Maybe Text)
- componentConditionProperty_operator :: Lens' ComponentConditionProperty (Maybe Text)
- componentConditionProperty_property :: Lens' ComponentConditionProperty (Maybe Text)
- componentConditionProperty_then :: Lens' ComponentConditionProperty (Maybe ComponentProperty)
- data ComponentDataConfiguration = ComponentDataConfiguration' {}
- newComponentDataConfiguration :: Text -> ComponentDataConfiguration
- componentDataConfiguration_identifiers :: Lens' ComponentDataConfiguration (Maybe [Text])
- componentDataConfiguration_predicate :: Lens' ComponentDataConfiguration (Maybe Predicate)
- componentDataConfiguration_sort :: Lens' ComponentDataConfiguration (Maybe [SortProperty])
- componentDataConfiguration_model :: Lens' ComponentDataConfiguration Text
- data ComponentEvent = ComponentEvent' {}
- newComponentEvent :: ComponentEvent
- componentEvent_action :: Lens' ComponentEvent (Maybe Text)
- componentEvent_bindingEvent :: Lens' ComponentEvent (Maybe Text)
- componentEvent_parameters :: Lens' ComponentEvent (Maybe ActionParameters)
- data ComponentProperty = ComponentProperty' {
- bindingProperties :: Maybe ComponentPropertyBindingProperties
- bindings :: Maybe (HashMap Text FormBindingElement)
- collectionBindingProperties :: Maybe ComponentPropertyBindingProperties
- componentName :: Maybe Text
- concat :: Maybe [ComponentProperty]
- condition :: Maybe ComponentConditionProperty
- configured :: Maybe Bool
- defaultValue :: Maybe Text
- event :: Maybe Text
- importedValue :: Maybe Text
- model :: Maybe Text
- property :: Maybe Text
- type' :: Maybe Text
- userAttribute :: Maybe Text
- value :: Maybe Text
- newComponentProperty :: ComponentProperty
- componentProperty_bindingProperties :: Lens' ComponentProperty (Maybe ComponentPropertyBindingProperties)
- componentProperty_bindings :: Lens' ComponentProperty (Maybe (HashMap Text FormBindingElement))
- componentProperty_collectionBindingProperties :: Lens' ComponentProperty (Maybe ComponentPropertyBindingProperties)
- componentProperty_componentName :: Lens' ComponentProperty (Maybe Text)
- componentProperty_concat :: Lens' ComponentProperty (Maybe [ComponentProperty])
- componentProperty_condition :: Lens' ComponentProperty (Maybe ComponentConditionProperty)
- componentProperty_configured :: Lens' ComponentProperty (Maybe Bool)
- componentProperty_defaultValue :: Lens' ComponentProperty (Maybe Text)
- componentProperty_event :: Lens' ComponentProperty (Maybe Text)
- componentProperty_importedValue :: Lens' ComponentProperty (Maybe Text)
- componentProperty_model :: Lens' ComponentProperty (Maybe Text)
- componentProperty_property :: Lens' ComponentProperty (Maybe Text)
- componentProperty_type :: Lens' ComponentProperty (Maybe Text)
- componentProperty_userAttribute :: Lens' ComponentProperty (Maybe Text)
- componentProperty_value :: Lens' ComponentProperty (Maybe Text)
- data ComponentPropertyBindingProperties = ComponentPropertyBindingProperties' {}
- newComponentPropertyBindingProperties :: Text -> ComponentPropertyBindingProperties
- componentPropertyBindingProperties_field :: Lens' ComponentPropertyBindingProperties (Maybe Text)
- componentPropertyBindingProperties_property :: Lens' ComponentPropertyBindingProperties Text
- data ComponentSummary = ComponentSummary' {
- appId :: Text
- componentType :: Text
- environmentName :: Text
- id :: Text
- name :: Text
- newComponentSummary :: Text -> Text -> Text -> Text -> Text -> ComponentSummary
- componentSummary_appId :: Lens' ComponentSummary Text
- componentSummary_componentType :: Lens' ComponentSummary Text
- componentSummary_environmentName :: Lens' ComponentSummary Text
- componentSummary_id :: Lens' ComponentSummary Text
- componentSummary_name :: Lens' ComponentSummary Text
- data ComponentVariant = ComponentVariant' {}
- newComponentVariant :: ComponentVariant
- componentVariant_overrides :: Lens' ComponentVariant (Maybe (HashMap Text (HashMap Text Text)))
- componentVariant_variantValues :: Lens' ComponentVariant (Maybe (HashMap Text Text))
- data CreateComponentData = CreateComponentData' {
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- events :: Maybe (HashMap Text ComponentEvent)
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- bindingProperties :: HashMap Text ComponentBindingPropertiesValue
- componentType :: Text
- name :: Text
- overrides :: HashMap Text (HashMap Text Text)
- properties :: HashMap Text ComponentProperty
- variants :: [ComponentVariant]
- newCreateComponentData :: Text -> Text -> CreateComponentData
- createComponentData_children :: Lens' CreateComponentData (Maybe [ComponentChild])
- createComponentData_collectionProperties :: Lens' CreateComponentData (Maybe (HashMap Text ComponentDataConfiguration))
- createComponentData_events :: Lens' CreateComponentData (Maybe (HashMap Text ComponentEvent))
- createComponentData_schemaVersion :: Lens' CreateComponentData (Maybe Text)
- createComponentData_sourceId :: Lens' CreateComponentData (Maybe Text)
- createComponentData_tags :: Lens' CreateComponentData (Maybe (HashMap Text Text))
- createComponentData_bindingProperties :: Lens' CreateComponentData (HashMap Text ComponentBindingPropertiesValue)
- createComponentData_componentType :: Lens' CreateComponentData Text
- createComponentData_name :: Lens' CreateComponentData Text
- createComponentData_overrides :: Lens' CreateComponentData (HashMap Text (HashMap Text Text))
- createComponentData_properties :: Lens' CreateComponentData (HashMap Text ComponentProperty)
- createComponentData_variants :: Lens' CreateComponentData [ComponentVariant]
- data CreateFormData = CreateFormData' {}
- newCreateFormData :: FormDataTypeConfig -> FormActionType -> Text -> Text -> FormStyle -> CreateFormData
- createFormData_cta :: Lens' CreateFormData (Maybe FormCTA)
- createFormData_tags :: Lens' CreateFormData (Maybe (HashMap Text Text))
- createFormData_dataType :: Lens' CreateFormData FormDataTypeConfig
- createFormData_fields :: Lens' CreateFormData (HashMap Text FieldConfig)
- createFormData_formActionType :: Lens' CreateFormData FormActionType
- createFormData_name :: Lens' CreateFormData Text
- createFormData_schemaVersion :: Lens' CreateFormData Text
- createFormData_sectionalElements :: Lens' CreateFormData (HashMap Text SectionalElement)
- createFormData_style :: Lens' CreateFormData FormStyle
- data CreateThemeData = CreateThemeData' {}
- newCreateThemeData :: Text -> CreateThemeData
- createThemeData_overrides :: Lens' CreateThemeData (Maybe [ThemeValues])
- createThemeData_tags :: Lens' CreateThemeData (Maybe (HashMap Text Text))
- createThemeData_name :: Lens' CreateThemeData Text
- createThemeData_values :: Lens' CreateThemeData [ThemeValues]
- data ExchangeCodeForTokenRequestBody = ExchangeCodeForTokenRequestBody' {
- code :: Sensitive Text
- redirectUri :: Text
- newExchangeCodeForTokenRequestBody :: Text -> Text -> ExchangeCodeForTokenRequestBody
- exchangeCodeForTokenRequestBody_code :: Lens' ExchangeCodeForTokenRequestBody Text
- exchangeCodeForTokenRequestBody_redirectUri :: Lens' ExchangeCodeForTokenRequestBody Text
- data FieldConfig = FieldConfig' {}
- newFieldConfig :: FieldConfig
- fieldConfig_excluded :: Lens' FieldConfig (Maybe Bool)
- fieldConfig_inputType :: Lens' FieldConfig (Maybe FieldInputConfig)
- fieldConfig_label :: Lens' FieldConfig (Maybe Text)
- fieldConfig_position :: Lens' FieldConfig (Maybe FieldPosition)
- fieldConfig_validations :: Lens' FieldConfig (Maybe [FieldValidationConfiguration])
- data FieldInputConfig = FieldInputConfig' {
- defaultChecked :: Maybe Bool
- defaultCountryCode :: Maybe Text
- defaultValue :: Maybe Text
- descriptiveText :: Maybe Text
- isArray :: Maybe Bool
- maxValue :: Maybe Double
- minValue :: Maybe Double
- name :: Maybe Text
- placeholder :: Maybe Text
- readOnly :: Maybe Bool
- required :: Maybe Bool
- step :: Maybe Double
- value :: Maybe Text
- valueMappings :: Maybe ValueMappings
- type' :: Text
- newFieldInputConfig :: Text -> FieldInputConfig
- fieldInputConfig_defaultChecked :: Lens' FieldInputConfig (Maybe Bool)
- fieldInputConfig_defaultCountryCode :: Lens' FieldInputConfig (Maybe Text)
- fieldInputConfig_defaultValue :: Lens' FieldInputConfig (Maybe Text)
- fieldInputConfig_descriptiveText :: Lens' FieldInputConfig (Maybe Text)
- fieldInputConfig_isArray :: Lens' FieldInputConfig (Maybe Bool)
- fieldInputConfig_maxValue :: Lens' FieldInputConfig (Maybe Double)
- fieldInputConfig_minValue :: Lens' FieldInputConfig (Maybe Double)
- fieldInputConfig_name :: Lens' FieldInputConfig (Maybe Text)
- fieldInputConfig_placeholder :: Lens' FieldInputConfig (Maybe Text)
- fieldInputConfig_readOnly :: Lens' FieldInputConfig (Maybe Bool)
- fieldInputConfig_required :: Lens' FieldInputConfig (Maybe Bool)
- fieldInputConfig_step :: Lens' FieldInputConfig (Maybe Double)
- fieldInputConfig_value :: Lens' FieldInputConfig (Maybe Text)
- fieldInputConfig_valueMappings :: Lens' FieldInputConfig (Maybe ValueMappings)
- fieldInputConfig_type :: Lens' FieldInputConfig Text
- data FieldPosition = FieldPosition' {}
- newFieldPosition :: FieldPosition
- fieldPosition_below :: Lens' FieldPosition (Maybe Text)
- fieldPosition_fixed :: Lens' FieldPosition (Maybe FixedPosition)
- fieldPosition_rightOf :: Lens' FieldPosition (Maybe Text)
- data FieldValidationConfiguration = FieldValidationConfiguration' {}
- newFieldValidationConfiguration :: Text -> FieldValidationConfiguration
- fieldValidationConfiguration_numValues :: Lens' FieldValidationConfiguration (Maybe [Int])
- fieldValidationConfiguration_strValues :: Lens' FieldValidationConfiguration (Maybe [Text])
- fieldValidationConfiguration_validationMessage :: Lens' FieldValidationConfiguration (Maybe Text)
- fieldValidationConfiguration_type :: Lens' FieldValidationConfiguration Text
- data Form = Form' {}
- newForm :: Text -> FormDataTypeConfig -> Text -> FormActionType -> Text -> Text -> Text -> FormStyle -> Form
- form_cta :: Lens' Form (Maybe FormCTA)
- form_tags :: Lens' Form (Maybe (HashMap Text Text))
- form_appId :: Lens' Form Text
- form_dataType :: Lens' Form FormDataTypeConfig
- form_environmentName :: Lens' Form Text
- form_fields :: Lens' Form (HashMap Text FieldConfig)
- form_formActionType :: Lens' Form FormActionType
- form_id :: Lens' Form Text
- form_name :: Lens' Form Text
- form_schemaVersion :: Lens' Form Text
- form_sectionalElements :: Lens' Form (HashMap Text SectionalElement)
- form_style :: Lens' Form FormStyle
- data FormBindingElement = FormBindingElement' {}
- newFormBindingElement :: Text -> Text -> FormBindingElement
- formBindingElement_element :: Lens' FormBindingElement Text
- formBindingElement_property :: Lens' FormBindingElement Text
- data FormButton = FormButton' {}
- newFormButton :: FormButton
- formButton_children :: Lens' FormButton (Maybe Text)
- formButton_excluded :: Lens' FormButton (Maybe Bool)
- formButton_position :: Lens' FormButton (Maybe FieldPosition)
- data FormCTA = FormCTA' {}
- newFormCTA :: FormCTA
- formCTA_cancel :: Lens' FormCTA (Maybe FormButton)
- formCTA_clear :: Lens' FormCTA (Maybe FormButton)
- formCTA_position :: Lens' FormCTA (Maybe FormButtonsPosition)
- formCTA_submit :: Lens' FormCTA (Maybe FormButton)
- data FormDataTypeConfig = FormDataTypeConfig' {}
- newFormDataTypeConfig :: FormDataSourceType -> Text -> FormDataTypeConfig
- formDataTypeConfig_dataSourceType :: Lens' FormDataTypeConfig FormDataSourceType
- formDataTypeConfig_dataTypeName :: Lens' FormDataTypeConfig Text
- data FormInputValueProperty = FormInputValueProperty' {}
- newFormInputValueProperty :: FormInputValueProperty
- formInputValueProperty_value :: Lens' FormInputValueProperty (Maybe Text)
- data FormStyle = FormStyle' {}
- newFormStyle :: FormStyle
- formStyle_horizontalGap :: Lens' FormStyle (Maybe FormStyleConfig)
- formStyle_outerPadding :: Lens' FormStyle (Maybe FormStyleConfig)
- formStyle_verticalGap :: Lens' FormStyle (Maybe FormStyleConfig)
- data FormStyleConfig = FormStyleConfig' {}
- newFormStyleConfig :: FormStyleConfig
- formStyleConfig_tokenReference :: Lens' FormStyleConfig (Maybe Text)
- formStyleConfig_value :: Lens' FormStyleConfig (Maybe Text)
- data FormSummary = FormSummary' {
- appId :: Text
- dataType :: FormDataTypeConfig
- environmentName :: Text
- formActionType :: FormActionType
- id :: Text
- name :: Text
- newFormSummary :: Text -> FormDataTypeConfig -> Text -> FormActionType -> Text -> Text -> FormSummary
- formSummary_appId :: Lens' FormSummary Text
- formSummary_dataType :: Lens' FormSummary FormDataTypeConfig
- formSummary_environmentName :: Lens' FormSummary Text
- formSummary_formActionType :: Lens' FormSummary FormActionType
- formSummary_id :: Lens' FormSummary Text
- formSummary_name :: Lens' FormSummary Text
- data MutationActionSetStateParameter = MutationActionSetStateParameter' {}
- newMutationActionSetStateParameter :: Text -> Text -> ComponentProperty -> MutationActionSetStateParameter
- mutationActionSetStateParameter_componentName :: Lens' MutationActionSetStateParameter Text
- mutationActionSetStateParameter_property :: Lens' MutationActionSetStateParameter Text
- mutationActionSetStateParameter_set :: Lens' MutationActionSetStateParameter ComponentProperty
- data Predicate = Predicate' {}
- newPredicate :: Predicate
- predicate_and :: Lens' Predicate (Maybe [Predicate])
- predicate_field :: Lens' Predicate (Maybe Text)
- predicate_operand :: Lens' Predicate (Maybe Text)
- predicate_operator :: Lens' Predicate (Maybe Text)
- predicate_or :: Lens' Predicate (Maybe [Predicate])
- data PutMetadataFlagBody = PutMetadataFlagBody' {}
- newPutMetadataFlagBody :: Text -> PutMetadataFlagBody
- putMetadataFlagBody_newValue :: Lens' PutMetadataFlagBody Text
- data RefreshTokenRequestBody = RefreshTokenRequestBody' {}
- newRefreshTokenRequestBody :: Text -> RefreshTokenRequestBody
- refreshTokenRequestBody_token :: Lens' RefreshTokenRequestBody Text
- data SectionalElement = SectionalElement' {}
- newSectionalElement :: Text -> SectionalElement
- sectionalElement_level :: Lens' SectionalElement (Maybe Int)
- sectionalElement_orientation :: Lens' SectionalElement (Maybe Text)
- sectionalElement_position :: Lens' SectionalElement (Maybe FieldPosition)
- sectionalElement_text :: Lens' SectionalElement (Maybe Text)
- sectionalElement_type :: Lens' SectionalElement Text
- data SortProperty = SortProperty' {
- direction :: SortDirection
- field :: Text
- newSortProperty :: SortDirection -> Text -> SortProperty
- sortProperty_direction :: Lens' SortProperty SortDirection
- sortProperty_field :: Lens' SortProperty Text
- data Theme = Theme' {}
- newTheme :: Text -> UTCTime -> Text -> Text -> Text -> Theme
- theme_modifiedAt :: Lens' Theme (Maybe UTCTime)
- theme_overrides :: Lens' Theme (Maybe [ThemeValues])
- theme_tags :: Lens' Theme (Maybe (HashMap Text Text))
- theme_appId :: Lens' Theme Text
- theme_createdAt :: Lens' Theme UTCTime
- theme_environmentName :: Lens' Theme Text
- theme_id :: Lens' Theme Text
- theme_name :: Lens' Theme Text
- theme_values :: Lens' Theme [ThemeValues]
- data ThemeSummary = ThemeSummary' {}
- newThemeSummary :: Text -> Text -> Text -> Text -> ThemeSummary
- themeSummary_appId :: Lens' ThemeSummary Text
- themeSummary_environmentName :: Lens' ThemeSummary Text
- themeSummary_id :: Lens' ThemeSummary Text
- themeSummary_name :: Lens' ThemeSummary Text
- data ThemeValue = ThemeValue' {}
- newThemeValue :: ThemeValue
- themeValue_children :: Lens' ThemeValue (Maybe [ThemeValues])
- themeValue_value :: Lens' ThemeValue (Maybe Text)
- data ThemeValues = ThemeValues' {}
- newThemeValues :: ThemeValues
- themeValues_key :: Lens' ThemeValues (Maybe Text)
- themeValues_value :: Lens' ThemeValues (Maybe ThemeValue)
- data UpdateComponentData = UpdateComponentData' {
- bindingProperties :: Maybe (HashMap Text ComponentBindingPropertiesValue)
- children :: Maybe [ComponentChild]
- collectionProperties :: Maybe (HashMap Text ComponentDataConfiguration)
- componentType :: Maybe Text
- events :: Maybe (HashMap Text ComponentEvent)
- id :: Maybe Text
- name :: Maybe Text
- overrides :: Maybe (HashMap Text (HashMap Text Text))
- properties :: Maybe (HashMap Text ComponentProperty)
- schemaVersion :: Maybe Text
- sourceId :: Maybe Text
- variants :: Maybe [ComponentVariant]
- newUpdateComponentData :: UpdateComponentData
- updateComponentData_bindingProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentBindingPropertiesValue))
- updateComponentData_children :: Lens' UpdateComponentData (Maybe [ComponentChild])
- updateComponentData_collectionProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentDataConfiguration))
- updateComponentData_componentType :: Lens' UpdateComponentData (Maybe Text)
- updateComponentData_events :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentEvent))
- updateComponentData_id :: Lens' UpdateComponentData (Maybe Text)
- updateComponentData_name :: Lens' UpdateComponentData (Maybe Text)
- updateComponentData_overrides :: Lens' UpdateComponentData (Maybe (HashMap Text (HashMap Text Text)))
- updateComponentData_properties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentProperty))
- updateComponentData_schemaVersion :: Lens' UpdateComponentData (Maybe Text)
- updateComponentData_sourceId :: Lens' UpdateComponentData (Maybe Text)
- updateComponentData_variants :: Lens' UpdateComponentData (Maybe [ComponentVariant])
- data UpdateFormData = UpdateFormData' {}
- newUpdateFormData :: UpdateFormData
- updateFormData_cta :: Lens' UpdateFormData (Maybe FormCTA)
- updateFormData_dataType :: Lens' UpdateFormData (Maybe FormDataTypeConfig)
- updateFormData_fields :: Lens' UpdateFormData (Maybe (HashMap Text FieldConfig))
- updateFormData_formActionType :: Lens' UpdateFormData (Maybe FormActionType)
- updateFormData_name :: Lens' UpdateFormData (Maybe Text)
- updateFormData_schemaVersion :: Lens' UpdateFormData (Maybe Text)
- updateFormData_sectionalElements :: Lens' UpdateFormData (Maybe (HashMap Text SectionalElement))
- updateFormData_style :: Lens' UpdateFormData (Maybe FormStyle)
- data UpdateThemeData = UpdateThemeData' {}
- newUpdateThemeData :: UpdateThemeData
- updateThemeData_id :: Lens' UpdateThemeData (Maybe Text)
- updateThemeData_name :: Lens' UpdateThemeData (Maybe Text)
- updateThemeData_overrides :: Lens' UpdateThemeData (Maybe [ThemeValues])
- updateThemeData_values :: Lens' UpdateThemeData [ThemeValues]
- data ValueMapping = ValueMapping' {}
- newValueMapping :: FormInputValueProperty -> ValueMapping
- valueMapping_displayValue :: Lens' ValueMapping (Maybe FormInputValueProperty)
- valueMapping_value :: Lens' ValueMapping FormInputValueProperty
- data ValueMappings = ValueMappings' {
- values :: [ValueMapping]
- newValueMappings :: ValueMappings
- valueMappings_values :: Lens' ValueMappings [ValueMapping]
Service Configuration
defaultService :: Service Source #
API version 2021-08-11 of the Amazon Amplify UI Builder SDK configuration.
Errors
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal error has occurred. Please retry your request.
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
An invalid or out-of-range value was supplied for the input parameter.
_ResourceConflictException :: AsError a => Fold a ServiceError Source #
The resource specified in the request conflicts with an existing resource.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource does not exist, or access was denied.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
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.
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
You don't have permission to perform this operation.
FixedPosition
newtype FixedPosition Source #
Constructors
| FixedPosition' | |
Fields | |
Bundled Patterns
| pattern FixedPosition_First :: FixedPosition |
Instances
FormActionType
newtype FormActionType Source #
Constructors
| FormActionType' | |
Fields | |
Bundled Patterns
| pattern FormActionType_Create :: FormActionType | |
| pattern FormActionType_Update :: FormActionType |
Instances
FormButtonsPosition
newtype FormButtonsPosition Source #
Constructors
| FormButtonsPosition' | |
Fields | |
Bundled Patterns
| pattern FormButtonsPosition_Bottom :: FormButtonsPosition | |
| pattern FormButtonsPosition_Top :: FormButtonsPosition | |
| pattern FormButtonsPosition_Top_and_bottom :: FormButtonsPosition |
Instances
FormDataSourceType
newtype FormDataSourceType Source #
Constructors
| FormDataSourceType' | |
Fields | |
Bundled Patterns
| pattern FormDataSourceType_Custom :: FormDataSourceType | |
| pattern FormDataSourceType_DataStore :: FormDataSourceType |
Instances
SortDirection
newtype SortDirection Source #
Constructors
| SortDirection' | |
Fields | |
Bundled Patterns
| pattern SortDirection_ASC :: SortDirection | |
| pattern SortDirection_DESC :: SortDirection |
Instances
TokenProviders
newtype TokenProviders Source #
Constructors
| TokenProviders' | |
Fields | |
Bundled Patterns
| pattern TokenProviders_Figma :: TokenProviders |
Instances
ActionParameters
data ActionParameters Source #
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.
See: newActionParameters smart constructor.
Constructors
| ActionParameters' | |
Fields
| |
Instances
newActionParameters :: ActionParameters Source #
Create a value of ActionParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:anchor:ActionParameters', actionParameters_anchor - The HTML anchor link to the location to open. Specify this value for a
navigation action.
$sel:fields:ActionParameters', actionParameters_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.
$sel:global:ActionParameters', actionParameters_global - Specifies whether the user should be signed out globally. Specify this
value for an auth sign out action.
$sel:id:ActionParameters', actionParameters_id - The unique ID of the component that the ActionParameters apply to.
ActionParameters, actionParameters_model - The name of the data model. Use when the action performs an operation on
an Amplify DataStore model.
$sel:state:ActionParameters', actionParameters_state - A key-value pair that specifies the state property name and its initial
value.
$sel:target:ActionParameters', actionParameters_target - The element within the same component to modify when the action occurs.
ActionParameters, actionParameters_type - The type of navigation action. Valid values are url and anchor. This
value is required for a navigation action.
$sel:url:ActionParameters', actionParameters_url - The URL to the location to open. Specify this value for a navigation
action.
actionParameters_anchor :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The HTML anchor link to the location to open. Specify this value for a navigation action.
actionParameters_fields :: Lens' ActionParameters (Maybe (HashMap Text ComponentProperty)) Source #
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.
actionParameters_global :: Lens' ActionParameters (Maybe ComponentProperty) Source #
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
actionParameters_id :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The unique ID of the component that the ActionParameters apply to.
actionParameters_model :: Lens' ActionParameters (Maybe Text) Source #
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
actionParameters_state :: Lens' ActionParameters (Maybe MutationActionSetStateParameter) Source #
A key-value pair that specifies the state property name and its initial value.
actionParameters_target :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The element within the same component to modify when the action occurs.
actionParameters_type :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The type of navigation action. Valid values are url and anchor. This
value is required for a navigation action.
actionParameters_url :: Lens' ActionParameters (Maybe ComponentProperty) Source #
The URL to the location to open. Specify this value for a navigation action.
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.
See: newComponent smart constructor.
Constructors
| Component' | |
Fields
| |
Instances
Create a value of Component with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Component, component_children - A list of the component's ComponentChild instances.
$sel:collectionProperties:Component', component_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.
Component, component_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.
$sel:modifiedAt:Component', component_modifiedAt - The time that the component was modified.
$sel:schemaVersion:Component', component_schemaVersion - The schema version of the component when it was imported.
Component, component_sourceId - The unique ID of the component in its original source system, such as
Figma.
$sel:tags:Component', component_tags - One or more key-value pairs to use when tagging the component.
$sel:appId:Component', component_appId - The unique ID of the Amplify app associated with the component.
Component, component_bindingProperties - The information to connect a component's properties to data at runtime.
You can't specify tags as a valid property for bindingProperties.
Component, component_componentType - The type of the component. This can be an Amplify custom UI component or
another custom component.
$sel:createdAt:Component', component_createdAt - The time that the component was created.
$sel:environmentName:Component', component_environmentName - The name of the backend environment that is a part of the Amplify app.
$sel:id:Component', component_id - The unique ID of the component.
Component, component_name - The name of the component.
Component, component_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.
Component, component_properties - Describes the component's properties. You can't specify tags as a
valid property for properties.
$sel:variants:Component', component_variants - A list of the component's variants. A variant is a unique style
configuration of a main component.
component_children :: Lens' Component (Maybe [ComponentChild]) Source #
A list of the component's ComponentChild instances.
component_collectionProperties :: Lens' Component (Maybe (HashMap Text ComponentDataConfiguration)) Source #
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.
component_events :: Lens' Component (Maybe (HashMap Text ComponentEvent)) Source #
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.
component_modifiedAt :: Lens' Component (Maybe UTCTime) Source #
The time that the component was modified.
component_schemaVersion :: Lens' Component (Maybe Text) Source #
The schema version of the component when it was imported.
component_sourceId :: Lens' Component (Maybe Text) Source #
The unique ID of the component in its original source system, such as Figma.
component_tags :: Lens' Component (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the component.
component_appId :: Lens' Component Text Source #
The unique ID of the Amplify app associated with the component.
component_bindingProperties :: Lens' Component (HashMap Text ComponentBindingPropertiesValue) Source #
The information to connect a component's properties to data at runtime.
You can't specify tags as a valid property for bindingProperties.
component_componentType :: Lens' Component Text Source #
The type of the component. This can be an Amplify custom UI component or another custom component.
component_environmentName :: Lens' Component Text Source #
The name of the backend environment that is a part of the Amplify app.
component_overrides :: Lens' Component (HashMap Text (HashMap Text Text)) Source #
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.
component_properties :: Lens' Component (HashMap Text ComponentProperty) Source #
Describes the component's properties. You can't specify tags as a
valid property for properties.
component_variants :: Lens' Component [ComponentVariant] Source #
A list of the component's variants. A variant is a unique style configuration of a main component.
ComponentBindingPropertiesValue
data ComponentBindingPropertiesValue Source #
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.
See: newComponentBindingPropertiesValue smart constructor.
Constructors
| ComponentBindingPropertiesValue' | |
Fields
| |
Instances
newComponentBindingPropertiesValue :: ComponentBindingPropertiesValue Source #
Create a value of ComponentBindingPropertiesValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bindingProperties:ComponentBindingPropertiesValue', componentBindingPropertiesValue_bindingProperties - Describes the properties to customize with data at runtime.
ComponentBindingPropertiesValue, componentBindingPropertiesValue_defaultValue - The default value of the property.
$sel:type':ComponentBindingPropertiesValue', componentBindingPropertiesValue_type - The property type.
componentBindingPropertiesValue_bindingProperties :: Lens' ComponentBindingPropertiesValue (Maybe ComponentBindingPropertiesValueProperties) Source #
Describes the properties to customize with data at runtime.
componentBindingPropertiesValue_defaultValue :: Lens' ComponentBindingPropertiesValue (Maybe Text) Source #
The default value of the property.
componentBindingPropertiesValue_type :: Lens' ComponentBindingPropertiesValue (Maybe Text) Source #
The property type.
ComponentBindingPropertiesValueProperties
data ComponentBindingPropertiesValueProperties Source #
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.
See: newComponentBindingPropertiesValueProperties smart constructor.
Constructors
| ComponentBindingPropertiesValueProperties' | |
Fields
| |
Instances
newComponentBindingPropertiesValueProperties :: ComponentBindingPropertiesValueProperties Source #
Create a value of ComponentBindingPropertiesValueProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_bucket - An Amazon S3 bucket.
$sel:defaultValue:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_defaultValue - The default value to assign to the property.
ComponentBindingPropertiesValueProperties, componentBindingPropertiesValueProperties_field - The field to bind the data to.
$sel:key:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_key - The storage key for an Amazon S3 bucket.
$sel:model:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_model - An Amplify DataStore model.
$sel:predicates:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_predicates - A list of predicates for binding a component's properties to data.
$sel:slotName:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_slotName - The name of a component slot.
$sel:userAttribute:ComponentBindingPropertiesValueProperties', componentBindingPropertiesValueProperties_userAttribute - An authenticated user attribute.
componentBindingPropertiesValueProperties_bucket :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
An Amazon S3 bucket.
componentBindingPropertiesValueProperties_defaultValue :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
The default value to assign to the property.
componentBindingPropertiesValueProperties_field :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
The field to bind the data to.
componentBindingPropertiesValueProperties_key :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
The storage key for an Amazon S3 bucket.
componentBindingPropertiesValueProperties_model :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
An Amplify DataStore model.
componentBindingPropertiesValueProperties_predicates :: Lens' ComponentBindingPropertiesValueProperties (Maybe [Predicate]) Source #
A list of predicates for binding a component's properties to data.
componentBindingPropertiesValueProperties_slotName :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
The name of a component slot.
componentBindingPropertiesValueProperties_userAttribute :: Lens' ComponentBindingPropertiesValueProperties (Maybe Text) Source #
An authenticated user attribute.
ComponentChild
data ComponentChild Source #
A nested UI configuration within a parent Component.
See: newComponentChild smart constructor.
Constructors
| ComponentChild' | |
Fields
| |
Instances
Create a value of ComponentChild with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:children:ComponentChild', componentChild_children - The list of ComponentChild instances for this component.
$sel:events:ComponentChild', componentChild_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.
$sel:sourceId:ComponentChild', componentChild_sourceId - The unique ID of the child component in its original source system, such
as Figma.
$sel:componentType:ComponentChild', componentChild_componentType - The type of the child component.
$sel:name:ComponentChild', componentChild_name - The name of the child component.
$sel:properties:ComponentChild', componentChild_properties - Describes the properties of the child component. You can't specify
tags as a valid property for properties.
componentChild_children :: Lens' ComponentChild (Maybe [ComponentChild]) Source #
The list of ComponentChild instances for this component.
componentChild_events :: Lens' ComponentChild (Maybe (HashMap Text ComponentEvent)) Source #
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.
componentChild_sourceId :: Lens' ComponentChild (Maybe Text) Source #
The unique ID of the child component in its original source system, such as Figma.
componentChild_componentType :: Lens' ComponentChild Text Source #
The type of the child component.
componentChild_name :: Lens' ComponentChild Text Source #
The name of the child component.
componentChild_properties :: Lens' ComponentChild (HashMap Text ComponentProperty) Source #
Describes the properties of the child component. You can't specify
tags as a valid property for properties.
ComponentConditionProperty
data ComponentConditionProperty Source #
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.
See: newComponentConditionProperty smart constructor.
Constructors
| ComponentConditionProperty' | |
Fields
| |
Instances
newComponentConditionProperty :: ComponentConditionProperty Source #
Create a value of ComponentConditionProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:else':ComponentConditionProperty', componentConditionProperty_else - The value to assign to the property if the condition is not met.
$sel:field:ComponentConditionProperty', componentConditionProperty_field - The name of a field. Specify this when the property is a data model.
$sel:operand:ComponentConditionProperty', componentConditionProperty_operand - The value of the property to evaluate.
$sel:operandType:ComponentConditionProperty', componentConditionProperty_operandType - The type of the property to evaluate.
$sel:operator:ComponentConditionProperty', componentConditionProperty_operator - The operator to use to perform the evaluation, such as eq to represent
equals.
$sel:property:ComponentConditionProperty', componentConditionProperty_property - The name of the conditional property.
$sel:then':ComponentConditionProperty', componentConditionProperty_then - The value to assign to the property if the condition is met.
componentConditionProperty_else :: Lens' ComponentConditionProperty (Maybe ComponentProperty) Source #
The value to assign to the property if the condition is not met.
componentConditionProperty_field :: Lens' ComponentConditionProperty (Maybe Text) Source #
The name of a field. Specify this when the property is a data model.
componentConditionProperty_operand :: Lens' ComponentConditionProperty (Maybe Text) Source #
The value of the property to evaluate.
componentConditionProperty_operandType :: Lens' ComponentConditionProperty (Maybe Text) Source #
The type of the property to evaluate.
componentConditionProperty_operator :: Lens' ComponentConditionProperty (Maybe Text) Source #
The operator to use to perform the evaluation, such as eq to represent
equals.
componentConditionProperty_property :: Lens' ComponentConditionProperty (Maybe Text) Source #
The name of the conditional property.
componentConditionProperty_then :: Lens' ComponentConditionProperty (Maybe ComponentProperty) Source #
The value to assign to the property if the condition is met.
ComponentDataConfiguration
data ComponentDataConfiguration Source #
Describes the configuration for binding a component's properties to data.
See: newComponentDataConfiguration smart constructor.
Constructors
| ComponentDataConfiguration' | |
Fields
| |
Instances
newComponentDataConfiguration Source #
Create a value of ComponentDataConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identifiers:ComponentDataConfiguration', componentDataConfiguration_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.
$sel:predicate:ComponentDataConfiguration', componentDataConfiguration_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.
$sel:sort:ComponentDataConfiguration', componentDataConfiguration_sort - Describes how to sort the component's properties.
$sel:model:ComponentDataConfiguration', componentDataConfiguration_model - The name of the data model to use to bind data to a component.
componentDataConfiguration_identifiers :: Lens' ComponentDataConfiguration (Maybe [Text]) Source #
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.
componentDataConfiguration_predicate :: Lens' ComponentDataConfiguration (Maybe Predicate) Source #
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.
componentDataConfiguration_sort :: Lens' ComponentDataConfiguration (Maybe [SortProperty]) Source #
Describes how to sort the component's properties.
componentDataConfiguration_model :: Lens' ComponentDataConfiguration Text Source #
The name of the data model to use to bind data to a component.
ComponentEvent
data ComponentEvent Source #
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.
See: newComponentEvent smart constructor.
Constructors
| ComponentEvent' | |
Fields
| |
Instances
newComponentEvent :: ComponentEvent Source #
Create a value of ComponentEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:ComponentEvent', componentEvent_action - The action to perform when a specific event is raised.
$sel:bindingEvent:ComponentEvent', componentEvent_bindingEvent - Binds an event to an action on a component. When you specify a
bindingEvent, the event is called when the action is performed.
$sel:parameters:ComponentEvent', componentEvent_parameters - Describes information about the action.
componentEvent_action :: Lens' ComponentEvent (Maybe Text) Source #
The action to perform when a specific event is raised.
componentEvent_bindingEvent :: Lens' ComponentEvent (Maybe Text) Source #
Binds an event to an action on a component. When you specify a
bindingEvent, the event is called when the action is performed.
componentEvent_parameters :: Lens' ComponentEvent (Maybe ActionParameters) Source #
Describes information about the action.
ComponentProperty
data ComponentProperty Source #
Describes the configuration for all of a component's properties. Use
ComponentProperty to specify the values to render or bind by default.
See: newComponentProperty smart constructor.
Constructors
| ComponentProperty' | |
Fields
| |
Instances
newComponentProperty :: ComponentProperty Source #
Create a value of ComponentProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bindingProperties:ComponentProperty', componentProperty_bindingProperties - The information to bind the component property to data at runtime.
$sel:bindings:ComponentProperty', componentProperty_bindings - The information to bind the component property to form data.
$sel:collectionBindingProperties:ComponentProperty', componentProperty_collectionBindingProperties - The information to bind the component property to data at runtime. Use
this for collection components.
$sel:componentName:ComponentProperty', componentProperty_componentName - The name of the component that is affected by an event.
$sel:concat:ComponentProperty', componentProperty_concat - A list of component properties to concatenate to create the value to
assign to this component property.
$sel:condition:ComponentProperty', componentProperty_condition - The conditional expression to use to assign a value to the component
property.
$sel:configured:ComponentProperty', componentProperty_configured - Specifies whether the user configured the property in Amplify Studio
after importing it.
$sel:defaultValue:ComponentProperty', componentProperty_defaultValue - The default value to assign to the component property.
$sel:event:ComponentProperty', componentProperty_event - An event that occurs in your app. Use this for workflow data binding.
$sel:importedValue:ComponentProperty', componentProperty_importedValue - The default value assigned to the property when the component is
imported into an app.
$sel:model:ComponentProperty', componentProperty_model - The data model to use to assign a value to the component property.
FormBindingElement, componentProperty_property - The name of the component's property that is affected by an event.
$sel:type':ComponentProperty', componentProperty_type - The component type.
$sel:userAttribute:ComponentProperty', componentProperty_userAttribute - An authenticated user attribute to use to assign a value to the
component property.
$sel:value:ComponentProperty', componentProperty_value - The value to assign to the component property.
componentProperty_bindingProperties :: Lens' ComponentProperty (Maybe ComponentPropertyBindingProperties) Source #
The information to bind the component property to data at runtime.
componentProperty_bindings :: Lens' ComponentProperty (Maybe (HashMap Text FormBindingElement)) Source #
The information to bind the component property to form data.
componentProperty_collectionBindingProperties :: Lens' ComponentProperty (Maybe ComponentPropertyBindingProperties) Source #
The information to bind the component property to data at runtime. Use this for collection components.
componentProperty_componentName :: Lens' ComponentProperty (Maybe Text) Source #
The name of the component that is affected by an event.
componentProperty_concat :: Lens' ComponentProperty (Maybe [ComponentProperty]) Source #
A list of component properties to concatenate to create the value to assign to this component property.
componentProperty_condition :: Lens' ComponentProperty (Maybe ComponentConditionProperty) Source #
The conditional expression to use to assign a value to the component property.
componentProperty_configured :: Lens' ComponentProperty (Maybe Bool) Source #
Specifies whether the user configured the property in Amplify Studio after importing it.
componentProperty_defaultValue :: Lens' ComponentProperty (Maybe Text) Source #
The default value to assign to the component property.
componentProperty_event :: Lens' ComponentProperty (Maybe Text) Source #
An event that occurs in your app. Use this for workflow data binding.
componentProperty_importedValue :: Lens' ComponentProperty (Maybe Text) Source #
The default value assigned to the property when the component is imported into an app.
componentProperty_model :: Lens' ComponentProperty (Maybe Text) Source #
The data model to use to assign a value to the component property.
componentProperty_property :: Lens' ComponentProperty (Maybe Text) Source #
The name of the component's property that is affected by an event.
componentProperty_type :: Lens' ComponentProperty (Maybe Text) Source #
The component type.
componentProperty_userAttribute :: Lens' ComponentProperty (Maybe Text) Source #
An authenticated user attribute to use to assign a value to the component property.
componentProperty_value :: Lens' ComponentProperty (Maybe Text) Source #
The value to assign to the component property.
ComponentPropertyBindingProperties
data ComponentPropertyBindingProperties Source #
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.
See: newComponentPropertyBindingProperties smart constructor.
Constructors
| ComponentPropertyBindingProperties' | |
Instances
newComponentPropertyBindingProperties Source #
Arguments
| :: Text | |
| -> ComponentPropertyBindingProperties |
Create a value of ComponentPropertyBindingProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:field:ComponentPropertyBindingProperties', componentPropertyBindingProperties_field - The data field to bind the property to.
$sel:property:ComponentPropertyBindingProperties', componentPropertyBindingProperties_property - The component property to bind to the data field.
componentPropertyBindingProperties_field :: Lens' ComponentPropertyBindingProperties (Maybe Text) Source #
The data field to bind the property to.
componentPropertyBindingProperties_property :: Lens' ComponentPropertyBindingProperties Text Source #
The component property to bind to the data field.
ComponentSummary
data ComponentSummary Source #
Contains a summary of a component. This is a read-only data type that is
returned by ListComponents.
See: newComponentSummary smart constructor.
Constructors
| ComponentSummary' | |
Fields
| |
Instances
Create a value of ComponentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appId:ComponentSummary', componentSummary_appId - The unique ID of the Amplify app associated with the component.
$sel:componentType:ComponentSummary', componentSummary_componentType - The component type.
$sel:environmentName:ComponentSummary', componentSummary_environmentName - The name of the backend environment that is a part of the Amplify app.
$sel:id:ComponentSummary', componentSummary_id - The unique ID of the component.
$sel:name:ComponentSummary', componentSummary_name - The name of the component.
componentSummary_appId :: Lens' ComponentSummary Text Source #
The unique ID of the Amplify app associated with the component.
componentSummary_componentType :: Lens' ComponentSummary Text Source #
The component type.
componentSummary_environmentName :: Lens' ComponentSummary Text Source #
The name of the backend environment that is a part of the Amplify app.
componentSummary_id :: Lens' ComponentSummary Text Source #
The unique ID of the component.
componentSummary_name :: Lens' ComponentSummary Text Source #
The name of the component.
ComponentVariant
data ComponentVariant Source #
Describes the style configuration of a unique variation of a main component.
See: newComponentVariant smart constructor.
Constructors
| ComponentVariant' | |
Fields
| |
Instances
newComponentVariant :: ComponentVariant Source #
Create a value of ComponentVariant with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:overrides:ComponentVariant', componentVariant_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.
$sel:variantValues:ComponentVariant', componentVariant_variantValues - The combination of variants that comprise this variant. You can't
specify tags as a valid property for variantValues.
componentVariant_overrides :: Lens' ComponentVariant (Maybe (HashMap Text (HashMap Text Text))) Source #
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.
componentVariant_variantValues :: Lens' ComponentVariant (Maybe (HashMap Text Text)) Source #
The combination of variants that comprise this variant. You can't
specify tags as a valid property for variantValues.
CreateComponentData
data CreateComponentData Source #
Represents all of the information that is required to create a component.
See: newCreateComponentData smart constructor.
Constructors
| CreateComponentData' | |
Fields
| |
Instances
newCreateComponentData Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateComponentData |
Create a value of CreateComponentData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateComponentData, createComponentData_children - A list of child components that are instances of the main component.
$sel:collectionProperties:CreateComponentData', createComponentData_collectionProperties - The data binding configuration for customizing a component's
properties. Use this for a collection component.
CreateComponentData, createComponentData_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.
$sel:schemaVersion:CreateComponentData', createComponentData_schemaVersion - The schema version of the component when it was imported.
CreateComponentData, createComponentData_sourceId - The unique ID of the component in its original source system, such as
Figma.
$sel:tags:CreateComponentData', createComponentData_tags - One or more key-value pairs to use when tagging the component data.
CreateComponentData, createComponentData_bindingProperties - The data binding information for the component's properties.
CreateComponentData, createComponentData_componentType - The component type. This can be an Amplify custom UI component or
another custom component.
CreateComponentData, createComponentData_name - The name of the component
CreateComponentData, createComponentData_overrides - Describes the component properties that can be overriden to customize an
instance of the component.
CreateComponentData, createComponentData_properties - Describes the component's properties.
$sel:variants:CreateComponentData', createComponentData_variants - A list of the unique variants of this component.
createComponentData_children :: Lens' CreateComponentData (Maybe [ComponentChild]) Source #
A list of child components that are instances of the main component.
createComponentData_collectionProperties :: Lens' CreateComponentData (Maybe (HashMap Text ComponentDataConfiguration)) Source #
The data binding configuration for customizing a component's properties. Use this for a collection component.
createComponentData_events :: Lens' CreateComponentData (Maybe (HashMap Text ComponentEvent)) Source #
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
createComponentData_schemaVersion :: Lens' CreateComponentData (Maybe Text) Source #
The schema version of the component when it was imported.
createComponentData_sourceId :: Lens' CreateComponentData (Maybe Text) Source #
The unique ID of the component in its original source system, such as Figma.
createComponentData_tags :: Lens' CreateComponentData (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the component data.
createComponentData_bindingProperties :: Lens' CreateComponentData (HashMap Text ComponentBindingPropertiesValue) Source #
The data binding information for the component's properties.
createComponentData_componentType :: Lens' CreateComponentData Text Source #
The component type. This can be an Amplify custom UI component or another custom component.
createComponentData_name :: Lens' CreateComponentData Text Source #
The name of the component
createComponentData_overrides :: Lens' CreateComponentData (HashMap Text (HashMap Text Text)) Source #
Describes the component properties that can be overriden to customize an instance of the component.
createComponentData_properties :: Lens' CreateComponentData (HashMap Text ComponentProperty) Source #
Describes the component's properties.
createComponentData_variants :: Lens' CreateComponentData [ComponentVariant] Source #
A list of the unique variants of this component.
CreateFormData
data CreateFormData Source #
Represents all of the information that is required to create a form.
See: newCreateFormData smart constructor.
Constructors
| CreateFormData' | |
Fields
| |
Instances
Arguments
| :: FormDataTypeConfig | |
| -> FormActionType | |
| -> Text | |
| -> Text | |
| -> FormStyle | |
| -> CreateFormData |
Create a value of CreateFormData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cta:CreateFormData', createFormData_cta - The FormCTA object that stores the call to action configuration for
the form.
$sel:tags:CreateFormData', createFormData_tags - One or more key-value pairs to use when tagging the form data.
$sel:dataType:CreateFormData', createFormData_dataType - The type of data source to use to create the form.
$sel:fields:CreateFormData', createFormData_fields - The configuration information for the form's fields.
$sel:formActionType:CreateFormData', createFormData_formActionType - Specifies whether to perform a create or update action on the form.
$sel:name:CreateFormData', createFormData_name - The name of the form.
$sel:schemaVersion:CreateFormData', createFormData_schemaVersion - The schema version of the form.
$sel:sectionalElements:CreateFormData', createFormData_sectionalElements - The configuration information for the visual helper elements for the
form. These elements are not associated with any data.
$sel:style:CreateFormData', createFormData_style - The configuration for the form's style.
createFormData_cta :: Lens' CreateFormData (Maybe FormCTA) Source #
The FormCTA object that stores the call to action configuration for
the form.
createFormData_tags :: Lens' CreateFormData (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the form data.
createFormData_dataType :: Lens' CreateFormData FormDataTypeConfig Source #
The type of data source to use to create the form.
createFormData_fields :: Lens' CreateFormData (HashMap Text FieldConfig) Source #
The configuration information for the form's fields.
createFormData_formActionType :: Lens' CreateFormData FormActionType Source #
Specifies whether to perform a create or update action on the form.
createFormData_name :: Lens' CreateFormData Text Source #
The name of the form.
createFormData_schemaVersion :: Lens' CreateFormData Text Source #
The schema version of the form.
createFormData_sectionalElements :: Lens' CreateFormData (HashMap Text SectionalElement) Source #
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
createFormData_style :: Lens' CreateFormData FormStyle Source #
The configuration for the form's style.
CreateThemeData
data CreateThemeData Source #
Represents all of the information that is required to create a theme.
See: newCreateThemeData smart constructor.
Constructors
| CreateThemeData' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateThemeData |
Create a value of CreateThemeData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:overrides:CreateThemeData', createThemeData_overrides - Describes the properties that can be overriden to customize an instance
of the theme.
$sel:tags:CreateThemeData', createThemeData_tags - One or more key-value pairs to use when tagging the theme data.
$sel:name:CreateThemeData', createThemeData_name - The name of the theme.
$sel:values:CreateThemeData', createThemeData_values - A list of key-value pairs that defines the properties of the theme.
createThemeData_overrides :: Lens' CreateThemeData (Maybe [ThemeValues]) Source #
Describes the properties that can be overriden to customize an instance of the theme.
createThemeData_tags :: Lens' CreateThemeData (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the theme data.
createThemeData_name :: Lens' CreateThemeData Text Source #
The name of the theme.
createThemeData_values :: Lens' CreateThemeData [ThemeValues] Source #
A list of key-value pairs that defines the properties of the theme.
ExchangeCodeForTokenRequestBody
data ExchangeCodeForTokenRequestBody Source #
Describes the configuration of a request to exchange an access code for a token.
See: newExchangeCodeForTokenRequestBody smart constructor.
Constructors
| ExchangeCodeForTokenRequestBody' | |
Fields
| |
Instances
newExchangeCodeForTokenRequestBody Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExchangeCodeForTokenRequestBody |
Create a value of ExchangeCodeForTokenRequestBody with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:ExchangeCodeForTokenRequestBody', exchangeCodeForTokenRequestBody_code - The access code to send in the request.
$sel:redirectUri:ExchangeCodeForTokenRequestBody', exchangeCodeForTokenRequestBody_redirectUri - The location of the application that will receive the access code.
exchangeCodeForTokenRequestBody_code :: Lens' ExchangeCodeForTokenRequestBody Text Source #
The access code to send in the request.
exchangeCodeForTokenRequestBody_redirectUri :: Lens' ExchangeCodeForTokenRequestBody Text Source #
The location of the application that will receive the access code.
FieldConfig
data FieldConfig Source #
Describes the configuration information for a field in a table.
See: newFieldConfig smart constructor.
Constructors
| FieldConfig' | |
Fields
| |
Instances
newFieldConfig :: FieldConfig Source #
Create a value of FieldConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excluded:FieldConfig', fieldConfig_excluded - Specifies whether to hide a field.
$sel:inputType:FieldConfig', fieldConfig_inputType - Describes the configuration for the default input value to display for a
field.
$sel:label:FieldConfig', fieldConfig_label - The label for the field.
$sel:position:FieldConfig', fieldConfig_position - Specifies the field position.
$sel:validations:FieldConfig', fieldConfig_validations - The validations to perform on the value in the field.
fieldConfig_excluded :: Lens' FieldConfig (Maybe Bool) Source #
Specifies whether to hide a field.
fieldConfig_inputType :: Lens' FieldConfig (Maybe FieldInputConfig) Source #
Describes the configuration for the default input value to display for a field.
fieldConfig_label :: Lens' FieldConfig (Maybe Text) Source #
The label for the field.
fieldConfig_position :: Lens' FieldConfig (Maybe FieldPosition) Source #
Specifies the field position.
fieldConfig_validations :: Lens' FieldConfig (Maybe [FieldValidationConfiguration]) Source #
The validations to perform on the value in the field.
FieldInputConfig
data FieldInputConfig Source #
Describes the configuration for the default input values to display for a field.
See: newFieldInputConfig smart constructor.
Constructors
| FieldInputConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> FieldInputConfig |
Create a value of FieldInputConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultChecked:FieldInputConfig', fieldInputConfig_defaultChecked - Specifies whether a field has a default value.
$sel:defaultCountryCode:FieldInputConfig', fieldInputConfig_defaultCountryCode - The default country code for a phone number.
$sel:defaultValue:FieldInputConfig', fieldInputConfig_defaultValue - The default value for the field.
$sel:descriptiveText:FieldInputConfig', fieldInputConfig_descriptiveText - The text to display to describe the field.
$sel:isArray:FieldInputConfig', fieldInputConfig_isArray - Specifies whether to render the field as an array. This property is
ignored if the dataSourceType for the form is a Data Store.
$sel:maxValue:FieldInputConfig', fieldInputConfig_maxValue - The maximum value to display for the field.
$sel:minValue:FieldInputConfig', fieldInputConfig_minValue - The minimum value to display for the field.
$sel:name:FieldInputConfig', fieldInputConfig_name - The name of the field.
$sel:placeholder:FieldInputConfig', fieldInputConfig_placeholder - The text to display as a placeholder for the field.
$sel:readOnly:FieldInputConfig', fieldInputConfig_readOnly - Specifies a read only field.
$sel:required:FieldInputConfig', fieldInputConfig_required - Specifies a field that requires input.
$sel:step:FieldInputConfig', fieldInputConfig_step - The stepping increment for a numeric value in a field.
$sel:value:FieldInputConfig', fieldInputConfig_value - The value for the field.
$sel:valueMappings:FieldInputConfig', fieldInputConfig_valueMappings - The information to use to customize the input fields with data at
runtime.
$sel:type':FieldInputConfig', fieldInputConfig_type - The input type for the field.
fieldInputConfig_defaultChecked :: Lens' FieldInputConfig (Maybe Bool) Source #
Specifies whether a field has a default value.
fieldInputConfig_defaultCountryCode :: Lens' FieldInputConfig (Maybe Text) Source #
The default country code for a phone number.
fieldInputConfig_defaultValue :: Lens' FieldInputConfig (Maybe Text) Source #
The default value for the field.
fieldInputConfig_descriptiveText :: Lens' FieldInputConfig (Maybe Text) Source #
The text to display to describe the field.
fieldInputConfig_isArray :: Lens' FieldInputConfig (Maybe Bool) Source #
Specifies whether to render the field as an array. This property is
ignored if the dataSourceType for the form is a Data Store.
fieldInputConfig_maxValue :: Lens' FieldInputConfig (Maybe Double) Source #
The maximum value to display for the field.
fieldInputConfig_minValue :: Lens' FieldInputConfig (Maybe Double) Source #
The minimum value to display for the field.
fieldInputConfig_name :: Lens' FieldInputConfig (Maybe Text) Source #
The name of the field.
fieldInputConfig_placeholder :: Lens' FieldInputConfig (Maybe Text) Source #
The text to display as a placeholder for the field.
fieldInputConfig_readOnly :: Lens' FieldInputConfig (Maybe Bool) Source #
Specifies a read only field.
fieldInputConfig_required :: Lens' FieldInputConfig (Maybe Bool) Source #
Specifies a field that requires input.
fieldInputConfig_step :: Lens' FieldInputConfig (Maybe Double) Source #
The stepping increment for a numeric value in a field.
fieldInputConfig_value :: Lens' FieldInputConfig (Maybe Text) Source #
The value for the field.
fieldInputConfig_valueMappings :: Lens' FieldInputConfig (Maybe ValueMappings) Source #
The information to use to customize the input fields with data at runtime.
fieldInputConfig_type :: Lens' FieldInputConfig Text Source #
The input type for the field.
FieldPosition
data FieldPosition Source #
Describes the field position.
See: newFieldPosition smart constructor.
Constructors
| FieldPosition' | |
Instances
newFieldPosition :: FieldPosition Source #
Create a value of FieldPosition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:below:FieldPosition', fieldPosition_below - The field position is below the field specified by the string.
$sel:fixed:FieldPosition', fieldPosition_fixed - The field position is fixed and doesn't change in relation to other
fields.
$sel:rightOf:FieldPosition', fieldPosition_rightOf - The field position is to the right of the field specified by the string.
fieldPosition_below :: Lens' FieldPosition (Maybe Text) Source #
The field position is below the field specified by the string.
fieldPosition_fixed :: Lens' FieldPosition (Maybe FixedPosition) Source #
The field position is fixed and doesn't change in relation to other fields.
fieldPosition_rightOf :: Lens' FieldPosition (Maybe Text) Source #
The field position is to the right of the field specified by the string.
FieldValidationConfiguration
data FieldValidationConfiguration Source #
Describes the validation configuration for a field.
See: newFieldValidationConfiguration smart constructor.
Constructors
| FieldValidationConfiguration' | |
Instances
newFieldValidationConfiguration Source #
Create a value of FieldValidationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numValues:FieldValidationConfiguration', fieldValidationConfiguration_numValues - The validation to perform on a number value.
$sel:strValues:FieldValidationConfiguration', fieldValidationConfiguration_strValues - The validation to perform on a string value.
$sel:validationMessage:FieldValidationConfiguration', fieldValidationConfiguration_validationMessage - The validation message to display.
$sel:type':FieldValidationConfiguration', fieldValidationConfiguration_type - The validation to perform on an object type.
fieldValidationConfiguration_numValues :: Lens' FieldValidationConfiguration (Maybe [Int]) Source #
The validation to perform on a number value.
fieldValidationConfiguration_strValues :: Lens' FieldValidationConfiguration (Maybe [Text]) Source #
The validation to perform on a string value.
fieldValidationConfiguration_validationMessage :: Lens' FieldValidationConfiguration (Maybe Text) Source #
The validation message to display.
fieldValidationConfiguration_type :: Lens' FieldValidationConfiguration Text Source #
The validation to perform on an object type.
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.
See: newForm smart constructor.
Constructors
| Form' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> FormDataTypeConfig | |
| -> Text | |
| -> FormActionType | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> FormStyle | |
| -> Form |
Create a value of Form with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cta:Form', form_cta - Stores the call to action configuration for the form.
$sel:tags:Form', form_tags - One or more key-value pairs to use when tagging the form.
$sel:appId:Form', form_appId - The unique ID of the Amplify app associated with the form.
$sel:dataType:Form', form_dataType - The type of data source to use to create the form.
$sel:environmentName:Form', form_environmentName - The name of the backend environment that is a part of the Amplify app.
$sel:fields:Form', form_fields - Stores the information about the form's fields.
$sel:formActionType:Form', form_formActionType - The operation to perform on the specified form.
$sel:id:Form', form_id - The unique ID of the form.
$sel:name:Form', form_name - The name of the form.
$sel:schemaVersion:Form', form_schemaVersion - The schema version of the form when it was imported.
$sel:sectionalElements:Form', form_sectionalElements - Stores the visual helper elements for the form that are not associated
with any data.
$sel:style:Form', form_style - Stores the configuration for the form's style.
form_cta :: Lens' Form (Maybe FormCTA) Source #
Stores the call to action configuration for the form.
form_tags :: Lens' Form (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the form.
form_dataType :: Lens' Form FormDataTypeConfig Source #
The type of data source to use to create the form.
form_environmentName :: Lens' Form Text Source #
The name of the backend environment that is a part of the Amplify app.
form_fields :: Lens' Form (HashMap Text FieldConfig) Source #
Stores the information about the form's fields.
form_formActionType :: Lens' Form FormActionType Source #
The operation to perform on the specified form.
form_sectionalElements :: Lens' Form (HashMap Text SectionalElement) Source #
Stores the visual helper elements for the form that are not associated with any data.
FormBindingElement
data FormBindingElement Source #
Describes how to bind a component property to form data.
See: newFormBindingElement smart constructor.
Constructors
| FormBindingElement' | |
Instances
newFormBindingElement Source #
Arguments
| :: Text | |
| -> Text | |
| -> FormBindingElement |
Create a value of FormBindingElement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:element:FormBindingElement', formBindingElement_element - The name of the component to retrieve a value from.
$sel:property:FormBindingElement', formBindingElement_property - The property to retrieve a value from.
formBindingElement_element :: Lens' FormBindingElement Text Source #
The name of the component to retrieve a value from.
formBindingElement_property :: Lens' FormBindingElement Text Source #
The property to retrieve a value from.
FormButton
data FormButton Source #
Describes the configuration for a button UI element that is a part of a form.
See: newFormButton smart constructor.
Constructors
| FormButton' | |
Instances
newFormButton :: FormButton Source #
Create a value of FormButton with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:children:FormButton', formButton_children - Describes the button's properties.
$sel:excluded:FormButton', formButton_excluded - Specifies whether the button is visible on the form.
$sel:position:FormButton', formButton_position - The position of the button.
formButton_children :: Lens' FormButton (Maybe Text) Source #
Describes the button's properties.
formButton_excluded :: Lens' FormButton (Maybe Bool) Source #
Specifies whether the button is visible on the form.
formButton_position :: Lens' FormButton (Maybe FieldPosition) Source #
The position of the button.
FormCTA
Describes the call to action button configuration for the form.
See: newFormCTA smart constructor.
Constructors
| FormCTA' | |
Fields
| |
Instances
newFormCTA :: FormCTA Source #
Create a value of FormCTA with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cancel:FormCTA', formCTA_cancel - Displays a cancel button.
$sel:clear:FormCTA', formCTA_clear - Displays a clear button.
FormCTA, formCTA_position - The position of the button.
$sel:submit:FormCTA', formCTA_submit - Displays a submit button.
formCTA_cancel :: Lens' FormCTA (Maybe FormButton) Source #
Displays a cancel button.
formCTA_clear :: Lens' FormCTA (Maybe FormButton) Source #
Displays a clear button.
formCTA_position :: Lens' FormCTA (Maybe FormButtonsPosition) Source #
The position of the button.
formCTA_submit :: Lens' FormCTA (Maybe FormButton) Source #
Displays a submit button.
FormDataTypeConfig
data FormDataTypeConfig Source #
Describes the data type configuration for the data source associated with a form.
See: newFormDataTypeConfig smart constructor.
Constructors
| FormDataTypeConfig' | |
Fields
| |
Instances
newFormDataTypeConfig Source #
Arguments
| :: FormDataSourceType | |
| -> Text | |
| -> FormDataTypeConfig |
Create a value of FormDataTypeConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSourceType:FormDataTypeConfig', formDataTypeConfig_dataSourceType - The data source type, either an Amplify DataStore model or a custom data
type.
$sel:dataTypeName:FormDataTypeConfig', formDataTypeConfig_dataTypeName - The unique name of the data type you are using as the data source for
the form.
formDataTypeConfig_dataSourceType :: Lens' FormDataTypeConfig FormDataSourceType Source #
The data source type, either an Amplify DataStore model or a custom data type.
formDataTypeConfig_dataTypeName :: Lens' FormDataTypeConfig Text Source #
The unique name of the data type you are using as the data source for the form.
FormInputValueProperty
data FormInputValueProperty Source #
Describes the configuration for an input field on a form. Use
FormInputValueProperty to specify the values to render or bind by
default.
See: newFormInputValueProperty smart constructor.
Constructors
| FormInputValueProperty' | |
Instances
newFormInputValueProperty :: FormInputValueProperty Source #
Create a value of FormInputValueProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:FormInputValueProperty', formInputValueProperty_value - The value to assign to the input field.
formInputValueProperty_value :: Lens' FormInputValueProperty (Maybe Text) Source #
The value to assign to the input field.
FormStyle
Describes the configuration for the form's style.
See: newFormStyle smart constructor.
Constructors
| FormStyle' | |
Fields
| |
Instances
newFormStyle :: FormStyle Source #
Create a value of FormStyle with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:horizontalGap:FormStyle', formStyle_horizontalGap - The spacing for the horizontal gap.
$sel:outerPadding:FormStyle', formStyle_outerPadding - The size of the outer padding for the form.
$sel:verticalGap:FormStyle', formStyle_verticalGap - The spacing for the vertical gap.
formStyle_horizontalGap :: Lens' FormStyle (Maybe FormStyleConfig) Source #
The spacing for the horizontal gap.
formStyle_outerPadding :: Lens' FormStyle (Maybe FormStyleConfig) Source #
The size of the outer padding for the form.
formStyle_verticalGap :: Lens' FormStyle (Maybe FormStyleConfig) Source #
The spacing for the vertical gap.
FormStyleConfig
data FormStyleConfig Source #
Describes the configuration settings for the form's style properties.
See: newFormStyleConfig smart constructor.
Constructors
| FormStyleConfig' | |
Instances
newFormStyleConfig :: FormStyleConfig Source #
Create a value of FormStyleConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tokenReference:FormStyleConfig', formStyleConfig_tokenReference - A reference to a design token to use to bind the form's style
properties to an existing theme.
$sel:value:FormStyleConfig', formStyleConfig_value - The value of the style setting.
formStyleConfig_tokenReference :: Lens' FormStyleConfig (Maybe Text) Source #
A reference to a design token to use to bind the form's style properties to an existing theme.
formStyleConfig_value :: Lens' FormStyleConfig (Maybe Text) Source #
The value of the style setting.
FormSummary
data FormSummary Source #
Describes the basic information about a form.
See: newFormSummary smart constructor.
Constructors
| FormSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> FormDataTypeConfig | |
| -> Text | |
| -> FormActionType | |
| -> Text | |
| -> Text | |
| -> FormSummary |
Create a value of FormSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appId:FormSummary', formSummary_appId - The unique ID for the app associated with the form summary.
$sel:dataType:FormSummary', formSummary_dataType - The form's data source type.
$sel:environmentName:FormSummary', formSummary_environmentName - The name of the backend environment that is part of the Amplify app.
$sel:formActionType:FormSummary', formSummary_formActionType - The type of operation to perform on the form.
$sel:id:FormSummary', formSummary_id - The ID of the form.
$sel:name:FormSummary', formSummary_name - The name of the form.
formSummary_appId :: Lens' FormSummary Text Source #
The unique ID for the app associated with the form summary.
formSummary_dataType :: Lens' FormSummary FormDataTypeConfig Source #
The form's data source type.
formSummary_environmentName :: Lens' FormSummary Text Source #
The name of the backend environment that is part of the Amplify app.
formSummary_formActionType :: Lens' FormSummary FormActionType Source #
The type of operation to perform on the form.
formSummary_id :: Lens' FormSummary Text Source #
The ID of the form.
formSummary_name :: Lens' FormSummary Text Source #
The name of the form.
MutationActionSetStateParameter
data MutationActionSetStateParameter Source #
Represents the state configuration when an action modifies a property of another element within the same component.
See: newMutationActionSetStateParameter smart constructor.
Constructors
| MutationActionSetStateParameter' | |
Fields
| |
Instances
newMutationActionSetStateParameter Source #
Arguments
| :: Text | |
| -> Text | |
| -> ComponentProperty | |
| -> MutationActionSetStateParameter |
Create a value of MutationActionSetStateParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
MutationActionSetStateParameter, mutationActionSetStateParameter_componentName - The name of the component that is being modified.
MutationActionSetStateParameter, mutationActionSetStateParameter_property - The name of the component property to apply the state configuration to.
$sel:set:MutationActionSetStateParameter', mutationActionSetStateParameter_set - The state configuration to assign to the property.
mutationActionSetStateParameter_componentName :: Lens' MutationActionSetStateParameter Text Source #
The name of the component that is being modified.
mutationActionSetStateParameter_property :: Lens' MutationActionSetStateParameter Text Source #
The name of the component property to apply the state configuration to.
mutationActionSetStateParameter_set :: Lens' MutationActionSetStateParameter ComponentProperty Source #
The state configuration to assign to the property.
Predicate
Stores information for generating Amplify DataStore queries. Use a
Predicate to retrieve a subset of the data in a collection.
See: newPredicate smart constructor.
Constructors
| Predicate' | |
Fields
| |
Instances
newPredicate :: Predicate Source #
Create a value of Predicate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:and:Predicate', predicate_and - A list of predicates to combine logically.
$sel:field:Predicate', predicate_field - The field to query.
$sel:operand:Predicate', predicate_operand - The value to use when performing the evaluation.
$sel:operator:Predicate', predicate_operator - The operator to use to perform the evaluation.
$sel:or:Predicate', predicate_or - A list of predicates to combine logically.
predicate_and :: Lens' Predicate (Maybe [Predicate]) Source #
A list of predicates to combine logically.
predicate_operand :: Lens' Predicate (Maybe Text) Source #
The value to use when performing the evaluation.
predicate_operator :: Lens' Predicate (Maybe Text) Source #
The operator to use to perform the evaluation.
predicate_or :: Lens' Predicate (Maybe [Predicate]) Source #
A list of predicates to combine logically.
PutMetadataFlagBody
data PutMetadataFlagBody Source #
Stores the metadata information about a feature on a form or view.
See: newPutMetadataFlagBody smart constructor.
Constructors
| PutMetadataFlagBody' | |
Instances
newPutMetadataFlagBody Source #
Arguments
| :: Text | |
| -> PutMetadataFlagBody |
Create a value of PutMetadataFlagBody with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:newValue':PutMetadataFlagBody', putMetadataFlagBody_newValue - The new information to store.
putMetadataFlagBody_newValue :: Lens' PutMetadataFlagBody Text Source #
The new information to store.
RefreshTokenRequestBody
data RefreshTokenRequestBody Source #
Describes a refresh token.
See: newRefreshTokenRequestBody smart constructor.
Constructors
| RefreshTokenRequestBody' | |
Instances
newRefreshTokenRequestBody Source #
Create a value of RefreshTokenRequestBody with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:token:RefreshTokenRequestBody', refreshTokenRequestBody_token - The token to use to refresh a previously issued access token that might
have expired.
refreshTokenRequestBody_token :: Lens' RefreshTokenRequestBody Text Source #
The token to use to refresh a previously issued access token that might have expired.
SectionalElement
data SectionalElement Source #
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.
See: newSectionalElement smart constructor.
Constructors
| SectionalElement' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SectionalElement |
Create a value of SectionalElement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:level:SectionalElement', sectionalElement_level - Specifies the size of the font for a Heading sectional element. Valid
values are 1 | 2 | 3 | 4 | 5 | 6.
$sel:orientation:SectionalElement', sectionalElement_orientation - Specifies the orientation for a Divider sectional element. Valid
values are horizontal or vertical.
$sel:position:SectionalElement', sectionalElement_position - Specifies the position of the text in a field for a Text sectional
element.
$sel:text:SectionalElement', sectionalElement_text - The text for a Text sectional element.
$sel:type':SectionalElement', sectionalElement_type - The type of sectional element. Valid values are Heading, Text, and
Divider.
sectionalElement_level :: Lens' SectionalElement (Maybe Int) Source #
Specifies the size of the font for a Heading sectional element. Valid
values are 1 | 2 | 3 | 4 | 5 | 6.
sectionalElement_orientation :: Lens' SectionalElement (Maybe Text) Source #
Specifies the orientation for a Divider sectional element. Valid
values are horizontal or vertical.
sectionalElement_position :: Lens' SectionalElement (Maybe FieldPosition) Source #
Specifies the position of the text in a field for a Text sectional
element.
sectionalElement_text :: Lens' SectionalElement (Maybe Text) Source #
The text for a Text sectional element.
sectionalElement_type :: Lens' SectionalElement Text Source #
The type of sectional element. Valid values are Heading, Text, and
Divider.
SortProperty
data SortProperty Source #
Describes how to sort the data that you bind to a component.
See: newSortProperty smart constructor.
Constructors
| SortProperty' | |
Fields
| |
Instances
Create a value of SortProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:direction:SortProperty', sortProperty_direction - The direction of the sort, either ascending or descending.
$sel:field:SortProperty', sortProperty_field - The field to perform the sort on.
sortProperty_direction :: Lens' SortProperty SortDirection Source #
The direction of the sort, either ascending or descending.
sortProperty_field :: Lens' SortProperty Text Source #
The field to perform the sort on.
Theme
A theme is a collection of style settings that apply globally to the components associated with an Amplify application.
See: newTheme smart constructor.
Constructors
| Theme' | |
Fields
| |
Instances
Create a value of Theme with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:modifiedAt:Theme', theme_modifiedAt - The time that the theme was modified.
$sel:overrides:Theme', theme_overrides - Describes the properties that can be overriden to customize a theme.
$sel:tags:Theme', theme_tags - One or more key-value pairs to use when tagging the theme.
$sel:appId:Theme', theme_appId - The unique ID for the Amplify app associated with the theme.
$sel:createdAt:Theme', theme_createdAt - The time that the theme was created.
$sel:environmentName:Theme', theme_environmentName - The name of the backend environment that is a part of the Amplify app.
$sel:id:Theme', theme_id - The ID for the theme.
$sel:name:Theme', theme_name - The name of the theme.
$sel:values:Theme', theme_values - A list of key-value pairs that defines the properties of the theme.
theme_overrides :: Lens' Theme (Maybe [ThemeValues]) Source #
Describes the properties that can be overriden to customize a theme.
theme_tags :: Lens' Theme (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the theme.
theme_appId :: Lens' Theme Text Source #
The unique ID for the Amplify app associated with the theme.
theme_environmentName :: Lens' Theme Text Source #
The name of the backend environment that is a part of the Amplify app.
theme_values :: Lens' Theme [ThemeValues] Source #
A list of key-value pairs that defines the properties of the theme.
ThemeSummary
data ThemeSummary Source #
Describes the basic information about a theme.
See: newThemeSummary smart constructor.
Constructors
| ThemeSummary' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ThemeSummary |
Create a value of ThemeSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appId:ThemeSummary', themeSummary_appId - The unique ID for the app associated with the theme summary.
$sel:environmentName:ThemeSummary', themeSummary_environmentName - The name of the backend environment that is part of the Amplify app.
$sel:id:ThemeSummary', themeSummary_id - The ID of the theme.
$sel:name:ThemeSummary', themeSummary_name - The name of the theme.
themeSummary_appId :: Lens' ThemeSummary Text Source #
The unique ID for the app associated with the theme summary.
themeSummary_environmentName :: Lens' ThemeSummary Text Source #
The name of the backend environment that is part of the Amplify app.
themeSummary_id :: Lens' ThemeSummary Text Source #
The ID of the theme.
themeSummary_name :: Lens' ThemeSummary Text Source #
The name of the theme.
ThemeValue
data ThemeValue Source #
Describes the configuration of a theme's properties.
See: newThemeValue smart constructor.
Constructors
| ThemeValue' | |
Instances
newThemeValue :: ThemeValue Source #
Create a value of ThemeValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:children:ThemeValue', themeValue_children - A list of key-value pairs that define the theme's properties.
ThemeValues, themeValue_value - The value of a theme property.
themeValue_children :: Lens' ThemeValue (Maybe [ThemeValues]) Source #
A list of key-value pairs that define the theme's properties.
themeValue_value :: Lens' ThemeValue (Maybe Text) Source #
The value of a theme property.
ThemeValues
data ThemeValues Source #
A key-value pair that defines a property of a theme.
See: newThemeValues smart constructor.
Constructors
| ThemeValues' | |
Instances
newThemeValues :: ThemeValues Source #
Create a value of ThemeValues with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:ThemeValues', themeValues_key - The name of the property.
$sel:value:ThemeValues', themeValues_value - The value of the property.
themeValues_key :: Lens' ThemeValues (Maybe Text) Source #
The name of the property.
themeValues_value :: Lens' ThemeValues (Maybe ThemeValue) Source #
The value of the property.
UpdateComponentData
data UpdateComponentData Source #
Updates and saves all of the information about a component, based on component ID.
See: newUpdateComponentData smart constructor.
Constructors
| UpdateComponentData' | |
Fields
| |
Instances
newUpdateComponentData :: UpdateComponentData Source #
Create a value of UpdateComponentData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateComponentData, updateComponentData_bindingProperties - The data binding information for the component's properties.
UpdateComponentData, updateComponentData_children - The components that are instances of the main component.
$sel:collectionProperties:UpdateComponentData', updateComponentData_collectionProperties - The configuration for binding a component's properties to a data model.
Use this for a collection component.
UpdateComponentData, updateComponentData_componentType - The type of the component. This can be an Amplify custom UI component or
another custom component.
UpdateComponentData, updateComponentData_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.
$sel:id:UpdateComponentData', updateComponentData_id - The unique ID of the component to update.
UpdateComponentData, updateComponentData_name - The name of the component to update.
UpdateComponentData, updateComponentData_overrides - Describes the properties that can be overriden to customize the
component.
UpdateComponentData, updateComponentData_properties - Describes the component's properties.
$sel:schemaVersion:UpdateComponentData', updateComponentData_schemaVersion - The schema version of the component when it was imported.
UpdateComponentData, updateComponentData_sourceId - The unique ID of the component in its original source system, such as
Figma.
$sel:variants:UpdateComponentData', updateComponentData_variants - A list of the unique variants of the main component being updated.
updateComponentData_bindingProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentBindingPropertiesValue)) Source #
The data binding information for the component's properties.
updateComponentData_children :: Lens' UpdateComponentData (Maybe [ComponentChild]) Source #
The components that are instances of the main component.
updateComponentData_collectionProperties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentDataConfiguration)) Source #
The configuration for binding a component's properties to a data model. Use this for a collection component.
updateComponentData_componentType :: Lens' UpdateComponentData (Maybe Text) Source #
The type of the component. This can be an Amplify custom UI component or another custom component.
updateComponentData_events :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentEvent)) Source #
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
updateComponentData_id :: Lens' UpdateComponentData (Maybe Text) Source #
The unique ID of the component to update.
updateComponentData_name :: Lens' UpdateComponentData (Maybe Text) Source #
The name of the component to update.
updateComponentData_overrides :: Lens' UpdateComponentData (Maybe (HashMap Text (HashMap Text Text))) Source #
Describes the properties that can be overriden to customize the component.
updateComponentData_properties :: Lens' UpdateComponentData (Maybe (HashMap Text ComponentProperty)) Source #
Describes the component's properties.
updateComponentData_schemaVersion :: Lens' UpdateComponentData (Maybe Text) Source #
The schema version of the component when it was imported.
updateComponentData_sourceId :: Lens' UpdateComponentData (Maybe Text) Source #
The unique ID of the component in its original source system, such as Figma.
updateComponentData_variants :: Lens' UpdateComponentData (Maybe [ComponentVariant]) Source #
A list of the unique variants of the main component being updated.
UpdateFormData
data UpdateFormData Source #
Updates and saves all of the information about a form, based on form ID.
See: newUpdateFormData smart constructor.
Constructors
| UpdateFormData' | |
Fields
| |
Instances
newUpdateFormData :: UpdateFormData Source #
Create a value of UpdateFormData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cta:UpdateFormData', updateFormData_cta - The FormCTA object that stores the call to action configuration for
the form.
$sel:dataType:UpdateFormData', updateFormData_dataType - The type of data source to use to create the form.
$sel:fields:UpdateFormData', updateFormData_fields - The configuration information for the form's fields.
$sel:formActionType:UpdateFormData', updateFormData_formActionType - Specifies whether to perform a create or update action on the form.
$sel:name:UpdateFormData', updateFormData_name - The name of the form.
$sel:schemaVersion:UpdateFormData', updateFormData_schemaVersion - The schema version of the form.
$sel:sectionalElements:UpdateFormData', updateFormData_sectionalElements - The configuration information for the visual helper elements for the
form. These elements are not associated with any data.
$sel:style:UpdateFormData', updateFormData_style - The configuration for the form's style.
updateFormData_cta :: Lens' UpdateFormData (Maybe FormCTA) Source #
The FormCTA object that stores the call to action configuration for
the form.
updateFormData_dataType :: Lens' UpdateFormData (Maybe FormDataTypeConfig) Source #
The type of data source to use to create the form.
updateFormData_fields :: Lens' UpdateFormData (Maybe (HashMap Text FieldConfig)) Source #
The configuration information for the form's fields.
updateFormData_formActionType :: Lens' UpdateFormData (Maybe FormActionType) Source #
Specifies whether to perform a create or update action on the form.
updateFormData_name :: Lens' UpdateFormData (Maybe Text) Source #
The name of the form.
updateFormData_schemaVersion :: Lens' UpdateFormData (Maybe Text) Source #
The schema version of the form.
updateFormData_sectionalElements :: Lens' UpdateFormData (Maybe (HashMap Text SectionalElement)) Source #
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
updateFormData_style :: Lens' UpdateFormData (Maybe FormStyle) Source #
The configuration for the form's style.
UpdateThemeData
data UpdateThemeData Source #
Saves the data binding information for a theme.
See: newUpdateThemeData smart constructor.
Constructors
| UpdateThemeData' | |
Instances
newUpdateThemeData :: UpdateThemeData Source #
Create a value of UpdateThemeData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UpdateThemeData', updateThemeData_id - The unique ID of the theme to update.
$sel:name:UpdateThemeData', updateThemeData_name - The name of the theme to update.
$sel:overrides:UpdateThemeData', updateThemeData_overrides - Describes the properties that can be overriden to customize the theme.
$sel:values:UpdateThemeData', updateThemeData_values - A list of key-value pairs that define the theme's properties.
updateThemeData_id :: Lens' UpdateThemeData (Maybe Text) Source #
The unique ID of the theme to update.
updateThemeData_name :: Lens' UpdateThemeData (Maybe Text) Source #
The name of the theme to update.
updateThemeData_overrides :: Lens' UpdateThemeData (Maybe [ThemeValues]) Source #
Describes the properties that can be overriden to customize the theme.
updateThemeData_values :: Lens' UpdateThemeData [ThemeValues] Source #
A list of key-value pairs that define the theme's properties.
ValueMapping
data ValueMapping Source #
Associates a complex object with a display value. Use ValueMapping to
store how to represent complex objects when they are displayed.
See: newValueMapping smart constructor.
Constructors
| ValueMapping' | |
Fields
| |
Instances
Arguments
| :: FormInputValueProperty | |
| -> ValueMapping |
Create a value of ValueMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:displayValue:ValueMapping', valueMapping_displayValue - The value to display for the complex object.
ValueMapping, valueMapping_value - The complex object.
valueMapping_displayValue :: Lens' ValueMapping (Maybe FormInputValueProperty) Source #
The value to display for the complex object.
valueMapping_value :: Lens' ValueMapping FormInputValueProperty Source #
The complex object.
ValueMappings
data ValueMappings Source #
Represents the data binding configuration for a value map.
See: newValueMappings smart constructor.
Constructors
| ValueMappings' | |
Fields
| |
Instances
newValueMappings :: ValueMappings Source #
Create a value of ValueMappings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:ValueMappings', valueMappings_values - The value and display value pairs.
valueMappings_values :: Lens' ValueMappings [ValueMapping] Source #
The value and display value pairs.