You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.AmplifyUIBuilder

Inherits:
AWS.Service show all
Identifier:
amplifyuibuilder
API Version:
2021-08-11
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using AmplifyUIBuilder

var amplifyuibuilder = new AWS.AmplifyUIBuilder();
amplifyuibuilder.createComponent(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AmplifyUIBuilder object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var amplifyuibuilder = new AWS.AmplifyUIBuilder({apiVersion: '2021-08-11'});

You can also set the API version globally in AWS.config.apiVersions using the amplifyuibuilder service identifier:

AWS.config.apiVersions = {
  amplifyuibuilder: '2021-08-11',
  // other service API versions
};

var amplifyuibuilder = new AWS.AmplifyUIBuilder();

Version:

  • 2021-08-11

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AmplifyUIBuilder(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AmplifyUIBuilder object

var amplifyuibuilder = new AWS.AmplifyUIBuilder({apiVersion: '2021-08-11'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AmplifyUIBuilder.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AmplifyUIBuilder.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AmplifyUIBuilder.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createComponent(params = {}, callback) ⇒ AWS.Request

Creates a new component for an Amplify app.

Service Reference:

Examples:

Calling the createComponent operation

var params = {
  appId: 'STRING_VALUE', /* required */
  componentToCreate: { /* required */
    bindingProperties: { /* required */
      '<String>': {
        bindingProperties: {
          bucket: 'STRING_VALUE',
          defaultValue: 'STRING_VALUE',
          field: 'STRING_VALUE',
          key: 'STRING_VALUE',
          model: 'STRING_VALUE',
          predicates: [ /* PredicateList */
            {
              and: /* recursive PredicateList */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              or: /* recursive PredicateList */
            },
            /* more items */
          ],
          userAttribute: 'STRING_VALUE'
        },
        defaultValue: 'STRING_VALUE',
        type: 'STRING_VALUE'
      },
      /* '<String>': ... */
    },
    componentType: 'STRING_VALUE', /* required */
    name: 'STRING_VALUE', /* required */
    overrides: { /* required */
      '<String>': {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      /* '<String>': ... */
    },
    properties: { /* required */
      '<String>': { /* ComponentProperty */
        bindingProperties: {
          property: 'STRING_VALUE', /* required */
          field: 'STRING_VALUE'
        },
        bindings: {
          '<String>': {
            element: 'STRING_VALUE', /* required */
            property: 'STRING_VALUE' /* required */
          },
          /* '<String>': ... */
        },
        collectionBindingProperties: {
          property: 'STRING_VALUE', /* required */
          field: 'STRING_VALUE'
        },
        componentName: 'STRING_VALUE',
        concat: [
          /* recursive ComponentProperty */,
          /* more items */
        ],
        condition: {
          else: /* recursive ComponentProperty */,
          field: 'STRING_VALUE',
          operand: 'STRING_VALUE',
          operandType: 'STRING_VALUE',
          operator: 'STRING_VALUE',
          property: 'STRING_VALUE',
          then: /* recursive ComponentProperty */
        },
        configured: true || false,
        defaultValue: 'STRING_VALUE',
        event: 'STRING_VALUE',
        importedValue: 'STRING_VALUE',
        model: 'STRING_VALUE',
        property: 'STRING_VALUE',
        type: 'STRING_VALUE',
        userAttribute: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      /* '<String>': ... */
    },
    variants: [ /* required */
      {
        overrides: {
          '<String>': {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          },
          /* '<String>': ... */
        },
        variantValues: {
          '<String>': 'STRING_VALUE',
          /* '<String>': ... */
        }
      },
      /* more items */
    ],
    children: [ /* ComponentChildList */
      {
        componentType: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        properties: { /* required */
          '<String>': { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          /* '<String>': ... */
        },
        children: /* recursive ComponentChildList */,
        events: {
          '<String>': {
            action: 'STRING_VALUE',
            bindingEvent: 'STRING_VALUE',
            parameters: {
              anchor: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              fields: {
                '<String>': { /* ComponentProperty */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  bindings: {
                    '<String>': {
                      element: 'STRING_VALUE', /* required */
                      property: 'STRING_VALUE' /* required */
                    },
                    /* '<String>': ... */
                  },
                  collectionBindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  componentName: 'STRING_VALUE',
                  concat: [
                    /* recursive ComponentProperty */,
                    /* more items */
                  ],
                  condition: {
                    else: /* recursive ComponentProperty */,
                    field: 'STRING_VALUE',
                    operand: 'STRING_VALUE',
                    operandType: 'STRING_VALUE',
                    operator: 'STRING_VALUE',
                    property: 'STRING_VALUE',
                    then: /* recursive ComponentProperty */
                  },
                  configured: true || false,
                  defaultValue: 'STRING_VALUE',
                  event: 'STRING_VALUE',
                  importedValue: 'STRING_VALUE',
                  model: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  type: 'STRING_VALUE',
                  userAttribute: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                },
                /* '<String>': ... */
              },
              global: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              id: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              model: 'STRING_VALUE',
              state: {
                componentName: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE', /* required */
                set: { /* ComponentProperty */ /* required */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  bindings: {
                    '<String>': {
                      element: 'STRING_VALUE', /* required */
                      property: 'STRING_VALUE' /* required */
                    },
                    /* '<String>': ... */
                  },
                  collectionBindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  componentName: 'STRING_VALUE',
                  concat: [
                    /* recursive ComponentProperty */,
                    /* more items */
                  ],
                  condition: {
                    else: /* recursive ComponentProperty */,
                    field: 'STRING_VALUE',
                    operand: 'STRING_VALUE',
                    operandType: 'STRING_VALUE',
                    operator: 'STRING_VALUE',
                    property: 'STRING_VALUE',
                    then: /* recursive ComponentProperty */
                  },
                  configured: true || false,
                  defaultValue: 'STRING_VALUE',
                  event: 'STRING_VALUE',
                  importedValue: 'STRING_VALUE',
                  model: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  type: 'STRING_VALUE',
                  userAttribute: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                }
              },
              target: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              type: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              url: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              }
            }
          },
          /* '<String>': ... */
        },
        sourceId: 'STRING_VALUE'
      },
      /* more items */
    ],
    collectionProperties: {
      '<String>': {
        model: 'STRING_VALUE', /* required */
        identifiers: [
          'STRING_VALUE',
          /* more items */
        ],
        predicate: { /* Predicate */
          and: [ /* PredicateList */
            /* recursive Predicate */,
            /* more items */
          ],
          field: 'STRING_VALUE',
          operand: 'STRING_VALUE',
          operator: 'STRING_VALUE',
          or: [ /* PredicateList */
            /* recursive Predicate */,
            /* more items */
          ]
        },
        sort: [
          {
            direction: ASC | DESC, /* required */
            field: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* '<String>': ... */
    },
    events: {
      '<String>': {
        action: 'STRING_VALUE',
        bindingEvent: 'STRING_VALUE',
        parameters: {
          anchor: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          fields: {
            '<String>': { /* ComponentProperty */
              bindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              bindings: {
                '<String>': {
                  element: 'STRING_VALUE', /* required */
                  property: 'STRING_VALUE' /* required */
                },
                /* '<String>': ... */
              },
              collectionBindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              componentName: 'STRING_VALUE',
              concat: [
                /* recursive ComponentProperty */,
                /* more items */
              ],
              condition: {
                else: /* recursive ComponentProperty */,
                field: 'STRING_VALUE',
                operand: 'STRING_VALUE',
                operandType: 'STRING_VALUE',
                operator: 'STRING_VALUE',
                property: 'STRING_VALUE',
                then: /* recursive ComponentProperty */
              },
              configured: true || false,
              defaultValue: 'STRING_VALUE',
              event: 'STRING_VALUE',
              importedValue: 'STRING_VALUE',
              model: 'STRING_VALUE',
              property: 'STRING_VALUE',
              type: 'STRING_VALUE',
              userAttribute: 'STRING_VALUE',
              value: 'STRING_VALUE'
            },
            /* '<String>': ... */
          },
          global: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          id: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          model: 'STRING_VALUE',
          state: {
            componentName: 'STRING_VALUE', /* required */
            property: 'STRING_VALUE', /* required */
            set: { /* ComponentProperty */ /* required */
              bindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              bindings: {
                '<String>': {
                  element: 'STRING_VALUE', /* required */
                  property: 'STRING_VALUE' /* required */
                },
                /* '<String>': ... */
              },
              collectionBindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              componentName: 'STRING_VALUE',
              concat: [
                /* recursive ComponentProperty */,
                /* more items */
              ],
              condition: {
                else: /* recursive ComponentProperty */,
                field: 'STRING_VALUE',
                operand: 'STRING_VALUE',
                operandType: 'STRING_VALUE',
                operator: 'STRING_VALUE',
                property: 'STRING_VALUE',
                then: /* recursive ComponentProperty */
              },
              configured: true || false,
              defaultValue: 'STRING_VALUE',
              event: 'STRING_VALUE',
              importedValue: 'STRING_VALUE',
              model: 'STRING_VALUE',
              property: 'STRING_VALUE',
              type: 'STRING_VALUE',
              userAttribute: 'STRING_VALUE',
              value: 'STRING_VALUE'
            }
          },
          target: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          type: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          url: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          }
        }
      },
      /* '<String>': ... */
    },
    schemaVersion: 'STRING_VALUE',
    sourceId: 'STRING_VALUE',
    tags: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  environmentName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.createComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID of the Amplify app to associate with the component.

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • componentToCreate — (map)

      Represents the configuration of the component to create.

      • bindingPropertiesrequired — (map<map>)

        The data binding information for the component's properties.

        • bindingProperties — (map)

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

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

            • 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 — (Array<map>)

        A list of child components that are instances of the main component.

        • componentTyperequired — (String)

          The type of the child component.

        • events — (map<map>)

          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.

          • action — (String)

            The action to perform when a specific event is raised.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • parameters — (map)

            Describes information about the action.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • fields — (map<map>)

              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.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • state — (map)

              A key-value pair that specifies the state property name and its initial value.

              • componentNamerequired — (String)

                The name of the component that is being modified.

              • propertyrequired — (String)

                The name of the component property to apply the state configuration to.

              • setrequired — (map)

                The state configuration to assign to the property.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

        • namerequired — (String)

          The name of the child component.

        • propertiesrequired — (map<map>)

          Describes the properties of the child component. You can't specify tags as a valid property for properties.

          • bindingProperties — (map)

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

            • field — (String)

              The data field to bind the property to.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • bindings — (map<map>)

            The information to bind the component property to form data.

            • elementrequired — (String)

              The name of the component to retrieve a value from.

            • propertyrequired — (String)

              The property to retrieve a value from.

          • collectionBindingProperties — (map)

            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.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • componentName — (String)

            The name of the component that is affected by an event.

          • concat — (Array<map>)

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

          • condition — (map)

            The conditional expression to use to assign a value 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.

            • operandType — (String)

              The type of the property to evaluate.

            • operator — (String)

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

            • property — (String)

              The name of the conditional property.

          • configured — (Boolean)

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

          • defaultValue — (String)

            The default value to assign to the component property.

          • event — (String)

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

          • importedValue — (String)

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

          • model — (String)

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

          • property — (String)

            The name of the component's property that is affected by an event.

          • type — (String)

            The component type.

          • userAttribute — (String)

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

          • value — (String)

            The value to assign to the component property.

        • sourceId — (String)

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

      • collectionProperties — (map<map>)

        The data binding configuration for customizing a component's properties. Use this for a collection component.

        • identifiers — (Array<String>)

          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.

        • modelrequired — (String)

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

        • predicate — (map)

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

            A list of predicates to combine logically.

          • field — (String)

            The field to query.

          • operand — (String)

            The value to use when performing the evaluation.

          • operator — (String)

            The operator to use to perform the evaluation.

          • or — (Array<map>)

            A list of predicates to combine logically.

        • sort — (Array<map>)

          Describes how to sort the component's properties.

          • directionrequired — (String)

            The direction of the sort, either ascending or descending.

            Possible values include:
            • "ASC"
            • "DESC"
          • fieldrequired — (String)

            The field to perform the sort on.

      • componentTyperequired — (String)

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

      • events — (map<map>)

        The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

        • action — (String)

          The action to perform when a specific event is raised.

        • bindingEvent — (String)

          Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

        • parameters — (map)

          Describes information about the action.

          • anchor — (map)

            The HTML anchor link to the location to open. Specify this value for a navigation action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • fields — (map<map>)

            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.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • global — (map)

            Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • id — (map)

            The unique ID of the component that the ActionParameters apply to.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • model — (String)

            The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

          • state — (map)

            A key-value pair that specifies the state property name and its initial value.

            • componentNamerequired — (String)

              The name of the component that is being modified.

            • propertyrequired — (String)

              The name of the component property to apply the state configuration to.

            • setrequired — (map)

              The state configuration to assign to the property.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

          • target — (map)

            The element within the same component to modify when the action occurs.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • type — (map)

            The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • url — (map)

            The URL to the location to open. Specify this value for a navigation action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

      • namerequired — (String)

        The name of the component

      • overridesrequired — (map<map<String>>)

        Describes the component properties that can be overriden to customize an instance of the component.

      • propertiesrequired — (map<map>)

        Describes the component's properties.

        • bindingProperties — (map)

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

          • field — (String)

            The data field to bind the property to.

          • propertyrequired — (String)

            The component property to bind to the data field.

        • bindings — (map<map>)

          The information to bind the component property to form data.

          • elementrequired — (String)

            The name of the component to retrieve a value from.

          • propertyrequired — (String)

            The property to retrieve a value from.

        • collectionBindingProperties — (map)

          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.

          • propertyrequired — (String)

            The component property to bind to the data field.

        • componentName — (String)

          The name of the component that is affected by an event.

        • concat — (Array<map>)

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

        • condition — (map)

          The conditional expression to use to assign a value 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.

          • operandType — (String)

            The type of the property to evaluate.

          • operator — (String)

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

          • property — (String)

            The name of the conditional property.

        • configured — (Boolean)

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

        • defaultValue — (String)

          The default value to assign to the component property.

        • event — (String)

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

        • importedValue — (String)

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

        • model — (String)

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

        • property — (String)

          The name of the component's property that is affected by an event.

        • type — (String)

          The component type.

        • userAttribute — (String)

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

        • value — (String)

          The value to assign to the component property.

      • schemaVersion — (String)

        The schema version of the component when it was imported.

      • sourceId — (String)

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

      • tags — (map<String>)

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

      • variantsrequired — (Array<map>)

        A list of the unique variants of this component.

        • overrides — (map<map<String>>)

          The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

        • variantValues — (map<String>)

          The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

    • environmentName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entity — (map)

        Describes the configuration of the new component.

        • appIdrequired — (String)

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

        • bindingPropertiesrequired — (map<map>)

          The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

          • bindingProperties — (map)

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

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

              • 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 — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

          • events — (map<map>)

            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.

            • action — (String)

              The action to perform when a specific event is raised.

            • bindingEvent — (String)

              Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

            • parameters — (map)

              Describes information about the action.

              • anchor — (map)

                The HTML anchor link to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • fields — (map<map>)

                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.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • global — (map)

                Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • id — (map)

                The unique ID of the component that the ActionParameters apply to.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • model — (String)

                The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

              • state — (map)

                A key-value pair that specifies the state property name and its initial value.

                • componentNamerequired — (String)

                  The name of the component that is being modified.

                • propertyrequired — (String)

                  The name of the component property to apply the state configuration to.

                • setrequired — (map)

                  The state configuration to assign to the property.

                  • bindingProperties — (map)

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

                    • field — (String)

                      The data field to bind the property to.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • bindings — (map<map>)

                    The information to bind the component property to form data.

                    • elementrequired — (String)

                      The name of the component to retrieve a value from.

                    • propertyrequired — (String)

                      The property to retrieve a value from.

                  • collectionBindingProperties — (map)

                    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.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • componentName — (String)

                    The name of the component that is affected by an event.

                  • concat — (Array<map>)

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

                  • condition — (map)

                    The conditional expression to use to assign a value 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.

                    • operandType — (String)

                      The type of the property to evaluate.

                    • operator — (String)

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

                    • property — (String)

                      The name of the conditional property.

                  • configured — (Boolean)

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

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • event — (String)

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

                  • importedValue — (String)

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

                  • model — (String)

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

                  • property — (String)

                    The name of the component's property that is affected by an event.

                  • type — (String)

                    The component type.

                  • userAttribute — (String)

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

                  • value — (String)

                    The value to assign to the component property.

              • target — (map)

                The element within the same component to modify when the action occurs.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • type — (map)

                The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • url — (map)

                The URL to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

          • namerequired — (String)

            The name of the child component.

          • propertiesrequired — (map<map>)

            Describes the properties of the child component. You can't specify tags as a valid property for properties.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • sourceId — (String)

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

        • collectionProperties — (map<map>)

          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.

          • identifiers — (Array<String>)

            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.

          • modelrequired — (String)

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

          • predicate — (map)

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

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operand — (String)

              The value to use when performing the evaluation.

            • operator — (String)

              The operator to use to perform the evaluation.

            • or — (Array<map>)

              A list of predicates to combine logically.

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
            • fieldrequired — (String)

              The field to perform the sort on.

        • componentTyperequired — (String)

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

        • createdAtrequired — (Date)

          The time that the component was created.

        • environmentNamerequired — (String)

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

        • events — (map<map>)

          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.

          • action — (String)

            The action to perform when a specific event is raised.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • parameters — (map)

            Describes information about the action.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • fields — (map<map>)

              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.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • state — (map)

              A key-value pair that specifies the state property name and its initial value.

              • componentNamerequired — (String)

                The name of the component that is being modified.

              • propertyrequired — (String)

                The name of the component property to apply the state configuration to.

              • setrequired — (map)

                The state configuration to assign to the property.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

        • idrequired — (String)

          The unique ID of the component.

        • modifiedAt — (Date)

          The time that the component was modified.

        • namerequired — (String)

          The name of the component.

        • overridesrequired — (map<map<String>>)

          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.

        • propertiesrequired — (map<map>)

          Describes the component's properties. You can't specify tags as a valid property for properties.

          • bindingProperties — (map)

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

            • field — (String)

              The data field to bind the property to.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • bindings — (map<map>)

            The information to bind the component property to form data.

            • elementrequired — (String)

              The name of the component to retrieve a value from.

            • propertyrequired — (String)

              The property to retrieve a value from.

          • collectionBindingProperties — (map)

            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.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • componentName — (String)

            The name of the component that is affected by an event.

          • concat — (Array<map>)

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

          • condition — (map)

            The conditional expression to use to assign a value 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.

            • operandType — (String)

              The type of the property to evaluate.

            • operator — (String)

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

            • property — (String)

              The name of the conditional property.

          • configured — (Boolean)

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

          • defaultValue — (String)

            The default value to assign to the component property.

          • event — (String)

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

          • importedValue — (String)

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

          • model — (String)

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

          • property — (String)

            The name of the component's property that is affected by an event.

          • type — (String)

            The component type.

          • userAttribute — (String)

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

          • value — (String)

            The value to assign to the component property.

        • schemaVersion — (String)

          The schema version of the component when it was imported.

        • sourceId — (String)

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

        • tags — (map<String>)

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

        • variantsrequired — (Array<map>)

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

          • overrides — (map<map<String>>)

            The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

          • variantValues — (map<String>)

            The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTheme(params = {}, callback) ⇒ AWS.Request

Creates a theme to apply to the components in an Amplify app.

Service Reference:

Examples:

Calling the createTheme operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  themeToCreate: { /* required */
    name: 'STRING_VALUE', /* required */
    values: [ /* ThemeValuesList */ /* required */
      {
        key: 'STRING_VALUE',
        value: {
          children: /* recursive ThemeValuesList */,
          value: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    overrides: [ /* ThemeValuesList */
      {
        key: 'STRING_VALUE',
        value: {
          children: /* recursive ThemeValuesList */,
          value: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    tags: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.createTheme(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

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

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • environmentName — (String)

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

    • themeToCreate — (map)

      Represents the configuration of the theme to create.

      • namerequired — (String)

        The name of the theme.

      • overrides — (Array<map>)

        Describes the properties that can be overriden to customize an instance of the theme.

        • key — (String)

          The name of the property.

        • value — (map)

          The value of the property.

          • value — (String)

            The value of a theme property.

      • tags — (map<String>)

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

      • valuesrequired — (Array<map>)

        A list of key-value pairs that deļ¬nes the properties of the theme.

        • key — (String)

          The name of the property.

        • value — (map)

          The value of the property.

          • value — (String)

            The value of a theme property.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entity — (map)

        Describes the configuration of the new theme.

        • appIdrequired — (String)

          The unique ID for the Amplify app associated with the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The ID for the theme.

        • modifiedAt — (Date)

          The time that the theme was modified.

        • namerequired — (String)

          The name of the theme.

        • overrides — (Array<map>)

          Describes the properties that can be overriden to customize a theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

        • tags — (map<String>)

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

        • valuesrequired — (Array<map>)

          A list of key-value pairs that defines the properties of the theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteComponent(params = {}, callback) ⇒ AWS.Request

Deletes a component from an Amplify app.

Service Reference:

Examples:

Calling the deleteComponent operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.deleteComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

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

    • environmentName — (String)

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

    • id — (String)

      The unique ID of the component to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTheme(params = {}, callback) ⇒ AWS.Request

Deletes a theme from an Amplify app.

Service Reference:

Examples:

Calling the deleteTheme operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.deleteTheme(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID of the Amplify app associated with the theme to delete.

    • environmentName — (String)

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

    • id — (String)

      The unique ID of the theme to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exchangeCodeForToken(params = {}, callback) ⇒ AWS.Request

Exchanges an access code for a token.

Service Reference:

Examples:

Calling the exchangeCodeForToken operation

var params = {
  provider: figma, /* required */
  request: { /* required */
    code: 'STRING_VALUE', /* required */
    redirectUri: 'STRING_VALUE' /* required */
  }
};
amplifyuibuilder.exchangeCodeForToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • provider — (String)

      The third-party provider for the token. The only valid value is figma.

      Possible values include:
      • "figma"
    • request — (map)

      Describes the configuration of the request.

      • coderequired — (String)

        The access code to send in the request.

      • redirectUrirequired — (String)

        The location of the application that will receive the access code.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportComponents(params = {}, callback) ⇒ AWS.Request

Exports component configurations to code that is ready to integrate into an Amplify app.

Service Reference:

Examples:

Calling the exportComponents operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.exportComponents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID of the Amplify app to export components to.

    • environmentName — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entities — (Array<map>)

        Represents the configuration of the exported components.

        • appIdrequired — (String)

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

        • bindingPropertiesrequired — (map<map>)

          The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

          • bindingProperties — (map)

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

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

              • 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 — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

          • events — (map<map>)

            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.

            • action — (String)

              The action to perform when a specific event is raised.

            • bindingEvent — (String)

              Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

            • parameters — (map)

              Describes information about the action.

              • anchor — (map)

                The HTML anchor link to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • fields — (map<map>)

                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.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • global — (map)

                Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • id — (map)

                The unique ID of the component that the ActionParameters apply to.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • model — (String)

                The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

              • state — (map)

                A key-value pair that specifies the state property name and its initial value.

                • componentNamerequired — (String)

                  The name of the component that is being modified.

                • propertyrequired — (String)

                  The name of the component property to apply the state configuration to.

                • setrequired — (map)

                  The state configuration to assign to the property.

                  • bindingProperties — (map)

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

                    • field — (String)

                      The data field to bind the property to.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • bindings — (map<map>)

                    The information to bind the component property to form data.

                    • elementrequired — (String)

                      The name of the component to retrieve a value from.

                    • propertyrequired — (String)

                      The property to retrieve a value from.

                  • collectionBindingProperties — (map)

                    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.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • componentName — (String)

                    The name of the component that is affected by an event.

                  • concat — (Array<map>)

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

                  • condition — (map)

                    The conditional expression to use to assign a value 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.

                    • operandType — (String)

                      The type of the property to evaluate.

                    • operator — (String)

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

                    • property — (String)

                      The name of the conditional property.

                  • configured — (Boolean)

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

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • event — (String)

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

                  • importedValue — (String)

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

                  • model — (String)

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

                  • property — (String)

                    The name of the component's property that is affected by an event.

                  • type — (String)

                    The component type.

                  • userAttribute — (String)

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

                  • value — (String)

                    The value to assign to the component property.

              • target — (map)

                The element within the same component to modify when the action occurs.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • type — (map)

                The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • url — (map)

                The URL to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

          • namerequired — (String)

            The name of the child component.

          • propertiesrequired — (map<map>)

            Describes the properties of the child component. You can't specify tags as a valid property for properties.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • sourceId — (String)

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

        • collectionProperties — (map<map>)

          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.

          • identifiers — (Array<String>)

            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.

          • modelrequired — (String)

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

          • predicate — (map)

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

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operand — (String)

              The value to use when performing the evaluation.

            • operator — (String)

              The operator to use to perform the evaluation.

            • or — (Array<map>)

              A list of predicates to combine logically.

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
            • fieldrequired — (String)

              The field to perform the sort on.

        • componentTyperequired — (String)

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

        • createdAtrequired — (Date)

          The time that the component was created.

        • environmentNamerequired — (String)

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

        • events — (map<map>)

          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.

          • action — (String)

            The action to perform when a specific event is raised.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • parameters — (map)

            Describes information about the action.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • fields — (map<map>)

              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.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • state — (map)

              A key-value pair that specifies the state property name and its initial value.

              • componentNamerequired — (String)

                The name of the component that is being modified.

              • propertyrequired — (String)

                The name of the component property to apply the state configuration to.

              • setrequired — (map)

                The state configuration to assign to the property.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

        • idrequired — (String)

          The unique ID of the component.

        • modifiedAt — (Date)

          The time that the component was modified.

        • namerequired — (String)

          The name of the component.

        • overridesrequired — (map<map<String>>)

          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.

        • propertiesrequired — (map<map>)

          Describes the component's properties. You can't specify tags as a valid property for properties.

          • bindingProperties — (map)

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

            • field — (String)

              The data field to bind the property to.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • bindings — (map<map>)

            The information to bind the component property to form data.

            • elementrequired — (String)

              The name of the component to retrieve a value from.

            • propertyrequired — (String)

              The property to retrieve a value from.

          • collectionBindingProperties — (map)

            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.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • componentName — (String)

            The name of the component that is affected by an event.

          • concat — (Array<map>)

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

          • condition — (map)

            The conditional expression to use to assign a value 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.

            • operandType — (String)

              The type of the property to evaluate.

            • operator — (String)

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

            • property — (String)

              The name of the conditional property.

          • configured — (Boolean)

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

          • defaultValue — (String)

            The default value to assign to the component property.

          • event — (String)

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

          • importedValue — (String)

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

          • model — (String)

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

          • property — (String)

            The name of the component's property that is affected by an event.

          • type — (String)

            The component type.

          • userAttribute — (String)

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

          • value — (String)

            The value to assign to the component property.

        • schemaVersion — (String)

          The schema version of the component when it was imported.

        • sourceId — (String)

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

        • tags — (map<String>)

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

        • variantsrequired — (Array<map>)

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

          • overrides — (map<map<String>>)

            The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

          • variantValues — (map<String>)

            The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

      • nextToken — (String)

        The pagination token that's included if more results are available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportThemes(params = {}, callback) ⇒ AWS.Request

Exports theme configurations to code that is ready to integrate into an Amplify app.

Service Reference:

Examples:

Calling the exportThemes operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.exportThemes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID of the Amplify app to export the themes to.

    • environmentName — (String)

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

    • nextToken — (String)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entities — (Array<map>)

        Represents the configuration of the exported themes.

        • appIdrequired — (String)

          The unique ID for the Amplify app associated with the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The ID for the theme.

        • modifiedAt — (Date)

          The time that the theme was modified.

        • namerequired — (String)

          The name of the theme.

        • overrides — (Array<map>)

          Describes the properties that can be overriden to customize a theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

        • tags — (map<String>)

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

        • valuesrequired — (Array<map>)

          A list of key-value pairs that defines the properties of the theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

      • nextToken — (String)

        The pagination token that's included if more results are available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getComponent(params = {}, callback) ⇒ AWS.Request

Returns an existing component for an Amplify app.

Service Reference:

Examples:

Calling the getComponent operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.getComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID of the Amplify app.

    • environmentName — (String)

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

    • id — (String)

      The unique ID of the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • component — (map)

        Represents the configuration settings for the component.

        • appIdrequired — (String)

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

        • bindingPropertiesrequired — (map<map>)

          The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

          • bindingProperties — (map)

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

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

              • 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 — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

          • events — (map<map>)

            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.

            • action — (String)

              The action to perform when a specific event is raised.

            • bindingEvent — (String)

              Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

            • parameters — (map)

              Describes information about the action.

              • anchor — (map)

                The HTML anchor link to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • fields — (map<map>)

                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.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • global — (map)

                Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • id — (map)

                The unique ID of the component that the ActionParameters apply to.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • model — (String)

                The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

              • state — (map)

                A key-value pair that specifies the state property name and its initial value.

                • componentNamerequired — (String)

                  The name of the component that is being modified.

                • propertyrequired — (String)

                  The name of the component property to apply the state configuration to.

                • setrequired — (map)

                  The state configuration to assign to the property.

                  • bindingProperties — (map)

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

                    • field — (String)

                      The data field to bind the property to.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • bindings — (map<map>)

                    The information to bind the component property to form data.

                    • elementrequired — (String)

                      The name of the component to retrieve a value from.

                    • propertyrequired — (String)

                      The property to retrieve a value from.

                  • collectionBindingProperties — (map)

                    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.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • componentName — (String)

                    The name of the component that is affected by an event.

                  • concat — (Array<map>)

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

                  • condition — (map)

                    The conditional expression to use to assign a value 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.

                    • operandType — (String)

                      The type of the property to evaluate.

                    • operator — (String)

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

                    • property — (String)

                      The name of the conditional property.

                  • configured — (Boolean)

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

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • event — (String)

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

                  • importedValue — (String)

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

                  • model — (String)

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

                  • property — (String)

                    The name of the component's property that is affected by an event.

                  • type — (String)

                    The component type.

                  • userAttribute — (String)

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

                  • value — (String)

                    The value to assign to the component property.

              • target — (map)

                The element within the same component to modify when the action occurs.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • type — (map)

                The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

              • url — (map)

                The URL to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

          • namerequired — (String)

            The name of the child component.

          • propertiesrequired — (map<map>)

            Describes the properties of the child component. You can't specify tags as a valid property for properties.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • sourceId — (String)

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

        • collectionProperties — (map<map>)

          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.

          • identifiers — (Array<String>)

            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.

          • modelrequired — (String)

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

          • predicate — (map)

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

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operand — (String)

              The value to use when performing the evaluation.

            • operator — (String)

              The operator to use to perform the evaluation.

            • or — (Array<map>)

              A list of predicates to combine logically.

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
            • fieldrequired — (String)

              The field to perform the sort on.

        • componentTyperequired — (String)

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

        • createdAtrequired — (Date)

          The time that the component was created.

        • environmentNamerequired — (String)

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

        • events — (map<map>)

          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.

          • action — (String)

            The action to perform when a specific event is raised.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • parameters — (map)

            Describes information about the action.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • fields — (map<map>)

              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.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • state — (map)

              A key-value pair that specifies the state property name and its initial value.

              • componentNamerequired — (String)

                The name of the component that is being modified.

              • propertyrequired — (String)

                The name of the component property to apply the state configuration to.

              • setrequired — (map)

                The state configuration to assign to the property.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

        • idrequired — (String)

          The unique ID of the component.

        • modifiedAt — (Date)

          The time that the component was modified.

        • namerequired — (String)

          The name of the component.

        • overridesrequired — (map<map<String>>)

          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.

        • propertiesrequired — (map<map>)

          Describes the component's properties. You can't specify tags as a valid property for properties.

          • bindingProperties — (map)

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

            • field — (String)

              The data field to bind the property to.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • bindings — (map<map>)

            The information to bind the component property to form data.

            • elementrequired — (String)

              The name of the component to retrieve a value from.

            • propertyrequired — (String)

              The property to retrieve a value from.

          • collectionBindingProperties — (map)

            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.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • componentName — (String)

            The name of the component that is affected by an event.

          • concat — (Array<map>)

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

          • condition — (map)

            The conditional expression to use to assign a value 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.

            • operandType — (String)

              The type of the property to evaluate.

            • operator — (String)

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

            • property — (String)

              The name of the conditional property.

          • configured — (Boolean)

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

          • defaultValue — (String)

            The default value to assign to the component property.

          • event — (String)

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

          • importedValue — (String)

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

          • model — (String)

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

          • property — (String)

            The name of the component's property that is affected by an event.

          • type — (String)

            The component type.

          • userAttribute — (String)

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

          • value — (String)

            The value to assign to the component property.

        • schemaVersion — (String)

          The schema version of the component when it was imported.

        • sourceId — (String)

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

        • tags — (map<String>)

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

        • variantsrequired — (Array<map>)

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

          • overrides — (map<map<String>>)

            The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

          • variantValues — (map<String>)

            The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTheme(params = {}, callback) ⇒ AWS.Request

Returns an existing theme for an Amplify app.

Service Reference:

Examples:

Calling the getTheme operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.getTheme(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID of the Amplify app.

    • environmentName — (String)

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

    • id — (String)

      The unique ID for the theme.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • theme — (map)

        Represents the configuration settings for the theme.

        • appIdrequired — (String)

          The unique ID for the Amplify app associated with the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The ID for the theme.

        • modifiedAt — (Date)

          The time that the theme was modified.

        • namerequired — (String)

          The name of the theme.

        • overrides — (Array<map>)

          Describes the properties that can be overriden to customize a theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

        • tags — (map<String>)

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

        • valuesrequired — (Array<map>)

          A list of key-value pairs that defines the properties of the theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listComponents(params = {}, callback) ⇒ AWS.Request

Retrieves a list of components for a specified Amplify app and backend environment.

Service Reference:

Examples:

Calling the listComponents operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.listComponents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID for the Amplify app.

    • environmentName — (String)

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

    • maxResults — (Integer)

      The maximum number of components to retrieve.

    • nextToken — (String)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entities — (Array<map>)

        The list of components for the Amplify app.

        • appIdrequired — (String)

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

        • componentTyperequired — (String)

          The component type.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The unique ID of the component.

        • namerequired — (String)

          The name of the component.

      • nextToken — (String)

        The pagination token that's included if more results are available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listThemes(params = {}, callback) ⇒ AWS.Request

Retrieves a list of themes for a specified Amplify app and backend environment.

Service Reference:

Examples:

Calling the listThemes operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.listThemes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID for the Amplify app.

    • environmentName — (String)

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

    • maxResults — (Integer)

      The maximum number of theme results to return in the response.

    • nextToken — (String)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entities — (Array<map>)

        The list of themes for the Amplify app.

        • appIdrequired — (String)

          The unique ID for the app associated with the theme summary.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The ID of the theme.

        • namerequired — (String)

          The name of the theme.

      • nextToken — (String)

        The pagination token that's returned if more results are available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

refreshToken(params = {}, callback) ⇒ AWS.Request

Refreshes a previously issued access token that might have expired.

Service Reference:

Examples:

Calling the refreshToken operation

var params = {
  provider: figma, /* required */
  refreshTokenBody: { /* required */
    token: 'STRING_VALUE' /* required */
  }
};
amplifyuibuilder.refreshToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • provider — (String)

      The third-party provider for the token. The only valid value is figma.

      Possible values include:
      • "figma"
    • refreshTokenBody — (map)

      Information about the refresh token request.

      • tokenrequired — (String)

        The token to use to refresh a previously issued access token that might have expired.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessToken — (String)

        The access token.

      • expiresIn — (Integer)

        The date and time when the new access token expires.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateComponent(params = {}, callback) ⇒ AWS.Request

Updates an existing component.

Service Reference:

Examples:

Calling the updateComponent operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  updatedComponent: { /* required */
    bindingProperties: {
      '<String>': {
        bindingProperties: {
          bucket: 'STRING_VALUE',
          defaultValue: 'STRING_VALUE',
          field: 'STRING_VALUE',
          key: 'STRING_VALUE',
          model: 'STRING_VALUE',
          predicates: [ /* PredicateList */
            {
              and: /* recursive PredicateList */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              or: /* recursive PredicateList */
            },
            /* more items */
          ],
          userAttribute: 'STRING_VALUE'
        },
        defaultValue: 'STRING_VALUE',
        type: 'STRING_VALUE'
      },
      /* '<String>': ... */
    },
    children: [ /* ComponentChildList */
      {
        componentType: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        properties: { /* required */
          '<String>': { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          /* '<String>': ... */
        },
        children: /* recursive ComponentChildList */,
        events: {
          '<String>': {
            action: 'STRING_VALUE',
            bindingEvent: 'STRING_VALUE',
            parameters: {
              anchor: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              fields: {
                '<String>': { /* ComponentProperty */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  bindings: {
                    '<String>': {
                      element: 'STRING_VALUE', /* required */
                      property: 'STRING_VALUE' /* required */
                    },
                    /* '<String>': ... */
                  },
                  collectionBindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  componentName: 'STRING_VALUE',
                  concat: [
                    /* recursive ComponentProperty */,
                    /* more items */
                  ],
                  condition: {
                    else: /* recursive ComponentProperty */,
                    field: 'STRING_VALUE',
                    operand: 'STRING_VALUE',
                    operandType: 'STRING_VALUE',
                    operator: 'STRING_VALUE',
                    property: 'STRING_VALUE',
                    then: /* recursive ComponentProperty */
                  },
                  configured: true || false,
                  defaultValue: 'STRING_VALUE',
                  event: 'STRING_VALUE',
                  importedValue: 'STRING_VALUE',
                  model: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  type: 'STRING_VALUE',
                  userAttribute: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                },
                /* '<String>': ... */
              },
              global: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              id: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              model: 'STRING_VALUE',
              state: {
                componentName: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE', /* required */
                set: { /* ComponentProperty */ /* required */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  bindings: {
                    '<String>': {
                      element: 'STRING_VALUE', /* required */
                      property: 'STRING_VALUE' /* required */
                    },
                    /* '<String>': ... */
                  },
                  collectionBindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  componentName: 'STRING_VALUE',
                  concat: [
                    /* recursive ComponentProperty */,
                    /* more items */
                  ],
                  condition: {
                    else: /* recursive ComponentProperty */,
                    field: 'STRING_VALUE',
                    operand: 'STRING_VALUE',
                    operandType: 'STRING_VALUE',
                    operator: 'STRING_VALUE',
                    property: 'STRING_VALUE',
                    then: /* recursive ComponentProperty */
                  },
                  configured: true || false,
                  defaultValue: 'STRING_VALUE',
                  event: 'STRING_VALUE',
                  importedValue: 'STRING_VALUE',
                  model: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  type: 'STRING_VALUE',
                  userAttribute: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                }
              },
              target: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              type: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              url: { /* ComponentProperty */
                bindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                bindings: {
                  '<String>': {
                    element: 'STRING_VALUE', /* required */
                    property: 'STRING_VALUE' /* required */
                  },
                  /* '<String>': ... */
                },
                collectionBindingProperties: {
                  property: 'STRING_VALUE', /* required */
                  field: 'STRING_VALUE'
                },
                componentName: 'STRING_VALUE',
                concat: [
                  /* recursive ComponentProperty */,
                  /* more items */
                ],
                condition: {
                  else: /* recursive ComponentProperty */,
                  field: 'STRING_VALUE',
                  operand: 'STRING_VALUE',
                  operandType: 'STRING_VALUE',
                  operator: 'STRING_VALUE',
                  property: 'STRING_VALUE',
                  then: /* recursive ComponentProperty */
                },
                configured: true || false,
                defaultValue: 'STRING_VALUE',
                event: 'STRING_VALUE',
                importedValue: 'STRING_VALUE',
                model: 'STRING_VALUE',
                property: 'STRING_VALUE',
                type: 'STRING_VALUE',
                userAttribute: 'STRING_VALUE',
                value: 'STRING_VALUE'
              }
            }
          },
          /* '<String>': ... */
        },
        sourceId: 'STRING_VALUE'
      },
      /* more items */
    ],
    collectionProperties: {
      '<String>': {
        model: 'STRING_VALUE', /* required */
        identifiers: [
          'STRING_VALUE',
          /* more items */
        ],
        predicate: { /* Predicate */
          and: [ /* PredicateList */
            /* recursive Predicate */,
            /* more items */
          ],
          field: 'STRING_VALUE',
          operand: 'STRING_VALUE',
          operator: 'STRING_VALUE',
          or: [ /* PredicateList */
            /* recursive Predicate */,
            /* more items */
          ]
        },
        sort: [
          {
            direction: ASC | DESC, /* required */
            field: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* '<String>': ... */
    },
    componentType: 'STRING_VALUE',
    events: {
      '<String>': {
        action: 'STRING_VALUE',
        bindingEvent: 'STRING_VALUE',
        parameters: {
          anchor: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          fields: {
            '<String>': { /* ComponentProperty */
              bindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              bindings: {
                '<String>': {
                  element: 'STRING_VALUE', /* required */
                  property: 'STRING_VALUE' /* required */
                },
                /* '<String>': ... */
              },
              collectionBindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              componentName: 'STRING_VALUE',
              concat: [
                /* recursive ComponentProperty */,
                /* more items */
              ],
              condition: {
                else: /* recursive ComponentProperty */,
                field: 'STRING_VALUE',
                operand: 'STRING_VALUE',
                operandType: 'STRING_VALUE',
                operator: 'STRING_VALUE',
                property: 'STRING_VALUE',
                then: /* recursive ComponentProperty */
              },
              configured: true || false,
              defaultValue: 'STRING_VALUE',
              event: 'STRING_VALUE',
              importedValue: 'STRING_VALUE',
              model: 'STRING_VALUE',
              property: 'STRING_VALUE',
              type: 'STRING_VALUE',
              userAttribute: 'STRING_VALUE',
              value: 'STRING_VALUE'
            },
            /* '<String>': ... */
          },
          global: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          id: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          model: 'STRING_VALUE',
          state: {
            componentName: 'STRING_VALUE', /* required */
            property: 'STRING_VALUE', /* required */
            set: { /* ComponentProperty */ /* required */
              bindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              bindings: {
                '<String>': {
                  element: 'STRING_VALUE', /* required */
                  property: 'STRING_VALUE' /* required */
                },
                /* '<String>': ... */
              },
              collectionBindingProperties: {
                property: 'STRING_VALUE', /* required */
                field: 'STRING_VALUE'
              },
              componentName: 'STRING_VALUE',
              concat: [
                /* recursive ComponentProperty */,
                /* more items */
              ],
              condition: {
                else: /* recursive ComponentProperty */,
                field: 'STRING_VALUE',
                operand: 'STRING_VALUE',
                operandType: 'STRING_VALUE',
                operator: 'STRING_VALUE',
                property: 'STRING_VALUE',
                then: /* recursive ComponentProperty */
              },
              configured: true || false,
              defaultValue: 'STRING_VALUE',
              event: 'STRING_VALUE',
              importedValue: 'STRING_VALUE',
              model: 'STRING_VALUE',
              property: 'STRING_VALUE',
              type: 'STRING_VALUE',
              userAttribute: 'STRING_VALUE',
              value: 'STRING_VALUE'
            }
          },
          target: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          type: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          },
          url: { /* ComponentProperty */
            bindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            bindings: {
              '<String>': {
                element: 'STRING_VALUE', /* required */
                property: 'STRING_VALUE' /* required */
              },
              /* '<String>': ... */
            },
            collectionBindingProperties: {
              property: 'STRING_VALUE', /* required */
              field: 'STRING_VALUE'
            },
            componentName: 'STRING_VALUE',
            concat: [
              /* recursive ComponentProperty */,
              /* more items */
            ],
            condition: {
              else: /* recursive ComponentProperty */,
              field: 'STRING_VALUE',
              operand: 'STRING_VALUE',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              property: 'STRING_VALUE',
              then: /* recursive ComponentProperty */
            },
            configured: true || false,
            defaultValue: 'STRING_VALUE',
            event: 'STRING_VALUE',
            importedValue: 'STRING_VALUE',
            model: 'STRING_VALUE',
            property: 'STRING_VALUE',
            type: 'STRING_VALUE',
            userAttribute: 'STRING_VALUE',
            value: 'STRING_VALUE'
          }
        }
      },
      /* '<String>': ... */
    },
    id: 'STRING_VALUE',
    name: 'STRING_VALUE',
    overrides: {
      '<String>': {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      /* '<String>': ... */
    },
    properties: {
      '<String>': { /* ComponentProperty */
        bindingProperties: {
          property: 'STRING_VALUE', /* required */
          field: 'STRING_VALUE'
        },
        bindings: {
          '<String>': {
            element: 'STRING_VALUE', /* required */
            property: 'STRING_VALUE' /* required */
          },
          /* '<String>': ... */
        },
        collectionBindingProperties: {
          property: 'STRING_VALUE', /* required */
          field: 'STRING_VALUE'
        },
        componentName: 'STRING_VALUE',
        concat: [
          /* recursive ComponentProperty */,
          /* more items */
        ],
        condition: {
          else: /* recursive ComponentProperty */,
          field: 'STRING_VALUE',
          operand: 'STRING_VALUE',
          operandType: 'STRING_VALUE',
          operator: 'STRING_VALUE',
          property: 'STRING_VALUE',
          then: /* recursive ComponentProperty */
        },
        configured: true || false,
        defaultValue: 'STRING_VALUE',
        event: 'STRING_VALUE',
        importedValue: 'STRING_VALUE',
        model: 'STRING_VALUE',
        property: 'STRING_VALUE',
        type: 'STRING_VALUE',
        userAttribute: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      /* '<String>': ... */
    },
    schemaVersion: 'STRING_VALUE',
    sourceId: 'STRING_VALUE',
    variants: [
      {
        overrides: {
          '<String>': {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          },
          /* '<String>': ... */
        },
        variantValues: {
          '<String>': 'STRING_VALUE',
          /* '<String>': ... */
        }
      },
      /* more items */
    ]
  },
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.updateComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID for the Amplify app.

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • environmentName — (String)

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

    • id — (String)

      The unique ID for the component.

    • updatedComponent — (map)

      The configuration of the updated component.

      • bindingProperties — (map<map>)

        The data binding information for the component's properties.

        • bindingProperties — (map)

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

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

            • 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 — (Array<map>)

        The components that are instances of the main component.

        • componentTyperequired — (String)

          The type of the child component.

        • events — (map<map>)

          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.

          • action — (String)

            The action to perform when a specific event is raised.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • parameters — (map)

            Describes information about the action.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • fields — (map<map>)

              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.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • state — (map)

              A key-value pair that specifies the state property name and its initial value.

              • componentNamerequired — (String)

                The name of the component that is being modified.

              • propertyrequired — (String)

                The name of the component property to apply the state configuration to.

              • setrequired — (map)

                The state configuration to assign to the property.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

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

                • model — (String)

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

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

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

                • value — (String)

                  The value to assign to the component property.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

        • namerequired — (String)

          The name of the child component.

        • propertiesrequired — (map<map>)

          Describes the properties of the child component. You can't specify tags as a valid property for properties.

          • bindingProperties — (map)

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

            • field — (String)

              The data field to bind the property to.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • bindings — (map<map>)

            The information to bind the component property to form data.

            • elementrequired — (String)

              The name of the component to retrieve a value from.

            • propertyrequired — (String)

              The property to retrieve a value from.

          • collectionBindingProperties — (map)

            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.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • componentName — (String)

            The name of the component that is affected by an event.

          • concat — (Array<map>)

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

          • condition — (map)

            The conditional expression to use to assign a value 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.

            • operandType — (String)

              The type of the property to evaluate.

            • operator — (String)

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

            • property — (String)

              The name of the conditional property.

          • configured — (Boolean)

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

          • defaultValue — (String)

            The default value to assign to the component property.

          • event — (String)

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

          • importedValue — (String)

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

          • model — (String)

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

          • property — (String)

            The name of the component's property that is affected by an event.

          • type — (String)

            The component type.

          • userAttribute — (String)

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

          • value — (String)

            The value to assign to the component property.

        • sourceId — (String)

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

      • collectionProperties — (map<map>)

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

        • identifiers — (Array<String>)

          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.

        • modelrequired — (String)

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

        • predicate — (map)

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

            A list of predicates to combine logically.

          • field — (String)

            The field to query.

          • operand — (String)

            The value to use when performing the evaluation.

          • operator — (String)

            The operator to use to perform the evaluation.

          • or — (Array<map>)

            A list of predicates to combine logically.

        • sort — (Array<map>)

          Describes how to sort the component's properties.

          • directionrequired — (String)

            The direction of the sort, either ascending or descending.

            Possible values include:
            • "ASC"
            • "DESC"
          • fieldrequired — (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.

      • events — (map<map>)

        The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

        • action — (String)

          The action to perform when a specific event is raised.

        • bindingEvent — (String)

          Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

        • parameters — (map)

          Describes information about the action.

          • anchor — (map)

            The HTML anchor link to the location to open. Specify this value for a navigation action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • fields — (map<map>)

            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.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • global — (map)

            Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • id — (map)

            The unique ID of the component that the ActionParameters apply to.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • model — (String)

            The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

          • state — (map)

            A key-value pair that specifies the state property name and its initial value.

            • componentNamerequired — (String)

              The name of the component that is being modified.

            • propertyrequired — (String)

              The name of the component property to apply the state configuration to.

            • setrequired — (map)

              The state configuration to assign to the property.

              • bindingProperties — (map)

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

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

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

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

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

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

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

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

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

              • importedValue — (String)

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

              • model — (String)

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

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

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

              • value — (String)

                The value to assign to the component property.

          • target — (map)

            The element within the same component to modify when the action occurs.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • type — (map)

            The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

          • url — (map)

            The URL to the location to open. Specify this value for a navigation action.

            • bindingProperties — (map)

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

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

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

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

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

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

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

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

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

            • importedValue — (String)

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

            • model — (String)

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

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

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

            • value — (String)

              The value to assign to the component property.

      • id — (String)

        The unique ID of the component to update.

      • name — (String)

        The name of the component to update.

      • overrides — (map<map<String>>)

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

      • properties — (map<map>)

        Describes the component's properties.

        • bindingProperties — (map)

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

          • field — (String)

            The data field to bind the property to.

          • propertyrequired — (String)

            The component property to bind to the data field.

        • bindings — (map<map>)

          The information to bind the component property to form data.

          • elementrequired — (String)

            The name of the component to retrieve a value from.

          • propertyrequired — (String)

            The property to retrieve a value from.

        • collectionBindingProperties — (map)

          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.

          • propertyrequired — (String)

            The component property to bind to the data field.

        • componentName — (String)

          The name of the component that is affected by an event.

        • concat — (Array<map>)

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

        • condition — (map)

          The conditional expression to use to assign a value 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.

          • operandType — (String)

            The type of the property to evaluate.

          • operator — (String)

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

          • property — (String)

            The name of the conditional property.

        • configured — (Boolean)

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

        • defaultValue — (String)

          The default value to assign to the component property.

        • event — (String)

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

        • importedValue — (String)

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

        • model — (String)

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

        • property — (String)

          The name of the component's property that is affected by an event.

        • type — (String)

          The component type.

        • userAttribute — (String)

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

        • value — (String)

          The value to assign to the component property.

      • schemaVersion — (String)

        The schema version of the component when it was imported.

      • sourceId — (String)

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

      • variants — (Array<map>)

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

        • overrides — (map<map<String>>)

          The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

        • variantValues — (map<String>)

          The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entity — (map)

        Describes the configuration of the updated component.

        • appIdrequired — (String)

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

        • bindingPropertiesrequired — (map<map>)

          The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

          • bindingProperties — (map)

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

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

              • 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 — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

          • events — (map<map>)

            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.

            • action — (String)

              The action to perform when a specific event is raised.

            • bindingEvent — (String)

              Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

            • parameters — (map)

              Describes information about the action.

              • anchor — (map)

                The HTML anchor link to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

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

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

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

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

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

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

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

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

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

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

              • fields — (map<map>)

                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.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

              • global — (map)

                Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

              • id — (map)

                The unique ID of the component that the ActionParameters apply to.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

              • model — (String)

                The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

              • state — (map)

                A key-value pair that specifies the state property name and its initial value.

                • componentNamerequired — (String)

                  The name of the component that is being modified.

                • propertyrequired — (String)

                  The name of the component property to apply the state configuration to.

                • setrequired — (map)

                  The state configuration to assign to the property.

                  • bindingProperties — (map)

                    The information to bind the component property to data at runtime.

                    • field — (String)

                      The data field to bind the property to.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • bindings — (map<map>)

                    The information to bind the component property to form data.

                    • elementrequired — (String)

                      The name of the component to retrieve a value from.

                    • propertyrequired — (String)

                      The property to retrieve a value from.

                  • collectionBindingProperties — (map)

                    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.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                  • componentName — (String)

                    The name of the component that is affected by an event.

                  • concat — (Array<map>)

                    A list of component properties to concatenate to create the value to assign to this component property.

                  • condition — (map)

                    The conditional expression to use to assign a value 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.

                    • operandType — (String)

                      The type of the property to evaluate.

                    • operator — (String)

                      The operator to use to perform the evaluation, such as eq to represent equals.

                    • property — (String)

                      The name of the conditional property.

                  • configured — (Boolean)

                    Specifies whether the user configured the property in Amplify Studio after importing it.

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • event — (String)

                    An event that occurs in your app. Use this for workflow data binding.

                  • importedValue — (String)

                    The default value assigned to the property when the component is imported into an app.

                  • model — (String)

                    The data model to use to assign a value to the component property.

                  • property — (String)

                    The name of the component's property that is affected by an event.

                  • type — (String)

                    The component type.

                  • userAttribute — (String)

                    An authenticated user attribute to use to assign a value to the component property.

                  • value — (String)

                    The value to assign to the component property.

              • target — (map)

                The element within the same component to modify when the action occurs.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

              • type — (map)

                The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

              • url — (map)

                The URL to the location to open. Specify this value for a navigation action.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

          • namerequired — (String)

            The name of the child component.

          • propertiesrequired — (map<map>)

            Describes the properties of the child component. You can't specify tags as a valid property for properties.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • field — (String)

                The data field to bind the property to.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • bindings — (map<map>)

              The information to bind the component property to form data.

              • elementrequired — (String)

                The name of the component to retrieve a value from.

              • propertyrequired — (String)

                The property to retrieve a value from.

            • collectionBindingProperties — (map)

              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.

              • propertyrequired — (String)

                The component property to bind to the data field.

            • componentName — (String)

              The name of the component that is affected by an event.

            • concat — (Array<map>)

              A list of component properties to concatenate to create the value to assign to this component property.

            • condition — (map)

              The conditional expression to use to assign a value 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.

              • operandType — (String)

                The type of the property to evaluate.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • property — (String)

                The name of the conditional property.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • defaultValue — (String)

              The default value to assign to the component property.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • model — (String)

              The data model to use to assign a value to the component property.

            • property — (String)

              The name of the component's property that is affected by an event.

            • type — (String)

              The component type.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • value — (String)

              The value to assign to the component property.

          • sourceId — (String)

            The unique ID of the child component in its original source system, such as Figma.

        • collectionProperties — (map<map>)

          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.

          • identifiers — (Array<String>)

            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.

          • modelrequired — (String)

            The name of the data model to use to bind data to a component.

          • predicate — (map)

            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 — (Array<map>)

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operand — (String)

              The value to use when performing the evaluation.

            • operator — (String)

              The operator to use to perform the evaluation.

            • or — (Array<map>)

              A list of predicates to combine logically.

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
            • fieldrequired — (String)

              The field to perform the sort on.

        • componentTyperequired — (String)

          The type of the component. This can be an Amplify custom UI component or another custom component.

        • createdAtrequired — (Date)

          The time that the component was created.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • events — (map<map>)

          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.

          • action — (String)

            The action to perform when a specific event is raised.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • parameters — (map)

            Describes information about the action.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

            • fields — (map<map>)

              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.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • state — (map)

              A key-value pair that specifies the state property name and its initial value.

              • componentNamerequired — (String)

                The name of the component that is being modified.

              • propertyrequired — (String)

                The name of the component property to apply the state configuration to.

              • setrequired — (map)

                The state configuration to assign to the property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • field — (String)

                    The data field to bind the property to.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • bindings — (map<map>)

                  The information to bind the component property to form data.

                  • elementrequired — (String)

                    The name of the component to retrieve a value from.

                  • propertyrequired — (String)

                    The property to retrieve a value from.

                • collectionBindingProperties — (map)

                  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.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • concat — (Array<map>)

                  A list of component properties to concatenate to create the value to assign to this component property.

                • condition — (map)

                  The conditional expression to use to assign a value 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.

                  • operandType — (String)

                    The type of the property to evaluate.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • property — (String)

                    The name of the conditional property.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • property — (String)

                  The name of the component's property that is affected by an event.

                • type — (String)

                  The component type.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • value — (String)

                  The value to assign to the component property.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • field — (String)

                  The data field to bind the property to.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • bindings — (map<map>)

                The information to bind the component property to form data.

                • elementrequired — (String)

                  The name of the component to retrieve a value from.

                • propertyrequired — (String)

                  The property to retrieve a value from.

              • collectionBindingProperties — (map)

                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.

                • propertyrequired — (String)

                  The component property to bind to the data field.

              • componentName — (String)

                The name of the component that is affected by an event.

              • concat — (Array<map>)

                A list of component properties to concatenate to create the value to assign to this component property.

              • condition — (map)

                The conditional expression to use to assign a value 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.

                • operandType — (String)

                  The type of the property to evaluate.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • property — (String)

                  The name of the conditional property.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • defaultValue — (String)

                The default value to assign to the component property.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • model — (String)

                The data model to use to assign a value to the component property.

              • property — (String)

                The name of the component's property that is affected by an event.

              • type — (String)

                The component type.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • value — (String)

                The value to assign to the component property.

        • idrequired — (String)

          The unique ID of the component.

        • modifiedAt — (Date)

          The time that the component was modified.

        • namerequired — (String)

          The name of the component.

        • overridesrequired — (map<map<String>>)

          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.

        • propertiesrequired — (map<map>)

          Describes the component's properties. You can't specify tags as a valid property for properties.

          • bindingProperties — (map)

            The information to bind the component property to data at runtime.

            • field — (String)

              The data field to bind the property to.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • bindings — (map<map>)

            The information to bind the component property to form data.

            • elementrequired — (String)

              The name of the component to retrieve a value from.

            • propertyrequired — (String)

              The property to retrieve a value from.

          • collectionBindingProperties — (map)

            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.

            • propertyrequired — (String)

              The component property to bind to the data field.

          • componentName — (String)

            The name of the component that is affected by an event.

          • concat — (Array<map>)

            A list of component properties to concatenate to create the value to assign to this component property.

          • condition — (map)

            The conditional expression to use to assign a value 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.

            • operandType — (String)

              The type of the property to evaluate.

            • operator — (String)

              The operator to use to perform the evaluation, such as eq to represent equals.

            • property — (String)

              The name of the conditional property.

          • configured — (Boolean)

            Specifies whether the user configured the property in Amplify Studio after importing it.

          • defaultValue — (String)

            The default value to assign to the component property.

          • event — (String)

            An event that occurs in your app. Use this for workflow data binding.

          • importedValue — (String)

            The default value assigned to the property when the component is imported into an app.

          • model — (String)

            The data model to use to assign a value to the component property.

          • property — (String)

            The name of the component's property that is affected by an event.

          • type — (String)

            The component type.

          • userAttribute — (String)

            An authenticated user attribute to use to assign a value to the component property.

          • value — (String)

            The value to assign to the component property.

        • schemaVersion — (String)

          The schema version of the component when it was imported.

        • sourceId — (String)

          The unique ID of the component in its original source system, such as Figma.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the component.

        • variantsrequired — (Array<map>)

          A list of the component's variants. A variant is a unique style configuration of a main component.

          • overrides — (map<map<String>>)

            The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

          • variantValues — (map<String>)

            The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateTheme(params = {}, callback) ⇒ AWS.Request

Updates an existing theme.

Service Reference:

Examples:

Calling the updateTheme operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  updatedTheme: { /* required */
    values: [ /* ThemeValuesList */ /* required */
      {
        key: 'STRING_VALUE',
        value: {
          children: /* recursive ThemeValuesList */,
          value: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    id: 'STRING_VALUE',
    name: 'STRING_VALUE',
    overrides: [ /* ThemeValuesList */
      {
        key: 'STRING_VALUE',
        value: {
          children: /* recursive ThemeValuesList */,
          value: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.updateTheme(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appId — (String)

      The unique ID for the Amplify app.

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • environmentName — (String)

      The name of the backend environment that is part of the Amplify app.

    • id — (String)

      The unique ID for the theme.

    • updatedTheme — (map)

      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.

      • overrides — (Array<map>)

        Describes the properties that can be overriden to customize the theme.

        • key — (String)

          The name of the property.

        • value — (map)

          The value of the property.

          • value — (String)

            The value of a theme property.

      • valuesrequired — (Array<map>)

        A list of key-value pairs that define the theme's properties.

        • key — (String)

          The name of the property.

        • value — (map)

          The value of the property.

          • value — (String)

            The value of a theme property.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • entity — (map)

        Describes the configuration of the updated theme.

        • appIdrequired — (String)

          The unique ID for the Amplify app associated with the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • idrequired — (String)

          The ID for the theme.

        • modifiedAt — (Date)

          The time that the theme was modified.

        • namerequired — (String)

          The name of the theme.

        • overrides — (Array<map>)

          Describes the properties that can be overriden to customize a theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the theme.

        • valuesrequired — (Array<map>)

          A list of key-value pairs that defines the properties of the theme.

          • key — (String)

            The name of the property.

          • value — (map)

            The value of the property.

            • value — (String)

              The value of a theme property.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.