Form ¶

class Form(TypedDict, closed=True):
    app_id: "str"
    """<p>The unique ID of the Amplify app associated with the form.</p>"""
    environment_name: "str"
    """<p>The name of the backend environment that is a part of the Amplify app.</p>"""
    id: "capo_amplifyuibuilder.types.uuid.Uuid"
    """<p>The unique ID of the form.</p>"""
    name: "capo_amplifyuibuilder.types.form_name.FormName"
    """<p>The name of the form.</p>"""
    form_action_type: "capo_amplifyuibuilder.types.form_action_type.FormActionType"
    """<p>The operation to perform on the specified form.</p>"""
    style: "capo_amplifyuibuilder.types.form_style.FormStyle"
    """<p>Stores the configuration for the form's style.</p>"""
    data_type: "capo_amplifyuibuilder.types.form_data_type_config.FormDataTypeConfig"
    """<p>The type of data source to use to create the form.</p>"""
    fields: "capo_amplifyuibuilder.types.fields_map.FieldsMap"
    """<p>Stores the information about the form's fields.</p>"""
    sectional_elements: (
        "capo_amplifyuibuilder.types.sectional_element_map.SectionalElementMap"
    )
    """<p>Stores the visual helper elements for the form that are not associated with any data.</p>"""
    schema_version: "str"
    """<p>The schema version of the form when it was imported.</p>"""
    tags: NotRequired["capo_amplifyuibuilder.types.tags.Tags"]
    """<p>One or more key-value pairs to use when tagging the form.</p>"""
    cta: NotRequired["capo_amplifyuibuilder.types.form_cta.FormCTA"]
    """<p>Stores the call to action configuration for the form.</p>"""
    label_decorator: NotRequired[
        "capo_amplifyuibuilder.types.label_decorator.LabelDecorator"
    ]
    """<p>Specifies an icon or decoration to display on the form.</p>"""