aws.amplifyuibuilder.get_component

Example SQL Queries

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

Description

Returns an existing component for an Amplify app.

• View All AmplifyUIBuilder Tables
• Boto3 Reference

Table Definition

Column Name	Column 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 component.	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
component Represents the configuration settings for the component.	STRUCT( "app_id" VARCHAR, "environment_name" VARCHAR, "source_id" VARCHAR, "id" VARCHAR, "name" VARCHAR, "component_type" VARCHAR, "properties" MAP(VARCHAR, STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR )), "children" STRUCT( "component_type" VARCHAR, "name" VARCHAR, "properties" MAP(VARCHAR, STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR )), "events" MAP(VARCHAR, STRUCT( "action" VARCHAR, "parameters" STRUCT( "type" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "url" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "anchor" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "target" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "global" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "model" VARCHAR, "id" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "fields" MAP(VARCHAR, STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR )), "state" STRUCT( "component_name" VARCHAR, "property" VARCHAR, "set" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ) ) ), "binding_event" VARCHAR )), "source_id" VARCHAR )[], "variants" STRUCT( "variant_values" MAP(VARCHAR, VARCHAR), "overrides" MAP(VARCHAR, MAP(VARCHAR, VARCHAR)) )[], "overrides" MAP(VARCHAR, MAP(VARCHAR, VARCHAR)), "binding_properties" MAP(VARCHAR, STRUCT( "type" VARCHAR, "binding_properties" STRUCT( "model" VARCHAR, "field" VARCHAR, "predicates" STRUCT( "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR )[], "user_attribute" VARCHAR, "bucket" VARCHAR, "key" VARCHAR, "default_value" VARCHAR, "slot_name" VARCHAR ), "default_value" VARCHAR )), "collection_properties" MAP(VARCHAR, STRUCT( "model" VARCHAR, "sort" STRUCT( "field" VARCHAR, "direction" VARCHAR )[], "predicate" STRUCT( "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "identifiers" VARCHAR[] )), "created_at" TIMESTAMP_S, "modified_at" TIMESTAMP_S, "tags" MAP(VARCHAR, VARCHAR), "events" MAP(VARCHAR, STRUCT( "action" VARCHAR, "parameters" STRUCT( "type" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "url" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "anchor" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "target" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "global" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "model" VARCHAR, "id" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ), "fields" MAP(VARCHAR, STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR )), "state" STRUCT( "component_name" VARCHAR, "property" VARCHAR, "set" STRUCT( "value" VARCHAR, "binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "collection_binding_properties" STRUCT( "property" VARCHAR, "field" VARCHAR ), "default_value" VARCHAR, "model" VARCHAR, "bindings" MAP(VARCHAR, STRUCT( "element" VARCHAR, "property" VARCHAR )), "event" VARCHAR, "user_attribute" VARCHAR, "condition" STRUCT( "property" VARCHAR, "field" VARCHAR, "operator" VARCHAR, "operand" VARCHAR, "operand_type" VARCHAR ), "configured" BOOLEAN, "type" VARCHAR, "imported_value" VARCHAR, "component_name" VARCHAR, "property" VARCHAR ) ) ), "binding_event" VARCHAR )), "schema_version" VARCHAR )
Show child fields component.app_id The unique ID of the Amplify app associated with the component. component.binding_properties The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties. component.children[] Show child fields component.children[].component_type The type of the child component. component.children[].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. component.children[].name The name of the child component. component.children[].properties Describes the properties of the child component. You can't specify tags as a valid property for properties. component.children[].source_id The unique ID of the child component in its original source system, such as Figma. component.collection_properties 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_type The type of the component. This can be an Amplify custom UI component or another custom component. component.created_at The time that the component was created. component.environment_name The name of the backend environment that is a part of the Amplify app. 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. component.id The unique ID of the component. component.modified_at The time that the component was modified. component.name The name of the 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.properties Describes the component's properties. You can't specify tags as a valid property for properties. component.schema_version The schema version of the component when it was imported. component.source_id The unique ID of the component in its original source system, such as Figma. component.tags One or more key-value pairs to use when tagging the component. component.variants[] Show child fields component.variants[].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. component.variants[].variant_values The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.