Skip to content

UpdateComponentData

Source code in docs_src/capo_amplifyuibuilder/types/update_component_data.py
class UpdateComponentData(TypedDict, closed=True):
    id: NotRequired["capo_amplifyuibuilder.types.uuid.Uuid"]
    """<p>The unique ID of the component to update.</p>"""
    name: NotRequired["capo_amplifyuibuilder.types.component_name.ComponentName"]
    """<p>The name of the component to update.</p>"""
    source_id: NotRequired["str"]
    """<p>The unique ID of the component in its original source system, such as Figma.</p>"""
    component_type: NotRequired[
        "capo_amplifyuibuilder.types.component_type.ComponentType"
    ]
    """<p>The type of the component. This can be an Amplify custom UI component or another custom component.</p>"""
    properties: NotRequired[
        "capo_amplifyuibuilder.types.component_properties.ComponentProperties"
    ]
    """<p>Describes the component's properties.</p>"""
    children: NotRequired[
        "capo_amplifyuibuilder.types.component_child_list.ComponentChildList"
    ]
    """<p>The components that are instances of the main component.</p>"""
    variants: NotRequired[
        "capo_amplifyuibuilder.types.component_variants.ComponentVariants"
    ]
    """<p>A list of the unique variants of the main component being updated.</p>"""
    overrides: NotRequired[
        "capo_amplifyuibuilder.types.component_overrides.ComponentOverrides"
    ]
    """<p>Describes the properties that can be overriden to customize the component.</p>"""
    binding_properties: NotRequired[
        "capo_amplifyuibuilder.types.component_binding_properties.ComponentBindingProperties"
    ]
    """<p>The data binding information for the component's properties.</p>"""
    collection_properties: NotRequired[
        "capo_amplifyuibuilder.types.component_collection_properties.ComponentCollectionProperties"
    ]
    """<p>The configuration for binding a component's properties to a data model. Use this for a collection component.</p>"""
    events: NotRequired["capo_amplifyuibuilder.types.component_events.ComponentEvents"]
    """<p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"""
    schema_version: NotRequired["str"]
    """<p>The schema version of the component when it was imported.</p>"""

binding_properties instance-attribute

binding_properties: NotRequired[ComponentBindingProperties]

The data binding information for the component's properties.

children instance-attribute

children: NotRequired[ComponentChildList]

The components that are instances of the main component.

collection_properties instance-attribute

collection_properties: NotRequired[ComponentCollectionProperties]

The configuration for binding a component's properties to a data model. Use this for a collection component.

component_type instance-attribute

component_type: NotRequired[ComponentType]

The type of the component. This can be an Amplify custom UI component or another custom component.

events instance-attribute

events: NotRequired[ComponentEvents]

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

id instance-attribute

id: NotRequired[Uuid]

The unique ID of the component to update.

name instance-attribute

name: NotRequired[ComponentName]

The name of the component to update.

overrides instance-attribute

overrides: NotRequired[ComponentOverrides]

Describes the properties that can be overriden to customize the component.

properties instance-attribute

properties: NotRequired[ComponentProperties]

Describes the component's properties.

schema_version instance-attribute

schema_version: NotRequired[str]

The schema version of the component when it was imported.

source_id instance-attribute

source_id: NotRequired[str]

The unique ID of the component in its original source system, such as Figma.

variants instance-attribute

variants: NotRequired[ComponentVariants]

A list of the unique variants of the main component being updated.