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.
Contents
- appId
-
The unique ID of the Amplify app associated with the form.
Type: String
Required: Yes
- dataType
-
The type of data source to use to create the form.
Type: FormDataTypeConfig object
Required: Yes
- environmentName
-
The name of the backend environment that is a part of the Amplify app.
Type: String
Required: Yes
- fields
-
Stores the information about the form's fields.
Type: String to FieldConfig object map
Required: Yes
- formActionType
-
The operation to perform on the specified form.
Type: String
Valid Values:
create | updateRequired: Yes
- id
-
The unique ID of the form.
Type: String
Required: Yes
- name
-
The name of the form.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- schemaVersion
-
The schema version of the form when it was imported.
Type: String
Required: Yes
- sectionalElements
-
Stores the visual helper elements for the form that are not associated with any data.
Type: String to SectionalElement object map
Required: Yes
- style
-
Stores the configuration for the form's style.
Type: FormStyle object
Required: Yes
- cta
-
Stores the call to action configuration for the form.
Type: FormCTA object
Required: No
- labelDecorator
-
Specifies an icon or decoration to display on the form.
Type: String
Valid Values:
required | optional | noneRequired: No
-
One or more key-value pairs to use when tagging the form.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
(?!aws:)[a-zA-Z+-=._:/]+Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
