| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateComponent
- CreateForm
- CreateTheme
- DeleteComponent
- DeleteForm
- DeleteTheme
- ExchangeCodeForToken
- ExportComponents (Paginated)
- ExportForms (Paginated)
- ExportThemes (Paginated)
- GetComponent
- GetForm
- GetMetadata
- GetTheme
- ListComponents (Paginated)
- ListForms (Paginated)
- ListThemes (Paginated)
- PutMetadataFlag
- RefreshToken
- UpdateComponent
- UpdateForm
- UpdateTheme
- Types
- 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
Derived from API version 2021-08-11 of the AWS service descriptions, licensed under Apache 2.0.
The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.
You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.
The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.
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
- data CreateComponent = CreateComponent' (Maybe Text) Text CreateComponentData Text
- newCreateComponent :: Text -> CreateComponentData -> Text -> CreateComponent
- data CreateComponentResponse = CreateComponentResponse' (Maybe Component) Int
- newCreateComponentResponse :: Int -> CreateComponentResponse
- data CreateForm = CreateForm' (Maybe Text) Text Text CreateFormData
- newCreateForm :: Text -> Text -> CreateFormData -> CreateForm
- data CreateFormResponse = CreateFormResponse' (Maybe Form) Int
- newCreateFormResponse :: Int -> CreateFormResponse
- data CreateTheme = CreateTheme' (Maybe Text) Text Text CreateThemeData
- newCreateTheme :: Text -> Text -> CreateThemeData -> CreateTheme
- data CreateThemeResponse = CreateThemeResponse' (Maybe Theme) Int
- newCreateThemeResponse :: Int -> CreateThemeResponse
- data DeleteComponent = DeleteComponent' Text Text Text
- newDeleteComponent :: Text -> Text -> Text -> DeleteComponent
- data DeleteComponentResponse = DeleteComponentResponse' {
- newDeleteComponentResponse :: DeleteComponentResponse
- data DeleteForm = DeleteForm' Text Text Text
- newDeleteForm :: Text -> Text -> Text -> DeleteForm
- data DeleteFormResponse = DeleteFormResponse' {
- newDeleteFormResponse :: DeleteFormResponse
- data DeleteTheme = DeleteTheme' Text Text Text
- newDeleteTheme :: Text -> Text -> Text -> DeleteTheme
- data DeleteThemeResponse = DeleteThemeResponse' {
- newDeleteThemeResponse :: DeleteThemeResponse
- data ExchangeCodeForToken = ExchangeCodeForToken' TokenProviders ExchangeCodeForTokenRequestBody
- newExchangeCodeForToken :: TokenProviders -> ExchangeCodeForTokenRequestBody -> ExchangeCodeForToken
- data ExchangeCodeForTokenResponse = ExchangeCodeForTokenResponse' Int (Sensitive Text) Int (Sensitive Text)
- newExchangeCodeForTokenResponse :: Int -> Text -> Int -> Text -> ExchangeCodeForTokenResponse
- data ExportComponents = ExportComponents' (Maybe Text) Text Text
- newExportComponents :: Text -> Text -> ExportComponents
- data ExportComponentsResponse = ExportComponentsResponse' (Maybe Text) Int [Component]
- newExportComponentsResponse :: Int -> ExportComponentsResponse
- data ExportForms = ExportForms' (Maybe Text) Text Text
- newExportForms :: Text -> Text -> ExportForms
- data ExportFormsResponse = ExportFormsResponse' (Maybe Text) Int [Form]
- newExportFormsResponse :: Int -> ExportFormsResponse
- data ExportThemes = ExportThemes' (Maybe Text) Text Text
- newExportThemes :: Text -> Text -> ExportThemes
- data ExportThemesResponse = ExportThemesResponse' (Maybe Text) Int [Theme]
- newExportThemesResponse :: Int -> ExportThemesResponse
- data GetComponent = GetComponent' Text Text Text
- newGetComponent :: Text -> Text -> Text -> GetComponent
- data GetComponentResponse = GetComponentResponse' (Maybe Component) Int
- newGetComponentResponse :: Int -> GetComponentResponse
- data GetForm = GetForm' Text Text Text
- newGetForm :: Text -> Text -> Text -> GetForm
- data GetFormResponse = GetFormResponse' (Maybe Form) Int
- newGetFormResponse :: Int -> GetFormResponse
- data GetMetadata = GetMetadata' Text Text
- newGetMetadata :: Text -> Text -> GetMetadata
- data GetMetadataResponse = GetMetadataResponse' Int (HashMap Text Text)
- newGetMetadataResponse :: Int -> GetMetadataResponse
- data GetTheme = GetTheme' Text Text Text
- newGetTheme :: Text -> Text -> Text -> GetTheme
- data GetThemeResponse = GetThemeResponse' (Maybe Theme) Int
- newGetThemeResponse :: Int -> GetThemeResponse
- data ListComponents = ListComponents' (Maybe Natural) (Maybe Text) Text Text
- newListComponents :: Text -> Text -> ListComponents
- data ListComponentsResponse = ListComponentsResponse' (Maybe Text) Int [ComponentSummary]
- newListComponentsResponse :: Int -> ListComponentsResponse
- data ListForms = ListForms' (Maybe Natural) (Maybe Text) Text Text
- newListForms :: Text -> Text -> ListForms
- data ListFormsResponse = ListFormsResponse' (Maybe Text) Int [FormSummary]
- newListFormsResponse :: Int -> ListFormsResponse
- data ListThemes = ListThemes' (Maybe Natural) (Maybe Text) Text Text
- newListThemes :: Text -> Text -> ListThemes
- data ListThemesResponse = ListThemesResponse' (Maybe Text) Int [ThemeSummary]
- newListThemesResponse :: Int -> ListThemesResponse
- data PutMetadataFlag = PutMetadataFlag' Text PutMetadataFlagBody Text Text
- newPutMetadataFlag :: Text -> PutMetadataFlagBody -> Text -> Text -> PutMetadataFlag
- data PutMetadataFlagResponse = PutMetadataFlagResponse' {
- newPutMetadataFlagResponse :: PutMetadataFlagResponse
- data RefreshToken = RefreshToken' TokenProviders RefreshTokenRequestBody
- newRefreshToken :: TokenProviders -> RefreshTokenRequestBody -> RefreshToken
- data RefreshTokenResponse = RefreshTokenResponse' Int (Sensitive Text) Int
- newRefreshTokenResponse :: Int -> Text -> Int -> RefreshTokenResponse
- data UpdateComponent = UpdateComponent' (Maybe Text) Text Text Text UpdateComponentData
- newUpdateComponent :: Text -> Text -> Text -> UpdateComponentData -> UpdateComponent
- data UpdateComponentResponse = UpdateComponentResponse' (Maybe Component) Int
- newUpdateComponentResponse :: Int -> UpdateComponentResponse
- data UpdateForm = UpdateForm' (Maybe Text) Text Text Text UpdateFormData
- newUpdateForm :: Text -> Text -> Text -> UpdateFormData -> UpdateForm
- data UpdateFormResponse = UpdateFormResponse' (Maybe Form) Int
- newUpdateFormResponse :: Int -> UpdateFormResponse
- data UpdateTheme = UpdateTheme' (Maybe Text) Text Text Text UpdateThemeData
- newUpdateTheme :: Text -> Text -> Text -> UpdateThemeData -> UpdateTheme
- data UpdateThemeResponse = UpdateThemeResponse' (Maybe Theme) Int
- newUpdateThemeResponse :: Int -> UpdateThemeResponse
- 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' (Maybe ComponentProperty) (Maybe (HashMap Text ComponentProperty)) (Maybe ComponentProperty) (Maybe ComponentProperty) (Maybe Text) (Maybe MutationActionSetStateParameter) (Maybe ComponentProperty) (Maybe ComponentProperty) (Maybe ComponentProperty)
- newActionParameters :: ActionParameters
- data Component = Component' (Maybe [ComponentChild]) (Maybe (HashMap Text ComponentDataConfiguration)) (Maybe (HashMap Text ComponentEvent)) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text (HashMap Text ComponentBindingPropertiesValue) Text ISO8601 Text Text Text (HashMap Text (HashMap Text Text)) (HashMap Text ComponentProperty) [ComponentVariant]
- newComponent :: Text -> Text -> UTCTime -> Text -> Text -> Text -> Component
- data ComponentBindingPropertiesValue = ComponentBindingPropertiesValue' (Maybe ComponentBindingPropertiesValueProperties) (Maybe Text) (Maybe Text)
- newComponentBindingPropertiesValue :: ComponentBindingPropertiesValue
- data ComponentBindingPropertiesValueProperties = ComponentBindingPropertiesValueProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Predicate]) (Maybe Text) (Maybe Text)
- newComponentBindingPropertiesValueProperties :: ComponentBindingPropertiesValueProperties
- data ComponentChild = ComponentChild' (Maybe [ComponentChild]) (Maybe (HashMap Text ComponentEvent)) (Maybe Text) Text Text (HashMap Text ComponentProperty)
- newComponentChild :: Text -> Text -> ComponentChild
- data ComponentConditionProperty = ComponentConditionProperty' (Maybe ComponentProperty) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ComponentProperty)
- newComponentConditionProperty :: ComponentConditionProperty
- data ComponentDataConfiguration = ComponentDataConfiguration' (Maybe [Text]) (Maybe Predicate) (Maybe [SortProperty]) Text
- newComponentDataConfiguration :: Text -> ComponentDataConfiguration
- data ComponentEvent = ComponentEvent' (Maybe Text) (Maybe Text) (Maybe ActionParameters)
- newComponentEvent :: ComponentEvent
- data ComponentProperty = ComponentProperty' (Maybe ComponentPropertyBindingProperties) (Maybe (HashMap Text FormBindingElement)) (Maybe ComponentPropertyBindingProperties) (Maybe Text) (Maybe [ComponentProperty]) (Maybe ComponentConditionProperty) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newComponentProperty :: ComponentProperty
- data ComponentPropertyBindingProperties = ComponentPropertyBindingProperties' (Maybe Text) Text
- newComponentPropertyBindingProperties :: Text -> ComponentPropertyBindingProperties
- data ComponentSummary = ComponentSummary' Text Text Text Text Text
- newComponentSummary :: Text -> Text -> Text -> Text -> Text -> ComponentSummary
- data ComponentVariant = ComponentVariant' (Maybe (HashMap Text (HashMap Text Text))) (Maybe (HashMap Text Text))
- newComponentVariant :: ComponentVariant
- data CreateComponentData = CreateComponentData' (Maybe [ComponentChild]) (Maybe (HashMap Text ComponentDataConfiguration)) (Maybe (HashMap Text ComponentEvent)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (HashMap Text ComponentBindingPropertiesValue) Text Text (HashMap Text (HashMap Text Text)) (HashMap Text ComponentProperty) [ComponentVariant]
- newCreateComponentData :: Text -> Text -> CreateComponentData
- data CreateFormData = CreateFormData' (Maybe FormCTA) (Maybe (HashMap Text Text)) FormDataTypeConfig (HashMap Text FieldConfig) FormActionType Text Text (HashMap Text SectionalElement) FormStyle
- newCreateFormData :: FormDataTypeConfig -> FormActionType -> Text -> Text -> FormStyle -> CreateFormData
- data CreateThemeData = CreateThemeData' (Maybe [ThemeValues]) (Maybe (HashMap Text Text)) Text [ThemeValues]
- newCreateThemeData :: Text -> CreateThemeData
- data ExchangeCodeForTokenRequestBody = ExchangeCodeForTokenRequestBody' (Sensitive Text) Text
- newExchangeCodeForTokenRequestBody :: Text -> Text -> ExchangeCodeForTokenRequestBody
- data FieldConfig = FieldConfig' (Maybe Bool) (Maybe FieldInputConfig) (Maybe Text) (Maybe FieldPosition) (Maybe [FieldValidationConfiguration])
- newFieldConfig :: FieldConfig
- data FieldInputConfig = FieldInputConfig' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Double) (Maybe Text) (Maybe ValueMappings) Text
- newFieldInputConfig :: Text -> FieldInputConfig
- data FieldPosition = FieldPosition' (Maybe Text) (Maybe FixedPosition) (Maybe Text)
- newFieldPosition :: FieldPosition
- data FieldValidationConfiguration = FieldValidationConfiguration' (Maybe [Int]) (Maybe [Text]) (Maybe Text) Text
- newFieldValidationConfiguration :: Text -> FieldValidationConfiguration
- data Form = Form' (Maybe FormCTA) (Maybe (HashMap Text Text)) Text FormDataTypeConfig Text (HashMap Text FieldConfig) FormActionType Text Text Text (HashMap Text SectionalElement) FormStyle
- newForm :: Text -> FormDataTypeConfig -> Text -> FormActionType -> Text -> Text -> Text -> FormStyle -> Form
- data FormBindingElement = FormBindingElement' Text Text
- newFormBindingElement :: Text -> Text -> FormBindingElement
- data FormButton = FormButton' (Maybe Text) (Maybe Bool) (Maybe FieldPosition)
- newFormButton :: FormButton
- data FormCTA = FormCTA' (Maybe FormButton) (Maybe FormButton) (Maybe FormButtonsPosition) (Maybe FormButton)
- newFormCTA :: FormCTA
- data FormDataTypeConfig = FormDataTypeConfig' FormDataSourceType Text
- newFormDataTypeConfig :: FormDataSourceType -> Text -> FormDataTypeConfig
- data FormInputValueProperty = FormInputValueProperty' (Maybe Text)
- newFormInputValueProperty :: FormInputValueProperty
- data FormStyle = FormStyle' (Maybe FormStyleConfig) (Maybe FormStyleConfig) (Maybe FormStyleConfig)
- newFormStyle :: FormStyle
- data FormStyleConfig = FormStyleConfig' (Maybe Text) (Maybe Text)
- newFormStyleConfig :: FormStyleConfig
- data FormSummary = FormSummary' Text FormDataTypeConfig Text FormActionType Text Text
- newFormSummary :: Text -> FormDataTypeConfig -> Text -> FormActionType -> Text -> Text -> FormSummary
- data MutationActionSetStateParameter = MutationActionSetStateParameter' Text Text ComponentProperty
- newMutationActionSetStateParameter :: Text -> Text -> ComponentProperty -> MutationActionSetStateParameter
- data Predicate = Predicate' (Maybe [Predicate]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Predicate])
- newPredicate :: Predicate
- data PutMetadataFlagBody = PutMetadataFlagBody' Text
- newPutMetadataFlagBody :: Text -> PutMetadataFlagBody
- data RefreshTokenRequestBody = RefreshTokenRequestBody' (Sensitive Text)
- newRefreshTokenRequestBody :: Text -> RefreshTokenRequestBody
- data SectionalElement = SectionalElement' (Maybe Int) (Maybe Text) (Maybe FieldPosition) (Maybe Text) Text
- newSectionalElement :: Text -> SectionalElement
- data SortProperty = SortProperty' SortDirection Text
- newSortProperty :: SortDirection -> Text -> SortProperty
- data Theme = Theme' (Maybe ISO8601) (Maybe [ThemeValues]) (Maybe (HashMap Text Text)) Text ISO8601 Text Text Text [ThemeValues]
- newTheme :: Text -> UTCTime -> Text -> Text -> Text -> Theme
- data ThemeSummary = ThemeSummary' Text Text Text Text
- newThemeSummary :: Text -> Text -> Text -> Text -> ThemeSummary
- data ThemeValue = ThemeValue' (Maybe [ThemeValues]) (Maybe Text)
- newThemeValue :: ThemeValue
- data ThemeValues = ThemeValues' (Maybe Text) (Maybe ThemeValue)
- newThemeValues :: ThemeValues
- data UpdateComponentData = UpdateComponentData' (Maybe (HashMap Text ComponentBindingPropertiesValue)) (Maybe [ComponentChild]) (Maybe (HashMap Text ComponentDataConfiguration)) (Maybe Text) (Maybe (HashMap Text ComponentEvent)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe (HashMap Text ComponentProperty)) (Maybe Text) (Maybe Text) (Maybe [ComponentVariant])
- newUpdateComponentData :: UpdateComponentData
- data UpdateFormData = UpdateFormData' (Maybe FormCTA) (Maybe FormDataTypeConfig) (Maybe (HashMap Text FieldConfig)) (Maybe FormActionType) (Maybe Text) (Maybe Text) (Maybe (HashMap Text SectionalElement)) (Maybe FormStyle)
- newUpdateFormData :: UpdateFormData
- data UpdateThemeData = UpdateThemeData' (Maybe Text) (Maybe Text) (Maybe [ThemeValues]) [ThemeValues]
- newUpdateThemeData :: UpdateThemeData
- data ValueMapping = ValueMapping' (Maybe FormInputValueProperty) FormInputValueProperty
- newValueMapping :: FormInputValueProperty -> ValueMapping
- data ValueMappings = ValueMappings' [ValueMapping]
- newValueMappings :: ValueMappings
Service Configuration
defaultService :: Service Source #
API version 2021-08-11 of the Amazon Amplify UI Builder SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AmplifyUiBuilder.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal error has occurred. Please retry your request.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
An invalid or out-of-range value was supplied for the input parameter.
ResourceConflictException
_ResourceConflictException :: AsError a => Fold a ServiceError Source #
The resource specified in the request conflicts with an existing resource.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource does not exist, or access was denied.
ServiceQuotaExceededException
_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
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
You don't have permission to perform this operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateComponent
data CreateComponent Source #
See: newCreateComponent smart constructor.
Constructors
| CreateComponent' (Maybe Text) Text CreateComponentData Text |
Instances
Arguments
| :: Text | |
| -> CreateComponentData | |
| -> Text | |
| -> CreateComponent |
Create a value of CreateComponent 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:clientToken:CreateComponent', createComponent_clientToken - The unique client token.
CreateComponent, createComponent_appId - The unique ID of the Amplify app to associate with the component.
$sel:componentToCreate:CreateComponent', createComponent_componentToCreate - Represents the configuration of the component to create.
CreateComponent, createComponent_environmentName - The name of the backend environment that is a part of the Amplify app.
data CreateComponentResponse Source #
See: newCreateComponentResponse smart constructor.
Constructors
| CreateComponentResponse' (Maybe Component) Int |
Instances
newCreateComponentResponse Source #
Create a value of CreateComponentResponse 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:entity:CreateComponentResponse', createComponentResponse_entity - Describes the configuration of the new component.
$sel:httpStatus:CreateComponentResponse', createComponentResponse_httpStatus - The response's http status code.
CreateForm
data CreateForm Source #
See: newCreateForm smart constructor.
Constructors
| CreateForm' (Maybe Text) Text Text CreateFormData |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateFormData | |
| -> CreateForm |
Create a value of CreateForm 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:clientToken:CreateForm', createForm_clientToken - The unique client token.
CreateForm, createForm_appId - The unique ID of the Amplify app to associate with the form.
CreateForm, createForm_environmentName - The name of the backend environment that is a part of the Amplify app.
$sel:formToCreate:CreateForm', createForm_formToCreate - Represents the configuration of the form to create.
data CreateFormResponse Source #
See: newCreateFormResponse smart constructor.
Constructors
| CreateFormResponse' (Maybe Form) Int |
Instances
newCreateFormResponse Source #
Arguments
| :: Int | |
| -> CreateFormResponse |
Create a value of CreateFormResponse 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:entity:CreateFormResponse', createFormResponse_entity - Describes the configuration of the new form.
$sel:httpStatus:CreateFormResponse', createFormResponse_httpStatus - The response's http status code.
CreateTheme
data CreateTheme Source #
See: newCreateTheme smart constructor.
Constructors
| CreateTheme' (Maybe Text) Text Text CreateThemeData |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateThemeData | |
| -> CreateTheme |
Create a value of CreateTheme 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:clientToken:CreateTheme', createTheme_clientToken - The unique client token.
CreateTheme, createTheme_appId - The unique ID of the Amplify app associated with the theme.
CreateTheme, createTheme_environmentName - The name of the backend environment that is a part of the Amplify app.
$sel:themeToCreate:CreateTheme', createTheme_themeToCreate - Represents the configuration of the theme to create.
data CreateThemeResponse Source #
See: newCreateThemeResponse smart constructor.
Constructors
| CreateThemeResponse' (Maybe Theme) Int |
Instances
newCreateThemeResponse Source #
Arguments
| :: Int | |
| -> CreateThemeResponse |
Create a value of CreateThemeResponse 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:entity:CreateThemeResponse', createThemeResponse_entity - Describes the configuration of the new theme.
$sel:httpStatus:CreateThemeResponse', createThemeResponse_httpStatus - The response's http status code.
DeleteComponent
data DeleteComponent Source #
See: newDeleteComponent smart constructor.
Constructors
| DeleteComponent' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteComponent |
Create a value of DeleteComponent 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:
DeleteComponent, deleteComponent_appId - The unique ID of the Amplify app associated with the component to
delete.
DeleteComponent, deleteComponent_environmentName - The name of the backend environment that is a part of the Amplify app.
DeleteComponent, deleteComponent_id - The unique ID of the component to delete.
data DeleteComponentResponse Source #
See: newDeleteComponentResponse smart constructor.
Constructors
| DeleteComponentResponse' | |
Instances
newDeleteComponentResponse :: DeleteComponentResponse Source #
Create a value of DeleteComponentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteForm
data DeleteForm Source #
See: newDeleteForm smart constructor.
Constructors
| DeleteForm' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteForm |
Create a value of DeleteForm 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:
DeleteForm, deleteForm_appId - The unique ID of the Amplify app associated with the form to delete.
DeleteForm, deleteForm_environmentName - The name of the backend environment that is a part of the Amplify app.
DeleteForm, deleteForm_id - The unique ID of the form to delete.
data DeleteFormResponse Source #
See: newDeleteFormResponse smart constructor.
Constructors
| DeleteFormResponse' | |
Instances
newDeleteFormResponse :: DeleteFormResponse Source #
Create a value of DeleteFormResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteTheme
data DeleteTheme Source #
See: newDeleteTheme smart constructor.
Constructors
| DeleteTheme' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteTheme |
Create a value of DeleteTheme 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:
DeleteTheme, deleteTheme_appId - The unique ID of the Amplify app associated with the theme to delete.
DeleteTheme, deleteTheme_environmentName - The name of the backend environment that is a part of the Amplify app.
DeleteTheme, deleteTheme_id - The unique ID of the theme to delete.
data DeleteThemeResponse Source #
See: newDeleteThemeResponse smart constructor.
Constructors
| DeleteThemeResponse' | |
Instances
newDeleteThemeResponse :: DeleteThemeResponse Source #
Create a value of DeleteThemeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ExchangeCodeForToken
data ExchangeCodeForToken Source #
See: newExchangeCodeForToken smart constructor.
Instances
newExchangeCodeForToken Source #
Arguments
| :: TokenProviders | |
| -> ExchangeCodeForTokenRequestBody | |
| -> ExchangeCodeForToken |
Create a value of ExchangeCodeForToken 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:provider:ExchangeCodeForToken', exchangeCodeForToken_provider - The third-party provider for the token. The only valid value is figma.
$sel:request:ExchangeCodeForToken', exchangeCodeForToken_request - Describes the configuration of the request.
data ExchangeCodeForTokenResponse Source #
See: newExchangeCodeForTokenResponse smart constructor.
Instances
newExchangeCodeForTokenResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Int | |
| -> Text | |
| -> ExchangeCodeForTokenResponse |
Create a value of ExchangeCodeForTokenResponse 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:httpStatus:ExchangeCodeForTokenResponse', exchangeCodeForTokenResponse_httpStatus - The response's http status code.
$sel:accessToken:ExchangeCodeForTokenResponse', exchangeCodeForTokenResponse_accessToken - The access token.
$sel:expiresIn:ExchangeCodeForTokenResponse', exchangeCodeForTokenResponse_expiresIn - The date and time when the new access token expires.
$sel:refreshToken:ExchangeCodeForTokenResponse', exchangeCodeForTokenResponse_refreshToken - The token to use to refresh a previously issued access token that might
have expired.
ExportComponents (Paginated)
data ExportComponents Source #
See: newExportComponents smart constructor.
Constructors
| ExportComponents' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExportComponents |
Create a value of ExportComponents 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:
ExportComponents, exportComponents_nextToken - The token to request the next page of results.
ExportComponents, exportComponents_appId - The unique ID of the Amplify app to export components to.
ExportComponents, exportComponents_environmentName - The name of the backend environment that is a part of the Amplify app.
data ExportComponentsResponse Source #
See: newExportComponentsResponse smart constructor.
Constructors
| ExportComponentsResponse' (Maybe Text) Int [Component] |
Instances
newExportComponentsResponse Source #
Create a value of ExportComponentsResponse 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:
ExportComponents, exportComponentsResponse_nextToken - The pagination token that's included if more results are available.
$sel:httpStatus:ExportComponentsResponse', exportComponentsResponse_httpStatus - The response's http status code.
$sel:entities:ExportComponentsResponse', exportComponentsResponse_entities - Represents the configuration of the exported components.
ExportForms (Paginated)
data ExportForms Source #
See: newExportForms smart constructor.
Constructors
| ExportForms' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExportForms |
Create a value of ExportForms 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:
ExportForms, exportForms_nextToken - The token to request the next page of results.
ExportForms, exportForms_appId - The unique ID of the Amplify app to export forms to.
ExportForms, exportForms_environmentName - The name of the backend environment that is a part of the Amplify app.
data ExportFormsResponse Source #
See: newExportFormsResponse smart constructor.
Constructors
| ExportFormsResponse' (Maybe Text) Int [Form] |
Instances
newExportFormsResponse Source #
Arguments
| :: Int | |
| -> ExportFormsResponse |
Create a value of ExportFormsResponse 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:
ExportForms, exportFormsResponse_nextToken - The pagination token that's included if more results are available.
$sel:httpStatus:ExportFormsResponse', exportFormsResponse_httpStatus - The response's http status code.
$sel:entities:ExportFormsResponse', exportFormsResponse_entities - Represents the configuration of the exported forms.
ExportThemes (Paginated)
data ExportThemes Source #
See: newExportThemes smart constructor.
Constructors
| ExportThemes' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExportThemes |
Create a value of ExportThemes 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:
ExportThemes, exportThemes_nextToken - The token to request the next page of results.
ExportThemes, exportThemes_appId - The unique ID of the Amplify app to export the themes to.
ExportThemes, exportThemes_environmentName - The name of the backend environment that is part of the Amplify app.
data ExportThemesResponse Source #
See: newExportThemesResponse smart constructor.
Constructors
| ExportThemesResponse' (Maybe Text) Int [Theme] |
Instances
newExportThemesResponse Source #
Arguments
| :: Int | |
| -> ExportThemesResponse |
Create a value of ExportThemesResponse 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:
ExportThemes, exportThemesResponse_nextToken - The pagination token that's included if more results are available.
$sel:httpStatus:ExportThemesResponse', exportThemesResponse_httpStatus - The response's http status code.
$sel:entities:ExportThemesResponse', exportThemesResponse_entities - Represents the configuration of the exported themes.
GetComponent
data GetComponent Source #
See: newGetComponent smart constructor.
Constructors
| GetComponent' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetComponent |
Create a value of GetComponent 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:
GetComponent, getComponent_appId - The unique ID of the Amplify app.
GetComponent, getComponent_environmentName - The name of the backend environment that is part of the Amplify app.
GetComponent, getComponent_id - The unique ID of the component.
data GetComponentResponse Source #
See: newGetComponentResponse smart constructor.
Constructors
| GetComponentResponse' (Maybe Component) Int |
Instances
newGetComponentResponse Source #
Arguments
| :: Int | |
| -> GetComponentResponse |
Create a value of GetComponentResponse 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:component:GetComponentResponse', getComponentResponse_component - Represents the configuration settings for the component.
$sel:httpStatus:GetComponentResponse', getComponentResponse_httpStatus - The response's http status code.
GetForm
See: newGetForm smart constructor.
Instances
Create a value of GetForm 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:
GetForm, getForm_appId - The unique ID of the Amplify app.
GetForm, getForm_environmentName - The name of the backend environment that is part of the Amplify app.
GetForm, getForm_id - The unique ID of the form.
data GetFormResponse Source #
See: newGetFormResponse smart constructor.
Constructors
| GetFormResponse' (Maybe Form) Int |
Instances
Arguments
| :: Int | |
| -> GetFormResponse |
Create a value of GetFormResponse 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:form:GetFormResponse', getFormResponse_form - Represents the configuration settings for the form.
$sel:httpStatus:GetFormResponse', getFormResponse_httpStatus - The response's http status code.
GetMetadata
data GetMetadata Source #
See: newGetMetadata smart constructor.
Constructors
| GetMetadata' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetMetadata |
Create a value of GetMetadata 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:
GetMetadata, getMetadata_appId - The unique ID of the Amplify app.
GetMetadata, getMetadata_environmentName - The name of the backend environment that is part of the Amplify app.
data GetMetadataResponse Source #
See: newGetMetadataResponse smart constructor.
Constructors
| GetMetadataResponse' Int (HashMap Text Text) |
Instances
newGetMetadataResponse Source #
Arguments
| :: Int | |
| -> GetMetadataResponse |
Create a value of GetMetadataResponse 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:httpStatus:GetMetadataResponse', getMetadataResponse_httpStatus - The response's http status code.
$sel:features:GetMetadataResponse', getMetadataResponse_features - Represents the configuration settings for the features metadata.
GetTheme
See: newGetTheme smart constructor.
Instances
Create a value of GetTheme 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:
GetTheme, getTheme_appId - The unique ID of the Amplify app.
GetTheme, getTheme_environmentName - The name of the backend environment that is part of the Amplify app.
GetTheme, getTheme_id - The unique ID for the theme.
data GetThemeResponse Source #
See: newGetThemeResponse smart constructor.
Constructors
| GetThemeResponse' (Maybe Theme) Int |
Instances
Arguments
| :: Int | |
| -> GetThemeResponse |
Create a value of GetThemeResponse 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:theme:GetThemeResponse', getThemeResponse_theme - Represents the configuration settings for the theme.
$sel:httpStatus:GetThemeResponse', getThemeResponse_httpStatus - The response's http status code.
ListComponents (Paginated)
data ListComponents Source #
See: newListComponents smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListComponents |
Create a value of ListComponents 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:maxResults:ListComponents', listComponents_maxResults - The maximum number of components to retrieve.
ListComponents, listComponents_nextToken - The token to request the next page of results.
ListComponents, listComponents_appId - The unique ID for the Amplify app.
ListComponents, listComponents_environmentName - The name of the backend environment that is a part of the Amplify app.
data ListComponentsResponse Source #
See: newListComponentsResponse smart constructor.
Constructors
| ListComponentsResponse' (Maybe Text) Int [ComponentSummary] |
Instances
newListComponentsResponse Source #
Create a value of ListComponentsResponse 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:
ListComponents, listComponentsResponse_nextToken - The pagination token that's included if more results are available.
$sel:httpStatus:ListComponentsResponse', listComponentsResponse_httpStatus - The response's http status code.
$sel:entities:ListComponentsResponse', listComponentsResponse_entities - The list of components for the Amplify app.
ListForms (Paginated)
See: newListForms smart constructor.
Instances
Create a value of ListForms 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:maxResults:ListForms', listForms_maxResults - The maximum number of forms to retrieve.
ListForms, listForms_nextToken - The token to request the next page of results.
ListForms, listForms_appId - The unique ID for the Amplify app.
ListForms, listForms_environmentName - The name of the backend environment that is a part of the Amplify app.
data ListFormsResponse Source #
See: newListFormsResponse smart constructor.
Constructors
| ListFormsResponse' (Maybe Text) Int [FormSummary] |
Instances
Arguments
| :: Int | |
| -> ListFormsResponse |
Create a value of ListFormsResponse 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:
ListForms, listFormsResponse_nextToken - The pagination token that's included if more results are available.
$sel:httpStatus:ListFormsResponse', listFormsResponse_httpStatus - The response's http status code.
$sel:entities:ListFormsResponse', listFormsResponse_entities - The list of forms for the Amplify app.
ListThemes (Paginated)
data ListThemes Source #
See: newListThemes smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListThemes |
Create a value of ListThemes 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:maxResults:ListThemes', listThemes_maxResults - The maximum number of theme results to return in the response.
ListThemes, listThemes_nextToken - The token to request the next page of results.
ListThemes, listThemes_appId - The unique ID for the Amplify app.
ListThemes, listThemes_environmentName - The name of the backend environment that is a part of the Amplify app.
data ListThemesResponse Source #
See: newListThemesResponse smart constructor.
Constructors
| ListThemesResponse' (Maybe Text) Int [ThemeSummary] |
Instances
newListThemesResponse Source #
Arguments
| :: Int | |
| -> ListThemesResponse |
Create a value of ListThemesResponse 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:
ListThemes, listThemesResponse_nextToken - The pagination token that's returned if more results are available.
$sel:httpStatus:ListThemesResponse', listThemesResponse_httpStatus - The response's http status code.
$sel:entities:ListThemesResponse', listThemesResponse_entities - The list of themes for the Amplify app.
PutMetadataFlag
data PutMetadataFlag Source #
See: newPutMetadataFlag smart constructor.
Constructors
| PutMetadataFlag' Text PutMetadataFlagBody Text Text |
Instances
Arguments
| :: Text | |
| -> PutMetadataFlagBody | |
| -> Text | |
| -> Text | |
| -> PutMetadataFlag |
Create a value of PutMetadataFlag 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:
PutMetadataFlag, putMetadataFlag_appId - The unique ID for the Amplify app.
$sel:body:PutMetadataFlag', putMetadataFlag_body - The metadata information to store.
PutMetadataFlag, putMetadataFlag_environmentName - The name of the backend environment that is part of the Amplify app.
$sel:featureName:PutMetadataFlag', putMetadataFlag_featureName - The name of the feature associated with the metadata.
data PutMetadataFlagResponse Source #
See: newPutMetadataFlagResponse smart constructor.
Constructors
| PutMetadataFlagResponse' | |
Instances
newPutMetadataFlagResponse :: PutMetadataFlagResponse Source #
Create a value of PutMetadataFlagResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RefreshToken
data RefreshToken Source #
See: newRefreshToken smart constructor.
Constructors
| RefreshToken' TokenProviders RefreshTokenRequestBody |
Instances
Arguments
| :: TokenProviders | |
| -> RefreshTokenRequestBody | |
| -> RefreshToken |
Create a value of RefreshToken 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:provider:RefreshToken', refreshToken_provider - The third-party provider for the token. The only valid value is figma.
$sel:refreshTokenBody:RefreshToken', refreshToken_refreshTokenBody - Information about the refresh token request.
data RefreshTokenResponse Source #
See: newRefreshTokenResponse smart constructor.
Constructors
| RefreshTokenResponse' Int (Sensitive Text) Int |
Instances
newRefreshTokenResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Int | |
| -> RefreshTokenResponse |
Create a value of RefreshTokenResponse 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:httpStatus:RefreshTokenResponse', refreshTokenResponse_httpStatus - The response's http status code.
$sel:accessToken:RefreshTokenResponse', refreshTokenResponse_accessToken - The access token.
$sel:expiresIn:RefreshTokenResponse', refreshTokenResponse_expiresIn - The date and time when the new access token expires.
UpdateComponent
data UpdateComponent Source #
See: newUpdateComponent smart constructor.
Constructors
| UpdateComponent' (Maybe Text) Text Text Text UpdateComponentData |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateComponentData | |
| -> UpdateComponent |
Create a value of UpdateComponent 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:clientToken:UpdateComponent', updateComponent_clientToken - The unique client token.
UpdateComponent, updateComponent_appId - The unique ID for the Amplify app.
UpdateComponent, updateComponent_environmentName - The name of the backend environment that is part of the Amplify app.
UpdateComponent, updateComponent_id - The unique ID for the component.
$sel:updatedComponent:UpdateComponent', updateComponent_updatedComponent - The configuration of the updated component.
data UpdateComponentResponse Source #
See: newUpdateComponentResponse smart constructor.
Constructors
| UpdateComponentResponse' (Maybe Component) Int |
Instances
newUpdateComponentResponse Source #
Create a value of UpdateComponentResponse 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:entity:UpdateComponentResponse', updateComponentResponse_entity - Describes the configuration of the updated component.
$sel:httpStatus:UpdateComponentResponse', updateComponentResponse_httpStatus - The response's http status code.
UpdateForm
data UpdateForm Source #
See: newUpdateForm smart constructor.
Constructors
| UpdateForm' (Maybe Text) Text Text Text UpdateFormData |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateFormData | |
| -> UpdateForm |
Create a value of UpdateForm 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:clientToken:UpdateForm', updateForm_clientToken - The unique client token.
UpdateForm, updateForm_appId - The unique ID for the Amplify app.
UpdateForm, updateForm_environmentName - The name of the backend environment that is part of the Amplify app.
UpdateForm, updateForm_id - The unique ID for the form.
$sel:updatedForm:UpdateForm', updateForm_updatedForm - The request accepts the following data in JSON format.
data UpdateFormResponse Source #
See: newUpdateFormResponse smart constructor.
Constructors
| UpdateFormResponse' (Maybe Form) Int |
Instances
newUpdateFormResponse Source #
Arguments
| :: Int | |
| -> UpdateFormResponse |
Create a value of UpdateFormResponse 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:entity:UpdateFormResponse', updateFormResponse_entity - Describes the configuration of the updated form.
$sel:httpStatus:UpdateFormResponse', updateFormResponse_httpStatus - The response's http status code.
UpdateTheme
data UpdateTheme Source #
See: newUpdateTheme smart constructor.
Constructors
| UpdateTheme' (Maybe Text) Text Text Text UpdateThemeData |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateThemeData | |
| -> UpdateTheme |
Create a value of UpdateTheme 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:clientToken:UpdateTheme', updateTheme_clientToken - The unique client token.
UpdateTheme, updateTheme_appId - The unique ID for the Amplify app.
UpdateTheme, updateTheme_environmentName - The name of the backend environment that is part of the Amplify app.
UpdateTheme, updateTheme_id - The unique ID for the theme.
$sel:updatedTheme:UpdateTheme', updateTheme_updatedTheme - The configuration of the updated theme.
data UpdateThemeResponse Source #
See: newUpdateThemeResponse smart constructor.
Constructors
| UpdateThemeResponse' (Maybe Theme) Int |
Instances
newUpdateThemeResponse Source #
Arguments
| :: Int | |
| -> UpdateThemeResponse |
Create a value of UpdateThemeResponse 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:entity:UpdateThemeResponse', updateThemeResponse_entity - Describes the configuration of the updated theme.
$sel:httpStatus:UpdateThemeResponse', updateThemeResponse_httpStatus - The response's http status code.
Types
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
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.
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
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.
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' (Maybe ComponentBindingPropertiesValueProperties) (Maybe Text) (Maybe Text) |
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.
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' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Predicate]) (Maybe Text) (Maybe Text) |
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.
ComponentChild
data ComponentChild Source #
A nested UI configuration within a parent Component.
See: newComponentChild smart constructor.
Constructors
| ComponentChild' (Maybe [ComponentChild]) (Maybe (HashMap Text ComponentEvent)) (Maybe Text) Text Text (HashMap Text ComponentProperty) |
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.
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' (Maybe ComponentProperty) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ComponentProperty) |
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.
ComponentDataConfiguration
data ComponentDataConfiguration Source #
Describes the configuration for binding a component's properties to data.
See: newComponentDataConfiguration smart constructor.
Constructors
| ComponentDataConfiguration' (Maybe [Text]) (Maybe Predicate) (Maybe [SortProperty]) Text |
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.
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' (Maybe Text) (Maybe Text) (Maybe ActionParameters) |
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.
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
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.
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' (Maybe Text) Text |
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.
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.
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.
ComponentVariant
data ComponentVariant Source #
Describes the style configuration of a unique variation of a main component.
See: newComponentVariant smart constructor.
Constructors
| ComponentVariant' (Maybe (HashMap Text (HashMap Text Text))) (Maybe (HashMap Text Text)) |
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.
CreateComponentData
data CreateComponentData Source #
Represents all of the information that is required to create a component.
See: newCreateComponentData smart constructor.
Constructors
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.
CreateFormData
data CreateFormData Source #
Represents all of the information that is required to create a form.
See: newCreateFormData smart constructor.
Constructors
| CreateFormData' (Maybe FormCTA) (Maybe (HashMap Text Text)) FormDataTypeConfig (HashMap Text FieldConfig) FormActionType Text Text (HashMap Text SectionalElement) FormStyle |
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.
CreateThemeData
data CreateThemeData Source #
Represents all of the information that is required to create a theme.
See: newCreateThemeData smart constructor.
Constructors
| CreateThemeData' (Maybe [ThemeValues]) (Maybe (HashMap Text Text)) Text [ThemeValues] |
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.
ExchangeCodeForTokenRequestBody
data ExchangeCodeForTokenRequestBody Source #
Describes the configuration of a request to exchange an access code for a token.
See: newExchangeCodeForTokenRequestBody smart constructor.
Constructors
| ExchangeCodeForTokenRequestBody' (Sensitive Text) Text |
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.
FieldConfig
data FieldConfig Source #
Describes the configuration information for a field in a table.
See: newFieldConfig smart constructor.
Constructors
| FieldConfig' (Maybe Bool) (Maybe FieldInputConfig) (Maybe Text) (Maybe FieldPosition) (Maybe [FieldValidationConfiguration]) |
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.
FieldInputConfig
data FieldInputConfig Source #
Describes the configuration for the default input values to display for a field.
See: newFieldInputConfig smart constructor.
Constructors
| FieldInputConfig' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Double) (Maybe Text) (Maybe ValueMappings) Text |
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.
FieldPosition
data FieldPosition Source #
Describes the field position.
See: newFieldPosition smart constructor.
Constructors
| FieldPosition' (Maybe Text) (Maybe FixedPosition) (Maybe Text) |
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.
FieldValidationConfiguration
data FieldValidationConfiguration Source #
Describes the validation configuration for a field.
See: newFieldValidationConfiguration smart constructor.
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.
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' (Maybe FormCTA) (Maybe (HashMap Text Text)) Text FormDataTypeConfig Text (HashMap Text FieldConfig) FormActionType Text Text Text (HashMap Text SectionalElement) FormStyle |
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.
FormBindingElement
data FormBindingElement Source #
Describes how to bind a component property to form data.
See: newFormBindingElement smart constructor.
Constructors
| FormBindingElement' Text Text |
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.
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' (Maybe Text) (Maybe Bool) (Maybe FieldPosition) |
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.
FormCTA
Describes the call to action button configuration for the form.
See: newFormCTA smart constructor.
Constructors
| FormCTA' (Maybe FormButton) (Maybe FormButton) (Maybe FormButtonsPosition) (Maybe FormButton) |
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.
FormDataTypeConfig
data FormDataTypeConfig Source #
Describes the data type configuration for the data source associated with a form.
See: newFormDataTypeConfig smart constructor.
Constructors
| FormDataTypeConfig' FormDataSourceType Text |
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.
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' (Maybe Text) |
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.
FormStyle
Describes the configuration for the form's style.
See: newFormStyle smart constructor.
Constructors
| FormStyle' (Maybe FormStyleConfig) (Maybe FormStyleConfig) (Maybe FormStyleConfig) |
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.
FormStyleConfig
data FormStyleConfig Source #
Describes the configuration settings for the form's style properties.
See: newFormStyleConfig smart constructor.
Constructors
| FormStyleConfig' (Maybe Text) (Maybe Text) |
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.
FormSummary
data FormSummary Source #
Describes the basic information about a form.
See: newFormSummary smart constructor.
Constructors
| FormSummary' Text FormDataTypeConfig Text FormActionType Text Text |
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.
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' Text Text ComponentProperty |
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.
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' (Maybe [Predicate]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Predicate]) |
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.
PutMetadataFlagBody
data PutMetadataFlagBody Source #
Stores the metadata information about a feature on a form or view.
See: newPutMetadataFlagBody smart constructor.
Constructors
| PutMetadataFlagBody' Text |
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.
RefreshTokenRequestBody
data RefreshTokenRequestBody Source #
Describes a refresh token.
See: newRefreshTokenRequestBody smart constructor.
Constructors
| RefreshTokenRequestBody' (Sensitive Text) |
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.
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' (Maybe Int) (Maybe Text) (Maybe FieldPosition) (Maybe Text) Text |
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.
SortProperty
data SortProperty Source #
Describes how to sort the data that you bind to a component.
See: newSortProperty smart constructor.
Constructors
| SortProperty' SortDirection Text |
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.
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' (Maybe ISO8601) (Maybe [ThemeValues]) (Maybe (HashMap Text Text)) Text ISO8601 Text Text Text [ThemeValues] |
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.
ThemeSummary
data ThemeSummary Source #
Describes the basic information about a theme.
See: newThemeSummary smart constructor.
Constructors
| ThemeSummary' Text Text Text Text |
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.
ThemeValue
data ThemeValue Source #
Describes the configuration of a theme's properties.
See: newThemeValue smart constructor.
Constructors
| ThemeValue' (Maybe [ThemeValues]) (Maybe Text) |
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.
ThemeValues
data ThemeValues Source #
A key-value pair that defines a property of a theme.
See: newThemeValues smart constructor.
Constructors
| ThemeValues' (Maybe Text) (Maybe ThemeValue) |
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.
UpdateComponentData
data UpdateComponentData Source #
Updates and saves all of the information about a component, based on component ID.
See: newUpdateComponentData smart constructor.
Constructors
| UpdateComponentData' (Maybe (HashMap Text ComponentBindingPropertiesValue)) (Maybe [ComponentChild]) (Maybe (HashMap Text ComponentDataConfiguration)) (Maybe Text) (Maybe (HashMap Text ComponentEvent)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe (HashMap Text ComponentProperty)) (Maybe Text) (Maybe Text) (Maybe [ComponentVariant]) |
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.
UpdateFormData
data UpdateFormData Source #
Updates and saves all of the information about a form, based on form ID.
See: newUpdateFormData smart constructor.
Constructors
| UpdateFormData' (Maybe FormCTA) (Maybe FormDataTypeConfig) (Maybe (HashMap Text FieldConfig)) (Maybe FormActionType) (Maybe Text) (Maybe Text) (Maybe (HashMap Text SectionalElement)) (Maybe FormStyle) |
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.
UpdateThemeData
data UpdateThemeData Source #
Saves the data binding information for a theme.
See: newUpdateThemeData smart constructor.
Constructors
| UpdateThemeData' (Maybe Text) (Maybe Text) (Maybe [ThemeValues]) [ThemeValues] |
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.
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' (Maybe FormInputValueProperty) FormInputValueProperty |
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.
ValueMappings
data ValueMappings Source #
Represents the data binding configuration for a value map.
See: newValueMappings smart constructor.
Constructors
| ValueMappings' [ValueMapping] |
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.