Skip to content

CreateFormData

Source code in docs_src/capo_amplifyuibuilder/types/create_form_data.py
class CreateFormData(TypedDict, closed=True):
    name: "capo_amplifyuibuilder.types.form_name.FormName"
    """<p>The name of the form.</p>"""
    data_type: "capo_amplifyuibuilder.types.form_data_type_config.FormDataTypeConfig"
    """<p>The type of data source to use to create the form.</p>"""
    form_action_type: "capo_amplifyuibuilder.types.form_action_type.FormActionType"
    """<p>Specifies whether to perform a create or update action on the form.</p>"""
    fields: "capo_amplifyuibuilder.types.fields_map.FieldsMap"
    """<p>The configuration information for the form's fields.</p>"""
    style: "capo_amplifyuibuilder.types.form_style.FormStyle"
    """<p>The configuration for the form's style.</p>"""
    sectional_elements: (
        "capo_amplifyuibuilder.types.sectional_element_map.SectionalElementMap"
    )
    """<p>The configuration information for the visual helper elements for the form. These elements are not associated with any data.</p>"""
    schema_version: "str"
    """<p>The schema version of the form.</p>"""
    cta: NotRequired["capo_amplifyuibuilder.types.form_cta.FormCTA"]
    """<p>The <code>FormCTA</code> object that stores the call to action configuration for the form.</p>"""
    tags: NotRequired["capo_amplifyuibuilder.types.tags.Tags"]
    """<p>One or more key-value pairs to use when tagging the form data.</p>"""
    label_decorator: NotRequired[
        "capo_amplifyuibuilder.types.label_decorator.LabelDecorator"
    ]
    """<p>Specifies an icon or decoration to display on the form.</p>"""

cta instance-attribute

cta: NotRequired[FormCTA]

The FormCTA object that stores the call to action configuration for the form.

data_type instance-attribute

data_type: FormDataTypeConfig

The type of data source to use to create the form.

fields instance-attribute

fields: FieldsMap

The configuration information for the form's fields.

form_action_type instance-attribute

form_action_type: FormActionType

Specifies whether to perform a create or update action on the form.

label_decorator instance-attribute

label_decorator: NotRequired[LabelDecorator]

Specifies an icon or decoration to display on the form.

name instance-attribute

name: FormName

The name of the form.

schema_version instance-attribute

schema_version: str

The schema version of the form.

sectional_elements instance-attribute

sectional_elements: SectionalElementMap

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

style instance-attribute

style: FormStyle

The configuration for the form's style.

tags instance-attribute

tags: NotRequired[Tags]

One or more key-value pairs to use when tagging the form data.