UpdateComponentData - AmplifyUIBuilder

UpdateComponentData

Updates and saves all of the information about a component, based on component ID.

Contents

bindingProperties

The data binding information for the component's properties.

Type: String to ComponentBindingPropertiesValue object map

Required: No

children

The components that are instances of the main component.

Type: Array of ComponentChild objects

Required: No

collectionProperties

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

Type: String to ComponentDataConfiguration object map

Required: No

componentType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

events

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

Type: String to ComponentEvent object map

Required: No

id

The unique ID of the component to update.

Type: String

Required: No

name

The name of the component to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

overrides

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

Type: String to string to string map map

Required: No

properties

Describes the component's properties.

Type: String to ComponentProperty object map

Required: No

schemaVersion

The schema version of the component when it was imported.

Type: String

Required: No

sourceId

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

Type: String

Required: No

variants

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

Type: Array of ComponentVariant objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: