| 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.Lens
Contents
- Operations
- Types
- 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
- createComponent_clientToken :: Lens' CreateComponent (Maybe Text)
- createComponent_appId :: Lens' CreateComponent Text
- createComponent_componentToCreate :: Lens' CreateComponent CreateComponentData
- createComponent_environmentName :: Lens' CreateComponent Text
- createComponentResponse_entity :: Lens' CreateComponentResponse (Maybe Component)
- createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int
- createForm_clientToken :: Lens' CreateForm (Maybe Text)
- createForm_appId :: Lens' CreateForm Text
- createForm_environmentName :: Lens' CreateForm Text
- createForm_formToCreate :: Lens' CreateForm CreateFormData
- createFormResponse_entity :: Lens' CreateFormResponse (Maybe Form)
- createFormResponse_httpStatus :: Lens' CreateFormResponse Int
- createTheme_clientToken :: Lens' CreateTheme (Maybe Text)
- createTheme_appId :: Lens' CreateTheme Text
- createTheme_environmentName :: Lens' CreateTheme Text
- createTheme_themeToCreate :: Lens' CreateTheme CreateThemeData
- createThemeResponse_entity :: Lens' CreateThemeResponse (Maybe Theme)
- createThemeResponse_httpStatus :: Lens' CreateThemeResponse Int
- deleteComponent_appId :: Lens' DeleteComponent Text
- deleteComponent_environmentName :: Lens' DeleteComponent Text
- deleteComponent_id :: Lens' DeleteComponent Text
- deleteForm_appId :: Lens' DeleteForm Text
- deleteForm_environmentName :: Lens' DeleteForm Text
- deleteForm_id :: Lens' DeleteForm Text
- deleteTheme_appId :: Lens' DeleteTheme Text
- deleteTheme_environmentName :: Lens' DeleteTheme Text
- deleteTheme_id :: Lens' DeleteTheme Text
- exchangeCodeForToken_provider :: Lens' ExchangeCodeForToken TokenProviders
- exchangeCodeForToken_request :: Lens' ExchangeCodeForToken ExchangeCodeForTokenRequestBody
- exchangeCodeForTokenResponse_httpStatus :: Lens' ExchangeCodeForTokenResponse Int
- exchangeCodeForTokenResponse_accessToken :: Lens' ExchangeCodeForTokenResponse Text
- exchangeCodeForTokenResponse_expiresIn :: Lens' ExchangeCodeForTokenResponse Int
- exchangeCodeForTokenResponse_refreshToken :: Lens' ExchangeCodeForTokenResponse Text
- exportComponents_nextToken :: Lens' ExportComponents (Maybe Text)
- exportComponents_appId :: Lens' ExportComponents Text
- exportComponents_environmentName :: Lens' ExportComponents Text
- exportComponentsResponse_nextToken :: Lens' ExportComponentsResponse (Maybe Text)
- exportComponentsResponse_httpStatus :: Lens' ExportComponentsResponse Int
- exportComponentsResponse_entities :: Lens' ExportComponentsResponse [Component]
- exportForms_nextToken :: Lens' ExportForms (Maybe Text)
- exportForms_appId :: Lens' ExportForms Text
- exportForms_environmentName :: Lens' ExportForms Text
- exportFormsResponse_nextToken :: Lens' ExportFormsResponse (Maybe Text)
- exportFormsResponse_httpStatus :: Lens' ExportFormsResponse Int
- exportFormsResponse_entities :: Lens' ExportFormsResponse [Form]
- exportThemes_nextToken :: Lens' ExportThemes (Maybe Text)
- exportThemes_appId :: Lens' ExportThemes Text
- exportThemes_environmentName :: Lens' ExportThemes Text
- exportThemesResponse_nextToken :: Lens' ExportThemesResponse (Maybe Text)
- exportThemesResponse_httpStatus :: Lens' ExportThemesResponse Int
- exportThemesResponse_entities :: Lens' ExportThemesResponse [Theme]
- getComponent_appId :: Lens' GetComponent Text
- getComponent_environmentName :: Lens' GetComponent Text
- getComponent_id :: Lens' GetComponent Text
- getComponentResponse_component :: Lens' GetComponentResponse (Maybe Component)
- getComponentResponse_httpStatus :: Lens' GetComponentResponse Int
- getForm_appId :: Lens' GetForm Text
- getForm_environmentName :: Lens' GetForm Text
- getForm_id :: Lens' GetForm Text
- getFormResponse_form :: Lens' GetFormResponse (Maybe Form)
- getFormResponse_httpStatus :: Lens' GetFormResponse Int
- getMetadata_appId :: Lens' GetMetadata Text
- getMetadata_environmentName :: Lens' GetMetadata Text
- getMetadataResponse_httpStatus :: Lens' GetMetadataResponse Int
- getMetadataResponse_features :: Lens' GetMetadataResponse (HashMap Text Text)
- getTheme_appId :: Lens' GetTheme Text
- getTheme_environmentName :: Lens' GetTheme Text
- getTheme_id :: Lens' GetTheme Text
- getThemeResponse_theme :: Lens' GetThemeResponse (Maybe Theme)
- getThemeResponse_httpStatus :: Lens' GetThemeResponse Int
- listComponents_maxResults :: Lens' ListComponents (Maybe Natural)
- listComponents_nextToken :: Lens' ListComponents (Maybe Text)
- listComponents_appId :: Lens' ListComponents Text
- listComponents_environmentName :: Lens' ListComponents Text
- listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text)
- listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int
- listComponentsResponse_entities :: Lens' ListComponentsResponse [ComponentSummary]
- listForms_maxResults :: Lens' ListForms (Maybe Natural)
- listForms_nextToken :: Lens' ListForms (Maybe Text)
- listForms_appId :: Lens' ListForms Text
- listForms_environmentName :: Lens' ListForms Text
- listFormsResponse_nextToken :: Lens' ListFormsResponse (Maybe Text)
- listFormsResponse_httpStatus :: Lens' ListFormsResponse Int
- listFormsResponse_entities :: Lens' ListFormsResponse [FormSummary]
- listThemes_maxResults :: Lens' ListThemes (Maybe Natural)
- listThemes_nextToken :: Lens' ListThemes (Maybe Text)
- listThemes_appId :: Lens' ListThemes Text
- listThemes_environmentName :: Lens' ListThemes Text
- listThemesResponse_nextToken :: Lens' ListThemesResponse (Maybe Text)
- listThemesResponse_httpStatus :: Lens' ListThemesResponse Int
- listThemesResponse_entities :: Lens' ListThemesResponse [ThemeSummary]
- putMetadataFlag_appId :: Lens' PutMetadataFlag Text
- putMetadataFlag_body :: Lens' PutMetadataFlag PutMetadataFlagBody
- putMetadataFlag_environmentName :: Lens' PutMetadataFlag Text
- putMetadataFlag_featureName :: Lens' PutMetadataFlag Text
- refreshToken_provider :: Lens' RefreshToken TokenProviders
- refreshToken_refreshTokenBody :: Lens' RefreshToken RefreshTokenRequestBody
- refreshTokenResponse_httpStatus :: Lens' RefreshTokenResponse Int
- refreshTokenResponse_accessToken :: Lens' RefreshTokenResponse Text
- refreshTokenResponse_expiresIn :: Lens' RefreshTokenResponse Int
- updateComponent_clientToken :: Lens' UpdateComponent (Maybe Text)
- updateComponent_appId :: Lens' UpdateComponent Text
- updateComponent_environmentName :: Lens' UpdateComponent Text
- updateComponent_id :: Lens' UpdateComponent Text
- updateComponent_updatedComponent :: Lens' UpdateComponent UpdateComponentData
- updateComponentResponse_entity :: Lens' UpdateComponentResponse (Maybe Component)
- updateComponentResponse_httpStatus :: Lens' UpdateComponentResponse Int
- updateForm_clientToken :: Lens' UpdateForm (Maybe Text)
- updateForm_appId :: Lens' UpdateForm Text
- updateForm_environmentName :: Lens' UpdateForm Text
- updateForm_id :: Lens' UpdateForm Text
- updateForm_updatedForm :: Lens' UpdateForm UpdateFormData
- updateFormResponse_entity :: Lens' UpdateFormResponse (Maybe Form)
- updateFormResponse_httpStatus :: Lens' UpdateFormResponse Int
- updateTheme_clientToken :: Lens' UpdateTheme (Maybe Text)
- updateTheme_appId :: Lens' UpdateTheme Text
- updateTheme_environmentName :: Lens' UpdateTheme Text
- updateTheme_id :: Lens' UpdateTheme Text
- updateTheme_updatedTheme :: Lens' UpdateTheme UpdateThemeData
- updateThemeResponse_entity :: Lens' UpdateThemeResponse (Maybe Theme)
- updateThemeResponse_httpStatus :: Lens' UpdateThemeResponse Int
- 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)
- 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]
- componentBindingPropertiesValue_bindingProperties :: Lens' ComponentBindingPropertiesValue (Maybe ComponentBindingPropertiesValueProperties)
- componentBindingPropertiesValue_defaultValue :: Lens' ComponentBindingPropertiesValue (Maybe Text)
- componentBindingPropertiesValue_type :: Lens' ComponentBindingPropertiesValue (Maybe Text)
- 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)
- 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)
- 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)
- componentDataConfiguration_identifiers :: Lens' ComponentDataConfiguration (Maybe [Text])
- componentDataConfiguration_predicate :: Lens' ComponentDataConfiguration (Maybe Predicate)
- componentDataConfiguration_sort :: Lens' ComponentDataConfiguration (Maybe [SortProperty])
- componentDataConfiguration_model :: Lens' ComponentDataConfiguration Text
- componentEvent_action :: Lens' ComponentEvent (Maybe Text)
- componentEvent_bindingEvent :: Lens' ComponentEvent (Maybe Text)
- componentEvent_parameters :: Lens' ComponentEvent (Maybe ActionParameters)
- 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)
- componentPropertyBindingProperties_field :: Lens' ComponentPropertyBindingProperties (Maybe Text)
- componentPropertyBindingProperties_property :: Lens' ComponentPropertyBindingProperties Text
- 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
- componentVariant_overrides :: Lens' ComponentVariant (Maybe (HashMap Text (HashMap Text Text)))
- componentVariant_variantValues :: Lens' ComponentVariant (Maybe (HashMap Text Text))
- 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]
- 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
- createThemeData_overrides :: Lens' CreateThemeData (Maybe [ThemeValues])
- createThemeData_tags :: Lens' CreateThemeData (Maybe (HashMap Text Text))
- createThemeData_name :: Lens' CreateThemeData Text
- createThemeData_values :: Lens' CreateThemeData [ThemeValues]
- exchangeCodeForTokenRequestBody_code :: Lens' ExchangeCodeForTokenRequestBody Text
- exchangeCodeForTokenRequestBody_redirectUri :: Lens' ExchangeCodeForTokenRequestBody Text
- 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])
- 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
- fieldPosition_below :: Lens' FieldPosition (Maybe Text)
- fieldPosition_fixed :: Lens' FieldPosition (Maybe FixedPosition)
- fieldPosition_rightOf :: Lens' FieldPosition (Maybe Text)
- fieldValidationConfiguration_numValues :: Lens' FieldValidationConfiguration (Maybe [Int])
- fieldValidationConfiguration_strValues :: Lens' FieldValidationConfiguration (Maybe [Text])
- fieldValidationConfiguration_validationMessage :: Lens' FieldValidationConfiguration (Maybe Text)
- fieldValidationConfiguration_type :: Lens' FieldValidationConfiguration Text
- 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
- formBindingElement_element :: Lens' FormBindingElement Text
- formBindingElement_property :: Lens' FormBindingElement Text
- formButton_children :: Lens' FormButton (Maybe Text)
- formButton_excluded :: Lens' FormButton (Maybe Bool)
- formButton_position :: Lens' FormButton (Maybe FieldPosition)
- formCTA_cancel :: Lens' FormCTA (Maybe FormButton)
- formCTA_clear :: Lens' FormCTA (Maybe FormButton)
- formCTA_position :: Lens' FormCTA (Maybe FormButtonsPosition)
- formCTA_submit :: Lens' FormCTA (Maybe FormButton)
- formDataTypeConfig_dataSourceType :: Lens' FormDataTypeConfig FormDataSourceType
- formDataTypeConfig_dataTypeName :: Lens' FormDataTypeConfig Text
- formInputValueProperty_value :: Lens' FormInputValueProperty (Maybe Text)
- formStyle_horizontalGap :: Lens' FormStyle (Maybe FormStyleConfig)
- formStyle_outerPadding :: Lens' FormStyle (Maybe FormStyleConfig)
- formStyle_verticalGap :: Lens' FormStyle (Maybe FormStyleConfig)
- formStyleConfig_tokenReference :: Lens' FormStyleConfig (Maybe Text)
- formStyleConfig_value :: Lens' FormStyleConfig (Maybe Text)
- 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
- mutationActionSetStateParameter_componentName :: Lens' MutationActionSetStateParameter Text
- mutationActionSetStateParameter_property :: Lens' MutationActionSetStateParameter Text
- mutationActionSetStateParameter_set :: Lens' MutationActionSetStateParameter ComponentProperty
- 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])
- putMetadataFlagBody_newValue :: Lens' PutMetadataFlagBody Text
- refreshTokenRequestBody_token :: Lens' RefreshTokenRequestBody Text
- 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
- sortProperty_direction :: Lens' SortProperty SortDirection
- sortProperty_field :: Lens' SortProperty Text
- 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]
- themeSummary_appId :: Lens' ThemeSummary Text
- themeSummary_environmentName :: Lens' ThemeSummary Text
- themeSummary_id :: Lens' ThemeSummary Text
- themeSummary_name :: Lens' ThemeSummary Text
- themeValue_children :: Lens' ThemeValue (Maybe [ThemeValues])
- themeValue_value :: Lens' ThemeValue (Maybe Text)
- themeValues_key :: Lens' ThemeValues (Maybe Text)
- themeValues_value :: Lens' ThemeValues (Maybe ThemeValue)
- 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])
- 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)
- updateThemeData_id :: Lens' UpdateThemeData (Maybe Text)
- updateThemeData_name :: Lens' UpdateThemeData (Maybe Text)
- updateThemeData_overrides :: Lens' UpdateThemeData (Maybe [ThemeValues])
- updateThemeData_values :: Lens' UpdateThemeData [ThemeValues]
- valueMapping_displayValue :: Lens' ValueMapping (Maybe FormInputValueProperty)
- valueMapping_value :: Lens' ValueMapping FormInputValueProperty
- valueMappings_values :: Lens' ValueMappings [ValueMapping]
Operations
CreateComponent
createComponent_clientToken :: Lens' CreateComponent (Maybe Text) Source #
The unique client token.
createComponent_appId :: Lens' CreateComponent Text Source #
The unique ID of the Amplify app to associate with the component.
createComponent_componentToCreate :: Lens' CreateComponent CreateComponentData Source #
Represents the configuration of the component to create.
createComponent_environmentName :: Lens' CreateComponent Text Source #
The name of the backend environment that is a part of the Amplify app.
createComponentResponse_entity :: Lens' CreateComponentResponse (Maybe Component) Source #
Describes the configuration of the new component.
createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int Source #
The response's http status code.
CreateForm
createForm_clientToken :: Lens' CreateForm (Maybe Text) Source #
The unique client token.
createForm_appId :: Lens' CreateForm Text Source #
The unique ID of the Amplify app to associate with the form.
createForm_environmentName :: Lens' CreateForm Text Source #
The name of the backend environment that is a part of the Amplify app.
createForm_formToCreate :: Lens' CreateForm CreateFormData Source #
Represents the configuration of the form to create.
createFormResponse_entity :: Lens' CreateFormResponse (Maybe Form) Source #
Describes the configuration of the new form.
createFormResponse_httpStatus :: Lens' CreateFormResponse Int Source #
The response's http status code.
CreateTheme
createTheme_clientToken :: Lens' CreateTheme (Maybe Text) Source #
The unique client token.
createTheme_appId :: Lens' CreateTheme Text Source #
The unique ID of the Amplify app associated with the theme.
createTheme_environmentName :: Lens' CreateTheme Text Source #
The name of the backend environment that is a part of the Amplify app.
createTheme_themeToCreate :: Lens' CreateTheme CreateThemeData Source #
Represents the configuration of the theme to create.
createThemeResponse_entity :: Lens' CreateThemeResponse (Maybe Theme) Source #
Describes the configuration of the new theme.
createThemeResponse_httpStatus :: Lens' CreateThemeResponse Int Source #
The response's http status code.
DeleteComponent
deleteComponent_appId :: Lens' DeleteComponent Text Source #
The unique ID of the Amplify app associated with the component to delete.
deleteComponent_environmentName :: Lens' DeleteComponent Text Source #
The name of the backend environment that is a part of the Amplify app.
deleteComponent_id :: Lens' DeleteComponent Text Source #
The unique ID of the component to delete.
DeleteForm
deleteForm_appId :: Lens' DeleteForm Text Source #
The unique ID of the Amplify app associated with the form to delete.
deleteForm_environmentName :: Lens' DeleteForm Text Source #
The name of the backend environment that is a part of the Amplify app.
deleteForm_id :: Lens' DeleteForm Text Source #
The unique ID of the form to delete.
DeleteTheme
deleteTheme_appId :: Lens' DeleteTheme Text Source #
The unique ID of the Amplify app associated with the theme to delete.
deleteTheme_environmentName :: Lens' DeleteTheme Text Source #
The name of the backend environment that is a part of the Amplify app.
deleteTheme_id :: Lens' DeleteTheme Text Source #
The unique ID of the theme to delete.
ExchangeCodeForToken
exchangeCodeForToken_provider :: Lens' ExchangeCodeForToken TokenProviders Source #
The third-party provider for the token. The only valid value is figma.
exchangeCodeForToken_request :: Lens' ExchangeCodeForToken ExchangeCodeForTokenRequestBody Source #
Describes the configuration of the request.
exchangeCodeForTokenResponse_httpStatus :: Lens' ExchangeCodeForTokenResponse Int Source #
The response's http status code.
exchangeCodeForTokenResponse_accessToken :: Lens' ExchangeCodeForTokenResponse Text Source #
The access token.
exchangeCodeForTokenResponse_expiresIn :: Lens' ExchangeCodeForTokenResponse Int Source #
The date and time when the new access token expires.
exchangeCodeForTokenResponse_refreshToken :: Lens' ExchangeCodeForTokenResponse Text Source #
The token to use to refresh a previously issued access token that might have expired.
ExportComponents
exportComponents_nextToken :: Lens' ExportComponents (Maybe Text) Source #
The token to request the next page of results.
exportComponents_appId :: Lens' ExportComponents Text Source #
The unique ID of the Amplify app to export components to.
exportComponents_environmentName :: Lens' ExportComponents Text Source #
The name of the backend environment that is a part of the Amplify app.
exportComponentsResponse_nextToken :: Lens' ExportComponentsResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
exportComponentsResponse_httpStatus :: Lens' ExportComponentsResponse Int Source #
The response's http status code.
exportComponentsResponse_entities :: Lens' ExportComponentsResponse [Component] Source #
Represents the configuration of the exported components.
ExportForms
exportForms_nextToken :: Lens' ExportForms (Maybe Text) Source #
The token to request the next page of results.
exportForms_appId :: Lens' ExportForms Text Source #
The unique ID of the Amplify app to export forms to.
exportForms_environmentName :: Lens' ExportForms Text Source #
The name of the backend environment that is a part of the Amplify app.
exportFormsResponse_nextToken :: Lens' ExportFormsResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
exportFormsResponse_httpStatus :: Lens' ExportFormsResponse Int Source #
The response's http status code.
exportFormsResponse_entities :: Lens' ExportFormsResponse [Form] Source #
Represents the configuration of the exported forms.
ExportThemes
exportThemes_nextToken :: Lens' ExportThemes (Maybe Text) Source #
The token to request the next page of results.
exportThemes_appId :: Lens' ExportThemes Text Source #
The unique ID of the Amplify app to export the themes to.
exportThemes_environmentName :: Lens' ExportThemes Text Source #
The name of the backend environment that is part of the Amplify app.
exportThemesResponse_nextToken :: Lens' ExportThemesResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
exportThemesResponse_httpStatus :: Lens' ExportThemesResponse Int Source #
The response's http status code.
exportThemesResponse_entities :: Lens' ExportThemesResponse [Theme] Source #
Represents the configuration of the exported themes.
GetComponent
getComponent_appId :: Lens' GetComponent Text Source #
The unique ID of the Amplify app.
getComponent_environmentName :: Lens' GetComponent Text Source #
The name of the backend environment that is part of the Amplify app.
getComponent_id :: Lens' GetComponent Text Source #
The unique ID of the component.
getComponentResponse_component :: Lens' GetComponentResponse (Maybe Component) Source #
Represents the configuration settings for the component.
getComponentResponse_httpStatus :: Lens' GetComponentResponse Int Source #
The response's http status code.
GetForm
getForm_environmentName :: Lens' GetForm Text Source #
The name of the backend environment that is part of the Amplify app.
getFormResponse_form :: Lens' GetFormResponse (Maybe Form) Source #
Represents the configuration settings for the form.
getFormResponse_httpStatus :: Lens' GetFormResponse Int Source #
The response's http status code.
GetMetadata
getMetadata_appId :: Lens' GetMetadata Text Source #
The unique ID of the Amplify app.
getMetadata_environmentName :: Lens' GetMetadata Text Source #
The name of the backend environment that is part of the Amplify app.
getMetadataResponse_httpStatus :: Lens' GetMetadataResponse Int Source #
The response's http status code.
getMetadataResponse_features :: Lens' GetMetadataResponse (HashMap Text Text) Source #
Represents the configuration settings for the features metadata.
GetTheme
getTheme_environmentName :: Lens' GetTheme Text Source #
The name of the backend environment that is part of the Amplify app.
getThemeResponse_theme :: Lens' GetThemeResponse (Maybe Theme) Source #
Represents the configuration settings for the theme.
getThemeResponse_httpStatus :: Lens' GetThemeResponse Int Source #
The response's http status code.
ListComponents
listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #
The maximum number of components to retrieve.
listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #
The token to request the next page of results.
listComponents_appId :: Lens' ListComponents Text Source #
The unique ID for the Amplify app.
listComponents_environmentName :: Lens' ListComponents Text Source #
The name of the backend environment that is a part of the Amplify app.
listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int Source #
The response's http status code.
listComponentsResponse_entities :: Lens' ListComponentsResponse [ComponentSummary] Source #
The list of components for the Amplify app.
ListForms
listForms_maxResults :: Lens' ListForms (Maybe Natural) Source #
The maximum number of forms to retrieve.
listForms_nextToken :: Lens' ListForms (Maybe Text) Source #
The token to request the next page of results.
listForms_environmentName :: Lens' ListForms Text Source #
The name of the backend environment that is a part of the Amplify app.
listFormsResponse_nextToken :: Lens' ListFormsResponse (Maybe Text) Source #
The pagination token that's included if more results are available.
listFormsResponse_httpStatus :: Lens' ListFormsResponse Int Source #
The response's http status code.
listFormsResponse_entities :: Lens' ListFormsResponse [FormSummary] Source #
The list of forms for the Amplify app.
ListThemes
listThemes_maxResults :: Lens' ListThemes (Maybe Natural) Source #
The maximum number of theme results to return in the response.
listThemes_nextToken :: Lens' ListThemes (Maybe Text) Source #
The token to request the next page of results.
listThemes_appId :: Lens' ListThemes Text Source #
The unique ID for the Amplify app.
listThemes_environmentName :: Lens' ListThemes Text Source #
The name of the backend environment that is a part of the Amplify app.
listThemesResponse_nextToken :: Lens' ListThemesResponse (Maybe Text) Source #
The pagination token that's returned if more results are available.
listThemesResponse_httpStatus :: Lens' ListThemesResponse Int Source #
The response's http status code.
listThemesResponse_entities :: Lens' ListThemesResponse [ThemeSummary] Source #
The list of themes for the Amplify app.
PutMetadataFlag
putMetadataFlag_appId :: Lens' PutMetadataFlag Text Source #
The unique ID for the Amplify app.
putMetadataFlag_body :: Lens' PutMetadataFlag PutMetadataFlagBody Source #
The metadata information to store.
putMetadataFlag_environmentName :: Lens' PutMetadataFlag Text Source #
The name of the backend environment that is part of the Amplify app.
putMetadataFlag_featureName :: Lens' PutMetadataFlag Text Source #
The name of the feature associated with the metadata.
RefreshToken
refreshToken_provider :: Lens' RefreshToken TokenProviders Source #
The third-party provider for the token. The only valid value is figma.
refreshToken_refreshTokenBody :: Lens' RefreshToken RefreshTokenRequestBody Source #
Information about the refresh token request.
refreshTokenResponse_httpStatus :: Lens' RefreshTokenResponse Int Source #
The response's http status code.
refreshTokenResponse_accessToken :: Lens' RefreshTokenResponse Text Source #
The access token.
refreshTokenResponse_expiresIn :: Lens' RefreshTokenResponse Int Source #
The date and time when the new access token expires.
UpdateComponent
updateComponent_clientToken :: Lens' UpdateComponent (Maybe Text) Source #
The unique client token.
updateComponent_appId :: Lens' UpdateComponent Text Source #
The unique ID for the Amplify app.
updateComponent_environmentName :: Lens' UpdateComponent Text Source #
The name of the backend environment that is part of the Amplify app.
updateComponent_id :: Lens' UpdateComponent Text Source #
The unique ID for the component.
updateComponent_updatedComponent :: Lens' UpdateComponent UpdateComponentData Source #
The configuration of the updated component.
updateComponentResponse_entity :: Lens' UpdateComponentResponse (Maybe Component) Source #
Describes the configuration of the updated component.
updateComponentResponse_httpStatus :: Lens' UpdateComponentResponse Int Source #
The response's http status code.
UpdateForm
updateForm_clientToken :: Lens' UpdateForm (Maybe Text) Source #
The unique client token.
updateForm_appId :: Lens' UpdateForm Text Source #
The unique ID for the Amplify app.
updateForm_environmentName :: Lens' UpdateForm Text Source #
The name of the backend environment that is part of the Amplify app.
updateForm_id :: Lens' UpdateForm Text Source #
The unique ID for the form.
updateForm_updatedForm :: Lens' UpdateForm UpdateFormData Source #
The request accepts the following data in JSON format.
updateFormResponse_entity :: Lens' UpdateFormResponse (Maybe Form) Source #
Describes the configuration of the updated form.
updateFormResponse_httpStatus :: Lens' UpdateFormResponse Int Source #
The response's http status code.
UpdateTheme
updateTheme_clientToken :: Lens' UpdateTheme (Maybe Text) Source #
The unique client token.
updateTheme_appId :: Lens' UpdateTheme Text Source #
The unique ID for the Amplify app.
updateTheme_environmentName :: Lens' UpdateTheme Text Source #
The name of the backend environment that is part of the Amplify app.
updateTheme_id :: Lens' UpdateTheme Text Source #
The unique ID for the theme.
updateTheme_updatedTheme :: Lens' UpdateTheme UpdateThemeData Source #
The configuration of the updated theme.
updateThemeResponse_entity :: Lens' UpdateThemeResponse (Maybe Theme) Source #
Describes the configuration of the updated theme.
updateThemeResponse_httpStatus :: Lens' UpdateThemeResponse Int Source #
The response's http status code.
Types
ActionParameters
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
formInputValueProperty_value :: Lens' FormInputValueProperty (Maybe Text) Source #
The value to assign to the input field.
FormStyle
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
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
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
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
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
putMetadataFlagBody_newValue :: Lens' PutMetadataFlagBody Text Source #
The new information to store.
RefreshTokenRequestBody
refreshTokenRequestBody_token :: Lens' RefreshTokenRequestBody Text Source #
The token to use to refresh a previously issued access token that might have expired.
SectionalElement
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
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
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
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
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
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
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
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
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
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
valueMappings_values :: Lens' ValueMappings [ValueMapping] Source #
The value and display value pairs.