AmplifyUIBuilder **************** Client ====== class AmplifyUIBuilder.Client A low-level client representing AWS Amplify UI Builder The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources. You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the *Amplify Docs*. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide. import boto3 client = boto3.client('amplifyuibuilder') These are the available methods: * can_paginate * close * create_component * create_form * create_theme * delete_component * delete_form * delete_theme * exchange_code_for_token * export_components * export_forms * export_themes * get_codegen_job * get_component * get_form * get_metadata * get_paginator * get_theme * get_waiter * list_codegen_jobs * list_components * list_forms * list_tags_for_resource * list_themes * put_metadata_flag * refresh_token * start_codegen_job * tag_resource * untag_resource * update_component * update_form * update_theme Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ExportComponents * ExportForms * ExportThemes * ListCodegenJobs * ListComponents * ListForms * ListThemes AmplifyUIBuilder / Paginator / ListForms ListForms ********* class AmplifyUIBuilder.Paginator.ListForms paginator = client.get_paginator('list_forms') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.list_forms()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* A token to resume pagination. AmplifyUIBuilder / Paginator / ListComponents ListComponents ************** class AmplifyUIBuilder.Paginator.ListComponents paginator = client.get_paginator('list_components') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.list_components()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* The list of components for the Amplify app. * *(dict) --* Contains a summary of a component. This is a read-only data type that is returned by "ListComponents". * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The component type. * **NextToken** *(string) --* A token to resume pagination. AmplifyUIBuilder / Paginator / ListThemes ListThemes ********** class AmplifyUIBuilder.Paginator.ListThemes paginator = client.get_paginator('list_themes') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.list_themes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* The list of themes for the Amplify app. * *(dict) --* Describes the basic information about a theme. * **appId** *(string) --* The unique ID for the app associated with the theme summary. * **environmentName** *(string) --* The name of the backend environment that is part of the Amplify app. * **id** *(string) --* The ID of the theme. * **name** *(string) --* The name of the theme. * **NextToken** *(string) --* A token to resume pagination. AmplifyUIBuilder / Paginator / ExportForms ExportForms *********** class AmplifyUIBuilder.Paginator.ExportForms paginator = client.get_paginator('export_forms') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.export_forms()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to export forms to. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'formActionType': 'create'|'update', 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'tags': { 'string': 'string' }, 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'labelDecorator': 'required'|'optional'|'none' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* Represents the configuration of the exported forms. * *(dict) --* Contains the configuration settings for a "Form" user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form. * **appId** *(string) --* The unique ID of the Amplify app associated with the form. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the form. * **name** *(string) --* The name of the form. * **formActionType** *(string) --* The operation to perform on the specified form. * **style** *(dict) --* Stores the configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **dataType** *(dict) --* The type of data source to use to create the form. * **dataSourceType** *(string) --* The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* The unique name of the data type you are using as the data source for the form. * **fields** *(dict) --* Stores the information about the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **sectionalElements** *(dict) --* Stores the visual helper elements for the form that are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* The schema version of the form when it was imported. * **tags** *(dict) --* One or more key-value pairs to use when tagging the form. * *(string) --* * *(string) --* * **cta** *(dict) --* Stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. * **NextToken** *(string) --* A token to resume pagination. AmplifyUIBuilder / Paginator / ListCodegenJobs ListCodegenJobs *************** class AmplifyUIBuilder.Paginator.ListCodegenJobs paginator = client.get_paginator('list_codegen_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.list_codegen_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* The list of code generation jobs for the Amplify app. * *(dict) --* A summary of the basic information about the code generation job. * **appId** *(string) --* The unique ID of the Amplify app associated with the code generation job. * **environmentName** *(string) --* The name of the backend environment associated with the code generation job. * **id** *(string) --* The unique ID for the code generation job summary. * **createdAt** *(datetime) --* The time that the code generation job summary was created. * **modifiedAt** *(datetime) --* The time that the code generation job summary was modified. * **NextToken** *(string) --* A token to resume pagination. AmplifyUIBuilder / Paginator / ExportThemes ExportThemes ************ class AmplifyUIBuilder.Paginator.ExportThemes paginator = client.get_paginator('export_themes') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.export_themes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to export the themes to. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* Represents the configuration of the exported themes. * *(dict) --* A theme is a collection of style settings that apply globally to the components associated with an Amplify application. * **appId** *(string) --* The unique ID for the Amplify app associated with the theme. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The ID for the theme. * **name** *(string) --* The name of the theme. * **createdAt** *(datetime) --* The time that the theme was created. * **modifiedAt** *(datetime) --* The time that the theme was modified. * **values** *(list) --* A list of key-value pairs that defines the properties of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize a theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **tags** *(dict) --* One or more key-value pairs to use when tagging the theme. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. AmplifyUIBuilder / Paginator / ExportComponents ExportComponents **************** class AmplifyUIBuilder.Paginator.ExportComponents paginator = client.get_paginator('export_components') paginate(**kwargs) Creates an iterator that will paginate through responses from "AmplifyUIBuilder.Client.export_components()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appId='string', environmentName='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to export components to. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'sourceId': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* Represents the configuration of the exported components. * *(dict) --* Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use "ComponentChild" to configure an instance of a "Component". A "ComponentChild" instance inherits the configuration of the main "Component". * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The type of the component. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* Describes the component's properties. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* A list of the component's "ComponentChild" instances. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* The type of the child component. * **name** *(string) --* The name of the child component. * **properties** *(dict) --* Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* A list of the component's variants. A variant is a unique style configuration of a main component. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* Describes the component's properties that can be overriden in a customized instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* The information to connect a component's properties to data at runtime. You can't specify "tags" as a valid property for "bindingProperties". * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The data binding configuration for the component's properties. Use this for a collection component. You can't specify "tags" as a valid property for "collectionProperties". * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* The field to perform the sort on. * **direction** *(string) --* The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **createdAt** *(datetime) --* The time that the component was created. * **modifiedAt** *(datetime) --* The time that the component was modified. * **tags** *(dict) --* One or more key-value pairs to use when tagging the component. * *(string) --* * *(string) --* * **events** *(dict) --* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. * **NextToken** *(string) --* A token to resume pagination. AmplifyUIBuilder / Client / delete_component delete_component **************** AmplifyUIBuilder.Client.delete_component(**kwargs) Deletes a component from an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.delete_component( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app associated with the component to delete. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID of the component to delete. Returns: None **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / get_paginator get_paginator ************* AmplifyUIBuilder.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. AmplifyUIBuilder / Client / list_forms list_forms ********** AmplifyUIBuilder.Client.list_forms(**kwargs) Retrieves a list of forms for a specified Amplify app and backend environment. See also: AWS API Documentation **Request Syntax** response = client.list_forms( appId='string', environmentName='string', nextToken='string', maxResults=123 ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. * **maxResults** (*integer*) -- The maximum number of forms to retrieve. Return type: dict Returns: **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. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / list_components list_components *************** AmplifyUIBuilder.Client.list_components(**kwargs) Retrieves a list of components for a specified Amplify app and backend environment. See also: AWS API Documentation **Request Syntax** response = client.list_components( appId='string', environmentName='string', nextToken='string', maxResults=123 ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. * **maxResults** (*integer*) -- The maximum number of components to retrieve. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* The list of components for the Amplify app. * *(dict) --* Contains a summary of a component. This is a read-only data type that is returned by "ListComponents". * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The component type. * **nextToken** *(string) --* The pagination token that's included if more results are available. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / export_components export_components ***************** AmplifyUIBuilder.Client.export_components(**kwargs) Exports component configurations to code that is ready to integrate into an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.export_components( appId='string', environmentName='string', nextToken='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to export components to. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'sourceId': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* Represents the configuration of the exported components. * *(dict) --* Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use "ComponentChild" to configure an instance of a "Component". A "ComponentChild" instance inherits the configuration of the main "Component". * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The type of the component. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* Describes the component's properties. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* A list of the component's "ComponentChild" instances. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* The type of the child component. * **name** *(string) --* The name of the child component. * **properties** *(dict) --* Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* A list of the component's variants. A variant is a unique style configuration of a main component. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* Describes the component's properties that can be overriden in a customized instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* The information to connect a component's properties to data at runtime. You can't specify "tags" as a valid property for "bindingProperties". * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The data binding configuration for the component's properties. Use this for a collection component. You can't specify "tags" as a valid property for "collectionProperties". * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* The field to perform the sort on. * **direction** *(string) --* The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **createdAt** *(datetime) --* The time that the component was created. * **modifiedAt** *(datetime) --* The time that the component was modified. * **tags** *(dict) --* One or more key-value pairs to use when tagging the component. * *(string) --* * *(string) --* * **events** *(dict) --* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. * **nextToken** *(string) --* The pagination token that's included if more results are available. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / can_paginate can_paginate ************ AmplifyUIBuilder.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. AmplifyUIBuilder / Client / delete_theme delete_theme ************ AmplifyUIBuilder.Client.delete_theme(**kwargs) Deletes a theme from an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.delete_theme( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app associated with the theme to delete. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID of the theme to delete. Returns: None **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / refresh_token refresh_token ************* AmplifyUIBuilder.Client.refresh_token(**kwargs) Note: This is for internal use. Amplify uses this action to refresh a previously issued access token that might have expired. See also: AWS API Documentation **Request Syntax** response = client.refresh_token( provider='figma', refreshTokenBody={ 'token': 'string', 'clientId': 'string' } ) Parameters: * **provider** (*string*) -- **[REQUIRED]** The third-party provider for the token. The only valid value is "figma". * **refreshTokenBody** (*dict*) -- **[REQUIRED]** Information about the refresh token request. * **token** *(string) --* **[REQUIRED]** The token to use to refresh a previously issued access token that might have expired. * **clientId** *(string) --* The ID of the client to request the token from. Return type: dict Returns: **Response Syntax** { 'accessToken': 'string', 'expiresIn': 123 } **Response Structure** * *(dict) --* * **accessToken** *(string) --* The access token. * **expiresIn** *(integer) --* The date and time when the new access token expires. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / list_themes list_themes *********** AmplifyUIBuilder.Client.list_themes(**kwargs) Retrieves a list of themes for a specified Amplify app and backend environment. See also: AWS API Documentation **Request Syntax** response = client.list_themes( appId='string', environmentName='string', nextToken='string', maxResults=123 ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. * **maxResults** (*integer*) -- The maximum number of theme results to return in the response. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* The list of themes for the Amplify app. * *(dict) --* Describes the basic information about a theme. * **appId** *(string) --* The unique ID for the app associated with the theme summary. * **environmentName** *(string) --* The name of the backend environment that is part of the Amplify app. * **id** *(string) --* The ID of the theme. * **name** *(string) --* The name of the theme. * **nextToken** *(string) --* The pagination token that's returned if more results are available. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / list_tags_for_resource list_tags_for_resource ********************** AmplifyUIBuilder.Client.list_tags_for_resource(**kwargs) Returns a list of tags for a specified Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to list tags. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A list of tag key value pairs for a specified Amazon Resource Name (ARN). * *(string) --* * *(string) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.UnauthorizedException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ThrottlingException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / untag_resource untag_resource ************** AmplifyUIBuilder.Client.untag_resource(**kwargs) Untags a resource with a specified Amazon Resource Name (ARN). See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to untag a resource. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys to use to untag a resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.UnauthorizedException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ThrottlingException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / list_codegen_jobs list_codegen_jobs ***************** AmplifyUIBuilder.Client.list_codegen_jobs(**kwargs) Retrieves a list of code generation jobs for a specified Amplify app and backend environment. See also: AWS API Documentation **Request Syntax** response = client.list_codegen_jobs( appId='string', environmentName='string', nextToken='string', maxResults=123 ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. * **maxResults** (*integer*) -- The maximum number of jobs to retrieve. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* The list of code generation jobs for the Amplify app. * *(dict) --* A summary of the basic information about the code generation job. * **appId** *(string) --* The unique ID of the Amplify app associated with the code generation job. * **environmentName** *(string) --* The name of the backend environment associated with the code generation job. * **id** *(string) --* The unique ID for the code generation job summary. * **createdAt** *(datetime) --* The time that the code generation job summary was created. * **modifiedAt** *(datetime) --* The time that the code generation job summary was modified. * **nextToken** *(string) --* The pagination token that's included if more results are available. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ThrottlingException" AmplifyUIBuilder / Client / get_waiter get_waiter ********** AmplifyUIBuilder.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" AmplifyUIBuilder / Client / get_codegen_job get_codegen_job *************** AmplifyUIBuilder.Client.get_codegen_job(**kwargs) Returns an existing code generation job. See also: AWS API Documentation **Request Syntax** response = client.get_codegen_job( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app associated with the code generation job. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app associated with the code generation job. * **id** (*string*) -- **[REQUIRED]** The unique ID of the code generation job. Return type: dict Returns: **Response Syntax** { 'job': { 'id': 'string', 'appId': 'string', 'environmentName': 'string', 'renderConfig': { 'react': { 'module': 'es2020'|'esnext', 'target': 'es2015'|'es2020', 'script': 'jsx'|'tsx'|'js', 'renderTypeDeclarations': True|False, 'inlineSourceMap': True|False, 'apiConfiguration': { 'graphQLConfig': { 'typesFilePath': 'string', 'queriesFilePath': 'string', 'mutationsFilePath': 'string', 'subscriptionsFilePath': 'string', 'fragmentsFilePath': 'string' }, 'dataStoreConfig': {}, 'noApiConfig': {} }, 'dependencies': { 'string': 'string' } } }, 'genericDataSchema': { 'dataSourceType': 'DataStore', 'models': { 'string': { 'fields': { 'string': { 'dataType': 'ID'|'String'|'Int'|'Float'|'AWSDate'|'AWSTime'|'AWSDateTime'|'AWSTimestamp'|'AWSEmail'|'AWSURL'|'AWSIPAddress'|'Boolean'|'AWSJSON'|'AWSPhone'|'Enum'|'Model'|'NonModel', 'dataTypeValue': 'string', 'required': True|False, 'readOnly': True|False, 'isArray': True|False, 'relationship': { 'type': 'HAS_MANY'|'HAS_ONE'|'BELONGS_TO', 'relatedModelName': 'string', 'relatedModelFields': [ 'string', ], 'canUnlinkAssociatedModel': True|False, 'relatedJoinFieldName': 'string', 'relatedJoinTableName': 'string', 'belongsToFieldOnRelatedModel': 'string', 'associatedFields': [ 'string', ], 'isHasManyIndex': True|False } } }, 'isJoinTable': True|False, 'primaryKeys': [ 'string', ] } }, 'enums': { 'string': { 'values': [ 'string', ] } }, 'nonModels': { 'string': { 'fields': { 'string': { 'dataType': 'ID'|'String'|'Int'|'Float'|'AWSDate'|'AWSTime'|'AWSDateTime'|'AWSTimestamp'|'AWSEmail'|'AWSURL'|'AWSIPAddress'|'Boolean'|'AWSJSON'|'AWSPhone'|'Enum'|'Model'|'NonModel', 'dataTypeValue': 'string', 'required': True|False, 'readOnly': True|False, 'isArray': True|False, 'relationship': { 'type': 'HAS_MANY'|'HAS_ONE'|'BELONGS_TO', 'relatedModelName': 'string', 'relatedModelFields': [ 'string', ], 'canUnlinkAssociatedModel': True|False, 'relatedJoinFieldName': 'string', 'relatedJoinTableName': 'string', 'belongsToFieldOnRelatedModel': 'string', 'associatedFields': [ 'string', ], 'isHasManyIndex': True|False } } } } } }, 'autoGenerateForms': True|False, 'features': { 'isRelationshipSupported': True|False, 'isNonModelSupported': True|False }, 'status': 'in_progress'|'failed'|'succeeded', 'statusMessage': 'string', 'asset': { 'downloadUrl': 'string' }, 'tags': { 'string': 'string' }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'dependencies': [ { 'name': 'string', 'supportedVersion': 'string', 'isSemVer': True|False, 'reason': 'string' }, ] } } **Response Structure** * *(dict) --* * **job** *(dict) --* The configuration settings for the code generation job. * **id** *(string) --* The unique ID for the code generation job. * **appId** *(string) --* The ID of the Amplify app associated with the code generation job. * **environmentName** *(string) --* The name of the backend environment associated with the code generation job. * **renderConfig** *(dict) --* Describes the configuration information for rendering the UI component associated with the code generation job. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "react". 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'} * **react** *(dict) --* The name of the "ReactStartCodegenJobData" object. * **module** *(string) --* The JavaScript module type. * **target** *(string) --* The ECMAScript specification to use. * **script** *(string) --* The file type to use for a JavaScript project. * **renderTypeDeclarations** *(boolean) --* Specifies whether the code generation job should render type declaration files. * **inlineSourceMap** *(boolean) --* Specifies whether the code generation job should render inline source maps. * **apiConfiguration** *(dict) --* The API configuration for the code generation job. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "graphQLConfig", "dataStoreConfig", "noApiConfig". 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'} * **graphQLConfig** *(dict) --* The configuration for an application using GraphQL APIs. * **typesFilePath** *(string) --* The path to the GraphQL types file, relative to the component output directory. * **queriesFilePath** *(string) --* The path to the GraphQL queries file, relative to the component output directory. * **mutationsFilePath** *(string) --* The path to the GraphQL mutations file, relative to the component output directory. * **subscriptionsFilePath** *(string) --* The path to the GraphQL subscriptions file, relative to the component output directory. * **fragmentsFilePath** *(string) --* The path to the GraphQL fragments file, relative to the component output directory. * **dataStoreConfig** *(dict) --* The configuration for an application using DataStore APIs. * **noApiConfig** *(dict) --* The configuration for an application with no API being used. * **dependencies** *(dict) --* Lists the dependency packages that may be required for the project code to run. * *(string) --* * *(string) --* * **genericDataSchema** *(dict) --* Describes the data schema for a code generation job. * **dataSourceType** *(string) --* The type of the data source for the schema. Currently, the only valid value is an Amplify "DataStore". * **models** *(dict) --* The name of a "CodegenGenericDataModel". * *(string) --* * *(dict) --* Describes a model in a generic data schema. * **fields** *(dict) --* The fields in the generic data model. * *(string) --* * *(dict) --* Describes a field in a generic data schema. * **dataType** *(string) --* The data type for the generic data field. * **dataTypeValue** *(string) --* The value of the data type for the generic data field. * **required** *(boolean) --* Specifies whether the generic data field is required. * **readOnly** *(boolean) --* Specifies whether the generic data field is read-only. * **isArray** *(boolean) --* Specifies whether the generic data field is an array. * **relationship** *(dict) --* The relationship of the generic data schema. * **type** *(string) --* The data relationship type. * **relatedModelName** *(string) --* The name of the related model in the data relationship. * **relatedModelFields** *(list) --* The related model fields in the data relationship. * *(string) --* * **canUnlinkAssociatedModel** *(boolean) --* Specifies whether the relationship can unlink the associated model. * **relatedJoinFieldName** *(string) --* The name of the related join field in the data relationship. * **relatedJoinTableName** *(string) --* The name of the related join table in the data relationship. * **belongsToFieldOnRelatedModel** *(string) --* The value of the "belongsTo" field on the related data model. * **associatedFields** *(list) --* The associated fields of the data relationship. * *(string) --* * **isHasManyIndex** *(boolean) --* Specifies whether the "@index" directive is supported for a "hasMany" data relationship. * **isJoinTable** *(boolean) --* Specifies whether the generic data model is a join table. * **primaryKeys** *(list) --* The primary keys of the generic data model. * *(string) --* * **enums** *(dict) --* The name of a "CodegenGenericDataEnum". * *(string) --* * *(dict) --* Describes the enums in a generic data schema. * **values** *(list) --* The list of enum values in the generic data schema. * *(string) --* * **nonModels** *(dict) --* The name of a "CodegenGenericDataNonModel". * *(string) --* * *(dict) --* Describes a non-model in a generic data schema. * **fields** *(dict) --* The fields in a generic data schema non model. * *(string) --* * *(dict) --* Describes a field in a generic data schema. * **dataType** *(string) --* The data type for the generic data field. * **dataTypeValue** *(string) --* The value of the data type for the generic data field. * **required** *(boolean) --* Specifies whether the generic data field is required. * **readOnly** *(boolean) --* Specifies whether the generic data field is read-only. * **isArray** *(boolean) --* Specifies whether the generic data field is an array. * **relationship** *(dict) --* The relationship of the generic data schema. * **type** *(string) --* The data relationship type. * **relatedModelName** *(string) --* The name of the related model in the data relationship. * **relatedModelFields** *(list) --* The related model fields in the data relationship. * *(string) --* * **canUnlinkAssociatedModel** *(boolean) --* Specifies whether the relationship can unlink the associated model. * **relatedJoinFieldName** *(string) --* The name of the related join field in the data relationship. * **relatedJoinTableName** *(string) --* The name of the related join table in the data relationship. * **belongsToFieldOnRelatedModel** *(string) --* The value of the "belongsTo" field on the related data model. * **associatedFields** *(list) --* The associated fields of the data relationship. * *(string) --* * **isHasManyIndex** *(boolean) --* Specifies whether the "@index" directive is supported for a "hasMany" data relationship. * **autoGenerateForms** *(boolean) --* Specifies whether to autogenerate forms in the code generation job. * **features** *(dict) --* Describes the feature flags that you can specify for a code generation job. * **isRelationshipSupported** *(boolean) --* Specifes whether a code generation job supports data relationships. * **isNonModelSupported** *(boolean) --* Specifies whether a code generation job supports non models. * **status** *(string) --* The status of the code generation job. * **statusMessage** *(string) --* The customized status message for the code generation job. * **asset** *(dict) --* The "CodegenJobAsset" to use for the code generation job. * **downloadUrl** *(string) --* The URL to use to access the asset. * **tags** *(dict) --* One or more key-value pairs to use when tagging the code generation job. * *(string) --* * *(string) --* * **createdAt** *(datetime) --* The time that the code generation job was created. * **modifiedAt** *(datetime) --* The time that the code generation job was modified. * **dependencies** *(list) --* Lists the dependency packages that may be required for the project code to run. * *(dict) --* Dependency package that may be required for the project code to run. * **name** *(string) --* Name of the dependency package. * **supportedVersion** *(string) --* Indicates the version of the supported dependency package. * **isSemVer** *(boolean) --* Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning. * **reason** *(string) --* Indicates the reason to include the dependency package in your project code. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ThrottlingException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / create_component create_component **************** AmplifyUIBuilder.Client.create_component(**kwargs) Creates a new component for an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.create_component( appId='string', environmentName='string', clientToken='string', componentToCreate={ 'name': 'string', 'sourceId': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'tags': { 'string': 'string' }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to associate with the component. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **clientToken** (*string*) -- The unique client token. This field is autopopulated if not provided. * **componentToCreate** (*dict*) -- **[REQUIRED]** Represents the configuration of the component to create. * **name** *(string) --* **[REQUIRED]** The name of the component * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **componentType** *(string) --* **[REQUIRED]** The component type. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* **[REQUIRED]** Describes the component's properties. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* A list of child components that are instances of the main component. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* **[REQUIRED]** The type of the child component. * **name** *(string) --* **[REQUIRED]** The name of the child component. * **properties** *(dict) --* **[REQUIRED]** Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* **[REQUIRED]** The name of the component that is being modified. * **property** *(string) --* **[REQUIRED]** The name of the component property to apply the state configuration to. * **set** *(dict) --* **[REQUIRED]** The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* **[REQUIRED]** A list of the unique variants of this component. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* **[REQUIRED]** Describes the component properties that can be overriden to customize an instance of the component. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* **[REQUIRED]** The data binding information for the component's properties. * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The data binding configuration for customizing a component's properties. Use this for a collection component. * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* **[REQUIRED]** The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* **[REQUIRED]** The field to perform the sort on. * **direction** *(string) --* **[REQUIRED]** The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **tags** *(dict) --* One or more key-value pairs to use when tagging the component data. * *(string) --* * *(string) --* * **events** *(dict) --* The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* **[REQUIRED]** The name of the component that is being modified. * **property** *(string) --* **[REQUIRED]** The name of the component property to apply the state configuration to. * **set** *(dict) --* **[REQUIRED]** The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. Return type: dict Returns: **Response Syntax** { 'entity': { 'appId': 'string', 'environmentName': 'string', 'sourceId': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' } } **Response Structure** * *(dict) --* * **entity** *(dict) --* Describes the configuration of the new component. * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The type of the component. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* Describes the component's properties. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* A list of the component's "ComponentChild" instances. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* The type of the child component. * **name** *(string) --* The name of the child component. * **properties** *(dict) --* Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* A list of the component's variants. A variant is a unique style configuration of a main component. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* Describes the component's properties that can be overriden in a customized instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* The information to connect a component's properties to data at runtime. You can't specify "tags" as a valid property for "bindingProperties". * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The data binding configuration for the component's properties. Use this for a collection component. You can't specify "tags" as a valid property for "collectionProperties". * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* The field to perform the sort on. * **direction** *(string) --* The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **createdAt** *(datetime) --* The time that the component was created. * **modifiedAt** *(datetime) --* The time that the component was modified. * **tags** *(dict) --* One or more key-value pairs to use when tagging the component. * *(string) --* * *(string) --* * **events** *(dict) --* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.ServiceQuotaExceededExceptio n" * "AmplifyUIBuilder.Client.exceptions.ResourceConflictException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / update_form update_form *********** AmplifyUIBuilder.Client.update_form(**kwargs) Updates an existing form. See also: AWS API Documentation **Request Syntax** response = client.update_form( appId='string', environmentName='string', id='string', clientToken='string', updatedForm={ 'name': 'string', 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'formActionType': 'create'|'update', 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'labelDecorator': 'required'|'optional'|'none' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID for the form. * **clientToken** (*string*) -- The unique client token. This field is autopopulated if not provided. * **updatedForm** (*dict*) -- **[REQUIRED]** The request accepts the following data in JSON format. * **name** *(string) --* The name of the form. * **dataType** *(dict) --* The type of data source to use to create the form. * **dataSourceType** *(string) --* **[REQUIRED]** The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* **[REQUIRED]** The unique name of the data type you are using as the data source for the form. * **formActionType** *(string) --* Specifies whether to perform a create or update action on the form. * **fields** *(dict) --* The configuration information for the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* **[REQUIRED]** The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* **[REQUIRED]** The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* **[REQUIRED]** The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* **[REQUIRED]** The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* **[REQUIRED]** The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* **[REQUIRED]** The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* **[REQUIRED]** The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* **[REQUIRED]** The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **style** *(dict) --* The configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **sectionalElements** *(dict) --* The configuration information for the visual helper elements for the form. These elements are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* **[REQUIRED]** The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* The schema version of the form. * **cta** *(dict) --* The "FormCTA" object that stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. Return type: dict Returns: **Response Syntax** { 'entity': { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'formActionType': 'create'|'update', 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'tags': { 'string': 'string' }, 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'labelDecorator': 'required'|'optional'|'none' } } **Response Structure** * *(dict) --* * **entity** *(dict) --* Describes the configuration of the updated form. * **appId** *(string) --* The unique ID of the Amplify app associated with the form. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the form. * **name** *(string) --* The name of the form. * **formActionType** *(string) --* The operation to perform on the specified form. * **style** *(dict) --* Stores the configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **dataType** *(dict) --* The type of data source to use to create the form. * **dataSourceType** *(string) --* The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* The unique name of the data type you are using as the data source for the form. * **fields** *(dict) --* Stores the information about the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **sectionalElements** *(dict) --* Stores the visual helper elements for the form that are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* The schema version of the form when it was imported. * **tags** *(dict) --* One or more key-value pairs to use when tagging the form. * *(string) --* * *(string) --* * **cta** *(dict) --* Stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.ResourceConflictException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / start_codegen_job start_codegen_job ***************** AmplifyUIBuilder.Client.start_codegen_job(**kwargs) Starts a code generation job for a specified Amplify app and backend environment. See also: AWS API Documentation **Request Syntax** response = client.start_codegen_job( appId='string', environmentName='string', clientToken='string', codegenJobToCreate={ 'renderConfig': { 'react': { 'module': 'es2020'|'esnext', 'target': 'es2015'|'es2020', 'script': 'jsx'|'tsx'|'js', 'renderTypeDeclarations': True|False, 'inlineSourceMap': True|False, 'apiConfiguration': { 'graphQLConfig': { 'typesFilePath': 'string', 'queriesFilePath': 'string', 'mutationsFilePath': 'string', 'subscriptionsFilePath': 'string', 'fragmentsFilePath': 'string' }, 'dataStoreConfig': {} , 'noApiConfig': {} }, 'dependencies': { 'string': 'string' } } }, 'genericDataSchema': { 'dataSourceType': 'DataStore', 'models': { 'string': { 'fields': { 'string': { 'dataType': 'ID'|'String'|'Int'|'Float'|'AWSDate'|'AWSTime'|'AWSDateTime'|'AWSTimestamp'|'AWSEmail'|'AWSURL'|'AWSIPAddress'|'Boolean'|'AWSJSON'|'AWSPhone'|'Enum'|'Model'|'NonModel', 'dataTypeValue': 'string', 'required': True|False, 'readOnly': True|False, 'isArray': True|False, 'relationship': { 'type': 'HAS_MANY'|'HAS_ONE'|'BELONGS_TO', 'relatedModelName': 'string', 'relatedModelFields': [ 'string', ], 'canUnlinkAssociatedModel': True|False, 'relatedJoinFieldName': 'string', 'relatedJoinTableName': 'string', 'belongsToFieldOnRelatedModel': 'string', 'associatedFields': [ 'string', ], 'isHasManyIndex': True|False } } }, 'isJoinTable': True|False, 'primaryKeys': [ 'string', ] } }, 'enums': { 'string': { 'values': [ 'string', ] } }, 'nonModels': { 'string': { 'fields': { 'string': { 'dataType': 'ID'|'String'|'Int'|'Float'|'AWSDate'|'AWSTime'|'AWSDateTime'|'AWSTimestamp'|'AWSEmail'|'AWSURL'|'AWSIPAddress'|'Boolean'|'AWSJSON'|'AWSPhone'|'Enum'|'Model'|'NonModel', 'dataTypeValue': 'string', 'required': True|False, 'readOnly': True|False, 'isArray': True|False, 'relationship': { 'type': 'HAS_MANY'|'HAS_ONE'|'BELONGS_TO', 'relatedModelName': 'string', 'relatedModelFields': [ 'string', ], 'canUnlinkAssociatedModel': True|False, 'relatedJoinFieldName': 'string', 'relatedJoinTableName': 'string', 'belongsToFieldOnRelatedModel': 'string', 'associatedFields': [ 'string', ], 'isHasManyIndex': True|False } } } } } }, 'autoGenerateForms': True|False, 'features': { 'isRelationshipSupported': True|False, 'isNonModelSupported': True|False }, 'tags': { 'string': 'string' } } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **clientToken** (*string*) -- The idempotency token used to ensure that the code generation job request completes only once. This field is autopopulated if not provided. * **codegenJobToCreate** (*dict*) -- **[REQUIRED]** The code generation job resource configuration. * **renderConfig** *(dict) --* **[REQUIRED]** The code generation configuration for the codegen job. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "react". * **react** *(dict) --* The name of the "ReactStartCodegenJobData" object. * **module** *(string) --* The JavaScript module type. * **target** *(string) --* The ECMAScript specification to use. * **script** *(string) --* The file type to use for a JavaScript project. * **renderTypeDeclarations** *(boolean) --* Specifies whether the code generation job should render type declaration files. * **inlineSourceMap** *(boolean) --* Specifies whether the code generation job should render inline source maps. * **apiConfiguration** *(dict) --* The API configuration for the code generation job. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "graphQLConfig", "dataStoreConfig", "noApiConfig". * **graphQLConfig** *(dict) --* The configuration for an application using GraphQL APIs. * **typesFilePath** *(string) --* **[REQUIRED]** The path to the GraphQL types file, relative to the component output directory. * **queriesFilePath** *(string) --* **[REQUIRED]** The path to the GraphQL queries file, relative to the component output directory. * **mutationsFilePath** *(string) --* **[REQUIRED]** The path to the GraphQL mutations file, relative to the component output directory. * **subscriptionsFilePath** *(string) --* **[REQUIRED]** The path to the GraphQL subscriptions file, relative to the component output directory. * **fragmentsFilePath** *(string) --* **[REQUIRED]** The path to the GraphQL fragments file, relative to the component output directory. * **dataStoreConfig** *(dict) --* The configuration for an application using DataStore APIs. * **noApiConfig** *(dict) --* The configuration for an application with no API being used. * **dependencies** *(dict) --* Lists the dependency packages that may be required for the project code to run. * *(string) --* * *(string) --* * **genericDataSchema** *(dict) --* The data schema to use for a code generation job. * **dataSourceType** *(string) --* **[REQUIRED]** The type of the data source for the schema. Currently, the only valid value is an Amplify "DataStore". * **models** *(dict) --* **[REQUIRED]** The name of a "CodegenGenericDataModel". * *(string) --* * *(dict) --* Describes a model in a generic data schema. * **fields** *(dict) --* **[REQUIRED]** The fields in the generic data model. * *(string) --* * *(dict) --* Describes a field in a generic data schema. * **dataType** *(string) --* **[REQUIRED]** The data type for the generic data field. * **dataTypeValue** *(string) --* **[REQUIRED]** The value of the data type for the generic data field. * **required** *(boolean) --* **[REQUIRED]** Specifies whether the generic data field is required. * **readOnly** *(boolean) --* **[REQUIRED]** Specifies whether the generic data field is read-only. * **isArray** *(boolean) --* **[REQUIRED]** Specifies whether the generic data field is an array. * **relationship** *(dict) --* The relationship of the generic data schema. * **type** *(string) --* **[REQUIRED]** The data relationship type. * **relatedModelName** *(string) --* **[REQUIRED]** The name of the related model in the data relationship. * **relatedModelFields** *(list) --* The related model fields in the data relationship. * *(string) --* * **canUnlinkAssociatedModel** *(boolean) --* Specifies whether the relationship can unlink the associated model. * **relatedJoinFieldName** *(string) --* The name of the related join field in the data relationship. * **relatedJoinTableName** *(string) --* The name of the related join table in the data relationship. * **belongsToFieldOnRelatedModel** *(string) --* The value of the "belongsTo" field on the related data model. * **associatedFields** *(list) --* The associated fields of the data relationship. * *(string) --* * **isHasManyIndex** *(boolean) --* Specifies whether the "@index" directive is supported for a "hasMany" data relationship. * **isJoinTable** *(boolean) --* Specifies whether the generic data model is a join table. * **primaryKeys** *(list) --* **[REQUIRED]** The primary keys of the generic data model. * *(string) --* * **enums** *(dict) --* **[REQUIRED]** The name of a "CodegenGenericDataEnum". * *(string) --* * *(dict) --* Describes the enums in a generic data schema. * **values** *(list) --* **[REQUIRED]** The list of enum values in the generic data schema. * *(string) --* * **nonModels** *(dict) --* **[REQUIRED]** The name of a "CodegenGenericDataNonModel". * *(string) --* * *(dict) --* Describes a non-model in a generic data schema. * **fields** *(dict) --* **[REQUIRED]** The fields in a generic data schema non model. * *(string) --* * *(dict) --* Describes a field in a generic data schema. * **dataType** *(string) --* **[REQUIRED]** The data type for the generic data field. * **dataTypeValue** *(string) --* **[REQUIRED]** The value of the data type for the generic data field. * **required** *(boolean) --* **[REQUIRED]** Specifies whether the generic data field is required. * **readOnly** *(boolean) --* **[REQUIRED]** Specifies whether the generic data field is read-only. * **isArray** *(boolean) --* **[REQUIRED]** Specifies whether the generic data field is an array. * **relationship** *(dict) --* The relationship of the generic data schema. * **type** *(string) --* **[REQUIRED]** The data relationship type. * **relatedModelName** *(string) --* **[REQUIRED]** The name of the related model in the data relationship. * **relatedModelFields** *(list) --* The related model fields in the data relationship. * *(string) --* * **canUnlinkAssociatedModel** *(boolean) --* Specifies whether the relationship can unlink the associated model. * **relatedJoinFieldName** *(string) --* The name of the related join field in the data relationship. * **relatedJoinTableName** *(string) --* The name of the related join table in the data relationship. * **belongsToFieldOnRelatedModel** *(string) --* The value of the "belongsTo" field on the related data model. * **associatedFields** *(list) --* The associated fields of the data relationship. * *(string) --* * **isHasManyIndex** *(boolean) --* Specifies whether the "@index" directive is supported for a "hasMany" data relationship. * **autoGenerateForms** *(boolean) --* Specifies whether to autogenerate forms in the code generation job. * **features** *(dict) --* The feature flags for a code generation job. * **isRelationshipSupported** *(boolean) --* Specifes whether a code generation job supports data relationships. * **isNonModelSupported** *(boolean) --* Specifies whether a code generation job supports non models. * **tags** *(dict) --* One or more key-value pairs to use when tagging the code generation job data. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'entity': { 'id': 'string', 'appId': 'string', 'environmentName': 'string', 'renderConfig': { 'react': { 'module': 'es2020'|'esnext', 'target': 'es2015'|'es2020', 'script': 'jsx'|'tsx'|'js', 'renderTypeDeclarations': True|False, 'inlineSourceMap': True|False, 'apiConfiguration': { 'graphQLConfig': { 'typesFilePath': 'string', 'queriesFilePath': 'string', 'mutationsFilePath': 'string', 'subscriptionsFilePath': 'string', 'fragmentsFilePath': 'string' }, 'dataStoreConfig': {}, 'noApiConfig': {} }, 'dependencies': { 'string': 'string' } } }, 'genericDataSchema': { 'dataSourceType': 'DataStore', 'models': { 'string': { 'fields': { 'string': { 'dataType': 'ID'|'String'|'Int'|'Float'|'AWSDate'|'AWSTime'|'AWSDateTime'|'AWSTimestamp'|'AWSEmail'|'AWSURL'|'AWSIPAddress'|'Boolean'|'AWSJSON'|'AWSPhone'|'Enum'|'Model'|'NonModel', 'dataTypeValue': 'string', 'required': True|False, 'readOnly': True|False, 'isArray': True|False, 'relationship': { 'type': 'HAS_MANY'|'HAS_ONE'|'BELONGS_TO', 'relatedModelName': 'string', 'relatedModelFields': [ 'string', ], 'canUnlinkAssociatedModel': True|False, 'relatedJoinFieldName': 'string', 'relatedJoinTableName': 'string', 'belongsToFieldOnRelatedModel': 'string', 'associatedFields': [ 'string', ], 'isHasManyIndex': True|False } } }, 'isJoinTable': True|False, 'primaryKeys': [ 'string', ] } }, 'enums': { 'string': { 'values': [ 'string', ] } }, 'nonModels': { 'string': { 'fields': { 'string': { 'dataType': 'ID'|'String'|'Int'|'Float'|'AWSDate'|'AWSTime'|'AWSDateTime'|'AWSTimestamp'|'AWSEmail'|'AWSURL'|'AWSIPAddress'|'Boolean'|'AWSJSON'|'AWSPhone'|'Enum'|'Model'|'NonModel', 'dataTypeValue': 'string', 'required': True|False, 'readOnly': True|False, 'isArray': True|False, 'relationship': { 'type': 'HAS_MANY'|'HAS_ONE'|'BELONGS_TO', 'relatedModelName': 'string', 'relatedModelFields': [ 'string', ], 'canUnlinkAssociatedModel': True|False, 'relatedJoinFieldName': 'string', 'relatedJoinTableName': 'string', 'belongsToFieldOnRelatedModel': 'string', 'associatedFields': [ 'string', ], 'isHasManyIndex': True|False } } } } } }, 'autoGenerateForms': True|False, 'features': { 'isRelationshipSupported': True|False, 'isNonModelSupported': True|False }, 'status': 'in_progress'|'failed'|'succeeded', 'statusMessage': 'string', 'asset': { 'downloadUrl': 'string' }, 'tags': { 'string': 'string' }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'dependencies': [ { 'name': 'string', 'supportedVersion': 'string', 'isSemVer': True|False, 'reason': 'string' }, ] } } **Response Structure** * *(dict) --* * **entity** *(dict) --* The code generation job for a UI component that is associated with an Amplify app. * **id** *(string) --* The unique ID for the code generation job. * **appId** *(string) --* The ID of the Amplify app associated with the code generation job. * **environmentName** *(string) --* The name of the backend environment associated with the code generation job. * **renderConfig** *(dict) --* Describes the configuration information for rendering the UI component associated with the code generation job. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "react". 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'} * **react** *(dict) --* The name of the "ReactStartCodegenJobData" object. * **module** *(string) --* The JavaScript module type. * **target** *(string) --* The ECMAScript specification to use. * **script** *(string) --* The file type to use for a JavaScript project. * **renderTypeDeclarations** *(boolean) --* Specifies whether the code generation job should render type declaration files. * **inlineSourceMap** *(boolean) --* Specifies whether the code generation job should render inline source maps. * **apiConfiguration** *(dict) --* The API configuration for the code generation job. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "graphQLConfig", "dataStoreConfig", "noApiConfig". 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'} * **graphQLConfig** *(dict) --* The configuration for an application using GraphQL APIs. * **typesFilePath** *(string) --* The path to the GraphQL types file, relative to the component output directory. * **queriesFilePath** *(string) --* The path to the GraphQL queries file, relative to the component output directory. * **mutationsFilePath** *(string) --* The path to the GraphQL mutations file, relative to the component output directory. * **subscriptionsFilePath** *(string) --* The path to the GraphQL subscriptions file, relative to the component output directory. * **fragmentsFilePath** *(string) --* The path to the GraphQL fragments file, relative to the component output directory. * **dataStoreConfig** *(dict) --* The configuration for an application using DataStore APIs. * **noApiConfig** *(dict) --* The configuration for an application with no API being used. * **dependencies** *(dict) --* Lists the dependency packages that may be required for the project code to run. * *(string) --* * *(string) --* * **genericDataSchema** *(dict) --* Describes the data schema for a code generation job. * **dataSourceType** *(string) --* The type of the data source for the schema. Currently, the only valid value is an Amplify "DataStore". * **models** *(dict) --* The name of a "CodegenGenericDataModel". * *(string) --* * *(dict) --* Describes a model in a generic data schema. * **fields** *(dict) --* The fields in the generic data model. * *(string) --* * *(dict) --* Describes a field in a generic data schema. * **dataType** *(string) --* The data type for the generic data field. * **dataTypeValue** *(string) --* The value of the data type for the generic data field. * **required** *(boolean) --* Specifies whether the generic data field is required. * **readOnly** *(boolean) --* Specifies whether the generic data field is read-only. * **isArray** *(boolean) --* Specifies whether the generic data field is an array. * **relationship** *(dict) --* The relationship of the generic data schema. * **type** *(string) --* The data relationship type. * **relatedModelName** *(string) --* The name of the related model in the data relationship. * **relatedModelFields** *(list) --* The related model fields in the data relationship. * *(string) --* * **canUnlinkAssociatedModel** *(boolean) --* Specifies whether the relationship can unlink the associated model. * **relatedJoinFieldName** *(string) --* The name of the related join field in the data relationship. * **relatedJoinTableName** *(string) --* The name of the related join table in the data relationship. * **belongsToFieldOnRelatedModel** *(string) --* The value of the "belongsTo" field on the related data model. * **associatedFields** *(list) --* The associated fields of the data relationship. * *(string) --* * **isHasManyIndex** *(boolean) --* Specifies whether the "@index" directive is supported for a "hasMany" data relationship. * **isJoinTable** *(boolean) --* Specifies whether the generic data model is a join table. * **primaryKeys** *(list) --* The primary keys of the generic data model. * *(string) --* * **enums** *(dict) --* The name of a "CodegenGenericDataEnum". * *(string) --* * *(dict) --* Describes the enums in a generic data schema. * **values** *(list) --* The list of enum values in the generic data schema. * *(string) --* * **nonModels** *(dict) --* The name of a "CodegenGenericDataNonModel". * *(string) --* * *(dict) --* Describes a non-model in a generic data schema. * **fields** *(dict) --* The fields in a generic data schema non model. * *(string) --* * *(dict) --* Describes a field in a generic data schema. * **dataType** *(string) --* The data type for the generic data field. * **dataTypeValue** *(string) --* The value of the data type for the generic data field. * **required** *(boolean) --* Specifies whether the generic data field is required. * **readOnly** *(boolean) --* Specifies whether the generic data field is read-only. * **isArray** *(boolean) --* Specifies whether the generic data field is an array. * **relationship** *(dict) --* The relationship of the generic data schema. * **type** *(string) --* The data relationship type. * **relatedModelName** *(string) --* The name of the related model in the data relationship. * **relatedModelFields** *(list) --* The related model fields in the data relationship. * *(string) --* * **canUnlinkAssociatedModel** *(boolean) --* Specifies whether the relationship can unlink the associated model. * **relatedJoinFieldName** *(string) --* The name of the related join field in the data relationship. * **relatedJoinTableName** *(string) --* The name of the related join table in the data relationship. * **belongsToFieldOnRelatedModel** *(string) --* The value of the "belongsTo" field on the related data model. * **associatedFields** *(list) --* The associated fields of the data relationship. * *(string) --* * **isHasManyIndex** *(boolean) --* Specifies whether the "@index" directive is supported for a "hasMany" data relationship. * **autoGenerateForms** *(boolean) --* Specifies whether to autogenerate forms in the code generation job. * **features** *(dict) --* Describes the feature flags that you can specify for a code generation job. * **isRelationshipSupported** *(boolean) --* Specifes whether a code generation job supports data relationships. * **isNonModelSupported** *(boolean) --* Specifies whether a code generation job supports non models. * **status** *(string) --* The status of the code generation job. * **statusMessage** *(string) --* The customized status message for the code generation job. * **asset** *(dict) --* The "CodegenJobAsset" to use for the code generation job. * **downloadUrl** *(string) --* The URL to use to access the asset. * **tags** *(dict) --* One or more key-value pairs to use when tagging the code generation job. * *(string) --* * *(string) --* * **createdAt** *(datetime) --* The time that the code generation job was created. * **modifiedAt** *(datetime) --* The time that the code generation job was modified. * **dependencies** *(list) --* Lists the dependency packages that may be required for the project code to run. * *(dict) --* Dependency package that may be required for the project code to run. * **name** *(string) --* Name of the dependency package. * **supportedVersion** *(string) --* Indicates the version of the supported dependency package. * **isSemVer** *(boolean) --* Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning. * **reason** *(string) --* Indicates the reason to include the dependency package in your project code. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ThrottlingException" AmplifyUIBuilder / Client / put_metadata_flag put_metadata_flag ***************** AmplifyUIBuilder.Client.put_metadata_flag(**kwargs) Stores the metadata information about a feature on a form. See also: AWS API Documentation **Request Syntax** response = client.put_metadata_flag( appId='string', environmentName='string', featureName='string', body={ 'newValue': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **featureName** (*string*) -- **[REQUIRED]** The name of the feature associated with the metadata. * **body** (*dict*) -- **[REQUIRED]** The metadata information to store. * **newValue** *(string) --* **[REQUIRED]** The new information to store. Returns: None **Exceptions** * "AmplifyUIBuilder.Client.exceptions.UnauthorizedException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / update_component update_component **************** AmplifyUIBuilder.Client.update_component(**kwargs) Updates an existing component. See also: AWS API Documentation **Request Syntax** response = client.update_component( appId='string', environmentName='string', id='string', clientToken='string', updatedComponent={ 'id': 'string', 'name': 'string', 'sourceId': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID for the component. * **clientToken** (*string*) -- The unique client token. This field is autopopulated if not provided. * **updatedComponent** (*dict*) -- **[REQUIRED]** The configuration of the updated component. * **id** *(string) --* The unique ID of the component to update. * **name** *(string) --* The name of the component to update. * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **componentType** *(string) --* The type of the component. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* Describes the component's properties. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The components that are instances of the main component. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* **[REQUIRED]** The type of the child component. * **name** *(string) --* **[REQUIRED]** The name of the child component. * **properties** *(dict) --* **[REQUIRED]** Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* **[REQUIRED]** The name of the component that is being modified. * **property** *(string) --* **[REQUIRED]** The name of the component property to apply the state configuration to. * **set** *(dict) --* **[REQUIRED]** The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* A list of the unique variants of the main component being updated. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* Describes the properties that can be overriden to customize the component. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* The data binding information for the component's properties. * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The configuration for binding a component's properties to a data model. Use this for a collection component. * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* **[REQUIRED]** The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* **[REQUIRED]** The field to perform the sort on. * **direction** *(string) --* **[REQUIRED]** The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **events** *(dict) --* The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* **[REQUIRED]** The name of the component that is being modified. * **property** *(string) --* **[REQUIRED]** The name of the component property to apply the state configuration to. * **set** *(dict) --* **[REQUIRED]** The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* **[REQUIRED]** The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* **[REQUIRED]** The name of the component to retrieve a value from. * **property** *(string) --* **[REQUIRED]** The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. Return type: dict Returns: **Response Syntax** { 'entity': { 'appId': 'string', 'environmentName': 'string', 'sourceId': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' } } **Response Structure** * *(dict) --* * **entity** *(dict) --* Describes the configuration of the updated component. * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The type of the component. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* Describes the component's properties. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* A list of the component's "ComponentChild" instances. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* The type of the child component. * **name** *(string) --* The name of the child component. * **properties** *(dict) --* Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* A list of the component's variants. A variant is a unique style configuration of a main component. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* Describes the component's properties that can be overriden in a customized instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* The information to connect a component's properties to data at runtime. You can't specify "tags" as a valid property for "bindingProperties". * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The data binding configuration for the component's properties. Use this for a collection component. You can't specify "tags" as a valid property for "collectionProperties". * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* The field to perform the sort on. * **direction** *(string) --* The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **createdAt** *(datetime) --* The time that the component was created. * **modifiedAt** *(datetime) --* The time that the component was modified. * **tags** *(dict) --* One or more key-value pairs to use when tagging the component. * *(string) --* * *(string) --* * **events** *(dict) --* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.ResourceConflictException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / update_theme update_theme ************ AmplifyUIBuilder.Client.update_theme(**kwargs) Updates an existing theme. See also: AWS API Documentation **Request Syntax** response = client.update_theme( appId='string', environmentName='string', id='string', clientToken='string', updatedTheme={ 'id': 'string', 'name': 'string', 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ] } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID for the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID for the theme. * **clientToken** (*string*) -- The unique client token. This field is autopopulated if not provided. * **updatedTheme** (*dict*) -- **[REQUIRED]** The configuration of the updated theme. * **id** *(string) --* The unique ID of the theme to update. * **name** *(string) --* The name of the theme to update. * **values** *(list) --* **[REQUIRED]** A list of key-value pairs that define the theme's properties. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. Return type: dict Returns: **Response Syntax** { 'entity': { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **entity** *(dict) --* Describes the configuration of the updated theme. * **appId** *(string) --* The unique ID for the Amplify app associated with the theme. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The ID for the theme. * **name** *(string) --* The name of the theme. * **createdAt** *(datetime) --* The time that the theme was created. * **modifiedAt** *(datetime) --* The time that the theme was modified. * **values** *(list) --* A list of key-value pairs that defines the properties of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize a theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **tags** *(dict) --* One or more key-value pairs to use when tagging the theme. * *(string) --* * *(string) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.ResourceConflictException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / get_component get_component ************* AmplifyUIBuilder.Client.get_component(**kwargs) Returns an existing component for an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.get_component( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID of the component. Return type: dict Returns: **Response Syntax** { 'component': { 'appId': 'string', 'environmentName': 'string', 'sourceId': 'string', 'id': 'string', 'name': 'string', 'componentType': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': [ { 'componentType': 'string', 'name': 'string', 'properties': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'children': {'... recursive ...'}, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'sourceId': 'string' }, ], 'variants': [ { 'variantValues': { 'string': 'string' }, 'overrides': { 'string': { 'string': 'string' } } }, ], 'overrides': { 'string': { 'string': 'string' } }, 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string', 'field': 'string', 'predicates': [ { 'or': {'... recursive ...'}, 'and': {'... recursive ...'}, 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, ], 'userAttribute': 'string', 'bucket': 'string', 'key': 'string', 'defaultValue': 'string', 'slotName': 'string' }, 'defaultValue': 'string' } }, 'collectionProperties': { 'string': { 'model': 'string', 'sort': [ { 'field': 'string', 'direction': 'ASC'|'DESC' }, ], 'predicate': { 'or': [ {'... recursive ...'}, ], 'and': [ {'... recursive ...'}, ], 'field': 'string', 'operator': 'string', 'operand': 'string', 'operandType': 'string' }, 'identifiers': [ 'string', ] } }, 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'tags': { 'string': 'string' }, 'events': { 'string': { 'action': 'string', 'parameters': { 'type': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'url': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'anchor': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'target': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'global': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'model': 'string', 'id': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' }, 'fields': { 'string': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } }, 'state': { 'componentName': 'string', 'property': 'string', 'set': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'collectionBindingProperties': { 'property': 'string', 'field': 'string' }, 'defaultValue': 'string', 'model': 'string', 'bindings': { 'string': { 'element': 'string', 'property': 'string' } }, 'event': 'string', 'userAttribute': 'string', 'concat': [ {'... recursive ...'}, ], 'condition': { 'property': 'string', 'field': 'string', 'operator': 'string', 'operand': 'string', 'then': {'... recursive ...'}, 'else': {'... recursive ...'}, 'operandType': 'string' }, 'configured': True|False, 'type': 'string', 'importedValue': 'string', 'componentName': 'string', 'property': 'string' } } }, 'bindingEvent': 'string' } }, 'schemaVersion': 'string' } } **Response Structure** * *(dict) --* * **component** *(dict) --* Represents the configuration settings for the component. * **appId** *(string) --* The unique ID of the Amplify app associated with the component. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **sourceId** *(string) --* The unique ID of the component in its original source system, such as Figma. * **id** *(string) --* The unique ID of the component. * **name** *(string) --* The name of the component. * **componentType** *(string) --* The type of the component. This can be an Amplify custom UI component or another custom component. * **properties** *(dict) --* Describes the component's properties. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* A list of the component's "ComponentChild" instances. * *(dict) --* A nested UI configuration within a parent "Component". * **componentType** *(string) --* The type of the child component. * **name** *(string) --* The name of the child component. * **properties** *(dict) --* Describes the properties of the child component. You can't specify "tags" as a valid property for "properties". * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **children** *(list) --* The list of "ComponentChild" instances for this component. * **events** *(dict) --* Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **sourceId** *(string) --* The unique ID of the child component in its original source system, such as Figma. * **variants** *(list) --* A list of the component's variants. A variant is a unique style configuration of a main component. * *(dict) --* Describes the style configuration of a unique variation of a main component. * **variantValues** *(dict) --* The combination of variants that comprise this variant. You can't specify "tags" as a valid property for "variantValues". * *(string) --* * *(string) --* * **overrides** *(dict) --* The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **overrides** *(dict) --* Describes the component's properties that can be overriden in a customized instance of the component. You can't specify "tags" as a valid property for "overrides". * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **bindingProperties** *(dict) --* The information to connect a component's properties to data at runtime. You can't specify "tags" as a valid property for "bindingProperties". * *(string) --* * *(dict) --* Represents the data binding configuration for a component at runtime. You can use "ComponentBindingPropertiesValue" to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **field** *(string) --* The field to bind the data to. * **predicates** *(list) --* A list of predicates for binding a component's properties to data. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * **and** *(list) --* A list of predicates to combine logically. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **userAttribute** *(string) --* An authenticated user attribute. * **bucket** *(string) --* An Amazon S3 bucket. * **key** *(string) --* The storage key for an Amazon S3 bucket. * **defaultValue** *(string) --* The default value to assign to the property. * **slotName** *(string) --* The name of a component slot. * **defaultValue** *(string) --* The default value of the property. * **collectionProperties** *(dict) --* The data binding configuration for the component's properties. Use this for a collection component. You can't specify "tags" as a valid property for "collectionProperties". * *(string) --* * *(dict) --* Describes the configuration for binding a component's properties to data. * **model** *(string) --* The name of the data model to use to bind data to a component. * **sort** *(list) --* Describes how to sort the component's properties. * *(dict) --* Describes how to sort the data that you bind to a component. * **field** *(string) --* The field to perform the sort on. * **direction** *(string) --* The direction of the sort, either ascending or descending. * **predicate** *(dict) --* Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. * **or** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **and** *(list) --* A list of predicates to combine logically. * *(dict) --* Stores information for generating Amplify DataStore queries. Use a "Predicate" to retrieve a subset of the data in a collection. * **field** *(string) --* The field to query. * **operator** *(string) --* The operator to use to perform the evaluation. * **operand** *(string) --* The value to use when performing the evaluation. * **operandType** *(string) --* The type of value to use when performing the evaluation. * **identifiers** *(list) --* A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query. * *(string) --* * **createdAt** *(datetime) --* The time that the component was created. * **modifiedAt** *(datetime) --* The time that the component was modified. * **tags** *(dict) --* One or more key-value pairs to use when tagging the component. * *(string) --* * *(string) --* * **events** *(dict) --* Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. * *(string) --* * *(dict) --* Describes the configuration of an event. You can bind an event and a corresponding action to a "Component" or a "ComponentChild". A button click is an example of an event. * **action** *(string) --* The action to perform when a specific event is raised. * **parameters** *(dict) --* Describes information about the action. * **type** *(dict) --* The type of navigation action. Valid values are "url" and "anchor". This value is required for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **url** *(dict) --* The URL to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **anchor** *(dict) --* The HTML anchor link to the location to open. Specify this value for a navigation action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **target** *(dict) --* The element within the same component to modify when the action occurs. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **global** *(dict) --* Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **model** *(string) --* The name of the data model. Use when the action performs an operation on an Amplify DataStore model. * **id** *(dict) --* The unique ID of the component that the "ActionParameters" apply to. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **fields** *(dict) --* A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. * *(string) --* * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **state** *(dict) --* A key-value pair that specifies the state property name and its initial value. * **componentName** *(string) --* The name of the component that is being modified. * **property** *(string) --* The name of the component property to apply the state configuration to. * **set** *(dict) --* The state configuration to assign to the property. * **value** *(string) --* The value to assign to the component property. * **bindingProperties** *(dict) --* The information to bind the component property to data at runtime. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **collectionBindingProperties** *(dict) --* The information to bind the component property to data at runtime. Use this for collection components. * **property** *(string) --* The component property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **defaultValue** *(string) --* The default value to assign to the component property. * **model** *(string) --* The data model to use to assign a value to the component property. * **bindings** *(dict) --* The information to bind the component property to form data. * *(string) --* * *(dict) --* Describes how to bind a component property to form data. * **element** *(string) --* The name of the component to retrieve a value from. * **property** *(string) --* The property to retrieve a value from. * **event** *(string) --* An event that occurs in your app. Use this for workflow data binding. * **userAttribute** *(string) --* An authenticated user attribute to use to assign a value to the component property. * **concat** *(list) --* A list of component properties to concatenate to create the value to assign to this component property. * *(dict) --* Describes the configuration for all of a component's properties. Use "ComponentProperty" to specify the values to render or bind by default. * **condition** *(dict) --* The conditional expression to use to assign a value to the component property. * **property** *(string) --* The name of the conditional property. * **field** *(string) --* The name of a field. Specify this when the property is a data model. * **operator** *(string) --* The operator to use to perform the evaluation, such as "eq" to represent equals. * **operand** *(string) --* The value of the property to evaluate. * **then** *(dict) --* The value to assign to the property if the condition is met. * **else** *(dict) --* The value to assign to the property if the condition is not met. * **operandType** *(string) --* The type of the property to evaluate. * **configured** *(boolean) --* Specifies whether the user configured the property in Amplify Studio after importing it. * **type** *(string) --* The component type. * **importedValue** *(string) --* The default value assigned to the property when the component is imported into an app. * **componentName** *(string) --* The name of the component that is affected by an event. * **property** *(string) --* The name of the component's property that is affected by an event. * **bindingEvent** *(string) --* Binds an event to an action on a component. When you specify a "bindingEvent", the event is called when the action is performed. * **schemaVersion** *(string) --* The schema version of the component when it was imported. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / close close ***** AmplifyUIBuilder.Client.close() Closes underlying endpoint connections. AmplifyUIBuilder / Client / get_form get_form ******** AmplifyUIBuilder.Client.get_form(**kwargs) Returns an existing form for an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.get_form( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID of the form. Return type: dict Returns: **Response Syntax** { 'form': { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'formActionType': 'create'|'update', 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'tags': { 'string': 'string' }, 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'labelDecorator': 'required'|'optional'|'none' } } **Response Structure** * *(dict) --* * **form** *(dict) --* Represents the configuration settings for the form. * **appId** *(string) --* The unique ID of the Amplify app associated with the form. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the form. * **name** *(string) --* The name of the form. * **formActionType** *(string) --* The operation to perform on the specified form. * **style** *(dict) --* Stores the configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **dataType** *(dict) --* The type of data source to use to create the form. * **dataSourceType** *(string) --* The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* The unique name of the data type you are using as the data source for the form. * **fields** *(dict) --* Stores the information about the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **sectionalElements** *(dict) --* Stores the visual helper elements for the form that are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* The schema version of the form when it was imported. * **tags** *(dict) --* One or more key-value pairs to use when tagging the form. * *(string) --* * *(string) --* * **cta** *(dict) --* Stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / exchange_code_for_token exchange_code_for_token *********************** AmplifyUIBuilder.Client.exchange_code_for_token(**kwargs) Note: This is for internal use. Amplify uses this action to exchange an access code for a token. See also: AWS API Documentation **Request Syntax** response = client.exchange_code_for_token( provider='figma', request={ 'code': 'string', 'redirectUri': 'string', 'clientId': 'string' } ) Parameters: * **provider** (*string*) -- **[REQUIRED]** The third-party provider for the token. The only valid value is "figma". * **request** (*dict*) -- **[REQUIRED]** Describes the configuration of the request. * **code** *(string) --* **[REQUIRED]** The access code to send in the request. * **redirectUri** *(string) --* **[REQUIRED]** The location of the application that will receive the access code. * **clientId** *(string) --* The ID of the client to request the token from. Return type: dict Returns: **Response Syntax** { 'accessToken': 'string', 'expiresIn': 123, 'refreshToken': 'string' } **Response Structure** * *(dict) --* * **accessToken** *(string) --* The access token. * **expiresIn** *(integer) --* The date and time when the new access token expires. * **refreshToken** *(string) --* The token to use to refresh a previously issued access token that might have expired. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / delete_form delete_form *********** AmplifyUIBuilder.Client.delete_form(**kwargs) Deletes a form from an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.delete_form( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app associated with the form to delete. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID of the form to delete. Returns: None **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / get_metadata get_metadata ************ AmplifyUIBuilder.Client.get_metadata(**kwargs) Returns existing metadata for an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.get_metadata( appId='string', environmentName='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. Return type: dict Returns: **Response Syntax** { 'features': { 'string': 'string' } } **Response Structure** * *(dict) --* * **features** *(dict) --* Represents the configuration settings for the features metadata. * *(string) --* * *(string) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.UnauthorizedException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / create_theme create_theme ************ AmplifyUIBuilder.Client.create_theme(**kwargs) Creates a theme to apply to the components in an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.create_theme( appId='string', environmentName='string', clientToken='string', themeToCreate={ 'name': 'string', 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'tags': { 'string': 'string' } } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app associated with the theme. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **clientToken** (*string*) -- The unique client token. This field is autopopulated if not provided. * **themeToCreate** (*dict*) -- **[REQUIRED]** Represents the configuration of the theme to create. * **name** *(string) --* **[REQUIRED]** The name of the theme. * **values** *(list) --* **[REQUIRED]** A list of key-value pairs that defines the properties of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize an instance of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **tags** *(dict) --* One or more key-value pairs to use when tagging the theme data. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'entity': { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **entity** *(dict) --* Describes the configuration of the new theme. * **appId** *(string) --* The unique ID for the Amplify app associated with the theme. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The ID for the theme. * **name** *(string) --* The name of the theme. * **createdAt** *(datetime) --* The time that the theme was created. * **modifiedAt** *(datetime) --* The time that the theme was modified. * **values** *(list) --* A list of key-value pairs that defines the properties of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize a theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **tags** *(dict) --* One or more key-value pairs to use when tagging the theme. * *(string) --* * *(string) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.ServiceQuotaExceededExceptio n" * "AmplifyUIBuilder.Client.exceptions.ResourceConflictException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / export_forms export_forms ************ AmplifyUIBuilder.Client.export_forms(**kwargs) Exports form configurations to code that is ready to integrate into an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.export_forms( appId='string', environmentName='string', nextToken='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to export forms to. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'formActionType': 'create'|'update', 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'tags': { 'string': 'string' }, 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'labelDecorator': 'required'|'optional'|'none' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* Represents the configuration of the exported forms. * *(dict) --* Contains the configuration settings for a "Form" user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form. * **appId** *(string) --* The unique ID of the Amplify app associated with the form. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the form. * **name** *(string) --* The name of the form. * **formActionType** *(string) --* The operation to perform on the specified form. * **style** *(dict) --* Stores the configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **dataType** *(dict) --* The type of data source to use to create the form. * **dataSourceType** *(string) --* The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* The unique name of the data type you are using as the data source for the form. * **fields** *(dict) --* Stores the information about the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **sectionalElements** *(dict) --* Stores the visual helper elements for the form that are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* The schema version of the form when it was imported. * **tags** *(dict) --* One or more key-value pairs to use when tagging the form. * *(string) --* * *(string) --* * **cta** *(dict) --* Stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. * **nextToken** *(string) --* The pagination token that's included if more results are available. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / tag_resource tag_resource ************ AmplifyUIBuilder.Client.tag_resource(**kwargs) Tags the resource with a tag key and value. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to tag a resource. * **tags** (*dict*) -- **[REQUIRED]** A list of tag key value pairs for a specified Amazon Resource Name (ARN). * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.UnauthorizedException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ThrottlingException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / get_theme get_theme ********* AmplifyUIBuilder.Client.get_theme(**kwargs) Returns an existing theme for an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.get_theme( appId='string', environmentName='string', id='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **id** (*string*) -- **[REQUIRED]** The unique ID for the theme. Return type: dict Returns: **Response Syntax** { 'theme': { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **theme** *(dict) --* Represents the configuration settings for the theme. * **appId** *(string) --* The unique ID for the Amplify app associated with the theme. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The ID for the theme. * **name** *(string) --* The name of the theme. * **createdAt** *(datetime) --* The time that the theme was created. * **modifiedAt** *(datetime) --* The time that the theme was modified. * **values** *(list) --* A list of key-value pairs that defines the properties of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize a theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **tags** *(dict) --* One or more key-value pairs to use when tagging the theme. * *(string) --* * *(string) --* **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" * "AmplifyUIBuilder.Client.exceptions.ResourceNotFoundException" AmplifyUIBuilder / Client / create_form create_form *********** AmplifyUIBuilder.Client.create_form(**kwargs) Creates a new form for an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.create_form( appId='string', environmentName='string', clientToken='string', formToCreate={ 'name': 'string', 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'formActionType': 'create'|'update', 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'tags': { 'string': 'string' }, 'labelDecorator': 'required'|'optional'|'none' } ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to associate with the form. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is a part of the Amplify app. * **clientToken** (*string*) -- The unique client token. This field is autopopulated if not provided. * **formToCreate** (*dict*) -- **[REQUIRED]** Represents the configuration of the form to create. * **name** *(string) --* **[REQUIRED]** The name of the form. * **dataType** *(dict) --* **[REQUIRED]** The type of data source to use to create the form. * **dataSourceType** *(string) --* **[REQUIRED]** The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* **[REQUIRED]** The unique name of the data type you are using as the data source for the form. * **formActionType** *(string) --* **[REQUIRED]** Specifies whether to perform a create or update action on the form. * **fields** *(dict) --* **[REQUIRED]** The configuration information for the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* **[REQUIRED]** The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* **[REQUIRED]** The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* **[REQUIRED]** The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* **[REQUIRED]** The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* **[REQUIRED]** The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* **[REQUIRED]** The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* **[REQUIRED]** The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* **[REQUIRED]** The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **style** *(dict) --* **[REQUIRED]** The configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **sectionalElements** *(dict) --* **[REQUIRED]** The configuration information for the visual helper elements for the form. These elements are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* **[REQUIRED]** The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* **[REQUIRED]** The schema version of the form. * **cta** *(dict) --* The "FormCTA" object that stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixed", "rightOf", "below". * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **tags** *(dict) --* One or more key-value pairs to use when tagging the form data. * *(string) --* * *(string) --* * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. Return type: dict Returns: **Response Syntax** { 'entity': { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'formActionType': 'create'|'update', 'style': { 'horizontalGap': { 'tokenReference': 'string', 'value': 'string' }, 'verticalGap': { 'tokenReference': 'string', 'value': 'string' }, 'outerPadding': { 'tokenReference': 'string', 'value': 'string' } }, 'dataType': { 'dataSourceType': 'DataStore'|'Custom', 'dataTypeName': 'string' }, 'fields': { 'string': { 'label': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'excluded': True|False, 'inputType': { 'type': 'string', 'required': True|False, 'readOnly': True|False, 'placeholder': 'string', 'defaultValue': 'string', 'descriptiveText': 'string', 'defaultChecked': True|False, 'defaultCountryCode': 'string', 'valueMappings': { 'values': [ { 'displayValue': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] }, 'value': { 'value': 'string', 'bindingProperties': { 'property': 'string', 'field': 'string' }, 'concat': [ {'... recursive ...'}, ] } }, ], 'bindingProperties': { 'string': { 'type': 'string', 'bindingProperties': { 'model': 'string' } } } }, 'name': 'string', 'minValue': ..., 'maxValue': ..., 'step': ..., 'value': 'string', 'isArray': True|False, 'fileUploaderConfig': { 'accessLevel': 'public'|'protected'|'private', 'acceptedFileTypes': [ 'string', ], 'showThumbnails': True|False, 'isResumable': True|False, 'maxFileCount': 123, 'maxSize': 123 } }, 'validations': [ { 'type': 'string', 'strValues': [ 'string', ], 'numValues': [ 123, ], 'validationMessage': 'string' }, ] } }, 'sectionalElements': { 'string': { 'type': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' }, 'text': 'string', 'level': 123, 'orientation': 'string', 'excluded': True|False } }, 'schemaVersion': 'string', 'tags': { 'string': 'string' }, 'cta': { 'position': 'top'|'bottom'|'top_and_bottom', 'clear': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'cancel': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } }, 'submit': { 'excluded': True|False, 'children': 'string', 'position': { 'fixed': 'first', 'rightOf': 'string', 'below': 'string' } } }, 'labelDecorator': 'required'|'optional'|'none' } } **Response Structure** * *(dict) --* * **entity** *(dict) --* Describes the configuration of the new form. * **appId** *(string) --* The unique ID of the Amplify app associated with the form. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The unique ID of the form. * **name** *(string) --* The name of the form. * **formActionType** *(string) --* The operation to perform on the specified form. * **style** *(dict) --* Stores the configuration for the form's style. * **horizontalGap** *(dict) --* The spacing for the horizontal gap. 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. * **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. * **dataType** *(dict) --* The type of data source to use to create the form. * **dataSourceType** *(string) --* The data source type, either an Amplify DataStore model or a custom data type. * **dataTypeName** *(string) --* The unique name of the data type you are using as the data source for the form. * **fields** *(dict) --* Stores the information about the form's fields. * *(string) --* * *(dict) --* Describes the configuration information for a field in a table. * **label** *(string) --* The label for the field. * **position** *(dict) --* Specifies the field position. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **excluded** *(boolean) --* Specifies whether to hide a field. * **inputType** *(dict) --* Describes the configuration for the default input value to display for a field. * **type** *(string) --* The input type for the field. * **required** *(boolean) --* Specifies a field that requires input. * **readOnly** *(boolean) --* Specifies a read only field. * **placeholder** *(string) --* The text to display as a placeholder for the field. * **defaultValue** *(string) --* The default value for the field. * **descriptiveText** *(string) --* The text to display to describe the field. * **defaultChecked** *(boolean) --* Specifies whether a field has a default value. * **defaultCountryCode** *(string) --* The default country code for a phone number. * **valueMappings** *(dict) --* The information to use to customize the input fields with data at runtime. * **values** *(list) --* The value and display value pairs. * *(dict) --* Associates a complex object with a display value. Use "ValueMapping" to store how to represent complex objects when they are displayed. * **displayValue** *(dict) --* The value to display for the complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **value** *(dict) --* The complex object. * **value** *(string) --* The value to assign to the input field. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * **property** *(string) --* The form property to bind to the data field. * **field** *(string) --* The data field to bind the property to. * **concat** *(list) --* A list of form properties to concatenate to create the value to assign to this field property. * *(dict) --* Describes the configuration for an input field on a form. Use "FormInputValueProperty" to specify the values to render or bind by default. * **bindingProperties** *(dict) --* The information to bind fields to data at runtime. * *(string) --* * *(dict) --* Represents the data binding configuration for a form's input fields at runtime.You can use "FormInputBindingPropertiesValue" to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app. * **type** *(string) --* The property type. * **bindingProperties** *(dict) --* Describes the properties to customize with data at runtime. * **model** *(string) --* An Amplify DataStore model. * **name** *(string) --* The name of the field. * **minValue** *(float) --* The minimum value to display for the field. * **maxValue** *(float) --* The maximum value to display for the field. * **step** *(float) --* The stepping increment for a numeric value in a field. * **value** *(string) --* The value for the field. * **isArray** *(boolean) --* Specifies whether to render the field as an array. This property is ignored if the "dataSourceType" for the form is a Data Store. * **fileUploaderConfig** *(dict) --* The configuration for the file uploader field. * **accessLevel** *(string) --* The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are "private", "protected", or "public". For detailed information about the permissions associated with each access level, see File access levels in the *Amplify documentation*. * **acceptedFileTypes** *(list) --* The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions. * *(string) --* * **showThumbnails** *(boolean) --* Specifies whether to display or hide the image preview after selecting a file for upload. The default value is "true" to display the image preview. * **isResumable** *(boolean) --* Allows the file upload operation to be paused and resumed. The default value is "false". When "isResumable" is set to "true", the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. * **maxFileCount** *(integer) --* Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files. * **maxSize** *(integer) --* The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size. * **validations** *(list) --* The validations to perform on the value in the field. * *(dict) --* Describes the validation configuration for a field. * **type** *(string) --* The validation to perform on an object type. * **strValues** *(list) --* The validation to perform on a string value. * *(string) --* * **numValues** *(list) --* The validation to perform on a number value. * *(integer) --* * **validationMessage** *(string) --* The validation message to display. * **sectionalElements** *(dict) --* Stores the visual helper elements for the form that are not associated with any data. * *(string) --* * *(dict) --* Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. * **type** *(string) --* The type of sectional element. Valid values are "Heading", "Text", and "Divider". * **position** *(dict) --* Specifies the position of the text in a field for a "Text" sectional element. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **text** *(string) --* The text for a "Text" sectional element. * **level** *(integer) --* Specifies the size of the font for a "Heading" sectional element. Valid values are "1 | 2 | 3 | 4 | 5 | 6". * **orientation** *(string) --* Specifies the orientation for a "Divider" sectional element. Valid values are "horizontal" or "vertical". * **excluded** *(boolean) --* Excludes a sectional element that was generated by default for a specified data model. * **schemaVersion** *(string) --* The schema version of the form when it was imported. * **tags** *(dict) --* One or more key-value pairs to use when tagging the form. * *(string) --* * *(string) --* * **cta** *(dict) --* Stores the call to action configuration for the form. * **position** *(string) --* The position of the button. * **clear** *(dict) --* Displays a clear button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **cancel** *(dict) --* Displays a cancel button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **submit** *(dict) --* Displays a submit button. * **excluded** *(boolean) --* Specifies whether the button is visible on the form. * **children** *(string) --* Describes the button's properties. * **position** *(dict) --* The position of the button. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixed", "rightOf", "below". 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'} * **fixed** *(string) --* The field position is fixed and doesn't change in relation to other fields. * **rightOf** *(string) --* The field position is to the right of the field specified by the string. * **below** *(string) --* The field position is below the field specified by the string. * **labelDecorator** *(string) --* Specifies an icon or decoration to display on the form. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.ServiceQuotaExceededExceptio n" * "AmplifyUIBuilder.Client.exceptions.ResourceConflictException" * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException" AmplifyUIBuilder / Client / export_themes export_themes ************* AmplifyUIBuilder.Client.export_themes(**kwargs) Exports theme configurations to code that is ready to integrate into an Amplify app. See also: AWS API Documentation **Request Syntax** response = client.export_themes( appId='string', environmentName='string', nextToken='string' ) Parameters: * **appId** (*string*) -- **[REQUIRED]** The unique ID of the Amplify app to export the themes to. * **environmentName** (*string*) -- **[REQUIRED]** The name of the backend environment that is part of the Amplify app. * **nextToken** (*string*) -- The token to request the next page of results. Return type: dict Returns: **Response Syntax** { 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'name': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'values': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'overrides': [ { 'key': 'string', 'value': { 'value': 'string', 'children': {'... recursive ...'} } }, ], 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entities** *(list) --* Represents the configuration of the exported themes. * *(dict) --* A theme is a collection of style settings that apply globally to the components associated with an Amplify application. * **appId** *(string) --* The unique ID for the Amplify app associated with the theme. * **environmentName** *(string) --* The name of the backend environment that is a part of the Amplify app. * **id** *(string) --* The ID for the theme. * **name** *(string) --* The name of the theme. * **createdAt** *(datetime) --* The time that the theme was created. * **modifiedAt** *(datetime) --* The time that the theme was modified. * **values** *(list) --* A list of key-value pairs that defines the properties of the theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **overrides** *(list) --* Describes the properties that can be overriden to customize a theme. * *(dict) --* A key-value pair that defines a property of a theme. * **key** *(string) --* The name of the property. * **value** *(dict) --* The value of the property. * **value** *(string) --* The value of a theme property. * **children** *(list) --* A list of key-value pairs that define the theme's properties. * **tags** *(dict) --* One or more key-value pairs to use when tagging the theme. * *(string) --* * *(string) --* * **nextToken** *(string) --* The pagination token that's included if more results are available. **Exceptions** * "AmplifyUIBuilder.Client.exceptions.InternalServerException" * "AmplifyUIBuilder.Client.exceptions.InvalidParameterException"