Skip to content
AWS for Query.Farm

aws.amplifyuibuilder.get_form

Example SQL Queries

SELECT * FROM
aws.amplifyuibuilder.get_form
WHERE
"app_id" = 'VALUE'
AND "environment_name" = 'VALUE'
AND "id" = 'VALUE';

Description

Returns an existing form for an Amplify app.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The unique ID of the Amplify app.

VARCHAR
environment_name Required Input Column

The name of the backend environment that is part of the Amplify app.

VARCHAR
id Required Input Column

The unique ID of the form.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
form

Represents the configuration settings for the form.

STRUCT(
    "app_id" VARCHAR,
    "environment_name" VARCHAR,
    "id" VARCHAR,
    "name" VARCHAR,
    "form_action_type" VARCHAR,
    "style" STRUCT(
        "horizontal_gap" STRUCT(
            "token_reference" VARCHAR,
            "value" VARCHAR
        ),
        "vertical_gap" STRUCT(
            "token_reference" VARCHAR,
            "value" VARCHAR
        ),
        "outer_padding" STRUCT(
            "token_reference" VARCHAR,
            "value" VARCHAR
        )
    ),
    "data_type" STRUCT(
        "data_source_type" VARCHAR,
        "data_type_name" VARCHAR
    ),
    "fields" MAP(VARCHAR, STRUCT(
            "label" VARCHAR,
            "position" STRUCT(
                "fixed" VARCHAR,
                "right_of" VARCHAR,
                "below" VARCHAR
            ),
            "excluded" BOOLEAN,
            "input_type" STRUCT(
                "type" VARCHAR,
                "required" BOOLEAN,
                "read_only" BOOLEAN,
                "placeholder" VARCHAR,
                "default_value" VARCHAR,
                "descriptive_text" VARCHAR,
                "default_checked" BOOLEAN,
                "default_country_code" VARCHAR,
                "value_mappings" STRUCT(
                    "values" STRUCT(
                        "display_value" STRUCT(
                            "value" VARCHAR,
                            "binding_properties" STRUCT(
                                "property" VARCHAR,
                                "field" VARCHAR
                            )
                        ),
                        "value" STRUCT(
                            "value" VARCHAR,
                            "binding_properties" STRUCT(
                                "property" VARCHAR,
                                "field" VARCHAR
                            )
                        )
                    )[],
                    "binding_properties" MAP(VARCHAR, STRUCT(
                            "type" VARCHAR,
                            "binding_properties" STRUCT(
                                "model" VARCHAR
                            )
                        ))
                ),
                "name" VARCHAR,
                "min_value" DOUBLE,
                "max_value" DOUBLE,
                "step" DOUBLE,
                "value" VARCHAR,
                "is_array" BOOLEAN,
                "file_uploader_config" STRUCT(
                    "access_level" VARCHAR,
                    "accepted_file_types" VARCHAR[],
                    "show_thumbnails" BOOLEAN,
                    "is_resumable" BOOLEAN,
                    "max_file_count" BIGINT,
                    "max_size" BIGINT
                )
            ),
            "validations" STRUCT(
                "type" VARCHAR,
                "str_values" VARCHAR[],
                "num_values" BIGINT[],
                "validation_message" VARCHAR
            )[]
        )),
    "sectional_elements" MAP(VARCHAR, STRUCT(
            "type" VARCHAR,
            "position" STRUCT(
                "fixed" VARCHAR,
                "right_of" VARCHAR,
                "below" VARCHAR
            ),
            "text" VARCHAR,
            "level" BIGINT,
            "orientation" VARCHAR,
            "excluded" BOOLEAN
        )),
    "schema_version" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "cta" STRUCT(
        "position" VARCHAR,
        "clear" STRUCT(
            "excluded" BOOLEAN,
            "children" VARCHAR,
            "position" STRUCT(
                "fixed" VARCHAR,
                "right_of" VARCHAR,
                "below" VARCHAR
            )
        ),
        "cancel" STRUCT(
            "excluded" BOOLEAN,
            "children" VARCHAR,
            "position" STRUCT(
                "fixed" VARCHAR,
                "right_of" VARCHAR,
                "below" VARCHAR
            )
        ),
        "submit" STRUCT(
            "excluded" BOOLEAN,
            "children" VARCHAR,
            "position" STRUCT(
                "fixed" VARCHAR,
                "right_of" VARCHAR,
                "below" VARCHAR
            )
        )
    ),
    "label_decorator" VARCHAR
)
Show child fields
form.app_id

The unique ID of the Amplify app associated with the form.

form.cta

Stores the call to action configuration for the form.

Show child fields
form.cta.cancel

Displays a cancel button.

Show child fields
form.cta.cancel.children

Describes the button's properties.

form.cta.cancel.excluded

Specifies whether the button is visible on the form.

form.cta.cancel.position

The position of the button.

Show child fields
form.cta.cancel.position.below

The field position is below the field specified by the string.

form.cta.cancel.position.fixed

The field position is fixed and doesn't change in relation to other fields.

form.cta.cancel.position.right_of

The field position is to the right of the field specified by the string.

form.cta.clear

Displays a clear button.

Show child fields
form.cta.clear.children

Describes the button's properties.

form.cta.clear.excluded

Specifies whether the button is visible on the form.

form.cta.clear.position

The position of the button.

Show child fields
form.cta.clear.position.below

The field position is below the field specified by the string.

form.cta.clear.position.fixed

The field position is fixed and doesn't change in relation to other fields.

form.cta.clear.position.right_of

The field position is to the right of the field specified by the string.

form.cta.position

The position of the button.

form.cta.submit

Displays a submit button.

Show child fields
form.cta.submit.children

Describes the button's properties.

form.cta.submit.excluded

Specifies whether the button is visible on the form.

form.cta.submit.position

The position of the button.

Show child fields
form.cta.submit.position.below

The field position is below the field specified by the string.

form.cta.submit.position.fixed

The field position is fixed and doesn't change in relation to other fields.

form.cta.submit.position.right_of

The field position is to the right of the field specified by the string.

form.data_type

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

Show child fields
form.data_type.data_source_type

The data source type, either an Amplify DataStore model or a custom data type.

form.data_type.data_type_name

The unique name of the data type you are using as the data source for the form.

form.environment_name

The name of the backend environment that is a part of the Amplify app.

form.fields

Stores the information about the form's fields.

form.form_action_type

The operation to perform on the specified form.

form.id

The unique ID of the form.

form.label_decorator

Specifies an icon or decoration to display on the form.

form.name

The name of the form.

form.schema_version

The schema version of the form when it was imported.

form.sectional_elements

Stores the visual helper elements for the form that are not associated with any data.

form.style

Stores the configuration for the form's style.

Show child fields
form.style.horizontal_gap

The spacing for the horizontal gap.

Show child fields
form.style.horizontal_gap.token_reference

A reference to a design token to use to bind the form's style properties to an existing theme.

form.style.horizontal_gap.value

The value of the style setting.

form.style.outer_padding

The size of the outer padding for the form.

Show child fields
form.style.outer_padding.token_reference

A reference to a design token to use to bind the form's style properties to an existing theme.

form.style.outer_padding.value

The value of the style setting.

form.style.vertical_gap

The spacing for the vertical gap.

Show child fields
form.style.vertical_gap.token_reference

A reference to a design token to use to bind the form's style properties to an existing theme.

form.style.vertical_gap.value

The value of the style setting.

form.tags

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