AmplifyUIBuilder.Client.update_component(**kwargs)¶Updates an existing component.
See also: AWS API Documentation
Request Syntax
response = client.update_component(
appId='string',
clientToken='string',
environmentName='string',
id='string',
updatedComponent={
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
)
[REQUIRED]
The unique ID for the Amplify app.
The unique client token.
This field is autopopulated if not provided.
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
[REQUIRED]
The unique ID for the component.
[REQUIRED]
The configuration of the updated component.
The data binding information for the component's properties.
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
Describes the properties to customize with data at runtime.
An Amazon S3 bucket.
The default value to assign to the property.
The field to bind the data to.
The storage key for an Amazon S3 bucket.
An Amplify DataStore model.
A list of predicates for binding a component's properties to data.
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
A list of predicates to combine logically.
The field to query.
The value to use when performing the evaluation.
The operator to use to perform the evaluation.
A list of predicates to combine logically.
The name of a component slot.
An authenticated user attribute.
The default value of the property.
The property type.
The components that are instances of the main component.
A nested UI configuration within a parent Component .
The list of ComponentChild instances for this component.
The type of the child component.
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.
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
The action to perform when a specific event is raised.
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
Describes information about the action.
The HTML anchor link to the location to open. Specify this value for a navigation action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The unique ID of the component that the ActionParameters apply to.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
A key-value pair that specifies the state property name and its initial value.
The name of the component that is being modified.
The name of the component property to apply the state configuration to.
The state configuration to assign to the property.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The element within the same component to modify when the action occurs.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The URL to the location to open. Specify this value for a navigation action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The name of the child component.
Describes the properties of the child component. You can't specify tags as a valid property for properties .
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The unique ID of the child component in its original source system, such as Figma.
The configuration for binding a component's properties to a data model. Use this for a collection component.
Describes the configuration for binding a component's properties to data.
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
The name of the data model to use to bind data to a component.
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
A list of predicates to combine logically.
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
The field to query.
The value to use when performing the evaluation.
The operator to use to perform the evaluation.
A list of predicates to combine logically.
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
Describes how to sort the component's properties.
Describes how to sort the data that you bind to a component.
The direction of the sort, either ascending or descending.
The field to perform the sort on.
The type of the component. This can be an Amplify custom UI component or another custom component.
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
The action to perform when a specific event is raised.
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
Describes information about the action.
The HTML anchor link to the location to open. Specify this value for a navigation action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The unique ID of the component that the ActionParameters apply to.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
A key-value pair that specifies the state property name and its initial value.
The name of the component that is being modified.
The name of the component property to apply the state configuration to.
The state configuration to assign to the property.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The element within the same component to modify when the action occurs.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The URL to the location to open. Specify this value for a navigation action.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The unique ID of the component to update.
The name of the component to update.
Describes the properties that can be overriden to customize the component.
Describes the component's properties.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The information to bind the component property to data at runtime.
The data field to bind the property to.
The component property to bind to the data field.
The information to bind the component property to form data.
Describes how to bind a component property to form data.
The name of the component to retrieve a value from.
The property to retrieve a value from.
The information to bind the component property to data at runtime. Use this for collection components.
The data field to bind the property to.
The component property to bind to the data field.
The name of the component that is affected by an event.
A list of component properties to concatenate to create the value to assign to this component property.
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The conditional expression to use to assign a value to the component property.
The value to assign to the property if the condition is not met.
The name of a field. Specify this when the property is a data model.
The value of the property to evaluate.
The type of the property to evaluate.
The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
The value to assign to the property if the condition is met.
Specifies whether the user configured the property in Amplify Studio after importing it.
The default value to assign to the component property.
An event that occurs in your app. Use this for workflow data binding.
The default value assigned to the property when the component is imported into an app.
The data model to use to assign a value to the component property.
The name of the component's property that is affected by an event.
The component type.
An authenticated user attribute to use to assign a value to the component property.
The value to assign to the component property.
The schema version of the component when it was imported.
The unique ID of the component in its original source system, such as Figma.
A list of the unique variants of the main component being updated.
Describes the style configuration of a unique variation of a main component.
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 .
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
dict
Response Syntax
{
'entity': {
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the updated component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
events (dict) --
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.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
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 .
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
events (dict) --
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.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
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 .
properties (dict) --
Describes the component's properties. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
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 .
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
Exceptions
AmplifyUIBuilder.Client.exceptions.ResourceConflictExceptionAmplifyUIBuilder.Client.exceptions.InternalServerExceptionAmplifyUIBuilder.Client.exceptions.InvalidParameterException