class Aws::AmplifyUIBuilder::Types::UpdateComponentData

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

@note When making an API call, you may pass UpdateComponentData

data as a hash:

    {
      binding_properties: {
        "String" => {
          binding_properties: {
            bucket: "String",
            default_value: "String",
            field: "String",
            key: "String",
            model: "String",
            predicates: [
              {
                and: {
                  # recursive PredicateList
                },
                field: "String",
                operand: "String",
                operator: "String",
                or: {
                  # recursive PredicateList
                },
              },
            ],
            user_attribute: "String",
          },
          default_value: "String",
          type: "String",
        },
      },
      children: [
        {
          children: {
            # recursive ComponentChildList
          },
          component_type: "String", # required
          events: {
            "String" => {
              action: "String",
              binding_event: "String",
              parameters: {
                anchor: {
                  binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  bindings: {
                    "String" => {
                      element: "String", # required
                      property: "String", # required
                    },
                  },
                  collection_binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  component_name: "String",
                  concat: [
                    {
                      # recursive ComponentProperty
                    },
                  ],
                  condition: {
                    else: {
                      # recursive ComponentProperty
                    },
                    field: "String",
                    operand: "String",
                    operand_type: "String",
                    operator: "String",
                    property: "String",
                    then: {
                      # recursive ComponentProperty
                    },
                  },
                  configured: false,
                  default_value: "String",
                  event: "String",
                  imported_value: "String",
                  model: "String",
                  property: "String",
                  type: "String",
                  user_attribute: "String",
                  value: "String",
                },
                fields: {
                  "String" => {
                    binding_properties: {
                      field: "String",
                      property: "String", # required
                    },
                    bindings: {
                      "String" => {
                        element: "String", # required
                        property: "String", # required
                      },
                    },
                    collection_binding_properties: {
                      field: "String",
                      property: "String", # required
                    },
                    component_name: "String",
                    concat: [
                      {
                        # recursive ComponentProperty
                      },
                    ],
                    condition: {
                      else: {
                        # recursive ComponentProperty
                      },
                      field: "String",
                      operand: "String",
                      operand_type: "String",
                      operator: "String",
                      property: "String",
                      then: {
                        # recursive ComponentProperty
                      },
                    },
                    configured: false,
                    default_value: "String",
                    event: "String",
                    imported_value: "String",
                    model: "String",
                    property: "String",
                    type: "String",
                    user_attribute: "String",
                    value: "String",
                  },
                },
                global: {
                  binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  bindings: {
                    "String" => {
                      element: "String", # required
                      property: "String", # required
                    },
                  },
                  collection_binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  component_name: "String",
                  concat: [
                    {
                      # recursive ComponentProperty
                    },
                  ],
                  condition: {
                    else: {
                      # recursive ComponentProperty
                    },
                    field: "String",
                    operand: "String",
                    operand_type: "String",
                    operator: "String",
                    property: "String",
                    then: {
                      # recursive ComponentProperty
                    },
                  },
                  configured: false,
                  default_value: "String",
                  event: "String",
                  imported_value: "String",
                  model: "String",
                  property: "String",
                  type: "String",
                  user_attribute: "String",
                  value: "String",
                },
                id: {
                  binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  bindings: {
                    "String" => {
                      element: "String", # required
                      property: "String", # required
                    },
                  },
                  collection_binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  component_name: "String",
                  concat: [
                    {
                      # recursive ComponentProperty
                    },
                  ],
                  condition: {
                    else: {
                      # recursive ComponentProperty
                    },
                    field: "String",
                    operand: "String",
                    operand_type: "String",
                    operator: "String",
                    property: "String",
                    then: {
                      # recursive ComponentProperty
                    },
                  },
                  configured: false,
                  default_value: "String",
                  event: "String",
                  imported_value: "String",
                  model: "String",
                  property: "String",
                  type: "String",
                  user_attribute: "String",
                  value: "String",
                },
                model: "String",
                state: {
                  component_name: "String", # required
                  property: "String", # required
                  set: { # required
                    binding_properties: {
                      field: "String",
                      property: "String", # required
                    },
                    bindings: {
                      "String" => {
                        element: "String", # required
                        property: "String", # required
                      },
                    },
                    collection_binding_properties: {
                      field: "String",
                      property: "String", # required
                    },
                    component_name: "String",
                    concat: [
                      {
                        # recursive ComponentProperty
                      },
                    ],
                    condition: {
                      else: {
                        # recursive ComponentProperty
                      },
                      field: "String",
                      operand: "String",
                      operand_type: "String",
                      operator: "String",
                      property: "String",
                      then: {
                        # recursive ComponentProperty
                      },
                    },
                    configured: false,
                    default_value: "String",
                    event: "String",
                    imported_value: "String",
                    model: "String",
                    property: "String",
                    type: "String",
                    user_attribute: "String",
                    value: "String",
                  },
                },
                target: {
                  binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  bindings: {
                    "String" => {
                      element: "String", # required
                      property: "String", # required
                    },
                  },
                  collection_binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  component_name: "String",
                  concat: [
                    {
                      # recursive ComponentProperty
                    },
                  ],
                  condition: {
                    else: {
                      # recursive ComponentProperty
                    },
                    field: "String",
                    operand: "String",
                    operand_type: "String",
                    operator: "String",
                    property: "String",
                    then: {
                      # recursive ComponentProperty
                    },
                  },
                  configured: false,
                  default_value: "String",
                  event: "String",
                  imported_value: "String",
                  model: "String",
                  property: "String",
                  type: "String",
                  user_attribute: "String",
                  value: "String",
                },
                type: {
                  binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  bindings: {
                    "String" => {
                      element: "String", # required
                      property: "String", # required
                    },
                  },
                  collection_binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  component_name: "String",
                  concat: [
                    {
                      # recursive ComponentProperty
                    },
                  ],
                  condition: {
                    else: {
                      # recursive ComponentProperty
                    },
                    field: "String",
                    operand: "String",
                    operand_type: "String",
                    operator: "String",
                    property: "String",
                    then: {
                      # recursive ComponentProperty
                    },
                  },
                  configured: false,
                  default_value: "String",
                  event: "String",
                  imported_value: "String",
                  model: "String",
                  property: "String",
                  type: "String",
                  user_attribute: "String",
                  value: "String",
                },
                url: {
                  binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  bindings: {
                    "String" => {
                      element: "String", # required
                      property: "String", # required
                    },
                  },
                  collection_binding_properties: {
                    field: "String",
                    property: "String", # required
                  },
                  component_name: "String",
                  concat: [
                    {
                      # recursive ComponentProperty
                    },
                  ],
                  condition: {
                    else: {
                      # recursive ComponentProperty
                    },
                    field: "String",
                    operand: "String",
                    operand_type: "String",
                    operator: "String",
                    property: "String",
                    then: {
                      # recursive ComponentProperty
                    },
                  },
                  configured: false,
                  default_value: "String",
                  event: "String",
                  imported_value: "String",
                  model: "String",
                  property: "String",
                  type: "String",
                  user_attribute: "String",
                  value: "String",
                },
              },
            },
          },
          name: "String", # required
          properties: { # required
            "String" => {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
          },
          source_id: "String",
        },
      ],
      collection_properties: {
        "String" => {
          identifiers: ["String"],
          model: "String", # required
          predicate: {
            and: [
              {
                # recursive Predicate
              },
            ],
            field: "String",
            operand: "String",
            operator: "String",
            or: [
              {
                # recursive Predicate
              },
            ],
          },
          sort: [
            {
              direction: "ASC", # required, accepts ASC, DESC
              field: "String", # required
            },
          ],
        },
      },
      component_type: "ComponentType",
      events: {
        "String" => {
          action: "String",
          binding_event: "String",
          parameters: {
            anchor: {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
            fields: {
              "String" => {
                binding_properties: {
                  field: "String",
                  property: "String", # required
                },
                bindings: {
                  "String" => {
                    element: "String", # required
                    property: "String", # required
                  },
                },
                collection_binding_properties: {
                  field: "String",
                  property: "String", # required
                },
                component_name: "String",
                concat: [
                  {
                    # recursive ComponentProperty
                  },
                ],
                condition: {
                  else: {
                    # recursive ComponentProperty
                  },
                  field: "String",
                  operand: "String",
                  operand_type: "String",
                  operator: "String",
                  property: "String",
                  then: {
                    # recursive ComponentProperty
                  },
                },
                configured: false,
                default_value: "String",
                event: "String",
                imported_value: "String",
                model: "String",
                property: "String",
                type: "String",
                user_attribute: "String",
                value: "String",
              },
            },
            global: {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
            id: {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
            model: "String",
            state: {
              component_name: "String", # required
              property: "String", # required
              set: { # required
                binding_properties: {
                  field: "String",
                  property: "String", # required
                },
                bindings: {
                  "String" => {
                    element: "String", # required
                    property: "String", # required
                  },
                },
                collection_binding_properties: {
                  field: "String",
                  property: "String", # required
                },
                component_name: "String",
                concat: [
                  {
                    # recursive ComponentProperty
                  },
                ],
                condition: {
                  else: {
                    # recursive ComponentProperty
                  },
                  field: "String",
                  operand: "String",
                  operand_type: "String",
                  operator: "String",
                  property: "String",
                  then: {
                    # recursive ComponentProperty
                  },
                },
                configured: false,
                default_value: "String",
                event: "String",
                imported_value: "String",
                model: "String",
                property: "String",
                type: "String",
                user_attribute: "String",
                value: "String",
              },
            },
            target: {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
            type: {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
            url: {
              binding_properties: {
                field: "String",
                property: "String", # required
              },
              bindings: {
                "String" => {
                  element: "String", # required
                  property: "String", # required
                },
              },
              collection_binding_properties: {
                field: "String",
                property: "String", # required
              },
              component_name: "String",
              concat: [
                {
                  # recursive ComponentProperty
                },
              ],
              condition: {
                else: {
                  # recursive ComponentProperty
                },
                field: "String",
                operand: "String",
                operand_type: "String",
                operator: "String",
                property: "String",
                then: {
                  # recursive ComponentProperty
                },
              },
              configured: false,
              default_value: "String",
              event: "String",
              imported_value: "String",
              model: "String",
              property: "String",
              type: "String",
              user_attribute: "String",
              value: "String",
            },
          },
        },
      },
      id: "Uuid",
      name: "ComponentName",
      overrides: {
        "String" => {
          "String" => "String",
        },
      },
      properties: {
        "String" => {
          binding_properties: {
            field: "String",
            property: "String", # required
          },
          bindings: {
            "String" => {
              element: "String", # required
              property: "String", # required
            },
          },
          collection_binding_properties: {
            field: "String",
            property: "String", # required
          },
          component_name: "String",
          concat: [
            {
              # recursive ComponentProperty
            },
          ],
          condition: {
            else: {
              # recursive ComponentProperty
            },
            field: "String",
            operand: "String",
            operand_type: "String",
            operator: "String",
            property: "String",
            then: {
              # recursive ComponentProperty
            },
          },
          configured: false,
          default_value: "String",
          event: "String",
          imported_value: "String",
          model: "String",
          property: "String",
          type: "String",
          user_attribute: "String",
          value: "String",
        },
      },
      schema_version: "String",
      source_id: "String",
      variants: [
        {
          overrides: {
            "String" => {
              "String" => "String",
            },
          },
          variant_values: {
            "String" => "String",
          },
        },
      ],
    }

@!attribute [rw] binding_properties

The data binding information for the component's properties.
@return [Hash<String,Types::ComponentBindingPropertiesValue>]

@!attribute [rw] children

The components that are instances of the main component.
@return [Array<Types::ComponentChild>]

@!attribute [rw] collection_properties

The configuration for binding a component's properties to a data
model. Use this for a collection component.
@return [Hash<String,Types::ComponentDataConfiguration>]

@!attribute [rw] component_type

The type of the component. This can be an Amplify custom UI
component or another custom component.
@return [String]

@!attribute [rw] 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.
@return [Hash<String,Types::ComponentEvent>]

@!attribute [rw] id

The unique ID of the component to update.
@return [String]

@!attribute [rw] name

The name of the component to update.
@return [String]

@!attribute [rw] overrides

Describes the properties that can be overriden to customize the
component.
@return [Hash<String,Hash<String,String>>]

@!attribute [rw] properties

Describes the component's properties.
@return [Hash<String,Types::ComponentProperty>]

@!attribute [rw] schema_version

The schema version of the component when it was imported.
@return [String]

@!attribute [rw] source_id

The unique ID of the component in its original source system, such
as Figma.
@return [String]

@!attribute [rw] variants

A list of the unique variants of the main component being updated.
@return [Array<Types::ComponentVariant>]

@see docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateComponentData AWS API Documentation

Constants

SENSITIVE