2022/09/14 - AWS Amplify UI Builder - 8 new 4 updated api methods
Changes Amplify Studio UIBuilder is introducing forms functionality. Forms can be configured from Data Store models, JSON, or from scratch. These forms can then be generated in your project and used like any other React components.
Creates a new form for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_form(
appId='string',
clientToken='string',
environmentName='string',
formToCreate={
'cta': {
'cancel': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'clear': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'position': 'top'|'bottom'|'top_and_bottom',
'submit': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'fields': {
'string': {
'excluded': True|False,
'inputType': {
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'maxValue': ...,
'minValue': ...,
'name': 'string',
'placeholder': 'string',
'readOnly': True|False,
'required': True|False,
'step': ...,
'type': 'string',
'value': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string'
},
'value': {
'value': 'string'
}
},
]
}
},
'label': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'validations': [
{
'numValues': [
123,
],
'strValues': [
'string',
],
'type': 'string',
'validationMessage': 'string'
},
]
}
},
'formActionType': 'create'|'update',
'name': 'string',
'schemaVersion': 'string',
'sectionalElements': {
'string': {
'level': 123,
'orientation': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'text': 'string',
'type': 'string'
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
}
},
'tags': {
'string': 'string'
}
}
)
string
[REQUIRED]
The unique ID of the Amplify app to associate with the form.
string
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
dict
[REQUIRED]
Represents the configuration of the form to create.
cta (dict) --
The FormCTA object that stores the call to action configuration for the form.
cancel (dict) --
Displays a cancel button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
clear (dict) --
Displays a clear button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
position (string) --
The position of the button.
submit (dict) --
Displays a submit button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
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.
fields (dict) -- [REQUIRED]
The configuration information for the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
maxValue (float) --
The maximum value to display for the field.
minValue (float) --
The minimum value to display for the field.
name (string) --
The name of the field.
placeholder (string) --
The text to display as a placeholder for the field.
readOnly (boolean) --
Specifies a read only field.
required (boolean) --
Specifies a field that requires input.
step (float) --
The stepping increment for a numeric value in a field.
type (string) -- [REQUIRED]
The input type for the field.
value (string) --
The value for the field.
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.
value (dict) -- [REQUIRED]
The complex object.
value (string) --
The value to assign to the input field.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
numValues (list) --
The validation to perform on a number value.
(integer) --
strValues (list) --
The validation to perform on a string value.
(string) --
type (string) -- [REQUIRED]
The validation to perform on an object type.
validationMessage (string) --
The validation message to display.
formActionType (string) -- [REQUIRED]
Specifies whether to perform a create or update action on the form.
name (string) -- [REQUIRED]
The name of the form.
schemaVersion (string) -- [REQUIRED]
The schema version of the form.
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.
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 .
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
text (string) --
The text for a Text sectional element.
type (string) -- [REQUIRED]
The type of sectional element. Valid values are Heading , Text , and Divider .
style (dict) -- [REQUIRED]
The configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: tokenReference, value.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: tokenReference, value.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: tokenReference, value.
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.
tags (dict) --
One or more key-value pairs to use when tagging the form data.
(string) --
(string) --
dict
Response Syntax
{
'entity': {
'appId': 'string',
'cta': {
'cancel': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'clear': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'position': 'top'|'bottom'|'top_and_bottom',
'submit': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'environmentName': 'string',
'fields': {
'string': {
'excluded': True|False,
'inputType': {
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'maxValue': ...,
'minValue': ...,
'name': 'string',
'placeholder': 'string',
'readOnly': True|False,
'required': True|False,
'step': ...,
'type': 'string',
'value': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string'
},
'value': {
'value': 'string'
}
},
]
}
},
'label': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'validations': [
{
'numValues': [
123,
],
'strValues': [
'string',
],
'type': 'string',
'validationMessage': 'string'
},
]
}
},
'formActionType': 'create'|'update',
'id': 'string',
'name': 'string',
'schemaVersion': 'string',
'sectionalElements': {
'string': {
'level': 123,
'orientation': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'text': 'string',
'type': 'string'
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
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.
cta (dict) --
Stores the call to action configuration for the form.
cancel (dict) --
Displays a cancel button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
clear (dict) --
Displays a clear button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
position (string) --
The position of the button.
submit (dict) --
Displays a submit button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
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.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
maxValue (float) --
The maximum value to display for the field.
minValue (float) --
The minimum value to display for the field.
name (string) --
The name of the field.
placeholder (string) --
The text to display as a placeholder for the field.
readOnly (boolean) --
Specifies a read only field.
required (boolean) --
Specifies a field that requires input.
step (float) --
The stepping increment for a numeric value in a field.
type (string) --
The input type for the field.
value (string) --
The value for the field.
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.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
numValues (list) --
The validation to perform on a number value.
(integer) --
strValues (list) --
The validation to perform on a string value.
(string) --
type (string) --
The validation to perform on an object type.
validationMessage (string) --
The validation message to display.
formActionType (string) --
The operation to perform on the specified form.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
schemaVersion (string) --
The schema version of the form when it was imported.
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.
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 .
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
text (string) --
The text for a Text sectional element.
type (string) --
The type of sectional element. Valid values are Heading , Text , and Divider .
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
Stores the metadata information about a feature on a form or view.
See also: AWS API Documentation
Request Syntax
client.put_metadata_flag(
appId='string',
body={
'newValue': 'string'
},
environmentName='string',
featureName='string'
)
string
[REQUIRED]
The unique ID for the Amplify app.
dict
[REQUIRED]
The metadata information to store.
newValue (string) -- [REQUIRED]
The new information to store.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The name of the feature associated with the metadata.
None
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',
'cta': {
'cancel': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'clear': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'position': 'top'|'bottom'|'top_and_bottom',
'submit': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'environmentName': 'string',
'fields': {
'string': {
'excluded': True|False,
'inputType': {
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'maxValue': ...,
'minValue': ...,
'name': 'string',
'placeholder': 'string',
'readOnly': True|False,
'required': True|False,
'step': ...,
'type': 'string',
'value': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string'
},
'value': {
'value': 'string'
}
},
]
}
},
'label': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'validations': [
{
'numValues': [
123,
],
'strValues': [
'string',
],
'type': 'string',
'validationMessage': 'string'
},
]
}
},
'formActionType': 'create'|'update',
'id': 'string',
'name': 'string',
'schemaVersion': 'string',
'sectionalElements': {
'string': {
'level': 123,
'orientation': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'text': 'string',
'type': 'string'
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
}
},
'tags': {
'string': 'string'
}
},
],
'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.
cta (dict) --
Stores the call to action configuration for the form.
cancel (dict) --
Displays a cancel button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
clear (dict) --
Displays a clear button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
position (string) --
The position of the button.
submit (dict) --
Displays a submit button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
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.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
maxValue (float) --
The maximum value to display for the field.
minValue (float) --
The minimum value to display for the field.
name (string) --
The name of the field.
placeholder (string) --
The text to display as a placeholder for the field.
readOnly (boolean) --
Specifies a read only field.
required (boolean) --
Specifies a field that requires input.
step (float) --
The stepping increment for a numeric value in a field.
type (string) --
The input type for the field.
value (string) --
The value for the field.
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.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
numValues (list) --
The validation to perform on a number value.
(integer) --
strValues (list) --
The validation to perform on a string value.
(string) --
type (string) --
The validation to perform on an object type.
validationMessage (string) --
The validation message to display.
formActionType (string) --
The operation to perform on the specified form.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
schemaVersion (string) --
The schema version of the form when it was imported.
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.
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 .
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
text (string) --
The text for a Text sectional element.
type (string) --
The type of sectional element. Valid values are Heading , Text , and Divider .
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
nextToken (string) --
The pagination token that's included if more results are available.
Returns existing metadata for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_metadata(
appId='string',
environmentName='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.
dict
Response Syntax
{
'features': {
'string': 'string'
}
}
Response Structure
(dict) --
features (dict) --
Represents the configuration settings for the features metadata.
(string) --
(string) --
Retrieves a list of forms for a specified Amplify app and backend environment.
See also: AWS API Documentation
Request Syntax
client.list_forms(
appId='string',
environmentName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
integer
The maximum number of forms to retrieve.
string
The token to request the next page of results.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'environmentName': 'string',
'formActionType': 'create'|'update',
'id': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
The list of forms for the Amplify app.
(dict) --
Describes the basic information about a form.
appId (string) --
The unique ID for the app associated with the form summary.
dataType (dict) --
The form's data source type.
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.
environmentName (string) --
The name of the backend environment that is part of the Amplify app.
formActionType (string) --
The type of operation to perform on the form.
id (string) --
The ID of the form.
name (string) --
The name of the form.
nextToken (string) --
The pagination token that's included if more results are available.
Updates an existing form.
See also: AWS API Documentation
Request Syntax
client.update_form(
appId='string',
clientToken='string',
environmentName='string',
id='string',
updatedForm={
'cta': {
'cancel': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'clear': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'position': 'top'|'bottom'|'top_and_bottom',
'submit': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'fields': {
'string': {
'excluded': True|False,
'inputType': {
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'maxValue': ...,
'minValue': ...,
'name': 'string',
'placeholder': 'string',
'readOnly': True|False,
'required': True|False,
'step': ...,
'type': 'string',
'value': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string'
},
'value': {
'value': 'string'
}
},
]
}
},
'label': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'validations': [
{
'numValues': [
123,
],
'strValues': [
'string',
],
'type': 'string',
'validationMessage': 'string'
},
]
}
},
'formActionType': 'create'|'update',
'name': 'string',
'schemaVersion': 'string',
'sectionalElements': {
'string': {
'level': 123,
'orientation': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'text': 'string',
'type': 'string'
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
}
}
}
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the form.
dict
[REQUIRED]
The request accepts the following data in JSON format.
cta (dict) --
The FormCTA object that stores the call to action configuration for the form.
cancel (dict) --
Displays a cancel button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
clear (dict) --
Displays a clear button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
position (string) --
The position of the button.
submit (dict) --
Displays a submit button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
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.
fields (dict) --
The configuration information for the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
maxValue (float) --
The maximum value to display for the field.
minValue (float) --
The minimum value to display for the field.
name (string) --
The name of the field.
placeholder (string) --
The text to display as a placeholder for the field.
readOnly (boolean) --
Specifies a read only field.
required (boolean) --
Specifies a field that requires input.
step (float) --
The stepping increment for a numeric value in a field.
type (string) -- [REQUIRED]
The input type for the field.
value (string) --
The value for the field.
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.
value (dict) -- [REQUIRED]
The complex object.
value (string) --
The value to assign to the input field.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
numValues (list) --
The validation to perform on a number value.
(integer) --
strValues (list) --
The validation to perform on a string value.
(string) --
type (string) -- [REQUIRED]
The validation to perform on an object type.
validationMessage (string) --
The validation message to display.
formActionType (string) --
Specifies whether to perform a create or update action on the form.
name (string) --
The name of the form.
schemaVersion (string) --
The schema version of the form.
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.
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 .
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: below, fixed, rightOf.
below (string) --
The field position is below the field specified by the string.
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.
text (string) --
The text for a Text sectional element.
type (string) -- [REQUIRED]
The type of sectional element. Valid values are Heading , Text , and Divider .
style (dict) --
The configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: tokenReference, value.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: tokenReference, value.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: tokenReference, value.
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.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'cta': {
'cancel': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'clear': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'position': 'top'|'bottom'|'top_and_bottom',
'submit': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'environmentName': 'string',
'fields': {
'string': {
'excluded': True|False,
'inputType': {
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'maxValue': ...,
'minValue': ...,
'name': 'string',
'placeholder': 'string',
'readOnly': True|False,
'required': True|False,
'step': ...,
'type': 'string',
'value': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string'
},
'value': {
'value': 'string'
}
},
]
}
},
'label': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'validations': [
{
'numValues': [
123,
],
'strValues': [
'string',
],
'type': 'string',
'validationMessage': 'string'
},
]
}
},
'formActionType': 'create'|'update',
'id': 'string',
'name': 'string',
'schemaVersion': 'string',
'sectionalElements': {
'string': {
'level': 123,
'orientation': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'text': 'string',
'type': 'string'
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
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.
cta (dict) --
Stores the call to action configuration for the form.
cancel (dict) --
Displays a cancel button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
clear (dict) --
Displays a clear button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
position (string) --
The position of the button.
submit (dict) --
Displays a submit button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
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.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
maxValue (float) --
The maximum value to display for the field.
minValue (float) --
The minimum value to display for the field.
name (string) --
The name of the field.
placeholder (string) --
The text to display as a placeholder for the field.
readOnly (boolean) --
Specifies a read only field.
required (boolean) --
Specifies a field that requires input.
step (float) --
The stepping increment for a numeric value in a field.
type (string) --
The input type for the field.
value (string) --
The value for the field.
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.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
numValues (list) --
The validation to perform on a number value.
(integer) --
strValues (list) --
The validation to perform on a string value.
(string) --
type (string) --
The validation to perform on an object type.
validationMessage (string) --
The validation message to display.
formActionType (string) --
The operation to perform on the specified form.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
schemaVersion (string) --
The schema version of the form when it was imported.
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.
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 .
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
text (string) --
The text for a Text sectional element.
type (string) --
The type of sectional element. Valid values are Heading , Text , and Divider .
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
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',
'cta': {
'cancel': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'clear': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
},
'position': 'top'|'bottom'|'top_and_bottom',
'submit': {
'children': 'string',
'excluded': True|False,
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
}
}
},
'dataType': {
'dataSourceType': 'DataStore'|'Custom',
'dataTypeName': 'string'
},
'environmentName': 'string',
'fields': {
'string': {
'excluded': True|False,
'inputType': {
'defaultChecked': True|False,
'defaultCountryCode': 'string',
'defaultValue': 'string',
'descriptiveText': 'string',
'maxValue': ...,
'minValue': ...,
'name': 'string',
'placeholder': 'string',
'readOnly': True|False,
'required': True|False,
'step': ...,
'type': 'string',
'value': 'string',
'valueMappings': {
'values': [
{
'displayValue': {
'value': 'string'
},
'value': {
'value': 'string'
}
},
]
}
},
'label': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'validations': [
{
'numValues': [
123,
],
'strValues': [
'string',
],
'type': 'string',
'validationMessage': 'string'
},
]
}
},
'formActionType': 'create'|'update',
'id': 'string',
'name': 'string',
'schemaVersion': 'string',
'sectionalElements': {
'string': {
'level': 123,
'orientation': 'string',
'position': {
'below': 'string',
'fixed': 'first',
'rightOf': 'string'
},
'text': 'string',
'type': 'string'
}
},
'style': {
'horizontalGap': {
'tokenReference': 'string',
'value': 'string'
},
'outerPadding': {
'tokenReference': 'string',
'value': 'string'
},
'verticalGap': {
'tokenReference': 'string',
'value': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
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.
cta (dict) --
Stores the call to action configuration for the form.
cancel (dict) --
Displays a cancel button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
clear (dict) --
Displays a clear button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
position (string) --
The position of the button.
submit (dict) --
Displays a submit button.
children (string) --
Describes the button's properties.
excluded (boolean) --
Specifies whether the button is visible on the form.
position (dict) --
The position of the button.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
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.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
fields (dict) --
Stores the information about the form's fields.
(string) --
(dict) --
Describes the configuration information for a field in a table.
excluded (boolean) --
Specifies whether to hide a field.
inputType (dict) --
Describes the configuration for the default input value to display for a field.
defaultChecked (boolean) --
Specifies whether a field has a default value.
defaultCountryCode (string) --
The default country code for a phone number.
defaultValue (string) --
The default value for the field.
descriptiveText (string) --
The text to display to describe the field.
maxValue (float) --
The maximum value to display for the field.
minValue (float) --
The minimum value to display for the field.
name (string) --
The name of the field.
placeholder (string) --
The text to display as a placeholder for the field.
readOnly (boolean) --
Specifies a read only field.
required (boolean) --
Specifies a field that requires input.
step (float) --
The stepping increment for a numeric value in a field.
type (string) --
The input type for the field.
value (string) --
The value for the field.
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.
value (dict) --
The complex object.
value (string) --
The value to assign to the input field.
label (string) --
The label for the field.
position (dict) --
Specifies the field position.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
validations (list) --
The validations to perform on the value in the field.
(dict) --
Describes the validation configuration for a field.
numValues (list) --
The validation to perform on a number value.
(integer) --
strValues (list) --
The validation to perform on a string value.
(string) --
type (string) --
The validation to perform on an object type.
validationMessage (string) --
The validation message to display.
formActionType (string) --
The operation to perform on the specified form.
id (string) --
The unique ID of the form.
name (string) --
The name of the form.
schemaVersion (string) --
The schema version of the form when it was imported.
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.
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 .
position (dict) --
Specifies the position of the text in a field for a Text sectional element.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: below, fixed, rightOf. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
below (string) --
The field position is below the field specified by the string.
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.
text (string) --
The text for a Text sectional element.
type (string) --
The type of sectional element. Valid values are Heading , Text , and Divider .
style (dict) --
Stores the configuration for the form's style.
horizontalGap (dict) --
The spacing for the horizontal gap.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: tokenReference, value. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
tags (dict) --
One or more key-value pairs to use when tagging the form.
(string) --
(string) --
Deletes a form from an Amplify app.
See also: AWS API Documentation
Request Syntax
client.delete_form(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app associated with the form to delete.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
[REQUIRED]
The unique ID of the form to delete.
None
{'componentToCreate': {'bindingProperties': {'bindingProperties': {'slotName': 'string'}}}}
Response {'entity': {'bindingProperties': {'bindingProperties': {'slotName': 'string'}}}}
Creates a new component for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_component(
appId='string',
clientToken='string',
componentToCreate={
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
},
environmentName='string'
)
string
[REQUIRED]
The unique ID of the Amplify app to associate with the component.
string
The unique client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
Represents the configuration of the component to create.
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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of child components that are instances of the main component.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) -- [REQUIRED]
The type of the child component.
events (dict) --
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) -- [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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
The data binding configuration for customizing a component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) -- [REQUIRED]
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
field (string) -- [REQUIRED]
The field to perform the sort on.
componentType (string) -- [REQUIRED]
The component type. This can be an Amplify custom UI component or another custom component.
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.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) -- [REQUIRED]
The name of the component
overrides (dict) -- [REQUIRED]
Describes the component properties that can be overriden to customize an instance of the component.
(string) --
(dict) --
(string) --
(string) --
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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component data.
(string) --
(string) --
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.
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) --
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
(string) --
(string) --
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the new component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
events (dict) --
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
events (dict) --
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
(string) --
(string) --
{'entities': {'bindingProperties': {'bindingProperties': {'slotName': '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',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
},
],
'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.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
events (dict) --
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
events (dict) --
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
(string) --
(string) --
nextToken (string) --
The pagination token that's included if more results are available.
{'component': {'bindingProperties': {'bindingProperties': {'slotName': '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',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
component (dict) --
Represents the configuration settings for the component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
events (dict) --
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
events (dict) --
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
(string) --
(string) --
{'updatedComponent': {'bindingProperties': {'bindingProperties': {'slotName': 'string'}}}}
Response {'entity': {'bindingProperties': {'bindingProperties': {'slotName': 'string'}}}}
Updates an existing component.
See also: AWS API Documentation
Request Syntax
client.update_component(
appId='string',
clientToken='string',
environmentName='string',
id='string',
updatedComponent={
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the component.
dict
[REQUIRED]
The configuration of the updated component.
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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
The components that are instances of the main component.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) -- [REQUIRED]
The type of the child component.
events (dict) --
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) -- [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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
The 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.
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) --
model (string) -- [REQUIRED]
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
field (string) -- [REQUIRED]
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
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.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) -- [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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (string) --
The unique ID of the component to update.
name (string) --
The name of the component to update.
overrides (dict) --
Describes the properties that can be overriden to customize the component.
(string) --
(dict) --
(string) --
(string) --
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.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
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.
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) --
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
(string) --
(string) --
dict
Response Syntax
{
'entity': {
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'slotName': 'string',
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string'
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'events': {
'string': {
'action': 'string',
'bindingEvent': 'string',
'parameters': {
'anchor': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'fields': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'global': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'id': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'model': 'string',
'state': {
'componentName': 'string',
'property': 'string',
'set': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'target': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'type': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
},
'url': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
}
},
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'componentName': 'string',
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operandType': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'property': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'schemaVersion': 'string',
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the updated component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
slotName (string) --
The name of a component slot.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
events (dict) --
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the child component in its original source system, such as Figma.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties .
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
events (dict) --
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
(string) --
(dict) --
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild . A button click is an example of an event.
action (string) --
The action to perform when a specific event is raised.
bindingEvent (string) --
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters (dict) --
Describes information about the action.
anchor (dict) --
The HTML anchor link to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
fields (dict) --
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
global (dict) --
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (dict) --
The unique ID of the component that the ActionParameters apply to.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
model (string) --
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state (dict) --
A key-value pair that specifies the state property name and its initial value.
componentName (string) --
The name of the component that is being modified.
property (string) --
The name of the component property to apply the state configuration to.
set (dict) --
The state configuration to assign to the property.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
target (dict) --
The element within the same component to modify when the action occurs.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
type (dict) --
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
url (dict) --
The URL to the location to open. Specify this value for a navigation action.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties. You can't specify tags as a valid property for properties .
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
componentName (string) --
The name of the component that is affected by an event.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property.
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operandType (string) --
The type of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to the property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
property (string) --
The name of the component's property that is affected by an event.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
schemaVersion (string) --
The schema version of the component when it was imported.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues .
(string) --
(string) --