2023/04/04 - AWS Amplify UI Builder - 10 updated api methods
Changes Support StorageField and custom displays for data-bound options in form builder. Support non-string operands for predicates in collections. Support choosing client to get token from.
{'componentToCreate': {'bindingProperties': {'bindingProperties': {'predicates': {'operandType': 'string'}}},
'collectionProperties': {'predicate': {'operandType': 'string'}}}}
Response {'entity': {'bindingProperties': {'bindingProperties': {'predicates': {'operandType': 'string'}}},
'collectionProperties': {'predicate': {'operandType': 'string'}}}}
Creates a new component for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_component(
appId='string',
environmentName='string',
clientToken='string',
componentToCreate={
'name': 'string',
'sourceId': 'string',
'componentType': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': [
{
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': {'... recursive ...'},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'sourceId': 'string'
},
],
'variants': [
{
'variantValues': {
'string': 'string'
},
'overrides': {
'string': {
'string': 'string'
}
}
},
],
'overrides': {
'string': {
'string': 'string'
}
},
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string',
'field': 'string',
'predicates': [
{
'or': {'... recursive ...'},
'and': {'... recursive ...'},
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
],
'userAttribute': 'string',
'bucket': 'string',
'key': 'string',
'defaultValue': 'string',
'slotName': 'string'
},
'defaultValue': 'string'
}
},
'collectionProperties': {
'string': {
'model': 'string',
'sort': [
{
'field': 'string',
'direction': 'ASC'|'DESC'
},
],
'predicate': {
'or': [
{'... recursive ...'},
],
'and': [
{'... recursive ...'},
],
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
'identifiers': [
'string',
]
}
},
'tags': {
'string': 'string'
},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'schemaVersion': 'string'
}
)
string
[REQUIRED]
The unique ID of the Amplify app to associate with the component.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
The unique client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
Represents the configuration of the component to create.
name (string) -- [REQUIRED]
The name of the component
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
componentType (string) -- [REQUIRED]
The component type. This can be an Amplify custom UI component or another custom component.
properties (dict) -- [REQUIRED]
Describes the component's 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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
A list of child components that are instances of the main component.
(dict) --
A nested UI configuration within a parent Component.
componentType (string) -- [REQUIRED]
The type of the child component.
name (string) -- [REQUIRED]
The name of the child component.
properties (dict) -- [REQUIRED]
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The list of ComponentChild instances for this 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [REQUIRED]
The name of the component that is being modified.
property (string) -- [REQUIRED]
The name of the component property to apply the state configuration to.
set (dict) -- [REQUIRED]
The state configuration to assign to the property.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
variants (list) -- [REQUIRED]
A list of the unique variants of this component.
(dict) --
Describes the style configuration of a unique variation of a main component.
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
overrides (dict) -- [REQUIRED]
Describes the component properties that can be overriden to customize an instance of the component.
(string) --
(dict) --
(string) --
(string) --
bindingProperties (dict) -- [REQUIRED]
The data binding information for the component's properties.
(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.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
field (string) --
The field to bind the data to.
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.
or (list) --
A list of predicates to combine logically.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
userAttribute (string) --
An authenticated user attribute.
bucket (string) --
An Amazon S3 bucket.
key (string) --
The storage key for an Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
slotName (string) --
The name of a component slot.
defaultValue (string) --
The default value of the property.
collectionProperties (dict) --
The data binding configuration for customizing a component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
model (string) -- [REQUIRED]
The name of the data model to use to bind data to a component.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
field (string) -- [REQUIRED]
The field to perform the sort on.
direction (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
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.
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.
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.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
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.
(string) --
tags (dict) --
One or more key-value pairs to use when tagging the component data.
(string) --
(string) --
events (dict) --
The event configuration for 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [REQUIRED]
The name of the component that is being modified.
property (string) -- [REQUIRED]
The name of the component property to apply the state configuration to.
set (dict) -- [REQUIRED]
The state configuration to assign to the property.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
schemaVersion (string) --
The schema version of the component when it was imported.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'environmentName': 'string',
'sourceId': 'string',
'id': 'string',
'name': 'string',
'componentType': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': [
{
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': {'... recursive ...'},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'sourceId': 'string'
},
],
'variants': [
{
'variantValues': {
'string': 'string'
},
'overrides': {
'string': {
'string': 'string'
}
}
},
],
'overrides': {
'string': {
'string': 'string'
}
},
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string',
'field': 'string',
'predicates': [
{
'or': {'... recursive ...'},
'and': {'... recursive ...'},
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
],
'userAttribute': 'string',
'bucket': 'string',
'key': 'string',
'defaultValue': 'string',
'slotName': 'string'
},
'defaultValue': 'string'
}
},
'collectionProperties': {
'string': {
'model': 'string',
'sort': [
{
'field': 'string',
'direction': 'ASC'|'DESC'
},
],
'predicate': {
'or': [
{'... recursive ...'},
],
'and': [
{'... recursive ...'},
],
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
'identifiers': [
'string',
]
}
},
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'schemaVersion': 'string'
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the new component.
appId (string) --
The unique ID of the Amplify app associated with the component.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
id (string) --
The unique ID of the component.
name (string) --
The name of the component.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component.
componentType (string) --
The type of the child component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The list of ComponentChild instances for this 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
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.
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
field (string) --
The field to bind the data to.
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.
or (list) --
A list of predicates to combine logically.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
userAttribute (string) --
An authenticated user attribute.
bucket (string) --
An Amazon S3 bucket.
key (string) --
The storage key for an Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
slotName (string) --
The name of a component slot.
defaultValue (string) --
The default value of the property.
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.
model (string) --
The name of the data model to use to bind data to a component.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
field (string) --
The field to perform the sort on.
direction (string) --
The direction of the sort, either ascending or descending.
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.
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.
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.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
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.
(string) --
createdAt (datetime) --
The time that the component was created.
modifiedAt (datetime) --
The time that the component was modified.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
schemaVersion (string) --
The schema version of the component when it was imported.
{'formToCreate': {'fields': {'inputType': {'fileUploaderConfig': {'acceptedFileTypes': ['string'],
'accessLevel': 'public '
'| '
'protected '
'| '
'private',
'isResumable': 'boolean',
'maxFileCount': 'integer',
'maxSize': 'integer',
'showThumbnails': 'boolean'},
'valueMappings': {'bindingProperties': {'string': {'bindingProperties': {'model': 'string'},
'type': 'string'}},
'values': {'displayValue': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]},
'value': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]}}}}},
'labelDecorator': 'required | optional | none',
'sectionalElements': {'excluded': 'boolean'}}}
Response {'entity': {'fields': {'inputType': {'fileUploaderConfig': {'acceptedFileTypes': ['string'],
'accessLevel': 'public '
'| '
'protected '
'| '
'private',
'isResumable': 'boolean',
'maxFileCount': 'integer',
'maxSize': 'integer',
'showThumbnails': 'boolean'},
'valueMappings': {'bindingProperties': {'string': {'bindingProperties': {'model': 'string'},
'type': 'string'}},
'values': {'displayValue': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]},
'value': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]}}}}},
'labelDecorator': 'required | optional | none',
'sectionalElements': {'excluded': 'boolean'}}}
Creates a new form for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_form(
appId='string',
environmentName='string',
clientToken='string',
formToCreate={
'name': 'string',
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'formActionType': 'create'|'update',
'fields': {
'string': {
'label': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'excluded': True|False,
'inputType': {
'type': 'string',
'required': True|False,
'readOnly': True|False,
'placeholder': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
},
'value': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
}
},
],
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string'
}
}
}
},
'name': 'string',
'minValue': ...,
'maxValue': ...,
'step': ...,
'value': 'string',
'isArray': True|False,
'fileUploaderConfig': {
'accessLevel': 'public'|'protected'|'private',
'acceptedFileTypes': [
'string',
],
'showThumbnails': True|False,
'isResumable': True|False,
'maxFileCount': 123,
'maxSize': 123
}
},
'validations': [
{
'type': 'string',
'strValues': [
'string',
],
'numValues': [
123,
],
'validationMessage': 'string'
},
]
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
}
},
'sectionalElements': {
'string': {
'type': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'text': 'string',
'level': 123,
'orientation': 'string',
'excluded': True|False
}
},
'schemaVersion': 'string',
'cta': {
'position': 'top'|'bottom'|'top_and_bottom',
'clear': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'cancel': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'submit': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
}
},
'tags': {
'string': 'string'
},
'labelDecorator': 'required'|'optional'|'none'
}
)
string
[REQUIRED]
The unique ID of the Amplify app to associate with the form.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
The unique client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
Represents the configuration of the form to create.
name (string) -- [REQUIRED]
The name of the form.
dataType (dict) -- [REQUIRED]
The type of data source to use to create the form.
dataSourceType (string) -- [REQUIRED]
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName (string) -- [REQUIRED]
The unique name of the data type you are using as the data source for the form.
formActionType (string) -- [REQUIRED]
Specifies whether to perform a create or update action on the form.
fields (dict) -- [REQUIRED]
The configuration information for the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
type (string) -- [REQUIRED]
The input type for the field.
required (boolean) --
Specifies a field that requires input.
readOnly (boolean) --
Specifies a read only field.
placeholder (string) --
The text to display as a placeholder for the field.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
valueMappings (dict) --
The information to use to customize the input fields with data at runtime.
values (list) -- [REQUIRED]
The value and display value pairs.
(dict) --
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
displayValue (dict) --
The value to display for the complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) -- [REQUIRED]
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
value (dict) -- [REQUIRED]
The complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) -- [REQUIRED]
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind fields to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
name (string) --
The name of the field.
minValue (float) --
The minimum value to display for the field.
maxValue (float) --
The maximum value to display for the field.
step (float) --
The stepping increment for a numeric value in a field.
value (string) --
The value for the field.
isArray (boolean) --
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
fileUploaderConfig (dict) --
The configuration for the file uploader field.
accessLevel (string) -- [REQUIRED]
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
acceptedFileTypes (list) -- [REQUIRED]
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
(string) --
showThumbnails (boolean) --
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.
isResumable (boolean) --
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
maxFileCount (integer) --
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize (integer) --
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
type (string) -- [REQUIRED]
The validation to perform on an object type.
strValues (list) --
The validation to perform on a string value.
(string) --
numValues (list) --
The validation to perform on a number value.
(integer) --
validationMessage (string) --
The validation message to display.
style (dict) -- [REQUIRED]
The configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
verticalGap (dict) --
The spacing for the vertical gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
outerPadding (dict) --
The size of the outer padding for the form.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
sectionalElements (dict) -- [REQUIRED]
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
(string) --
(dict) --
Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
type (string) -- [REQUIRED]
The type of sectional element. Valid values are Heading, Text, and Divider.
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
text (string) --
The text for a Text sectional element.
level (integer) --
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
orientation (string) --
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
excluded (boolean) --
Excludes a sectional element that was generated by default for a specified data model.
schemaVersion (string) -- [REQUIRED]
The schema version of the form.
cta (dict) --
The FormCTA object that stores the call to action configuration for the form.
position (string) --
The position of the button.
clear (dict) --
Displays a clear button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
cancel (dict) --
Displays a cancel button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
submit (dict) --
Displays a submit button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
tags (dict) --
One or more key-value pairs to use when tagging the form data.
(string) --
(string) --
labelDecorator (string) --
Specifies an icon or decoration to display on the form.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'environmentName': 'string',
'id': 'string',
'name': 'string',
'formActionType': 'create'|'update',
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'fields': {
'string': {
'label': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'excluded': True|False,
'inputType': {
'type': 'string',
'required': True|False,
'readOnly': True|False,
'placeholder': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
},
'value': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
}
},
],
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string'
}
}
}
},
'name': 'string',
'minValue': ...,
'maxValue': ...,
'step': ...,
'value': 'string',
'isArray': True|False,
'fileUploaderConfig': {
'accessLevel': 'public'|'protected'|'private',
'acceptedFileTypes': [
'string',
],
'showThumbnails': True|False,
'isResumable': True|False,
'maxFileCount': 123,
'maxSize': 123
}
},
'validations': [
{
'type': 'string',
'strValues': [
'string',
],
'numValues': [
123,
],
'validationMessage': 'string'
},
]
}
},
'sectionalElements': {
'string': {
'type': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'text': 'string',
'level': 123,
'orientation': 'string',
'excluded': True|False
}
},
'schemaVersion': 'string',
'tags': {
'string': 'string'
},
'cta': {
'position': 'top'|'bottom'|'top_and_bottom',
'clear': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'cancel': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'submit': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
}
},
'labelDecorator': 'required'|'optional'|'none'
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the new form.
appId (string) --
The unique ID of the Amplify app associated with the form.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
formActionType (string) --
The operation to perform on the specified form.
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
verticalGap (dict) --
The spacing for the vertical gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
outerPadding (dict) --
The size of the outer padding for the form.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
dataType (dict) --
The type of data source to use to create the form.
dataSourceType (string) --
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName (string) --
The unique name of the data type you are using as the data source for the form.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
type (string) --
The input type for the field.
required (boolean) --
Specifies a field that requires input.
readOnly (boolean) --
Specifies a read only field.
placeholder (string) --
The text to display as a placeholder for the field.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
valueMappings (dict) --
The information to use to customize the input fields with data at runtime.
values (list) --
The value and display value pairs.
(dict) --
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
displayValue (dict) --
The value to display for the complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind fields to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
name (string) --
The name of the field.
minValue (float) --
The minimum value to display for the field.
maxValue (float) --
The maximum value to display for the field.
step (float) --
The stepping increment for a numeric value in a field.
value (string) --
The value for the field.
isArray (boolean) --
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
fileUploaderConfig (dict) --
The configuration for the file uploader field.
accessLevel (string) --
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
acceptedFileTypes (list) --
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
(string) --
showThumbnails (boolean) --
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.
isResumable (boolean) --
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
maxFileCount (integer) --
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize (integer) --
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
type (string) --
The validation to perform on an object type.
strValues (list) --
The validation to perform on a string value.
(string) --
numValues (list) --
The validation to perform on a number value.
(integer) --
validationMessage (string) --
The validation message to display.
sectionalElements (dict) --
Stores the visual helper elements for the form that are not associated with any data.
(string) --
(dict) --
Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
type (string) --
The type of sectional element. Valid values are Heading, Text, and Divider.
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
text (string) --
The text for a Text sectional element.
level (integer) --
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
orientation (string) --
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
excluded (boolean) --
Excludes a sectional element that was generated by default for a specified data model.
schemaVersion (string) --
The schema version of the form when it was imported.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
cta (dict) --
Stores the call to action configuration for the form.
position (string) --
The position of the button.
clear (dict) --
Displays a clear button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
cancel (dict) --
Displays a cancel button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
submit (dict) --
Displays a submit button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
labelDecorator (string) --
Specifies an icon or decoration to display on the form.
{'request': {'clientId': 'string'}}
Exchanges an access code for a token.
See also: AWS API Documentation
Request Syntax
client.exchange_code_for_token(
provider='figma',
request={
'code': 'string',
'redirectUri': 'string',
'clientId': 'string'
}
)
string
[REQUIRED]
The third-party provider for the token. The only valid value is figma.
dict
[REQUIRED]
Describes the configuration of the request.
code (string) -- [REQUIRED]
The access code to send in the request.
redirectUri (string) -- [REQUIRED]
The location of the application that will receive the access code.
clientId (string) --
The ID of the client to request the token from.
dict
Response Syntax
{
'accessToken': 'string',
'expiresIn': 123,
'refreshToken': 'string'
}
Response Structure
(dict) --
accessToken (string) --
The access token.
expiresIn (integer) --
The date and time when the new access token expires.
refreshToken (string) --
The token to use to refresh a previously issued access token that might have expired.
{'entities': {'bindingProperties': {'bindingProperties': {'predicates': {'operandType': 'string'}}},
'collectionProperties': {'predicate': {'operandType': 'string'}}}}
Exports component configurations to code that is ready to integrate into an Amplify app.
See also: AWS API Documentation
Request Syntax
client.export_components(
appId='string',
environmentName='string',
nextToken='string'
)
string
[REQUIRED]
The unique ID of the Amplify app to export components to.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
The token to request the next page of results.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'environmentName': 'string',
'sourceId': 'string',
'id': 'string',
'name': 'string',
'componentType': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': [
{
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': {'... recursive ...'},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'sourceId': 'string'
},
],
'variants': [
{
'variantValues': {
'string': 'string'
},
'overrides': {
'string': {
'string': 'string'
}
}
},
],
'overrides': {
'string': {
'string': 'string'
}
},
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string',
'field': 'string',
'predicates': [
{
'or': {'... recursive ...'},
'and': {'... recursive ...'},
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
],
'userAttribute': 'string',
'bucket': 'string',
'key': 'string',
'defaultValue': 'string',
'slotName': 'string'
},
'defaultValue': 'string'
}
},
'collectionProperties': {
'string': {
'model': 'string',
'sort': [
{
'field': 'string',
'direction': 'ASC'|'DESC'
},
],
'predicate': {
'or': [
{'... recursive ...'},
],
'and': [
{'... recursive ...'},
],
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
'identifiers': [
'string',
]
}
},
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'schemaVersion': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
Represents the configuration of the exported components.
(dict) --
Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.
appId (string) --
The unique ID of the Amplify app associated with the component.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
id (string) --
The unique ID of the component.
name (string) --
The name of the component.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component.
componentType (string) --
The type of the child component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The list of ComponentChild instances for this 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
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.
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
field (string) --
The field to bind the data to.
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.
or (list) --
A list of predicates to combine logically.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
userAttribute (string) --
An authenticated user attribute.
bucket (string) --
An Amazon S3 bucket.
key (string) --
The storage key for an Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
slotName (string) --
The name of a component slot.
defaultValue (string) --
The default value of the property.
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.
model (string) --
The name of the data model to use to bind data to a component.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
field (string) --
The field to perform the sort on.
direction (string) --
The direction of the sort, either ascending or descending.
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.
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.
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.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
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.
(string) --
createdAt (datetime) --
The time that the component was created.
modifiedAt (datetime) --
The time that the component was modified.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
schemaVersion (string) --
The schema version of the component when it was imported.
nextToken (string) --
The pagination token that's included if more results are available.
{'entities': {'fields': {'inputType': {'fileUploaderConfig': {'acceptedFileTypes': ['string'],
'accessLevel': 'public '
'| '
'protected '
'| '
'private',
'isResumable': 'boolean',
'maxFileCount': 'integer',
'maxSize': 'integer',
'showThumbnails': 'boolean'},
'valueMappings': {'bindingProperties': {'string': {'bindingProperties': {'model': 'string'},
'type': 'string'}},
'values': {'displayValue': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]},
'value': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]}}}}},
'labelDecorator': 'required | optional | none',
'sectionalElements': {'excluded': 'boolean'}}}
Exports form configurations to code that is ready to integrate into an Amplify app.
See also: AWS API Documentation
Request Syntax
client.export_forms(
appId='string',
environmentName='string',
nextToken='string'
)
string
[REQUIRED]
The unique ID of the Amplify app to export forms to.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
The token to request the next page of results.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'environmentName': 'string',
'id': 'string',
'name': 'string',
'formActionType': 'create'|'update',
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'fields': {
'string': {
'label': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'excluded': True|False,
'inputType': {
'type': 'string',
'required': True|False,
'readOnly': True|False,
'placeholder': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
},
'value': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
}
},
],
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string'
}
}
}
},
'name': 'string',
'minValue': ...,
'maxValue': ...,
'step': ...,
'value': 'string',
'isArray': True|False,
'fileUploaderConfig': {
'accessLevel': 'public'|'protected'|'private',
'acceptedFileTypes': [
'string',
],
'showThumbnails': True|False,
'isResumable': True|False,
'maxFileCount': 123,
'maxSize': 123
}
},
'validations': [
{
'type': 'string',
'strValues': [
'string',
],
'numValues': [
123,
],
'validationMessage': 'string'
},
]
}
},
'sectionalElements': {
'string': {
'type': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'text': 'string',
'level': 123,
'orientation': 'string',
'excluded': True|False
}
},
'schemaVersion': 'string',
'tags': {
'string': 'string'
},
'cta': {
'position': 'top'|'bottom'|'top_and_bottom',
'clear': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'cancel': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'submit': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
}
},
'labelDecorator': 'required'|'optional'|'none'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
Represents the configuration of the exported forms.
(dict) --
Contains the configuration settings for a Form user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.
appId (string) --
The unique ID of the Amplify app associated with the form.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
formActionType (string) --
The operation to perform on the specified form.
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
verticalGap (dict) --
The spacing for the vertical gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
outerPadding (dict) --
The size of the outer padding for the form.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
dataType (dict) --
The type of data source to use to create the form.
dataSourceType (string) --
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName (string) --
The unique name of the data type you are using as the data source for the form.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
type (string) --
The input type for the field.
required (boolean) --
Specifies a field that requires input.
readOnly (boolean) --
Specifies a read only field.
placeholder (string) --
The text to display as a placeholder for the field.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
valueMappings (dict) --
The information to use to customize the input fields with data at runtime.
values (list) --
The value and display value pairs.
(dict) --
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
displayValue (dict) --
The value to display for the complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind fields to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
name (string) --
The name of the field.
minValue (float) --
The minimum value to display for the field.
maxValue (float) --
The maximum value to display for the field.
step (float) --
The stepping increment for a numeric value in a field.
value (string) --
The value for the field.
isArray (boolean) --
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
fileUploaderConfig (dict) --
The configuration for the file uploader field.
accessLevel (string) --
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
acceptedFileTypes (list) --
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
(string) --
showThumbnails (boolean) --
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.
isResumable (boolean) --
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
maxFileCount (integer) --
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize (integer) --
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
type (string) --
The validation to perform on an object type.
strValues (list) --
The validation to perform on a string value.
(string) --
numValues (list) --
The validation to perform on a number value.
(integer) --
validationMessage (string) --
The validation message to display.
sectionalElements (dict) --
Stores the visual helper elements for the form that are not associated with any data.
(string) --
(dict) --
Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
type (string) --
The type of sectional element. Valid values are Heading, Text, and Divider.
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
text (string) --
The text for a Text sectional element.
level (integer) --
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
orientation (string) --
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
excluded (boolean) --
Excludes a sectional element that was generated by default for a specified data model.
schemaVersion (string) --
The schema version of the form when it was imported.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
cta (dict) --
Stores the call to action configuration for the form.
position (string) --
The position of the button.
clear (dict) --
Displays a clear button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
cancel (dict) --
Displays a cancel button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
submit (dict) --
Displays a submit button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
labelDecorator (string) --
Specifies an icon or decoration to display on the form.
nextToken (string) --
The pagination token that's included if more results are available.
{'component': {'bindingProperties': {'bindingProperties': {'predicates': {'operandType': 'string'}}},
'collectionProperties': {'predicate': {'operandType': 'string'}}}}
Returns an existing component for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_component(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID of the component.
dict
Response Syntax
{
'component': {
'appId': 'string',
'environmentName': 'string',
'sourceId': 'string',
'id': 'string',
'name': 'string',
'componentType': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': [
{
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': {'... recursive ...'},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'sourceId': 'string'
},
],
'variants': [
{
'variantValues': {
'string': 'string'
},
'overrides': {
'string': {
'string': 'string'
}
}
},
],
'overrides': {
'string': {
'string': 'string'
}
},
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string',
'field': 'string',
'predicates': [
{
'or': {'... recursive ...'},
'and': {'... recursive ...'},
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
],
'userAttribute': 'string',
'bucket': 'string',
'key': 'string',
'defaultValue': 'string',
'slotName': 'string'
},
'defaultValue': 'string'
}
},
'collectionProperties': {
'string': {
'model': 'string',
'sort': [
{
'field': 'string',
'direction': 'ASC'|'DESC'
},
],
'predicate': {
'or': [
{'... recursive ...'},
],
'and': [
{'... recursive ...'},
],
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
'identifiers': [
'string',
]
}
},
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'schemaVersion': 'string'
}
}
Response Structure
(dict) --
component (dict) --
Represents the configuration settings for the component.
appId (string) --
The unique ID of the Amplify app associated with the component.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
id (string) --
The unique ID of the component.
name (string) --
The name of the component.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component.
componentType (string) --
The type of the child component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The list of ComponentChild instances for this 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
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.
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
field (string) --
The field to bind the data to.
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.
or (list) --
A list of predicates to combine logically.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
userAttribute (string) --
An authenticated user attribute.
bucket (string) --
An Amazon S3 bucket.
key (string) --
The storage key for an Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
slotName (string) --
The name of a component slot.
defaultValue (string) --
The default value of the property.
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.
model (string) --
The name of the data model to use to bind data to a component.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
field (string) --
The field to perform the sort on.
direction (string) --
The direction of the sort, either ascending or descending.
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.
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.
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.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
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.
(string) --
createdAt (datetime) --
The time that the component was created.
modifiedAt (datetime) --
The time that the component was modified.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
schemaVersion (string) --
The schema version of the component when it was imported.
{'form': {'fields': {'inputType': {'fileUploaderConfig': {'acceptedFileTypes': ['string'],
'accessLevel': 'public '
'| '
'protected '
'| '
'private',
'isResumable': 'boolean',
'maxFileCount': 'integer',
'maxSize': 'integer',
'showThumbnails': 'boolean'},
'valueMappings': {'bindingProperties': {'string': {'bindingProperties': {'model': 'string'},
'type': 'string'}},
'values': {'displayValue': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]},
'value': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]}}}}},
'labelDecorator': 'required | optional | none',
'sectionalElements': {'excluded': 'boolean'}}}
Returns an existing form for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_form(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID of the form.
dict
Response Syntax
{
'form': {
'appId': 'string',
'environmentName': 'string',
'id': 'string',
'name': 'string',
'formActionType': 'create'|'update',
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'fields': {
'string': {
'label': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'excluded': True|False,
'inputType': {
'type': 'string',
'required': True|False,
'readOnly': True|False,
'placeholder': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
},
'value': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
}
},
],
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string'
}
}
}
},
'name': 'string',
'minValue': ...,
'maxValue': ...,
'step': ...,
'value': 'string',
'isArray': True|False,
'fileUploaderConfig': {
'accessLevel': 'public'|'protected'|'private',
'acceptedFileTypes': [
'string',
],
'showThumbnails': True|False,
'isResumable': True|False,
'maxFileCount': 123,
'maxSize': 123
}
},
'validations': [
{
'type': 'string',
'strValues': [
'string',
],
'numValues': [
123,
],
'validationMessage': 'string'
},
]
}
},
'sectionalElements': {
'string': {
'type': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'text': 'string',
'level': 123,
'orientation': 'string',
'excluded': True|False
}
},
'schemaVersion': 'string',
'tags': {
'string': 'string'
},
'cta': {
'position': 'top'|'bottom'|'top_and_bottom',
'clear': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'cancel': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'submit': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
}
},
'labelDecorator': 'required'|'optional'|'none'
}
}
Response Structure
(dict) --
form (dict) --
Represents the configuration settings for the form.
appId (string) --
The unique ID of the Amplify app associated with the form.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
formActionType (string) --
The operation to perform on the specified form.
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
verticalGap (dict) --
The spacing for the vertical gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
outerPadding (dict) --
The size of the outer padding for the form.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
dataType (dict) --
The type of data source to use to create the form.
dataSourceType (string) --
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName (string) --
The unique name of the data type you are using as the data source for the form.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
type (string) --
The input type for the field.
required (boolean) --
Specifies a field that requires input.
readOnly (boolean) --
Specifies a read only field.
placeholder (string) --
The text to display as a placeholder for the field.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
valueMappings (dict) --
The information to use to customize the input fields with data at runtime.
values (list) --
The value and display value pairs.
(dict) --
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
displayValue (dict) --
The value to display for the complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind fields to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
name (string) --
The name of the field.
minValue (float) --
The minimum value to display for the field.
maxValue (float) --
The maximum value to display for the field.
step (float) --
The stepping increment for a numeric value in a field.
value (string) --
The value for the field.
isArray (boolean) --
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
fileUploaderConfig (dict) --
The configuration for the file uploader field.
accessLevel (string) --
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
acceptedFileTypes (list) --
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
(string) --
showThumbnails (boolean) --
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.
isResumable (boolean) --
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
maxFileCount (integer) --
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize (integer) --
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
type (string) --
The validation to perform on an object type.
strValues (list) --
The validation to perform on a string value.
(string) --
numValues (list) --
The validation to perform on a number value.
(integer) --
validationMessage (string) --
The validation message to display.
sectionalElements (dict) --
Stores the visual helper elements for the form that are not associated with any data.
(string) --
(dict) --
Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
type (string) --
The type of sectional element. Valid values are Heading, Text, and Divider.
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
text (string) --
The text for a Text sectional element.
level (integer) --
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
orientation (string) --
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
excluded (boolean) --
Excludes a sectional element that was generated by default for a specified data model.
schemaVersion (string) --
The schema version of the form when it was imported.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
cta (dict) --
Stores the call to action configuration for the form.
position (string) --
The position of the button.
clear (dict) --
Displays a clear button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
cancel (dict) --
Displays a cancel button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
submit (dict) --
Displays a submit button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
labelDecorator (string) --
Specifies an icon or decoration to display on the form.
{'refreshTokenBody': {'clientId': 'string'}}
Refreshes a previously issued access token that might have expired.
See also: AWS API Documentation
Request Syntax
client.refresh_token(
provider='figma',
refreshTokenBody={
'token': 'string',
'clientId': 'string'
}
)
string
[REQUIRED]
The third-party provider for the token. The only valid value is figma.
dict
[REQUIRED]
Information about the refresh token request.
token (string) -- [REQUIRED]
The token to use to refresh a previously issued access token that might have expired.
clientId (string) --
The ID of the client to request the token from.
dict
Response Syntax
{
'accessToken': 'string',
'expiresIn': 123
}
Response Structure
(dict) --
accessToken (string) --
The access token.
expiresIn (integer) --
The date and time when the new access token expires.
{'updatedComponent': {'bindingProperties': {'bindingProperties': {'predicates': {'operandType': 'string'}}},
'collectionProperties': {'predicate': {'operandType': 'string'}}}}
Response {'entity': {'bindingProperties': {'bindingProperties': {'predicates': {'operandType': 'string'}}},
'collectionProperties': {'predicate': {'operandType': 'string'}}}}
Updates an existing component.
See also: AWS API Documentation
Request Syntax
client.update_component(
appId='string',
environmentName='string',
id='string',
clientToken='string',
updatedComponent={
'id': 'string',
'name': 'string',
'sourceId': 'string',
'componentType': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': [
{
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': {'... recursive ...'},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'sourceId': 'string'
},
],
'variants': [
{
'variantValues': {
'string': 'string'
},
'overrides': {
'string': {
'string': 'string'
}
}
},
],
'overrides': {
'string': {
'string': 'string'
}
},
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string',
'field': 'string',
'predicates': [
{
'or': {'... recursive ...'},
'and': {'... recursive ...'},
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
],
'userAttribute': 'string',
'bucket': 'string',
'key': 'string',
'defaultValue': 'string',
'slotName': 'string'
},
'defaultValue': 'string'
}
},
'collectionProperties': {
'string': {
'model': 'string',
'sort': [
{
'field': 'string',
'direction': 'ASC'|'DESC'
},
],
'predicate': {
'or': [
{'... recursive ...'},
],
'and': [
{'... recursive ...'},
],
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
'identifiers': [
'string',
]
}
},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'schemaVersion': 'string'
}
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the component.
string
The unique client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
The configuration of the updated component.
id (string) --
The unique ID of the component to update.
name (string) --
The name of the component to update.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
properties (dict) --
Describes the component's 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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The components that are instances of the main component.
(dict) --
A nested UI configuration within a parent Component.
componentType (string) -- [REQUIRED]
The type of the child component.
name (string) -- [REQUIRED]
The name of the child component.
properties (dict) -- [REQUIRED]
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The list of ComponentChild instances for this 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [REQUIRED]
The name of the component that is being modified.
property (string) -- [REQUIRED]
The name of the component property to apply the state configuration to.
set (dict) -- [REQUIRED]
The state configuration to assign to the property.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
variants (list) --
A list of the unique variants of the main component being updated.
(dict) --
Describes the style configuration of a unique variation of a main component.
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
overrides (dict) --
Describes the properties that can be overriden to customize the component.
(string) --
(dict) --
(string) --
(string) --
bindingProperties (dict) --
The data binding information for the component's properties.
(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.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
field (string) --
The field to bind the data to.
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.
or (list) --
A list of predicates to combine logically.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
userAttribute (string) --
An authenticated user attribute.
bucket (string) --
An Amazon S3 bucket.
key (string) --
The storage key for an Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
slotName (string) --
The name of a component slot.
defaultValue (string) --
The default value of the property.
collectionProperties (dict) --
The configuration for binding a component's properties to a data model. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
model (string) -- [REQUIRED]
The name of the data model to use to bind data to a component.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
field (string) -- [REQUIRED]
The field to perform the sort on.
direction (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
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.
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.
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.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
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.
(string) --
events (dict) --
The event configuration for 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [REQUIRED]
The name of the component that is being modified.
property (string) -- [REQUIRED]
The name of the component property to apply the state configuration to.
set (dict) -- [REQUIRED]
The state configuration to assign to the property.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) -- [REQUIRED]
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
schemaVersion (string) --
The schema version of the component when it was imported.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'environmentName': 'string',
'sourceId': 'string',
'id': 'string',
'name': 'string',
'componentType': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': [
{
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'children': {'... recursive ...'},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'sourceId': 'string'
},
],
'variants': [
{
'variantValues': {
'string': 'string'
},
'overrides': {
'string': {
'string': 'string'
}
}
},
],
'overrides': {
'string': {
'string': 'string'
}
},
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string',
'field': 'string',
'predicates': [
{
'or': {'... recursive ...'},
'and': {'... recursive ...'},
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
],
'userAttribute': 'string',
'bucket': 'string',
'key': 'string',
'defaultValue': 'string',
'slotName': 'string'
},
'defaultValue': 'string'
}
},
'collectionProperties': {
'string': {
'model': 'string',
'sort': [
{
'field': 'string',
'direction': 'ASC'|'DESC'
},
],
'predicate': {
'or': [
{'... recursive ...'},
],
'and': [
{'... recursive ...'},
],
'field': 'string',
'operator': 'string',
'operand': 'string',
'operandType': 'string'
},
'identifiers': [
'string',
]
}
},
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'events': {
'string': {
'action': 'string',
'parameters': {
'type': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'url': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'anchor': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'target': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'global': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'model': 'string',
'id': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
},
'fields': {
'string': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
},
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'collectionBindingProperties': {
'property': 'string',
'field': 'string'
},
'defaultValue': 'string',
'model': 'string',
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'event': 'string',
'userAttribute': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'property': 'string',
'field': 'string',
'operator': 'string',
'operand': 'string',
'then': {'... recursive ...'},
'else': {'... recursive ...'},
'operandType': 'string'
},
'configured': True|False,
'type': 'string',
'importedValue': 'string',
'componentName': 'string',
'property': 'string'
}
}
},
'bindingEvent': 'string'
}
},
'schemaVersion': '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.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
id (string) --
The unique ID of the component.
name (string) --
The name of the component.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component.
componentType (string) --
The type of the child component.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
children (list) --
The list of ComponentChild instances for this 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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
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.
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
(string) --
(dict) --
(string) --
(string) --
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.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
field (string) --
The field to bind the data to.
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.
or (list) --
A list of predicates to combine logically.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
userAttribute (string) --
An authenticated user attribute.
bucket (string) --
An Amazon S3 bucket.
key (string) --
The storage key for an Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
slotName (string) --
The name of a component slot.
defaultValue (string) --
The default value of the property.
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.
model (string) --
The name of the data model to use to bind data to a component.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
field (string) --
The field to perform the sort on.
direction (string) --
The direction of the sort, either ascending or descending.
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.
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.
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.
operator (string) --
The operator to use to perform the evaluation.
operand (string) --
The value to use when performing the evaluation.
operandType (string) --
The type of value to use when performing the evaluation.
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.
(string) --
createdAt (datetime) --
The time that the component was created.
modifiedAt (datetime) --
The time that the component was modified.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
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.
parameters (dict) --
Describes information about the action.
type (dict) --
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
target (dict) --
The element within the same component to modify when the action occurs.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
value (string) --
The value to assign to the component property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
property (string) --
The component property to bind to the data field.
field (string) --
The data field to bind the property to.
defaultValue (string) --
The default value to assign to the component property.
model (string) --
The data model to use to assign a value to the component property.
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.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
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.
property (string) --
The name of the conditional property.
field (string) --
The name of a field. Specify this when the property is a data model.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
operand (string) --
The value of the property to evaluate.
then (dict) --
The value to assign to the property if the condition is met.
else (dict) --
The value to assign to the property if the condition is not met.
operandType (string) --
The type of the property to evaluate.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
type (string) --
The component type.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
componentName (string) --
The name of the component that is affected by an event.
property (string) --
The name of the component's property that is affected by an event.
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.
schemaVersion (string) --
The schema version of the component when it was imported.
{'updatedForm': {'fields': {'inputType': {'fileUploaderConfig': {'acceptedFileTypes': ['string'],
'accessLevel': 'public '
'| '
'protected '
'| '
'private',
'isResumable': 'boolean',
'maxFileCount': 'integer',
'maxSize': 'integer',
'showThumbnails': 'boolean'},
'valueMappings': {'bindingProperties': {'string': {'bindingProperties': {'model': 'string'},
'type': 'string'}},
'values': {'displayValue': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]},
'value': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]}}}}},
'labelDecorator': 'required | optional | none',
'sectionalElements': {'excluded': 'boolean'}}}
Response {'entity': {'fields': {'inputType': {'fileUploaderConfig': {'acceptedFileTypes': ['string'],
'accessLevel': 'public '
'| '
'protected '
'| '
'private',
'isResumable': 'boolean',
'maxFileCount': 'integer',
'maxSize': 'integer',
'showThumbnails': 'boolean'},
'valueMappings': {'bindingProperties': {'string': {'bindingProperties': {'model': 'string'},
'type': 'string'}},
'values': {'displayValue': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]},
'value': {'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': [{'bindingProperties': {'field': 'string',
'property': 'string'},
'concat': (),
'value': 'string'}]}}}}},
'labelDecorator': 'required | optional | none',
'sectionalElements': {'excluded': 'boolean'}}}
Updates an existing form.
See also: AWS API Documentation
Request Syntax
client.update_form(
appId='string',
environmentName='string',
id='string',
clientToken='string',
updatedForm={
'name': 'string',
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'formActionType': 'create'|'update',
'fields': {
'string': {
'label': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'excluded': True|False,
'inputType': {
'type': 'string',
'required': True|False,
'readOnly': True|False,
'placeholder': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
},
'value': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
}
},
],
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string'
}
}
}
},
'name': 'string',
'minValue': ...,
'maxValue': ...,
'step': ...,
'value': 'string',
'isArray': True|False,
'fileUploaderConfig': {
'accessLevel': 'public'|'protected'|'private',
'acceptedFileTypes': [
'string',
],
'showThumbnails': True|False,
'isResumable': True|False,
'maxFileCount': 123,
'maxSize': 123
}
},
'validations': [
{
'type': 'string',
'strValues': [
'string',
],
'numValues': [
123,
],
'validationMessage': 'string'
},
]
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
}
},
'sectionalElements': {
'string': {
'type': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'text': 'string',
'level': 123,
'orientation': 'string',
'excluded': True|False
}
},
'schemaVersion': 'string',
'cta': {
'position': 'top'|'bottom'|'top_and_bottom',
'clear': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'cancel': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'submit': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
}
},
'labelDecorator': 'required'|'optional'|'none'
}
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the form.
string
The unique client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
The request accepts the following data in JSON format.
name (string) --
The name of the form.
dataType (dict) --
The type of data source to use to create the form.
dataSourceType (string) -- [REQUIRED]
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName (string) -- [REQUIRED]
The unique name of the data type you are using as the data source for the form.
formActionType (string) --
Specifies whether to perform a create or update action on the form.
fields (dict) --
The configuration information for the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
type (string) -- [REQUIRED]
The input type for the field.
required (boolean) --
Specifies a field that requires input.
readOnly (boolean) --
Specifies a read only field.
placeholder (string) --
The text to display as a placeholder for the field.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
valueMappings (dict) --
The information to use to customize the input fields with data at runtime.
values (list) -- [REQUIRED]
The value and display value pairs.
(dict) --
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
displayValue (dict) --
The value to display for the complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) -- [REQUIRED]
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
value (dict) -- [REQUIRED]
The complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) -- [REQUIRED]
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind fields to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
name (string) --
The name of the field.
minValue (float) --
The minimum value to display for the field.
maxValue (float) --
The maximum value to display for the field.
step (float) --
The stepping increment for a numeric value in a field.
value (string) --
The value for the field.
isArray (boolean) --
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
fileUploaderConfig (dict) --
The configuration for the file uploader field.
accessLevel (string) -- [REQUIRED]
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
acceptedFileTypes (list) -- [REQUIRED]
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
(string) --
showThumbnails (boolean) --
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.
isResumable (boolean) --
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
maxFileCount (integer) --
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize (integer) --
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
type (string) -- [REQUIRED]
The validation to perform on an object type.
strValues (list) --
The validation to perform on a string value.
(string) --
numValues (list) --
The validation to perform on a number value.
(integer) --
validationMessage (string) --
The validation message to display.
style (dict) --
The configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
verticalGap (dict) --
The spacing for the vertical gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
outerPadding (dict) --
The size of the outer padding for the form.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
sectionalElements (dict) --
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
(string) --
(dict) --
Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
type (string) -- [REQUIRED]
The type of sectional element. Valid values are Heading, Text, and Divider.
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
text (string) --
The text for a Text sectional element.
level (integer) --
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
orientation (string) --
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
excluded (boolean) --
Excludes a sectional element that was generated by default for a specified data model.
schemaVersion (string) --
The schema version of the form.
cta (dict) --
The FormCTA object that stores the call to action configuration for the form.
position (string) --
The position of the button.
clear (dict) --
Displays a clear button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
cancel (dict) --
Displays a cancel button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
submit (dict) --
Displays a submit button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
labelDecorator (string) --
Specifies an icon or decoration to display on the form.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'environmentName': 'string',
'id': 'string',
'name': 'string',
'formActionType': 'create'|'update',
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'fields': {
'string': {
'label': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'excluded': True|False,
'inputType': {
'type': 'string',
'required': True|False,
'readOnly': True|False,
'placeholder': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
},
'value': {
'value': 'string',
'bindingProperties': {
'property': 'string',
'field': 'string'
},
'concat': [
{'... recursive ...'},
]
}
},
],
'bindingProperties': {
'string': {
'type': 'string',
'bindingProperties': {
'model': 'string'
}
}
}
},
'name': 'string',
'minValue': ...,
'maxValue': ...,
'step': ...,
'value': 'string',
'isArray': True|False,
'fileUploaderConfig': {
'accessLevel': 'public'|'protected'|'private',
'acceptedFileTypes': [
'string',
],
'showThumbnails': True|False,
'isResumable': True|False,
'maxFileCount': 123,
'maxSize': 123
}
},
'validations': [
{
'type': 'string',
'strValues': [
'string',
],
'numValues': [
123,
],
'validationMessage': 'string'
},
]
}
},
'sectionalElements': {
'string': {
'type': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
},
'text': 'string',
'level': 123,
'orientation': 'string',
'excluded': True|False
}
},
'schemaVersion': 'string',
'tags': {
'string': 'string'
},
'cta': {
'position': 'top'|'bottom'|'top_and_bottom',
'clear': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'cancel': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
},
'submit': {
'excluded': True|False,
'children': 'string',
'position': {
'fixed': 'first',
'rightOf': 'string',
'below': 'string'
}
}
},
'labelDecorator': 'required'|'optional'|'none'
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the updated form.
appId (string) --
The unique ID of the Amplify app associated with the form.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
formActionType (string) --
The operation to perform on the specified form.
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
verticalGap (dict) --
The spacing for the vertical gap.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
outerPadding (dict) --
The size of the outer padding for the form.
tokenReference (string) --
A reference to a design token to use to bind the form's style properties to an existing theme.
value (string) --
The value of the style setting.
dataType (dict) --
The type of data source to use to create the form.
dataSourceType (string) --
The data source type, either an Amplify DataStore model or a custom data type.
dataTypeName (string) --
The unique name of the data type you are using as the data source for the form.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
type (string) --
The input type for the field.
required (boolean) --
Specifies a field that requires input.
readOnly (boolean) --
Specifies a read only field.
placeholder (string) --
The text to display as a placeholder for the field.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
valueMappings (dict) --
The information to use to customize the input fields with data at runtime.
values (list) --
The value and display value pairs.
(dict) --
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
displayValue (dict) --
The value to display for the complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
bindingProperties (dict) --
The information to bind fields to data at runtime.
property (string) --
The form property to bind to the data field.
field (string) --
The data field to bind the property to.
concat (list) --
A list of form properties to concatenate to create the value to assign to this field property.
(dict) --
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind fields to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
type (string) --
The property type.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
model (string) --
An Amplify DataStore model.
name (string) --
The name of the field.
minValue (float) --
The minimum value to display for the field.
maxValue (float) --
The maximum value to display for the field.
step (float) --
The stepping increment for a numeric value in a field.
value (string) --
The value for the field.
isArray (boolean) --
Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
fileUploaderConfig (dict) --
The configuration for the file uploader field.
accessLevel (string) --
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
acceptedFileTypes (list) --
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
(string) --
showThumbnails (boolean) --
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.
isResumable (boolean) --
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
maxFileCount (integer) --
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
maxSize (integer) --
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
type (string) --
The validation to perform on an object type.
strValues (list) --
The validation to perform on a string value.
(string) --
numValues (list) --
The validation to perform on a number value.
(integer) --
validationMessage (string) --
The validation message to display.
sectionalElements (dict) --
Stores the visual helper elements for the form that are not associated with any data.
(string) --
(dict) --
Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
type (string) --
The type of sectional element. Valid values are Heading, Text, and Divider.
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
text (string) --
The text for a Text sectional element.
level (integer) --
Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
orientation (string) --
Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
excluded (boolean) --
Excludes a sectional element that was generated by default for a specified data model.
schemaVersion (string) --
The schema version of the form when it was imported.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
cta (dict) --
Stores the call to action configuration for the form.
position (string) --
The position of the button.
clear (dict) --
Displays a clear button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
cancel (dict) --
Displays a cancel button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
submit (dict) --
Displays a submit button.
excluded (boolean) --
Specifies whether the button is visible on the form.
children (string) --
Describes the button's properties.
position (dict) --
The position of the button.
fixed (string) --
The field position is fixed and doesn't change in relation to other fields.
rightOf (string) --
The field position is to the right of the field specified by the string.
below (string) --
The field position is below the field specified by the string.
labelDecorator (string) --
Specifies an icon or decoration to display on the form.