[ aws . amplifyuibuilder ]

update-component

Description

Updates an existing component.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-component
--app-id <value>
[--client-token <value>]
--environment-name <value>
--id <value>
--updated-component <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The unique ID for the Amplify app.

--client-token (string)

The unique client token.

--environment-name (string)

The name of the backend environment that is part of the Amplify app.

--id (string)

The unique ID for the component.

--updated-component (structure)

The configuration of the updated component.

bindingProperties -> (map)

The data binding information for the component’s properties.

key -> (string)

value -> (structure)

Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.

bindingProperties -> (structure)

Describes the properties to customize with data at runtime.

bucket -> (string)

An Amazon S3 bucket.

defaultValue -> (string)

The default value to assign to the property.

field -> (string)

The field to bind the data to.

key -> (string)

The storage key for an Amazon S3 bucket.

model -> (string)

An Amplify DataStore model.

predicates -> (list)

A list of predicates for binding a component’s properties to data.

(structure)

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.

(structure)

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

(structure)

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

userAttribute -> (string)

An authenticated user attribute.

defaultValue -> (string)

The default value of the property.

type -> (string)

The property type.

children -> (list)

The components that are instances of the main component.

(structure)

A nested UI configuration within a parent Component .

children -> (list)

The list of ComponentChild instances for this component.

(structure)

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 -> (map)

Describes the properties of the child component.

key -> (string)

value -> (structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

(structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

condition -> (structure)

The conditional expression to use to assign a value to the component property..

else -> (structure)

The value to assign to the property if the condition is not met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

then -> (structure)

The value to assign to the property if the condition is met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

componentType -> (string)

The type of the child component.

name -> (string)

The name of the child component.

properties -> (map)

Describes the properties of the child component.

key -> (string)

value -> (structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

(structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

condition -> (structure)

The conditional expression to use to assign a value to the component property..

else -> (structure)

The value to assign to the property if the condition is not met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

then -> (structure)

The value to assign to the property if the condition is met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

collectionProperties -> (map)

The configuration for binding a component’s properties to a data model. Use this for a collection component.

key -> (string)

value -> (structure)

Describes the configuration for binding a component’s properties to data.

identifiers -> (list)

A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.

(string)

model -> (string)

The name of the data model to use to bind data to a component.

predicate -> (structure)

Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.

and -> (list)

A list of predicates to combine logically.

(structure)

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.

( … recursive … )

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

( … recursive … )

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

(structure)

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.

( … recursive … )

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

( … recursive … )

sort -> (list)

Describes how to sort the component’s properties.

(structure)

Describes how to sort the data that you bind to a component.

direction -> (string)

The direction of the sort, either ascending or descending.

field -> (string)

The field to perform the sort on.

componentType -> (string)

The type of the component. This can be an Amplify custom UI component or another custom component.

id -> (string)

The unique ID of the component to update.

name -> (string)

The name of the component to update.

overrides -> (map)

Describes the properties that can be overriden to customize the component.

key -> (string)

value -> (map)

key -> (string)

value -> (string)

properties -> (map)

Describes the component’s properties.

key -> (string)

value -> (structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

(structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

condition -> (structure)

The conditional expression to use to assign a value to the component property..

else -> (structure)

The value to assign to the property if the condition is not met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

then -> (structure)

The value to assign to the property if the condition is met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

sourceId -> (string)

The unique ID of the component in its original source system, such as Figma.

variants -> (list)

A list of the unique variants of the main component being updated.

(structure)

Describes the style configuration of a unique variation of a main component.

overrides -> (map)

The properties of the component variant that can be overriden when customizing an instance of the component.

key -> (string)

value -> (map)

key -> (string)

value -> (string)

variantValues -> (map)

The combination of variants that comprise this variant.

key -> (string)

value -> (string)

JSON Syntax:

{
  "bindingProperties": {"string": {
        "bindingProperties": {
          "bucket": "string",
          "defaultValue": "string",
          "field": "string",
          "key": "string",
          "model": "string",
          "predicates": [
            {
              "and": [
                {
                  "and": ,
                  "field": "string",
                  "operand": "string",
                  "operator": "string",
                  "or":
                }
                ...
              ],
              "field": "string",
              "operand": "string",
              "operator": "string",
              "or": [
                {
                  "and": ,
                  "field": "string",
                  "operand": "string",
                  "operator": "string",
                  "or":
                }
                ...
              ]
            }
            ...
          ],
          "userAttribute": "string"
        },
        "defaultValue": "string",
        "type": "string"
      }
    ...},
  "children": [
    {
      "children": [
        {
          "children": ,
          "componentType": "string",
          "name": "string",
          "properties": {"string": {
                "bindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "bindings": {"string": {
                      "element": "string",
                      "property": "string"
                    }
                  ...},
                "collectionBindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "concat": [
                  {
                    "bindingProperties": {
                      "field": "string",
                      "property": "string"
                    },
                    "bindings": {"string": {
                          "element": "string",
                          "property": "string"
                        }
                      ...},
                    "collectionBindingProperties": {
                      "field": "string",
                      "property": "string"
                    },
                    "concat": [
                      { ... recursive ... }
                      ...
                    ],
                    "condition": {
                      "else": { ... recursive ... },
                      "field": "string",
                      "operand": "string",
                      "operator": "string",
                      "property": "string",
                      "then": { ... recursive ... }
                    },
                    "configured": true|false,
                    "defaultValue": "string",
                    "event": "string",
                    "importedValue": "string",
                    "model": "string",
                    "type": "string",
                    "userAttribute": "string",
                    "value": "string"
                  }
                  ...
                ],
                "condition": {
                  "else": {
                    "bindingProperties": {
                      "field": "string",
                      "property": "string"
                    },
                    "bindings": {"string": {
                          "element": "string",
                          "property": "string"
                        }
                      ...},
                    "collectionBindingProperties": {
                      "field": "string",
                      "property": "string"
                    },
                    "concat": [
                      { ... recursive ... }
                      ...
                    ],
                    "condition": {
                      "else": { ... recursive ... },
                      "field": "string",
                      "operand": "string",
                      "operator": "string",
                      "property": "string",
                      "then": { ... recursive ... }
                    },
                    "configured": true|false,
                    "defaultValue": "string",
                    "event": "string",
                    "importedValue": "string",
                    "model": "string",
                    "type": "string",
                    "userAttribute": "string",
                    "value": "string"
                  },
                  "field": "string",
                  "operand": "string",
                  "operator": "string",
                  "property": "string",
                  "then": {
                    "bindingProperties": {
                      "field": "string",
                      "property": "string"
                    },
                    "bindings": {"string": {
                          "element": "string",
                          "property": "string"
                        }
                      ...},
                    "collectionBindingProperties": {
                      "field": "string",
                      "property": "string"
                    },
                    "concat": [
                      { ... recursive ... }
                      ...
                    ],
                    "condition": {
                      "else": { ... recursive ... },
                      "field": "string",
                      "operand": "string",
                      "operator": "string",
                      "property": "string",
                      "then": { ... recursive ... }
                    },
                    "configured": true|false,
                    "defaultValue": "string",
                    "event": "string",
                    "importedValue": "string",
                    "model": "string",
                    "type": "string",
                    "userAttribute": "string",
                    "value": "string"
                  }
                },
                "configured": true|false,
                "defaultValue": "string",
                "event": "string",
                "importedValue": "string",
                "model": "string",
                "type": "string",
                "userAttribute": "string",
                "value": "string"
              }
            ...}
        }
        ...
      ],
      "componentType": "string",
      "name": "string",
      "properties": {"string": {
            "bindingProperties": {
              "field": "string",
              "property": "string"
            },
            "bindings": {"string": {
                  "element": "string",
                  "property": "string"
                }
              ...},
            "collectionBindingProperties": {
              "field": "string",
              "property": "string"
            },
            "concat": [
              {
                "bindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "bindings": {"string": {
                      "element": "string",
                      "property": "string"
                    }
                  ...},
                "collectionBindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "concat": [
                  { ... recursive ... }
                  ...
                ],
                "condition": {
                  "else": { ... recursive ... },
                  "field": "string",
                  "operand": "string",
                  "operator": "string",
                  "property": "string",
                  "then": { ... recursive ... }
                },
                "configured": true|false,
                "defaultValue": "string",
                "event": "string",
                "importedValue": "string",
                "model": "string",
                "type": "string",
                "userAttribute": "string",
                "value": "string"
              }
              ...
            ],
            "condition": {
              "else": {
                "bindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "bindings": {"string": {
                      "element": "string",
                      "property": "string"
                    }
                  ...},
                "collectionBindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "concat": [
                  { ... recursive ... }
                  ...
                ],
                "condition": {
                  "else": { ... recursive ... },
                  "field": "string",
                  "operand": "string",
                  "operator": "string",
                  "property": "string",
                  "then": { ... recursive ... }
                },
                "configured": true|false,
                "defaultValue": "string",
                "event": "string",
                "importedValue": "string",
                "model": "string",
                "type": "string",
                "userAttribute": "string",
                "value": "string"
              },
              "field": "string",
              "operand": "string",
              "operator": "string",
              "property": "string",
              "then": {
                "bindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "bindings": {"string": {
                      "element": "string",
                      "property": "string"
                    }
                  ...},
                "collectionBindingProperties": {
                  "field": "string",
                  "property": "string"
                },
                "concat": [
                  { ... recursive ... }
                  ...
                ],
                "condition": {
                  "else": { ... recursive ... },
                  "field": "string",
                  "operand": "string",
                  "operator": "string",
                  "property": "string",
                  "then": { ... recursive ... }
                },
                "configured": true|false,
                "defaultValue": "string",
                "event": "string",
                "importedValue": "string",
                "model": "string",
                "type": "string",
                "userAttribute": "string",
                "value": "string"
              }
            },
            "configured": true|false,
            "defaultValue": "string",
            "event": "string",
            "importedValue": "string",
            "model": "string",
            "type": "string",
            "userAttribute": "string",
            "value": "string"
          }
        ...}
    }
    ...
  ],
  "collectionProperties": {"string": {
        "identifiers": ["string", ...],
        "model": "string",
        "predicate": {
          "and": [
            {
              "and": [
                { ... recursive ... }
                ...
              ],
              "field": "string",
              "operand": "string",
              "operator": "string",
              "or": [
                { ... recursive ... }
                ...
              ]
            }
            ...
          ],
          "field": "string",
          "operand": "string",
          "operator": "string",
          "or": [
            {
              "and": [
                { ... recursive ... }
                ...
              ],
              "field": "string",
              "operand": "string",
              "operator": "string",
              "or": [
                { ... recursive ... }
                ...
              ]
            }
            ...
          ]
        },
        "sort": [
          {
            "direction": "ASC"|"DESC",
            "field": "string"
          }
          ...
        ]
      }
    ...},
  "componentType": "string",
  "id": "string",
  "name": "string",
  "overrides": {"string": {"string": "string"
        ...}
    ...},
  "properties": {"string": {
        "bindingProperties": {
          "field": "string",
          "property": "string"
        },
        "bindings": {"string": {
              "element": "string",
              "property": "string"
            }
          ...},
        "collectionBindingProperties": {
          "field": "string",
          "property": "string"
        },
        "concat": [
          {
            "bindingProperties": {
              "field": "string",
              "property": "string"
            },
            "bindings": {"string": {
                  "element": "string",
                  "property": "string"
                }
              ...},
            "collectionBindingProperties": {
              "field": "string",
              "property": "string"
            },
            "concat": [
              { ... recursive ... }
              ...
            ],
            "condition": {
              "else": { ... recursive ... },
              "field": "string",
              "operand": "string",
              "operator": "string",
              "property": "string",
              "then": { ... recursive ... }
            },
            "configured": true|false,
            "defaultValue": "string",
            "event": "string",
            "importedValue": "string",
            "model": "string",
            "type": "string",
            "userAttribute": "string",
            "value": "string"
          }
          ...
        ],
        "condition": {
          "else": {
            "bindingProperties": {
              "field": "string",
              "property": "string"
            },
            "bindings": {"string": {
                  "element": "string",
                  "property": "string"
                }
              ...},
            "collectionBindingProperties": {
              "field": "string",
              "property": "string"
            },
            "concat": [
              { ... recursive ... }
              ...
            ],
            "condition": {
              "else": { ... recursive ... },
              "field": "string",
              "operand": "string",
              "operator": "string",
              "property": "string",
              "then": { ... recursive ... }
            },
            "configured": true|false,
            "defaultValue": "string",
            "event": "string",
            "importedValue": "string",
            "model": "string",
            "type": "string",
            "userAttribute": "string",
            "value": "string"
          },
          "field": "string",
          "operand": "string",
          "operator": "string",
          "property": "string",
          "then": {
            "bindingProperties": {
              "field": "string",
              "property": "string"
            },
            "bindings": {"string": {
                  "element": "string",
                  "property": "string"
                }
              ...},
            "collectionBindingProperties": {
              "field": "string",
              "property": "string"
            },
            "concat": [
              { ... recursive ... }
              ...
            ],
            "condition": {
              "else": { ... recursive ... },
              "field": "string",
              "operand": "string",
              "operator": "string",
              "property": "string",
              "then": { ... recursive ... }
            },
            "configured": true|false,
            "defaultValue": "string",
            "event": "string",
            "importedValue": "string",
            "model": "string",
            "type": "string",
            "userAttribute": "string",
            "value": "string"
          }
        },
        "configured": true|false,
        "defaultValue": "string",
        "event": "string",
        "importedValue": "string",
        "model": "string",
        "type": "string",
        "userAttribute": "string",
        "value": "string"
      }
    ...},
  "sourceId": "string",
  "variants": [
    {
      "overrides": {"string": {"string": "string"
            ...}
        ...},
      "variantValues": {"string": "string"
        ...}
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

entity -> (structure)

Describes the configuration of the updated component.

appId -> (string)

The unique ID of the Amplify app associated with the component.

bindingProperties -> (map)

The information to connect a component’s properties to data at runtime.

key -> (string)

value -> (structure)

Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.

bindingProperties -> (structure)

Describes the properties to customize with data at runtime.

bucket -> (string)

An Amazon S3 bucket.

defaultValue -> (string)

The default value to assign to the property.

field -> (string)

The field to bind the data to.

key -> (string)

The storage key for an Amazon S3 bucket.

model -> (string)

An Amplify DataStore model.

predicates -> (list)

A list of predicates for binding a component’s properties to data.

(structure)

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.

(structure)

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

(structure)

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

userAttribute -> (string)

An authenticated user attribute.

defaultValue -> (string)

The default value of the property.

type -> (string)

The property type.

children -> (list)

A list of the component’s ComponentChild instances.

(structure)

A nested UI configuration within a parent Component .

children -> (list)

The list of ComponentChild instances for this component.

(structure)

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 -> (map)

Describes the properties of the child component.

key -> (string)

value -> (structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

(structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

condition -> (structure)

The conditional expression to use to assign a value to the component property..

else -> (structure)

The value to assign to the property if the condition is not met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

then -> (structure)

The value to assign to the property if the condition is met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

componentType -> (string)

The type of the child component.

name -> (string)

The name of the child component.

properties -> (map)

Describes the properties of the child component.

key -> (string)

value -> (structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

(structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

condition -> (structure)

The conditional expression to use to assign a value to the component property..

else -> (structure)

The value to assign to the property if the condition is not met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

then -> (structure)

The value to assign to the property if the condition is met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

collectionProperties -> (map)

The data binding configuration for the component’s properties. Use this for a collection component.

key -> (string)

value -> (structure)

Describes the configuration for binding a component’s properties to data.

identifiers -> (list)

A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.

(string)

model -> (string)

The name of the data model to use to bind data to a component.

predicate -> (structure)

Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.

and -> (list)

A list of predicates to combine logically.

(structure)

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.

( … recursive … )

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

( … recursive … )

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

(structure)

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.

( … recursive … )

field -> (string)

The field to query.

operand -> (string)

The value to use when performing the evaluation.

operator -> (string)

The operator to use to perform the evaluation.

or -> (list)

A list of predicates to combine logically.

( … recursive … )

sort -> (list)

Describes how to sort the component’s properties.

(structure)

Describes how to sort the data that you bind to a component.

direction -> (string)

The direction of the sort, either ascending or descending.

field -> (string)

The field to perform the sort on.

componentType -> (string)

The type of the component. This can be an Amplify custom UI component or another custom component.

createdAt -> (timestamp)

The time that the component was created.

environmentName -> (string)

The name of the backend environment that is a part of the Amplify app.

id -> (string)

The unique ID of the component.

modifiedAt -> (timestamp)

The time that the component was modified.

name -> (string)

The name of the component.

overrides -> (map)

Describes the component’s properties that can be overriden in a customized instance of the component.

key -> (string)

value -> (map)

key -> (string)

value -> (string)

properties -> (map)

Describes the component’s properties.

key -> (string)

value -> (structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

(structure)

Describes the configuration for all of a component’s properties. Use ComponentProperty to specify the values to render or bind by default.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

condition -> (structure)

The conditional expression to use to assign a value to the component property..

else -> (structure)

The value to assign to the property if the condition is not met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

then -> (structure)

The value to assign to the property if the condition is met.

bindingProperties -> (structure)

The information to bind the component property to data at runtime.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

bindings -> (map)

The information to bind the component property to form data.

key -> (string)

value -> (structure)

Describes how to bind a component property to form data.

element -> (string)

The name of the component to retrieve a value from.

property -> (string)

The property to retrieve a value from.

collectionBindingProperties -> (structure)

The information to bind the component property to data at runtime. Use this for collection components.

field -> (string)

The data field to bind the property to.

property -> (string)

The component property to bind to the data field.

concat -> (list)

A list of component properties to concatenate to create the value to assign to this component property.

( … recursive … )

condition -> (structure)

The conditional expression to use to assign a value to the component property..

( … recursive … )field -> (string)

The name of a field. Specify this when the property is a data model.

operand -> (string)

The value of the property to evaluate.

operator -> (string)

The operator to use to perform the evaluation, such as eq to represent equals.

property -> (string)

The name of the conditional property.

( … recursive … )

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

configured -> (boolean)

Specifies whether the user configured the property in Amplify Studio after importing it.

defaultValue -> (string)

The default value to assign to the component property.

event -> (string)

An event that occurs in your app. Use this for workflow data binding.

importedValue -> (string)

The default value assigned to property when the component is imported into an app.

model -> (string)

The data model to use to assign a value to the component property.

type -> (string)

The component type.

userAttribute -> (string)

An authenticated user attribute to use to assign a value to the component property.

value -> (string)

The value to assign to the component property.

sourceId -> (string)

The unique ID of the component in its original source system, such as Figma.

tags -> (map)

One or more key-value pairs to use when tagging the component.

key -> (string)

value -> (string)

variants -> (list)

A list of the component’s variants. A variant is a unique style configuration of a main component.

(structure)

Describes the style configuration of a unique variation of a main component.

overrides -> (map)

The properties of the component variant that can be overriden when customizing an instance of the component.

key -> (string)

value -> (map)

key -> (string)

value -> (string)

variantValues -> (map)

The combination of variants that comprise this variant.

key -> (string)

value -> (string)