Class: Aws::AmplifyUIBuilder::Types::UpdateComponentData
- Inherits:
-
Struct
- Object
- Struct
- Aws::AmplifyUIBuilder::Types::UpdateComponentData
- Defined in:
- gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb
Overview
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",
},
},
],
}
Updates and saves all of the information about a component, based on component ID.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#binding_properties ⇒ Hash<String,Types::ComponentBindingPropertiesValue>
The data binding information for the component's properties.
-
#children ⇒ Array<Types::ComponentChild>
The components that are instances of the main component.
-
#collection_properties ⇒ Hash<String,Types::ComponentDataConfiguration>
The configuration for binding a component's properties to a data model.
-
#component_type ⇒ String
The type of the component.
-
#events ⇒ Hash<String,Types::ComponentEvent>
The event configuration for the component.
-
#id ⇒ String
The unique ID of the component to update.
-
#name ⇒ String
The name of the component to update.
-
#overrides ⇒ Hash<String,Hash<String,String>>
Describes the properties that can be overriden to customize the component.
-
#properties ⇒ Hash<String,Types::ComponentProperty>
Describes the component's properties.
-
#schema_version ⇒ String
The schema version of the component when it was imported.
-
#source_id ⇒ String
The unique ID of the component in its original source system, such as Figma.
-
#variants ⇒ Array<Types::ComponentVariant>
A list of the unique variants of the main component being updated.
Instance Attribute Details
#binding_properties ⇒ Hash<String,Types::ComponentBindingPropertiesValue>
The data binding information for the component's properties.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#children ⇒ Array<Types::ComponentChild>
The components that are instances of the main component.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#collection_properties ⇒ Hash<String,Types::ComponentDataConfiguration>
The configuration for binding a component's properties to a data model. Use this for a collection component.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#component_type ⇒ String
The type of the component. This can be an Amplify custom UI component or another custom component.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#events ⇒ Hash<String,Types::ComponentEvent>
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The unique ID of the component to update.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the component to update.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#overrides ⇒ Hash<String,Hash<String,String>>
Describes the properties that can be overriden to customize the component.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#properties ⇒ Hash<String,Types::ComponentProperty>
Describes the component's properties.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#schema_version ⇒ String
The schema version of the component when it was imported.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#source_id ⇒ String
The unique ID of the component in its original source system, such as Figma.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |
#variants ⇒ Array<Types::ComponentVariant>
A list of the unique variants of the main component being updated.
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 |
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 6540 class UpdateComponentData < Struct.new( :binding_properties, :children, :collection_properties, :component_type, :events, :id, :name, :overrides, :properties, :schema_version, :source_id, :variants) SENSITIVE = [] include Aws::Structure end |