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, 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',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              or: /* recursive PredicateList */
            },
            /* more items */
          ],
          slotName: 'STRING_VALUE',
          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',
          operandType: '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.

    • environmentName — (String)

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

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

      • namerequired — (String)

        The name of the component

      • sourceId — (String)

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

      • componentTyperequired — (String)

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

      • propertiesrequired — (map<map>)

        Describes the component's properties.

        • value — (String)

          The value to assign to the component property.

        • bindingProperties — (map)

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

          • propertyrequired — (String)

            The component property to bind to the data field.

          • field — (String)

            The data field to bind the property to.

        • collectionBindingProperties — (map)

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

          • propertyrequired — (String)

            The component property to bind to the data field.

          • field — (String)

            The data field to bind the property to.

        • defaultValue — (String)

          The default value to assign to the component property.

        • model — (String)

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

        • bindings — (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.

        • event — (String)

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

        • userAttribute — (String)

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

        • concat — (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.

          • property — (String)

            The name of the conditional property.

          • field — (String)

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

          • operator — (String)

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

          • operand — (String)

            The value of the property to evaluate.

          • operandType — (String)

            The type of the property to evaluate.

        • configured — (Boolean)

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

        • type — (String)

          The component type.

        • importedValue — (String)

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

        • componentName — (String)

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

        • property — (String)

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

      • children — (Array<map>)

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

        • componentTyperequired — (String)

          The type of the child component.

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

          • value — (String)

            The value to assign to the component property.

          • bindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • collectionBindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • defaultValue — (String)

            The default value to assign to the component property.

          • model — (String)

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

          • bindings — (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.

          • event — (String)

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

          • userAttribute — (String)

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

          • concat — (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.

            • property — (String)

              The name of the conditional property.

            • field — (String)

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

            • operator — (String)

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

            • operand — (String)

              The value of the property to evaluate.

            • operandType — (String)

              The type of the property to evaluate.

          • configured — (Boolean)

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

          • type — (String)

            The component type.

          • importedValue — (String)

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

          • componentName — (String)

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

          • property — (String)

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

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

          • parameters — (map)

            Describes information about the action.

            • type — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • url — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • anchor — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • target — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • global — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • model — (String)

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

            • id — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • fields — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • state — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

          • bindingEvent — (String)

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

        • sourceId — (String)

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

      • variantsrequired — (Array<map>)

        A list of the unique variants of this component.

        • variantValues — (map<String>)

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

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

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

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

      • bindingPropertiesrequired — (map<map>)

        The data binding information for the component's properties.

        • type — (String)

          The property type.

        • bindingProperties — (map)

          Describes the properties to customize with data at runtime.

          • model — (String)

            An Amplify DataStore model.

          • field — (String)

            The field to bind the data to.

          • predicates — (Array<map>)

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

            • field — (String)

              The field to query.

            • operator — (String)

              The operator to use to perform the evaluation.

            • operand — (String)

              The value to use when performing the evaluation.

            • operandType — (String)

              The type of value to use when performing the evaluation.

          • userAttribute — (String)

            An authenticated user attribute.

          • bucket — (String)

            An Amazon S3 bucket.

          • key — (String)

            The storage key for an Amazon S3 bucket.

          • defaultValue — (String)

            The default value to assign to the property.

          • slotName — (String)

            The name of a component slot.

        • defaultValue — (String)

          The default value of the property.

      • collectionProperties — (map<map>)

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

        • modelrequired — (String)

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

        • sort — (Array<map>)

          Describes how to sort the component's properties.

          • fieldrequired — (String)

            The field to perform the sort on.

          • directionrequired — (String)

            The direction of the sort, either ascending or descending.

            Possible values include:
            • "ASC"
            • "DESC"
        • 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.

          • or — (Array<map>)

            A list of predicates to combine logically.

          • and — (Array<map>)

            A list of predicates to combine logically.

          • field — (String)

            The field to query.

          • operator — (String)

            The operator to use to perform the evaluation.

          • operand — (String)

            The value to use when performing the evaluation.

          • operandType — (String)

            The type of value to use when performing the evaluation.

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

      • tags — (map<String>)

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

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

        • parameters — (map)

          Describes information about the action.

          • type — (map)

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • url — (map)

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • anchor — (map)

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • target — (map)

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • global — (map)

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • model — (String)

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

          • id — (map)

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • fields — (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.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

          • state — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

        • bindingEvent — (String)

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

      • schemaVersion — (String)

        The schema version of the component when it was imported.

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.

        • environmentNamerequired — (String)

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

        • sourceId — (String)

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

        • idrequired — (String)

          The unique ID of the component.

        • namerequired — (String)

          The name of the component.

        • componentTyperequired — (String)

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

        • propertiesrequired — (map<map>)

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

          • value — (String)

            The value to assign to the component property.

          • bindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • collectionBindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • defaultValue — (String)

            The default value to assign to the component property.

          • model — (String)

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

          • bindings — (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.

          • event — (String)

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

          • userAttribute — (String)

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

          • concat — (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.

            • property — (String)

              The name of the conditional property.

            • field — (String)

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

            • operator — (String)

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

            • operand — (String)

              The value of the property to evaluate.

            • operandType — (String)

              The type of the property to evaluate.

          • configured — (Boolean)

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

          • type — (String)

            The component type.

          • importedValue — (String)

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

          • componentName — (String)

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

          • property — (String)

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

        • children — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

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

            • parameters — (map)

              Describes information about the action.

              • type — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • url — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • anchor — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • target — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • global — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • model — (String)

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

              • id — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • fields — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • state — (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.

                  • value — (String)

                    The value to assign to the component property.

                  • bindingProperties — (map)

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

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • collectionBindingProperties — (map)

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

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • model — (String)

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

                  • bindings — (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.

                  • event — (String)

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

                  • userAttribute — (String)

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

                  • concat — (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.

                    • property — (String)

                      The name of the conditional property.

                    • field — (String)

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

                    • operator — (String)

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

                    • operand — (String)

                      The value of the property to evaluate.

                    • operandType — (String)

                      The type of the property to evaluate.

                  • configured — (Boolean)

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

                  • type — (String)

                    The component type.

                  • importedValue — (String)

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

                  • componentName — (String)

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

                  • property — (String)

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

            • bindingEvent — (String)

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

          • sourceId — (String)

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

        • variantsrequired — (Array<map>)

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

          • variantValues — (map<String>)

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

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

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

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

          • type — (String)

            The property type.

          • bindingProperties — (map)

            Describes the properties to customize with data at runtime.

            • model — (String)

              An Amplify DataStore model.

            • field — (String)

              The field to bind the data to.

            • predicates — (Array<map>)

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

              • field — (String)

                The field to query.

              • operator — (String)

                The operator to use to perform the evaluation.

              • operand — (String)

                The value to use when performing the evaluation.

              • operandType — (String)

                The type of value to use when performing the evaluation.

            • userAttribute — (String)

              An authenticated user attribute.

            • bucket — (String)

              An Amazon S3 bucket.

            • key — (String)

              The storage key for an Amazon S3 bucket.

            • defaultValue — (String)

              The default value to assign to the property.

            • slotName — (String)

              The name of a component slot.

          • defaultValue — (String)

            The default value of the property.

        • collectionProperties — (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.

          • modelrequired — (String)

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

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • fieldrequired — (String)

              The field to perform the sort on.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
          • 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.

            • or — (Array<map>)

              A list of predicates to combine logically.

            • and — (Array<map>)

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operator — (String)

              The operator to use to perform the evaluation.

            • operand — (String)

              The value to use when performing the evaluation.

            • operandType — (String)

              The type of value to use when performing the evaluation.

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

        • createdAtrequired — (Date)

          The time that the component was created.

        • modifiedAt — (Date)

          The time that the component was modified.

        • tags — (map<String>)

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

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

          • parameters — (map)

            Describes information about the action.

            • type — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • url — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • anchor — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • target — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • global — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • model — (String)

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

            • id — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • fields — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • state — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

          • bindingEvent — (String)

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

        • schemaVersion — (String)

          The schema version of the component when it was imported.

Returns:

  • (AWS.Request)

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

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

Creates a new form for an Amplify app.

Service Reference:

Examples:

Calling the createForm operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  formToCreate: { /* required */
    dataType: { /* required */
      dataSourceType: DataStore | Custom, /* required */
      dataTypeName: 'STRING_VALUE' /* required */
    },
    fields: { /* required */
      '<String>': {
        excluded: true || false,
        inputType: {
          type: 'STRING_VALUE', /* required */
          defaultChecked: true || false,
          defaultCountryCode: 'STRING_VALUE',
          defaultValue: 'STRING_VALUE',
          descriptiveText: 'STRING_VALUE',
          fileUploaderConfig: {
            acceptedFileTypes: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            accessLevel: public | protected | private, /* required */
            isResumable: true || false,
            maxFileCount: 'NUMBER_VALUE',
            maxSize: 'NUMBER_VALUE',
            showThumbnails: true || false
          },
          isArray: true || false,
          maxValue: 'NUMBER_VALUE',
          minValue: 'NUMBER_VALUE',
          name: 'STRING_VALUE',
          placeholder: 'STRING_VALUE',
          readOnly: true || false,
          required: true || false,
          step: 'NUMBER_VALUE',
          value: 'STRING_VALUE',
          valueMappings: {
            values: [ /* required */
              {
                value: { /* FormInputValueProperty */ /* required */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  concat: [
                    /* recursive FormInputValueProperty */,
                    /* more items */
                  ],
                  value: 'STRING_VALUE'
                },
                displayValue: { /* FormInputValueProperty */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  concat: [
                    /* recursive FormInputValueProperty */,
                    /* more items */
                  ],
                  value: 'STRING_VALUE'
                }
              },
              /* more items */
            ],
            bindingProperties: {
              '<String>': {
                bindingProperties: {
                  model: 'STRING_VALUE'
                },
                type: 'STRING_VALUE'
              },
              /* '<String>': ... */
            }
          }
        },
        label: 'STRING_VALUE',
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        },
        validations: [
          {
            type: 'STRING_VALUE', /* required */
            numValues: [
              'NUMBER_VALUE',
              /* more items */
            ],
            strValues: [
              'STRING_VALUE',
              /* more items */
            ],
            validationMessage: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* '<String>': ... */
    },
    formActionType: create | update, /* required */
    name: 'STRING_VALUE', /* required */
    schemaVersion: 'STRING_VALUE', /* required */
    sectionalElements: { /* required */
      '<String>': {
        type: 'STRING_VALUE', /* required */
        excluded: true || false,
        level: 'NUMBER_VALUE',
        orientation: 'STRING_VALUE',
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        },
        text: 'STRING_VALUE'
      },
      /* '<String>': ... */
    },
    style: { /* required */
      horizontalGap: {
        tokenReference: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      outerPadding: {
        tokenReference: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      verticalGap: {
        tokenReference: 'STRING_VALUE',
        value: 'STRING_VALUE'
      }
    },
    cta: {
      cancel: {
        children: 'STRING_VALUE',
        excluded: true || false,
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        }
      },
      clear: {
        children: 'STRING_VALUE',
        excluded: true || false,
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        }
      },
      position: top | bottom | top_and_bottom,
      submit: {
        children: 'STRING_VALUE',
        excluded: true || false,
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        }
      }
    },
    labelDecorator: required | optional | none,
    tags: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.createForm(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 form.

    • environmentName — (String)

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

    • clientToken — (String)

      The unique client token.

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

      Represents the configuration of the form to create.

      • namerequired — (String)

        The name of the form.

      • dataTyperequired — (map)

        The type of data source to use to create the form.

        • dataSourceTyperequired — (String)

          The data source type, either an Amplify DataStore model or a custom data type.

          Possible values include:
          • "DataStore"
          • "Custom"
        • dataTypeNamerequired — (String)

          The unique name of the data type you are using as the data source for the form.

      • formActionTyperequired — (String)

        Specifies whether to perform a create or update action on the form.

        Possible values include:
        • "create"
        • "update"
      • fieldsrequired — (map<map>)

        The configuration information for the form's fields.

        • label — (String)

          The label for the field.

        • position — (map)

          Specifies the field position.

          • fixed — (String)

            The field position is fixed and doesn't change in relation to other fields.

            Possible values include:
            • "first"
          • rightOf — (String)

            The field position is to the right of the field specified by the string.

          • below — (String)

            The field position is below the field specified by the string.

        • excluded — (Boolean)

          Specifies whether to hide a field.

        • inputType — (map)

          Describes the configuration for the default input value to display for a field.

          • typerequired — (String)

            The input type for the field.

          • required — (Boolean)

            Specifies a field that requires input.

          • readOnly — (Boolean)

            Specifies a read only field.

          • placeholder — (String)

            The text to display as a placeholder for the field.

          • defaultValue — (String)

            The default value for the field.

          • descriptiveText — (String)

            The text to display to describe the field.

          • defaultChecked — (Boolean)

            Specifies whether a field has a default value.

          • defaultCountryCode — (String)

            The default country code for a phone number.

          • valueMappings — (map)

            The information to use to customize the input fields with data at runtime.

            • valuesrequired — (Array<map>)

              The value and display value pairs.

              • displayValue — (map)

                The value to display for the complex object.

                • value — (String)

                  The value to assign to the input field.

                • bindingProperties — (map)

                  The information to bind fields to data at runtime.

                  • propertyrequired — (String)

                    The form property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • concat — (Array<map>)

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

              • valuerequired — (map)

                The complex object.

                • value — (String)

                  The value to assign to the input field.

                • bindingProperties — (map)

                  The information to bind fields to data at runtime.

                  • propertyrequired — (String)

                    The form property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • concat — (Array<map>)

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

            • bindingProperties — (map<map>)

              The information to bind fields to data at runtime.

              • type — (String)

                The property type.

              • bindingProperties — (map)

                Describes the properties to customize with data at runtime.

                • model — (String)

                  An Amplify DataStore model.

          • name — (String)

            The name of the field.

          • minValue — (Float)

            The minimum value to display for the field.

          • maxValue — (Float)

            The maximum value to display for the field.

          • step — (Float)

            The stepping increment for a numeric value in a field.

          • value — (String)

            The value for the field.

          • isArray — (Boolean)

            Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

          • fileUploaderConfig — (map)

            The configuration for the file uploader field.

            • accessLevelrequired — (String)

              The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

              Possible values include:
              • "public"
              • "protected"
              • "private"
            • acceptedFileTypesrequired — (Array<String>)

              The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

            • showThumbnails — (Boolean)

              Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

            • isResumable — (Boolean)

              Allows the file upload operation to be paused and resumed. The default value is false.

              When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

            • maxFileCount — (Integer)

              Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

            • maxSize — (Integer)

              The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

        • validations — (Array<map>)

          The validations to perform on the value in the field.

          • typerequired — (String)

            The validation to perform on an object type.

          • strValues — (Array<String>)

            The validation to perform on a string value.

          • numValues — (Array<Integer>)

            The validation to perform on a number value.

          • validationMessage — (String)

            The validation message to display.

      • stylerequired — (map)

        The configuration for the form's style.

        • horizontalGap — (map)

          The spacing for the horizontal gap.

          • tokenReference — (String)

            A reference to a design token to use to bind the form's style properties to an existing theme.

          • value — (String)

            The value of the style setting.

        • verticalGap — (map)

          The spacing for the vertical gap.

          • tokenReference — (String)

            A reference to a design token to use to bind the form's style properties to an existing theme.

          • value — (String)

            The value of the style setting.

        • outerPadding — (map)

          The size of the outer padding for the form.

          • tokenReference — (String)

            A reference to a design token to use to bind the form's style properties to an existing theme.

          • value — (String)

            The value of the style setting.

      • sectionalElementsrequired — (map<map>)

        The configuration information for the visual helper elements for the form. These elements are not associated with any data.

        • typerequired — (String)

          The type of sectional element. Valid values are Heading, Text, and Divider.

        • position — (map)

          Specifies the position of the text in a field for a Text sectional element.

          • fixed — (String)

            The field position is fixed and doesn't change in relation to other fields.

            Possible values include:
            • "first"
          • rightOf — (String)

            The field position is to the right of the field specified by the string.

          • below — (String)

            The field position is below the field specified by the string.

        • text — (String)

          The text for a Text sectional element.

        • level — (Integer)

          Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

        • orientation — (String)

          Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

        • excluded — (Boolean)

          Excludes a sectional element that was generated by default for a specified data model.

      • schemaVersionrequired — (String)

        The schema version of the form.

      • cta — (map)

        The FormCTA object that stores the call to action configuration for the form.

        • position — (String)

          The position of the button.

          Possible values include:
          • "top"
          • "bottom"
          • "top_and_bottom"
        • clear — (map)

          Displays a clear button.

          • excluded — (Boolean)

            Specifies whether the button is visible on the form.

          • children — (String)

            Describes the button's properties.

          • position — (map)

            The position of the button.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

        • cancel — (map)

          Displays a cancel button.

          • excluded — (Boolean)

            Specifies whether the button is visible on the form.

          • children — (String)

            Describes the button's properties.

          • position — (map)

            The position of the button.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

        • submit — (map)

          Displays a submit button.

          • excluded — (Boolean)

            Specifies whether the button is visible on the form.

          • children — (String)

            Describes the button's properties.

          • position — (map)

            The position of the button.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

      • tags — (map<String>)

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

      • labelDecorator — (String)

        Specifies an icon or decoration to display on the form.

        Possible values include:
        • "required"
        • "optional"
        • "none"

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

        • appIdrequired — (String)

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

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The unique ID of the form.

        • namerequired — (String)

          The name of the form.

        • formActionTyperequired — (String)

          The operation to perform on the specified form.

          Possible values include:
          • "create"
          • "update"
        • stylerequired — (map)

          Stores the configuration for the form's style.

          • horizontalGap — (map)

            The spacing for the horizontal gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • verticalGap — (map)

            The spacing for the vertical gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • outerPadding — (map)

            The size of the outer padding for the form.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

        • dataTyperequired — (map)

          The type of data source to use to create the form.

          • dataSourceTyperequired — (String)

            The data source type, either an Amplify DataStore model or a custom data type.

            Possible values include:
            • "DataStore"
            • "Custom"
          • dataTypeNamerequired — (String)

            The unique name of the data type you are using as the data source for the form.

        • fieldsrequired — (map<map>)

          Stores the information about the form's fields.

          • label — (String)

            The label for the field.

          • position — (map)

            Specifies the field position.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • excluded — (Boolean)

            Specifies whether to hide a field.

          • inputType — (map)

            Describes the configuration for the default input value to display for a field.

            • typerequired — (String)

              The input type for the field.

            • required — (Boolean)

              Specifies a field that requires input.

            • readOnly — (Boolean)

              Specifies a read only field.

            • placeholder — (String)

              The text to display as a placeholder for the field.

            • defaultValue — (String)

              The default value for the field.

            • descriptiveText — (String)

              The text to display to describe the field.

            • defaultChecked — (Boolean)

              Specifies whether a field has a default value.

            • defaultCountryCode — (String)

              The default country code for a phone number.

            • valueMappings — (map)

              The information to use to customize the input fields with data at runtime.

              • valuesrequired — (Array<map>)

                The value and display value pairs.

                • displayValue — (map)

                  The value to display for the complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

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

                • valuerequired — (map)

                  The complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

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

              • bindingProperties — (map<map>)

                The information to bind fields to data at runtime.

                • type — (String)

                  The property type.

                • bindingProperties — (map)

                  Describes the properties to customize with data at runtime.

                  • model — (String)

                    An Amplify DataStore model.

            • name — (String)

              The name of the field.

            • minValue — (Float)

              The minimum value to display for the field.

            • maxValue — (Float)

              The maximum value to display for the field.

            • step — (Float)

              The stepping increment for a numeric value in a field.

            • value — (String)

              The value for the field.

            • isArray — (Boolean)

              Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

            • fileUploaderConfig — (map)

              The configuration for the file uploader field.

              • accessLevelrequired — (String)

                The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

                Possible values include:
                • "public"
                • "protected"
                • "private"
              • acceptedFileTypesrequired — (Array<String>)

                The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

              • showThumbnails — (Boolean)

                Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

              • isResumable — (Boolean)

                Allows the file upload operation to be paused and resumed. The default value is false.

                When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

              • maxFileCount — (Integer)

                Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

              • maxSize — (Integer)

                The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

          • validations — (Array<map>)

            The validations to perform on the value in the field.

            • typerequired — (String)

              The validation to perform on an object type.

            • strValues — (Array<String>)

              The validation to perform on a string value.

            • numValues — (Array<Integer>)

              The validation to perform on a number value.

            • validationMessage — (String)

              The validation message to display.

        • sectionalElementsrequired — (map<map>)

          Stores the visual helper elements for the form that are not associated with any data.

          • typerequired — (String)

            The type of sectional element. Valid values are Heading, Text, and Divider.

          • position — (map)

            Specifies the position of the text in a field for a Text sectional element.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • text — (String)

            The text for a Text sectional element.

          • level — (Integer)

            Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

          • orientation — (String)

            Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

          • excluded — (Boolean)

            Excludes a sectional element that was generated by default for a specified data model.

        • schemaVersionrequired — (String)

          The schema version of the form when it was imported.

        • tags — (map<String>)

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

        • cta — (map)

          Stores the call to action configuration for the form.

          • position — (String)

            The position of the button.

            Possible values include:
            • "top"
            • "bottom"
            • "top_and_bottom"
          • clear — (map)

            Displays a clear button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • cancel — (map)

            Displays a cancel button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • submit — (map)

            Displays a submit button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

        • labelDecorator — (String)

          Specifies an icon or decoration to display on the form.

          Possible values include:
          • "required"
          • "optional"
          • "none"

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.

    • environmentName — (String)

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

    • clientToken — (String)

      The unique client token.

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

      Represents the configuration of the theme to create.

      • namerequired — (String)

        The name of the theme.

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

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

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.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The ID for the theme.

        • namerequired — (String)

          The name of the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • modifiedAt — (Date)

          The time that the theme was modified.

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

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

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.

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

Deletes a form from an Amplify app.

Service Reference:

Examples:

Calling the deleteForm operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.deleteForm(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 form 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 form 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

Note: This is for internal use.

Amplify uses this action to exchange 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 */
    clientId: 'STRING_VALUE'
  }
};
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.

      • clientId — (String)

        The ID of the client to request the token from.

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.

        • environmentNamerequired — (String)

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

        • sourceId — (String)

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

        • idrequired — (String)

          The unique ID of the component.

        • namerequired — (String)

          The name of the component.

        • componentTyperequired — (String)

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

        • propertiesrequired — (map<map>)

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

          • value — (String)

            The value to assign to the component property.

          • bindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • collectionBindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • defaultValue — (String)

            The default value to assign to the component property.

          • model — (String)

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

          • bindings — (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.

          • event — (String)

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

          • userAttribute — (String)

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

          • concat — (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.

            • property — (String)

              The name of the conditional property.

            • field — (String)

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

            • operator — (String)

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

            • operand — (String)

              The value of the property to evaluate.

            • operandType — (String)

              The type of the property to evaluate.

          • configured — (Boolean)

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

          • type — (String)

            The component type.

          • importedValue — (String)

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

          • componentName — (String)

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

          • property — (String)

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

        • children — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

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

            • parameters — (map)

              Describes information about the action.

              • type — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • url — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • anchor — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • target — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • global — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • model — (String)

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

              • id — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • fields — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • state — (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.

                  • value — (String)

                    The value to assign to the component property.

                  • bindingProperties — (map)

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

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • collectionBindingProperties — (map)

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

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • model — (String)

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

                  • bindings — (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.

                  • event — (String)

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

                  • userAttribute — (String)

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

                  • concat — (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.

                    • property — (String)

                      The name of the conditional property.

                    • field — (String)

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

                    • operator — (String)

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

                    • operand — (String)

                      The value of the property to evaluate.

                    • operandType — (String)

                      The type of the property to evaluate.

                  • configured — (Boolean)

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

                  • type — (String)

                    The component type.

                  • importedValue — (String)

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

                  • componentName — (String)

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

                  • property — (String)

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

            • bindingEvent — (String)

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

          • sourceId — (String)

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

        • variantsrequired — (Array<map>)

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

          • variantValues — (map<String>)

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

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

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

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

          • type — (String)

            The property type.

          • bindingProperties — (map)

            Describes the properties to customize with data at runtime.

            • model — (String)

              An Amplify DataStore model.

            • field — (String)

              The field to bind the data to.

            • predicates — (Array<map>)

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

              • field — (String)

                The field to query.

              • operator — (String)

                The operator to use to perform the evaluation.

              • operand — (String)

                The value to use when performing the evaluation.

              • operandType — (String)

                The type of value to use when performing the evaluation.

            • userAttribute — (String)

              An authenticated user attribute.

            • bucket — (String)

              An Amazon S3 bucket.

            • key — (String)

              The storage key for an Amazon S3 bucket.

            • defaultValue — (String)

              The default value to assign to the property.

            • slotName — (String)

              The name of a component slot.

          • defaultValue — (String)

            The default value of the property.

        • collectionProperties — (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.

          • modelrequired — (String)

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

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • fieldrequired — (String)

              The field to perform the sort on.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
          • 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.

            • or — (Array<map>)

              A list of predicates to combine logically.

            • and — (Array<map>)

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operator — (String)

              The operator to use to perform the evaluation.

            • operand — (String)

              The value to use when performing the evaluation.

            • operandType — (String)

              The type of value to use when performing the evaluation.

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

        • createdAtrequired — (Date)

          The time that the component was created.

        • modifiedAt — (Date)

          The time that the component was modified.

        • tags — (map<String>)

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

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

          • parameters — (map)

            Describes information about the action.

            • type — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • url — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • anchor — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • target — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • global — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • model — (String)

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

            • id — (map)

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

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • fields — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

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

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

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

              • bindings — (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.

              • event — (String)

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

              • userAttribute — (String)

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

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

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

                • operator — (String)

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

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

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

              • type — (String)

                The component type.

              • importedValue — (String)

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

              • componentName — (String)

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

              • property — (String)

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

            • state — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

          • bindingEvent — (String)

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

        • schemaVersion — (String)

          The schema version of the component when it was imported.

      • nextToken — (String)

        The pagination token that's included if more results are available.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the exportForms operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.exportForms(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 forms 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 forms.

        • appIdrequired — (String)

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

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The unique ID of the form.

        • namerequired — (String)

          The name of the form.

        • formActionTyperequired — (String)

          The operation to perform on the specified form.

          Possible values include:
          • "create"
          • "update"
        • stylerequired — (map)

          Stores the configuration for the form's style.

          • horizontalGap — (map)

            The spacing for the horizontal gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • verticalGap — (map)

            The spacing for the vertical gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • outerPadding — (map)

            The size of the outer padding for the form.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

        • dataTyperequired — (map)

          The type of data source to use to create the form.

          • dataSourceTyperequired — (String)

            The data source type, either an Amplify DataStore model or a custom data type.

            Possible values include:
            • "DataStore"
            • "Custom"
          • dataTypeNamerequired — (String)

            The unique name of the data type you are using as the data source for the form.

        • fieldsrequired — (map<map>)

          Stores the information about the form's fields.

          • label — (String)

            The label for the field.

          • position — (map)

            Specifies the field position.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • excluded — (Boolean)

            Specifies whether to hide a field.

          • inputType — (map)

            Describes the configuration for the default input value to display for a field.

            • typerequired — (String)

              The input type for the field.

            • required — (Boolean)

              Specifies a field that requires input.

            • readOnly — (Boolean)

              Specifies a read only field.

            • placeholder — (String)

              The text to display as a placeholder for the field.

            • defaultValue — (String)

              The default value for the field.

            • descriptiveText — (String)

              The text to display to describe the field.

            • defaultChecked — (Boolean)

              Specifies whether a field has a default value.

            • defaultCountryCode — (String)

              The default country code for a phone number.

            • valueMappings — (map)

              The information to use to customize the input fields with data at runtime.

              • valuesrequired — (Array<map>)

                The value and display value pairs.

                • displayValue — (map)

                  The value to display for the complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

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

                • valuerequired — (map)

                  The complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

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

              • bindingProperties — (map<map>)

                The information to bind fields to data at runtime.

                • type — (String)

                  The property type.

                • bindingProperties — (map)

                  Describes the properties to customize with data at runtime.

                  • model — (String)

                    An Amplify DataStore model.

            • name — (String)

              The name of the field.

            • minValue — (Float)

              The minimum value to display for the field.

            • maxValue — (Float)

              The maximum value to display for the field.

            • step — (Float)

              The stepping increment for a numeric value in a field.

            • value — (String)

              The value for the field.

            • isArray — (Boolean)

              Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

            • fileUploaderConfig — (map)

              The configuration for the file uploader field.

              • accessLevelrequired — (String)

                The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

                Possible values include:
                • "public"
                • "protected"
                • "private"
              • acceptedFileTypesrequired — (Array<String>)

                The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

              • showThumbnails — (Boolean)

                Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

              • isResumable — (Boolean)

                Allows the file upload operation to be paused and resumed. The default value is false.

                When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

              • maxFileCount — (Integer)

                Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

              • maxSize — (Integer)

                The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

          • validations — (Array<map>)

            The validations to perform on the value in the field.

            • typerequired — (String)

              The validation to perform on an object type.

            • strValues — (Array<String>)

              The validation to perform on a string value.

            • numValues — (Array<Integer>)

              The validation to perform on a number value.

            • validationMessage — (String)

              The validation message to display.

        • sectionalElementsrequired — (map<map>)

          Stores the visual helper elements for the form that are not associated with any data.

          • typerequired — (String)

            The type of sectional element. Valid values are Heading, Text, and Divider.

          • position — (map)

            Specifies the position of the text in a field for a Text sectional element.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • text — (String)

            The text for a Text sectional element.

          • level — (Integer)

            Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

          • orientation — (String)

            Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

          • excluded — (Boolean)

            Excludes a sectional element that was generated by default for a specified data model.

        • schemaVersionrequired — (String)

          The schema version of the form when it was imported.

        • tags — (map<String>)

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

        • cta — (map)

          Stores the call to action configuration for the form.

          • position — (String)

            The position of the button.

            Possible values include:
            • "top"
            • "bottom"
            • "top_and_bottom"
          • clear — (map)

            Displays a clear button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • cancel — (map)

            Displays a cancel button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • submit — (map)

            Displays a submit button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

        • labelDecorator — (String)

          Specifies an icon or decoration to display on the form.

          Possible values include:
          • "required"
          • "optional"
          • "none"
      • 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.

        • environmentNamerequired — (String)

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

        • idrequired — (String)

          The ID for the theme.

        • namerequired — (String)

          The name of the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • modifiedAt — (Date)

          The time that the theme was modified.

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

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

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

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

Returns an existing code generation job.

Service Reference:

Examples:

Calling the getCodegenJob operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.getCodegenJob(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 code generation job.

    • environmentName — (String)

      The name of the backend environment that is a part of the Amplify app associated with the code generation job.

    • id — (String)

      The unique ID of the code generation job.

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:

      • job — (map)

        The configuration settings for the code generation job.

        • idrequired — (String)

          The unique ID for the code generation job.

        • appIdrequired — (String)

          The ID of the Amplify app associated with the code generation job.

        • environmentNamerequired — (String)

          The name of the backend environment associated with the code generation job.

        • renderConfig — (map)

          Describes the configuration information for rendering the UI component associated with the code generation job.

          • react — (map)

            The name of the ReactStartCodegenJobData object.

            • module — (String)

              The JavaScript module type.

              Possible values include:
              • "es2020"
              • "esnext"
            • target — (String)

              The ECMAScript specification to use.

              Possible values include:
              • "es2015"
              • "es2020"
            • script — (String)

              The file type to use for a JavaScript project.

              Possible values include:
              • "jsx"
              • "tsx"
              • "js"
            • renderTypeDeclarations — (Boolean)

              Specifies whether the code generation job should render type declaration files.

            • inlineSourceMap — (Boolean)

              Specifies whether the code generation job should render inline source maps.

            • apiConfiguration — (map)

              The API configuration for the code generation job.

              • graphQLConfig — (map)

                The configuration for an application using GraphQL APIs.

                • typesFilePathrequired — (String)

                  The path to the GraphQL types file, relative to the component output directory.

                • queriesFilePathrequired — (String)

                  The path to the GraphQL queries file, relative to the component output directory.

                • mutationsFilePathrequired — (String)

                  The path to the GraphQL mutations file, relative to the component output directory.

                • subscriptionsFilePathrequired — (String)

                  The path to the GraphQL subscriptions file, relative to the component output directory.

                • fragmentsFilePathrequired — (String)

                  The path to the GraphQL fragments file, relative to the component output directory.

              • dataStoreConfig — (map)

                The configuration for an application using DataStore APIs.

              • noApiConfig — (map)

                The configuration for an application with no API being used.

            • dependencies — (map<String>)

              Lists the dependency packages that may be required for the project code to run.

        • genericDataSchema — (map)

          Describes the data schema for a code generation job.

          • dataSourceTyperequired — (String)

            The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.

            Possible values include:
            • "DataStore"
          • modelsrequired — (map<map>)

            The name of a CodegenGenericDataModel.

            • fieldsrequired — (map<map>)

              The fields in the generic data model.

              • dataTyperequired — (String)

                The data type for the generic data field.

                Possible values include:
                • "ID"
                • "String"
                • "Int"
                • "Float"
                • "AWSDate"
                • "AWSTime"
                • "AWSDateTime"
                • "AWSTimestamp"
                • "AWSEmail"
                • "AWSURL"
                • "AWSIPAddress"
                • "Boolean"
                • "AWSJSON"
                • "AWSPhone"
                • "Enum"
                • "Model"
                • "NonModel"
              • dataTypeValuerequired — (String)

                The value of the data type for the generic data field.

              • requiredrequired — (Boolean)

                Specifies whether the generic data field is required.

              • readOnlyrequired — (Boolean)

                Specifies whether the generic data field is read-only.

              • isArrayrequired — (Boolean)

                Specifies whether the generic data field is an array.

              • relationship — (map)

                The relationship of the generic data schema.

                • typerequired — (String)

                  The data relationship type.

                  Possible values include:
                  • "HAS_MANY"
                  • "HAS_ONE"
                  • "BELONGS_TO"
                • relatedModelNamerequired — (String)

                  The name of the related model in the data relationship.

                • relatedModelFields — (Array<String>)

                  The related model fields in the data relationship.

                • canUnlinkAssociatedModel — (Boolean)

                  Specifies whether the relationship can unlink the associated model.

                • relatedJoinFieldName — (String)

                  The name of the related join field in the data relationship.

                • relatedJoinTableName — (String)

                  The name of the related join table in the data relationship.

                • belongsToFieldOnRelatedModel — (String)

                  The value of the belongsTo field on the related data model.

                • associatedFields — (Array<String>)

                  The associated fields of the data relationship.

                • isHasManyIndex — (Boolean)

                  Specifies whether the @index directive is supported for a hasMany data relationship.

            • isJoinTable — (Boolean)

              Specifies whether the generic data model is a join table.

            • primaryKeysrequired — (Array<String>)

              The primary keys of the generic data model.

          • enumsrequired — (map<map>)

            The name of a CodegenGenericDataEnum.

            • valuesrequired — (Array<String>)

              The list of enum values in the generic data schema.

          • nonModelsrequired — (map<map>)

            The name of a CodegenGenericDataNonModel.

            • fieldsrequired — (map<map>)

              The fields in a generic data schema non model.

              • dataTyperequired — (String)

                The data type for the generic data field.

                Possible values include:
                • "ID"
                • "String"
                • "Int"
                • "Float"
                • "AWSDate"
                • "AWSTime"
                • "AWSDateTime"
                • "AWSTimestamp"
                • "AWSEmail"
                • "AWSURL"
                • "AWSIPAddress"
                • "Boolean"
                • "AWSJSON"
                • "AWSPhone"
                • "Enum"
                • "Model"
                • "NonModel"
              • dataTypeValuerequired — (String)

                The value of the data type for the generic data field.

              • requiredrequired — (Boolean)

                Specifies whether the generic data field is required.

              • readOnlyrequired — (Boolean)

                Specifies whether the generic data field is read-only.

              • isArrayrequired — (Boolean)

                Specifies whether the generic data field is an array.

              • relationship — (map)

                The relationship of the generic data schema.

                • typerequired — (String)

                  The data relationship type.

                  Possible values include:
                  • "HAS_MANY"
                  • "HAS_ONE"
                  • "BELONGS_TO"
                • relatedModelNamerequired — (String)

                  The name of the related model in the data relationship.

                • relatedModelFields — (Array<String>)

                  The related model fields in the data relationship.

                • canUnlinkAssociatedModel — (Boolean)

                  Specifies whether the relationship can unlink the associated model.

                • relatedJoinFieldName — (String)

                  The name of the related join field in the data relationship.

                • relatedJoinTableName — (String)

                  The name of the related join table in the data relationship.

                • belongsToFieldOnRelatedModel — (String)

                  The value of the belongsTo field on the related data model.

                • associatedFields — (Array<String>)

                  The associated fields of the data relationship.

                • isHasManyIndex — (Boolean)

                  Specifies whether the @index directive is supported for a hasMany data relationship.

        • autoGenerateForms — (Boolean)

          Specifies whether to autogenerate forms in the code generation job.

        • features — (map)

          Describes the feature flags that you can specify for a code generation job.

          • isRelationshipSupported — (Boolean)

            Specifes whether a code generation job supports data relationships.

          • isNonModelSupported — (Boolean)

            Specifies whether a code generation job supports non models.

        • status — (String)

          The status of the code generation job.

          Possible values include:
          • "in_progress"
          • "failed"
          • "succeeded"
        • statusMessage — (String)

          The customized status message for the code generation job.

        • asset — (map)

          The CodegenJobAsset to use for the code generation job.

          • downloadUrl — (String)

            The URL to use to access the asset.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the code generation job.

        • createdAt — (Date)

          The time that the code generation job was created.

        • modifiedAt — (Date)

          The time that the code generation job was modified.

        • dependencies — (Array<map>)

          Lists the dependency packages that may be required for the project code to run.

          • name — (String)

            Name of the dependency package.

          • supportedVersion — (String)

            Indicates the version of the supported dependency package.

          • isSemVer — (Boolean)

            Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.

          • reason — (String)

            Indicates the reason to include the dependency package in your project code.

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.

        • environmentNamerequired — (String)

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

        • sourceId — (String)

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

        • idrequired — (String)

          The unique ID of the component.

        • namerequired — (String)

          The name of the component.

        • componentTyperequired — (String)

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

        • propertiesrequired — (map<map>)

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

          • value — (String)

            The value to assign to the component property.

          • bindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • collectionBindingProperties — (map)

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

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • defaultValue — (String)

            The default value to assign to the component property.

          • model — (String)

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

          • bindings — (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.

          • event — (String)

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

          • userAttribute — (String)

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

          • concat — (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.

            • property — (String)

              The name of the conditional property.

            • field — (String)

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

            • operator — (String)

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

            • operand — (String)

              The value of the property to evaluate.

            • operandType — (String)

              The type of the property to evaluate.

          • configured — (Boolean)

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

          • type — (String)

            The component type.

          • importedValue — (String)

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

          • componentName — (String)

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

          • property — (String)

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

        • children — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

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

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

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

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

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

            • bindings — (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.

            • event — (String)

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

            • userAttribute — (String)

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

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

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

              • operator — (String)

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

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

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

            • type — (String)

              The component type.

            • importedValue — (String)

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

            • componentName — (String)

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

            • property — (String)

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

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

            • parameters — (map)

              Describes information about the action.

              • type — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • url — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • anchor — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

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

                • type — (String)

                  The component type.

                • importedValue — (String)

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

                • componentName — (String)

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

                • property — (String)

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

              • target — (map)

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

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

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

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

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

                • bindings — (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.

                • event — (String)

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

                • userAttribute — (String)

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

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

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

                  • operator — (String)

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

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • global — (map)

                Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • model — (String)

                The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

              • id — (map)

                The unique ID of the component that the ActionParameters apply to.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • fields — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • state — (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.

                  • value — (String)

                    The value to assign to the component property.

                  • bindingProperties — (map)

                    The information to bind the component property to data at runtime.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • collectionBindingProperties — (map)

                    The information to bind the component property to data at runtime. Use this for collection components.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • model — (String)

                    The data model to use to assign a value to the component property.

                  • bindings — (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.

                  • event — (String)

                    An event that occurs in your app. Use this for workflow data binding.

                  • userAttribute — (String)

                    An authenticated user attribute to use to assign a value to the component property.

                  • concat — (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.

                    • property — (String)

                      The name of the conditional property.

                    • field — (String)

                      The name of a field. Specify this when the property is a data model.

                    • operator — (String)

                      The operator to use to perform the evaluation, such as eq to represent equals.

                    • operand — (String)

                      The value of the property to evaluate.

                    • operandType — (String)

                      The type of the property to evaluate.

                  • configured — (Boolean)

                    Specifies whether the user configured the property in Amplify Studio after importing it.

                  • type — (String)

                    The component type.

                  • importedValue — (String)

                    The default value assigned to the property when the component is imported into an app.

                  • componentName — (String)

                    The name of the component that is affected by an event.

                  • property — (String)

                    The name of the component's property that is affected by an event.

            • bindingEvent — (String)

              Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • sourceId — (String)

            The unique ID of the child component in its original source system, such as Figma.

        • variantsrequired — (Array<map>)

          A list of the component's variants. A variant is a unique style configuration of a main component.

          • variantValues — (map<String>)

            The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

          • 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.

        • 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.

        • 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.

          • type — (String)

            The property type.

          • bindingProperties — (map)

            Describes the properties to customize with data at runtime.

            • model — (String)

              An Amplify DataStore model.

            • field — (String)

              The field to bind the data to.

            • predicates — (Array<map>)

              A list of predicates for binding a component's properties to data.

              • field — (String)

                The field to query.

              • operator — (String)

                The operator to use to perform the evaluation.

              • operand — (String)

                The value to use when performing the evaluation.

              • operandType — (String)

                The type of value to use when performing the evaluation.

            • userAttribute — (String)

              An authenticated user attribute.

            • bucket — (String)

              An Amazon S3 bucket.

            • key — (String)

              The storage key for an Amazon S3 bucket.

            • defaultValue — (String)

              The default value to assign to the property.

            • slotName — (String)

              The name of a component slot.

          • defaultValue — (String)

            The default value of the property.

        • collectionProperties — (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.

          • modelrequired — (String)

            The name of the data model to use to bind data to a component.

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • fieldrequired — (String)

              The field to perform the sort on.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
          • 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.

            • or — (Array<map>)

              A list of predicates to combine logically.

            • and — (Array<map>)

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operator — (String)

              The operator to use to perform the evaluation.

            • operand — (String)

              The value to use when performing the evaluation.

            • operandType — (String)

              The type of value to use when performing the evaluation.

          • 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.

        • createdAtrequired — (Date)

          The time that the component was created.

        • modifiedAt — (Date)

          The time that the component was modified.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the component.

        • 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.

          • parameters — (map)

            Describes information about the action.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • fields — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • state — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

        • schemaVersion — (String)

          The schema version of the component when it was imported.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getForm(params = {}, callback) ⇒ AWS.Request

Returns an existing form for an Amplify app.

Service Reference:

Examples:

Calling the getForm operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
amplifyuibuilder.getForm(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 form.

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:

      • form — (map)

        Represents the configuration settings for the form.

        • appIdrequired — (String)

          The unique ID of the Amplify app associated with the form.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • idrequired — (String)

          The unique ID of the form.

        • namerequired — (String)

          The name of the form.

        • formActionTyperequired — (String)

          The operation to perform on the specified form.

          Possible values include:
          • "create"
          • "update"
        • stylerequired — (map)

          Stores the configuration for the form's style.

          • horizontalGap — (map)

            The spacing for the horizontal gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • verticalGap — (map)

            The spacing for the vertical gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • outerPadding — (map)

            The size of the outer padding for the form.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

        • dataTyperequired — (map)

          The type of data source to use to create the form.

          • dataSourceTyperequired — (String)

            The data source type, either an Amplify DataStore model or a custom data type.

            Possible values include:
            • "DataStore"
            • "Custom"
          • dataTypeNamerequired — (String)

            The unique name of the data type you are using as the data source for the form.

        • fieldsrequired — (map<map>)

          Stores the information about the form's fields.

          • label — (String)

            The label for the field.

          • position — (map)

            Specifies the field position.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • excluded — (Boolean)

            Specifies whether to hide a field.

          • inputType — (map)

            Describes the configuration for the default input value to display for a field.

            • typerequired — (String)

              The input type for the field.

            • required — (Boolean)

              Specifies a field that requires input.

            • readOnly — (Boolean)

              Specifies a read only field.

            • placeholder — (String)

              The text to display as a placeholder for the field.

            • defaultValue — (String)

              The default value for the field.

            • descriptiveText — (String)

              The text to display to describe the field.

            • defaultChecked — (Boolean)

              Specifies whether a field has a default value.

            • defaultCountryCode — (String)

              The default country code for a phone number.

            • valueMappings — (map)

              The information to use to customize the input fields with data at runtime.

              • valuesrequired — (Array<map>)

                The value and display value pairs.

                • displayValue — (map)

                  The value to display for the complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

                    A list of form properties to concatenate to create the value to assign to this field property.

                • valuerequired — (map)

                  The complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

                    A list of form properties to concatenate to create the value to assign to this field property.

              • bindingProperties — (map<map>)

                The information to bind fields to data at runtime.

                • type — (String)

                  The property type.

                • bindingProperties — (map)

                  Describes the properties to customize with data at runtime.

                  • model — (String)

                    An Amplify DataStore model.

            • name — (String)

              The name of the field.

            • minValue — (Float)

              The minimum value to display for the field.

            • maxValue — (Float)

              The maximum value to display for the field.

            • step — (Float)

              The stepping increment for a numeric value in a field.

            • value — (String)

              The value for the field.

            • isArray — (Boolean)

              Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

            • fileUploaderConfig — (map)

              The configuration for the file uploader field.

              • accessLevelrequired — (String)

                The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

                Possible values include:
                • "public"
                • "protected"
                • "private"
              • acceptedFileTypesrequired — (Array<String>)

                The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

              • showThumbnails — (Boolean)

                Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

              • isResumable — (Boolean)

                Allows the file upload operation to be paused and resumed. The default value is false.

                When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

              • maxFileCount — (Integer)

                Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

              • maxSize — (Integer)

                The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

          • validations — (Array<map>)

            The validations to perform on the value in the field.

            • typerequired — (String)

              The validation to perform on an object type.

            • strValues — (Array<String>)

              The validation to perform on a string value.

            • numValues — (Array<Integer>)

              The validation to perform on a number value.

            • validationMessage — (String)

              The validation message to display.

        • sectionalElementsrequired — (map<map>)

          Stores the visual helper elements for the form that are not associated with any data.

          • typerequired — (String)

            The type of sectional element. Valid values are Heading, Text, and Divider.

          • position — (map)

            Specifies the position of the text in a field for a Text sectional element.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • text — (String)

            The text for a Text sectional element.

          • level — (Integer)

            Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

          • orientation — (String)

            Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

          • excluded — (Boolean)

            Excludes a sectional element that was generated by default for a specified data model.

        • schemaVersionrequired — (String)

          The schema version of the form when it was imported.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the form.

        • cta — (map)

          Stores the call to action configuration for the form.

          • position — (String)

            The position of the button.

            Possible values include:
            • "top"
            • "bottom"
            • "top_and_bottom"
          • clear — (map)

            Displays a clear button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • cancel — (map)

            Displays a cancel button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • submit — (map)

            Displays a submit button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

        • labelDecorator — (String)

          Specifies an icon or decoration to display on the form.

          Possible values include:
          • "required"
          • "optional"
          • "none"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getMetadata(params = {}, callback) ⇒ AWS.Request

Returns existing metadata for an Amplify app.

Service Reference:

Examples:

Calling the getMetadata operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE' /* required */
};
amplifyuibuilder.getMetadata(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.

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:

      • features — (map<String>)

        Represents the configuration settings for the features metadata.

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.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • idrequired — (String)

          The ID for the theme.

        • namerequired — (String)

          The name of the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • modifiedAt — (Date)

          The time that the theme was modified.

        • 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.

        • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCodegenJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

Service Reference:

Examples:

Calling the listCodegenJobs operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.listCodegenJobs(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.

    • nextToken — (String)

      The token to request the next page of results.

    • maxResults — (Integer)

      The maximum number of jobs to retrieve.

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 code generation jobs for the Amplify app.

        • appIdrequired — (String)

          The unique ID of the Amplify app associated with the code generation job.

        • environmentNamerequired — (String)

          The name of the backend environment associated with the code generation job.

        • idrequired — (String)

          The unique ID for the code generation job summary.

        • createdAt — (Date)

          The time that the code generation job summary was created.

        • modifiedAt — (Date)

          The time that the code generation job summary was modified.

      • 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.

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.

    • nextToken — (String)

      The token to request the next page of results.

    • maxResults — (Integer)

      The maximum number of components to retrieve.

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.

        • 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.

        • componentTyperequired — (String)

          The component type.

      • 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.

listForms(params = {}, callback) ⇒ AWS.Request

Retrieves a list of forms for a specified Amplify app and backend environment.

Service Reference:

Examples:

Calling the listForms operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amplifyuibuilder.listForms(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.

    • nextToken — (String)

      The token to request the next page of results.

    • maxResults — (Integer)

      The maximum number of forms to retrieve.

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 forms for the Amplify app.

        • appIdrequired — (String)

          The unique ID for the app associated with the form summary.

        • dataTyperequired — (map)

          The form's data source type.

          • dataSourceTyperequired — (String)

            The data source type, either an Amplify DataStore model or a custom data type.

            Possible values include:
            • "DataStore"
            • "Custom"
          • dataTypeNamerequired — (String)

            The unique name of the data type you are using as the data source for the form.

        • environmentNamerequired — (String)

          The name of the backend environment that is part of the Amplify app.

        • formActionTyperequired — (String)

          The type of operation to perform on the form.

          Possible values include:
          • "create"
          • "update"
        • idrequired — (String)

          The ID of the form.

        • namerequired — (String)

          The name of the form.

      • 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.

    • nextToken — (String)

      The token to request the next page of results.

    • maxResults — (Integer)

      The maximum number of theme results to return in the response.

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.

putMetadataFlag(params = {}, callback) ⇒ AWS.Request

Stores the metadata information about a feature on a form.

Service Reference:

Examples:

Calling the putMetadataFlag operation

var params = {
  appId: 'STRING_VALUE', /* required */
  body: { /* required */
    newValue: 'STRING_VALUE' /* required */
  },
  environmentName: 'STRING_VALUE', /* required */
  featureName: 'STRING_VALUE' /* required */
};
amplifyuibuilder.putMetadataFlag(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 part of the Amplify app.

    • featureName — (String)

      The name of the feature associated with the metadata.

    • body — (map)

      The metadata information to store.

      • newValuerequired — (String)

        The new information to store.

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.

refreshToken(params = {}, callback) ⇒ AWS.Request

Note: This is for internal use.

Amplify uses this action to refresh 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 */
    clientId: 'STRING_VALUE'
  }
};
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.

      • clientId — (String)

        The ID of the client to request the token from.

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.

startCodegenJob(params = {}, callback) ⇒ AWS.Request

Starts a code generation job for a specified Amplify app and backend environment.

Service Reference:

Examples:

Calling the startCodegenJob operation

var params = {
  appId: 'STRING_VALUE', /* required */
  codegenJobToCreate: { /* required */
    renderConfig: { /* required */
      react: {
        apiConfiguration: {
          dataStoreConfig: {
          },
          graphQLConfig: {
            fragmentsFilePath: 'STRING_VALUE', /* required */
            mutationsFilePath: 'STRING_VALUE', /* required */
            queriesFilePath: 'STRING_VALUE', /* required */
            subscriptionsFilePath: 'STRING_VALUE', /* required */
            typesFilePath: 'STRING_VALUE' /* required */
          },
          noApiConfig: {
          }
        },
        dependencies: {
          '<String>': 'STRING_VALUE',
          /* '<String>': ... */
        },
        inlineSourceMap: true || false,
        module: es2020 | esnext,
        renderTypeDeclarations: true || false,
        script: jsx | tsx | js,
        target: es2015 | es2020
      }
    },
    autoGenerateForms: true || false,
    features: {
      isNonModelSupported: true || false,
      isRelationshipSupported: true || false
    },
    genericDataSchema: {
      dataSourceType: DataStore, /* required */
      enums: { /* required */
        '<String>': {
          values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<String>': ... */
      },
      models: { /* required */
        '<String>': {
          fields: { /* required */
            '<String>': {
              dataType: ID | String | Int | Float | AWSDate | AWSTime | AWSDateTime | AWSTimestamp | AWSEmail | AWSURL | AWSIPAddress | Boolean | AWSJSON | AWSPhone | Enum | Model | NonModel, /* required */
              dataTypeValue: 'STRING_VALUE', /* required */
              isArray: true || false, /* required */
              readOnly: true || false, /* required */
              required: true || false, /* required */
              relationship: {
                relatedModelName: 'STRING_VALUE', /* required */
                type: HAS_MANY | HAS_ONE | BELONGS_TO, /* required */
                associatedFields: [
                  'STRING_VALUE',
                  /* more items */
                ],
                belongsToFieldOnRelatedModel: 'STRING_VALUE',
                canUnlinkAssociatedModel: true || false,
                isHasManyIndex: true || false,
                relatedJoinFieldName: 'STRING_VALUE',
                relatedJoinTableName: 'STRING_VALUE',
                relatedModelFields: [
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            },
            /* '<String>': ... */
          },
          primaryKeys: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          isJoinTable: true || false
        },
        /* '<String>': ... */
      },
      nonModels: { /* required */
        '<String>': {
          fields: { /* required */
            '<String>': {
              dataType: ID | String | Int | Float | AWSDate | AWSTime | AWSDateTime | AWSTimestamp | AWSEmail | AWSURL | AWSIPAddress | Boolean | AWSJSON | AWSPhone | Enum | Model | NonModel, /* required */
              dataTypeValue: 'STRING_VALUE', /* required */
              isArray: true || false, /* required */
              readOnly: true || false, /* required */
              required: true || false, /* required */
              relationship: {
                relatedModelName: 'STRING_VALUE', /* required */
                type: HAS_MANY | HAS_ONE | BELONGS_TO, /* required */
                associatedFields: [
                  'STRING_VALUE',
                  /* more items */
                ],
                belongsToFieldOnRelatedModel: 'STRING_VALUE',
                canUnlinkAssociatedModel: true || false,
                isHasManyIndex: true || false,
                relatedJoinFieldName: 'STRING_VALUE',
                relatedJoinTableName: 'STRING_VALUE',
                relatedModelFields: [
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            },
            /* '<String>': ... */
          }
        },
        /* '<String>': ... */
      }
    },
    tags: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  environmentName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.startCodegenJob(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.

    • clientToken — (String)

      The idempotency token used to ensure that the code generation job request completes only once.

      If a token is not provided, the SDK will use a version 4 UUID.
    • codegenJobToCreate — (map)

      The code generation job resource configuration.

      • renderConfigrequired — (map)

        The code generation configuration for the codegen job.

        • react — (map)

          The name of the ReactStartCodegenJobData object.

          • module — (String)

            The JavaScript module type.

            Possible values include:
            • "es2020"
            • "esnext"
          • target — (String)

            The ECMAScript specification to use.

            Possible values include:
            • "es2015"
            • "es2020"
          • script — (String)

            The file type to use for a JavaScript project.

            Possible values include:
            • "jsx"
            • "tsx"
            • "js"
          • renderTypeDeclarations — (Boolean)

            Specifies whether the code generation job should render type declaration files.

          • inlineSourceMap — (Boolean)

            Specifies whether the code generation job should render inline source maps.

          • apiConfiguration — (map)

            The API configuration for the code generation job.

            • graphQLConfig — (map)

              The configuration for an application using GraphQL APIs.

              • typesFilePathrequired — (String)

                The path to the GraphQL types file, relative to the component output directory.

              • queriesFilePathrequired — (String)

                The path to the GraphQL queries file, relative to the component output directory.

              • mutationsFilePathrequired — (String)

                The path to the GraphQL mutations file, relative to the component output directory.

              • subscriptionsFilePathrequired — (String)

                The path to the GraphQL subscriptions file, relative to the component output directory.

              • fragmentsFilePathrequired — (String)

                The path to the GraphQL fragments file, relative to the component output directory.

            • dataStoreConfig — (map)

              The configuration for an application using DataStore APIs.

            • noApiConfig — (map)

              The configuration for an application with no API being used.

          • dependencies — (map<String>)

            Lists the dependency packages that may be required for the project code to run.

      • genericDataSchema — (map)

        The data schema to use for a code generation job.

        • dataSourceTyperequired — (String)

          The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.

          Possible values include:
          • "DataStore"
        • modelsrequired — (map<map>)

          The name of a CodegenGenericDataModel.

          • fieldsrequired — (map<map>)

            The fields in the generic data model.

            • dataTyperequired — (String)

              The data type for the generic data field.

              Possible values include:
              • "ID"
              • "String"
              • "Int"
              • "Float"
              • "AWSDate"
              • "AWSTime"
              • "AWSDateTime"
              • "AWSTimestamp"
              • "AWSEmail"
              • "AWSURL"
              • "AWSIPAddress"
              • "Boolean"
              • "AWSJSON"
              • "AWSPhone"
              • "Enum"
              • "Model"
              • "NonModel"
            • dataTypeValuerequired — (String)

              The value of the data type for the generic data field.

            • requiredrequired — (Boolean)

              Specifies whether the generic data field is required.

            • readOnlyrequired — (Boolean)

              Specifies whether the generic data field is read-only.

            • isArrayrequired — (Boolean)

              Specifies whether the generic data field is an array.

            • relationship — (map)

              The relationship of the generic data schema.

              • typerequired — (String)

                The data relationship type.

                Possible values include:
                • "HAS_MANY"
                • "HAS_ONE"
                • "BELONGS_TO"
              • relatedModelNamerequired — (String)

                The name of the related model in the data relationship.

              • relatedModelFields — (Array<String>)

                The related model fields in the data relationship.

              • canUnlinkAssociatedModel — (Boolean)

                Specifies whether the relationship can unlink the associated model.

              • relatedJoinFieldName — (String)

                The name of the related join field in the data relationship.

              • relatedJoinTableName — (String)

                The name of the related join table in the data relationship.

              • belongsToFieldOnRelatedModel — (String)

                The value of the belongsTo field on the related data model.

              • associatedFields — (Array<String>)

                The associated fields of the data relationship.

              • isHasManyIndex — (Boolean)

                Specifies whether the @index directive is supported for a hasMany data relationship.

          • isJoinTable — (Boolean)

            Specifies whether the generic data model is a join table.

          • primaryKeysrequired — (Array<String>)

            The primary keys of the generic data model.

        • enumsrequired — (map<map>)

          The name of a CodegenGenericDataEnum.

          • valuesrequired — (Array<String>)

            The list of enum values in the generic data schema.

        • nonModelsrequired — (map<map>)

          The name of a CodegenGenericDataNonModel.

          • fieldsrequired — (map<map>)

            The fields in a generic data schema non model.

            • dataTyperequired — (String)

              The data type for the generic data field.

              Possible values include:
              • "ID"
              • "String"
              • "Int"
              • "Float"
              • "AWSDate"
              • "AWSTime"
              • "AWSDateTime"
              • "AWSTimestamp"
              • "AWSEmail"
              • "AWSURL"
              • "AWSIPAddress"
              • "Boolean"
              • "AWSJSON"
              • "AWSPhone"
              • "Enum"
              • "Model"
              • "NonModel"
            • dataTypeValuerequired — (String)

              The value of the data type for the generic data field.

            • requiredrequired — (Boolean)

              Specifies whether the generic data field is required.

            • readOnlyrequired — (Boolean)

              Specifies whether the generic data field is read-only.

            • isArrayrequired — (Boolean)

              Specifies whether the generic data field is an array.

            • relationship — (map)

              The relationship of the generic data schema.

              • typerequired — (String)

                The data relationship type.

                Possible values include:
                • "HAS_MANY"
                • "HAS_ONE"
                • "BELONGS_TO"
              • relatedModelNamerequired — (String)

                The name of the related model in the data relationship.

              • relatedModelFields — (Array<String>)

                The related model fields in the data relationship.

              • canUnlinkAssociatedModel — (Boolean)

                Specifies whether the relationship can unlink the associated model.

              • relatedJoinFieldName — (String)

                The name of the related join field in the data relationship.

              • relatedJoinTableName — (String)

                The name of the related join table in the data relationship.

              • belongsToFieldOnRelatedModel — (String)

                The value of the belongsTo field on the related data model.

              • associatedFields — (Array<String>)

                The associated fields of the data relationship.

              • isHasManyIndex — (Boolean)

                Specifies whether the @index directive is supported for a hasMany data relationship.

      • autoGenerateForms — (Boolean)

        Specifies whether to autogenerate forms in the code generation job.

      • features — (map)

        The feature flags for a code generation job.

        • isRelationshipSupported — (Boolean)

          Specifes whether a code generation job supports data relationships.

        • isNonModelSupported — (Boolean)

          Specifies whether a code generation job supports non models.

      • tags — (map<String>)

        One or more key-value pairs to use when tagging the code generation job data.

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)

        The code generation job for a UI component that is associated with an Amplify app.

        • idrequired — (String)

          The unique ID for the code generation job.

        • appIdrequired — (String)

          The ID of the Amplify app associated with the code generation job.

        • environmentNamerequired — (String)

          The name of the backend environment associated with the code generation job.

        • renderConfig — (map)

          Describes the configuration information for rendering the UI component associated with the code generation job.

          • react — (map)

            The name of the ReactStartCodegenJobData object.

            • module — (String)

              The JavaScript module type.

              Possible values include:
              • "es2020"
              • "esnext"
            • target — (String)

              The ECMAScript specification to use.

              Possible values include:
              • "es2015"
              • "es2020"
            • script — (String)

              The file type to use for a JavaScript project.

              Possible values include:
              • "jsx"
              • "tsx"
              • "js"
            • renderTypeDeclarations — (Boolean)

              Specifies whether the code generation job should render type declaration files.

            • inlineSourceMap — (Boolean)

              Specifies whether the code generation job should render inline source maps.

            • apiConfiguration — (map)

              The API configuration for the code generation job.

              • graphQLConfig — (map)

                The configuration for an application using GraphQL APIs.

                • typesFilePathrequired — (String)

                  The path to the GraphQL types file, relative to the component output directory.

                • queriesFilePathrequired — (String)

                  The path to the GraphQL queries file, relative to the component output directory.

                • mutationsFilePathrequired — (String)

                  The path to the GraphQL mutations file, relative to the component output directory.

                • subscriptionsFilePathrequired — (String)

                  The path to the GraphQL subscriptions file, relative to the component output directory.

                • fragmentsFilePathrequired — (String)

                  The path to the GraphQL fragments file, relative to the component output directory.

              • dataStoreConfig — (map)

                The configuration for an application using DataStore APIs.

              • noApiConfig — (map)

                The configuration for an application with no API being used.

            • dependencies — (map<String>)

              Lists the dependency packages that may be required for the project code to run.

        • genericDataSchema — (map)

          Describes the data schema for a code generation job.

          • dataSourceTyperequired — (String)

            The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.

            Possible values include:
            • "DataStore"
          • modelsrequired — (map<map>)

            The name of a CodegenGenericDataModel.

            • fieldsrequired — (map<map>)

              The fields in the generic data model.

              • dataTyperequired — (String)

                The data type for the generic data field.

                Possible values include:
                • "ID"
                • "String"
                • "Int"
                • "Float"
                • "AWSDate"
                • "AWSTime"
                • "AWSDateTime"
                • "AWSTimestamp"
                • "AWSEmail"
                • "AWSURL"
                • "AWSIPAddress"
                • "Boolean"
                • "AWSJSON"
                • "AWSPhone"
                • "Enum"
                • "Model"
                • "NonModel"
              • dataTypeValuerequired — (String)

                The value of the data type for the generic data field.

              • requiredrequired — (Boolean)

                Specifies whether the generic data field is required.

              • readOnlyrequired — (Boolean)

                Specifies whether the generic data field is read-only.

              • isArrayrequired — (Boolean)

                Specifies whether the generic data field is an array.

              • relationship — (map)

                The relationship of the generic data schema.

                • typerequired — (String)

                  The data relationship type.

                  Possible values include:
                  • "HAS_MANY"
                  • "HAS_ONE"
                  • "BELONGS_TO"
                • relatedModelNamerequired — (String)

                  The name of the related model in the data relationship.

                • relatedModelFields — (Array<String>)

                  The related model fields in the data relationship.

                • canUnlinkAssociatedModel — (Boolean)

                  Specifies whether the relationship can unlink the associated model.

                • relatedJoinFieldName — (String)

                  The name of the related join field in the data relationship.

                • relatedJoinTableName — (String)

                  The name of the related join table in the data relationship.

                • belongsToFieldOnRelatedModel — (String)

                  The value of the belongsTo field on the related data model.

                • associatedFields — (Array<String>)

                  The associated fields of the data relationship.

                • isHasManyIndex — (Boolean)

                  Specifies whether the @index directive is supported for a hasMany data relationship.

            • isJoinTable — (Boolean)

              Specifies whether the generic data model is a join table.

            • primaryKeysrequired — (Array<String>)

              The primary keys of the generic data model.

          • enumsrequired — (map<map>)

            The name of a CodegenGenericDataEnum.

            • valuesrequired — (Array<String>)

              The list of enum values in the generic data schema.

          • nonModelsrequired — (map<map>)

            The name of a CodegenGenericDataNonModel.

            • fieldsrequired — (map<map>)

              The fields in a generic data schema non model.

              • dataTyperequired — (String)

                The data type for the generic data field.

                Possible values include:
                • "ID"
                • "String"
                • "Int"
                • "Float"
                • "AWSDate"
                • "AWSTime"
                • "AWSDateTime"
                • "AWSTimestamp"
                • "AWSEmail"
                • "AWSURL"
                • "AWSIPAddress"
                • "Boolean"
                • "AWSJSON"
                • "AWSPhone"
                • "Enum"
                • "Model"
                • "NonModel"
              • dataTypeValuerequired — (String)

                The value of the data type for the generic data field.

              • requiredrequired — (Boolean)

                Specifies whether the generic data field is required.

              • readOnlyrequired — (Boolean)

                Specifies whether the generic data field is read-only.

              • isArrayrequired — (Boolean)

                Specifies whether the generic data field is an array.

              • relationship — (map)

                The relationship of the generic data schema.

                • typerequired — (String)

                  The data relationship type.

                  Possible values include:
                  • "HAS_MANY"
                  • "HAS_ONE"
                  • "BELONGS_TO"
                • relatedModelNamerequired — (String)

                  The name of the related model in the data relationship.

                • relatedModelFields — (Array<String>)

                  The related model fields in the data relationship.

                • canUnlinkAssociatedModel — (Boolean)

                  Specifies whether the relationship can unlink the associated model.

                • relatedJoinFieldName — (String)

                  The name of the related join field in the data relationship.

                • relatedJoinTableName — (String)

                  The name of the related join table in the data relationship.

                • belongsToFieldOnRelatedModel — (String)

                  The value of the belongsTo field on the related data model.

                • associatedFields — (Array<String>)

                  The associated fields of the data relationship.

                • isHasManyIndex — (Boolean)

                  Specifies whether the @index directive is supported for a hasMany data relationship.

        • autoGenerateForms — (Boolean)

          Specifies whether to autogenerate forms in the code generation job.

        • features — (map)

          Describes the feature flags that you can specify for a code generation job.

          • isRelationshipSupported — (Boolean)

            Specifes whether a code generation job supports data relationships.

          • isNonModelSupported — (Boolean)

            Specifies whether a code generation job supports non models.

        • status — (String)

          The status of the code generation job.

          Possible values include:
          • "in_progress"
          • "failed"
          • "succeeded"
        • statusMessage — (String)

          The customized status message for the code generation job.

        • asset — (map)

          The CodegenJobAsset to use for the code generation job.

          • downloadUrl — (String)

            The URL to use to access the asset.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the code generation job.

        • createdAt — (Date)

          The time that the code generation job was created.

        • modifiedAt — (Date)

          The time that the code generation job was modified.

        • dependencies — (Array<map>)

          Lists the dependency packages that may be required for the project code to run.

          • name — (String)

            Name of the dependency package.

          • supportedVersion — (String)

            Indicates the version of the supported dependency package.

          • isSemVer — (Boolean)

            Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.

          • reason — (String)

            Indicates the reason to include the dependency package in your project code.

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',
              operandType: 'STRING_VALUE',
              operator: 'STRING_VALUE',
              or: /* recursive PredicateList */
            },
            /* more items */
          ],
          slotName: 'STRING_VALUE',
          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',
          operandType: '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.

    • environmentName — (String)

      The name of the backend environment that is part of the Amplify app.

    • id — (String)

      The unique ID for the component.

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • updatedComponent — (map)

      The configuration of the updated component.

      • id — (String)

        The unique ID of the component to update.

      • name — (String)

        The name of the component to update.

      • sourceId — (String)

        The unique ID of the component in its original source system, such as Figma.

      • componentType — (String)

        The type of the component. This can be an Amplify custom UI component or another custom component.

      • properties — (map<map>)

        Describes the component's properties.

        • value — (String)

          The value to assign to the component property.

        • bindingProperties — (map)

          The information to bind the component property to data at runtime.

          • propertyrequired — (String)

            The component property to bind to the data field.

          • field — (String)

            The data field to bind the property to.

        • collectionBindingProperties — (map)

          The information to bind the component property to data at runtime. Use this for collection components.

          • propertyrequired — (String)

            The component property to bind to the data field.

          • field — (String)

            The data field to bind the property to.

        • defaultValue — (String)

          The default value to assign to the component property.

        • model — (String)

          The data model to use to assign a value to the component property.

        • bindings — (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.

        • event — (String)

          An event that occurs in your app. Use this for workflow data binding.

        • userAttribute — (String)

          An authenticated user attribute to use to assign a value to the component property.

        • concat — (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.

          • property — (String)

            The name of the conditional property.

          • field — (String)

            The name of a field. Specify this when the property is a data model.

          • operator — (String)

            The operator to use to perform the evaluation, such as eq to represent equals.

          • operand — (String)

            The value of the property to evaluate.

          • operandType — (String)

            The type of the property to evaluate.

        • configured — (Boolean)

          Specifies whether the user configured the property in Amplify Studio after importing it.

        • type — (String)

          The component type.

        • importedValue — (String)

          The default value assigned to the property when the component is imported into an app.

        • componentName — (String)

          The name of the component that is affected by an event.

        • property — (String)

          The name of the component's property that is affected by an event.

      • children — (Array<map>)

        The components that are instances of the main component.

        • componentTyperequired — (String)

          The type of the child component.

        • 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.

          • value — (String)

            The value to assign to the component property.

          • bindingProperties — (map)

            The information to bind the component property to data at runtime.

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • collectionBindingProperties — (map)

            The information to bind the component property to data at runtime. Use this for collection components.

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • defaultValue — (String)

            The default value to assign to the component property.

          • model — (String)

            The data model to use to assign a value to the component property.

          • bindings — (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.

          • event — (String)

            An event that occurs in your app. Use this for workflow data binding.

          • userAttribute — (String)

            An authenticated user attribute to use to assign a value to the component property.

          • concat — (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.

            • property — (String)

              The name of the conditional property.

            • field — (String)

              The name of a field. Specify this when the property is a data model.

            • operator — (String)

              The operator to use to perform the evaluation, such as eq to represent equals.

            • operand — (String)

              The value of the property to evaluate.

            • operandType — (String)

              The type of the property to evaluate.

          • configured — (Boolean)

            Specifies whether the user configured the property in Amplify Studio after importing it.

          • type — (String)

            The component type.

          • importedValue — (String)

            The default value assigned to the property when the component is imported into an app.

          • componentName — (String)

            The name of the component that is affected by an event.

          • property — (String)

            The name of the component's property that is affected by an event.

        • 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.

          • parameters — (map)

            Describes information about the action.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • fields — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • state — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

        • sourceId — (String)

          The unique ID of the child component in its original source system, such as Figma.

      • variants — (Array<map>)

        A list of the unique variants of the main component being updated.

        • variantValues — (map<String>)

          The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

        • 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.

      • overrides — (map<map<String>>)

        Describes the properties that can be overriden to customize the component.

      • bindingProperties — (map<map>)

        The data binding information for the component's properties.

        • type — (String)

          The property type.

        • bindingProperties — (map)

          Describes the properties to customize with data at runtime.

          • model — (String)

            An Amplify DataStore model.

          • field — (String)

            The field to bind the data to.

          • predicates — (Array<map>)

            A list of predicates for binding a component's properties to data.

            • field — (String)

              The field to query.

            • operator — (String)

              The operator to use to perform the evaluation.

            • operand — (String)

              The value to use when performing the evaluation.

            • operandType — (String)

              The type of value to use when performing the evaluation.

          • userAttribute — (String)

            An authenticated user attribute.

          • bucket — (String)

            An Amazon S3 bucket.

          • key — (String)

            The storage key for an Amazon S3 bucket.

          • defaultValue — (String)

            The default value to assign to the property.

          • slotName — (String)

            The name of a component slot.

        • defaultValue — (String)

          The default value of the property.

      • collectionProperties — (map<map>)

        The configuration for binding a component's properties to a data model. Use this for a collection component.

        • modelrequired — (String)

          The name of the data model to use to bind data to a component.

        • sort — (Array<map>)

          Describes how to sort the component's properties.

          • fieldrequired — (String)

            The field to perform the sort on.

          • directionrequired — (String)

            The direction of the sort, either ascending or descending.

            Possible values include:
            • "ASC"
            • "DESC"
        • 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.

          • or — (Array<map>)

            A list of predicates to combine logically.

          • and — (Array<map>)

            A list of predicates to combine logically.

          • field — (String)

            The field to query.

          • operator — (String)

            The operator to use to perform the evaluation.

          • operand — (String)

            The value to use when performing the evaluation.

          • operandType — (String)

            The type of value to use when performing the evaluation.

        • 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.

      • 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.

        • parameters — (map)

          Describes information about the action.

          • type — (map)

            The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • url — (map)

            The URL to the location to open. Specify this value for a navigation action.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • anchor — (map)

            The HTML anchor link to the location to open. Specify this value for a navigation action.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • target — (map)

            The element within the same component to modify when the action occurs.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • global — (map)

            Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • model — (String)

            The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

          • id — (map)

            The unique ID of the component that the ActionParameters apply to.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • fields — (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.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • state — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

        • bindingEvent — (String)

          Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

      • schemaVersion — (String)

        The schema version of the component when it was imported.

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.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • sourceId — (String)

          The unique ID of the component in its original source system, such as Figma.

        • idrequired — (String)

          The unique ID of the component.

        • namerequired — (String)

          The name of the component.

        • componentTyperequired — (String)

          The type of the component. This can be an Amplify custom UI component or another custom component.

        • propertiesrequired — (map<map>)

          Describes the component's properties. You can't specify tags as a valid property for properties.

          • value — (String)

            The value to assign to the component property.

          • bindingProperties — (map)

            The information to bind the component property to data at runtime.

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • collectionBindingProperties — (map)

            The information to bind the component property to data at runtime. Use this for collection components.

            • propertyrequired — (String)

              The component property to bind to the data field.

            • field — (String)

              The data field to bind the property to.

          • defaultValue — (String)

            The default value to assign to the component property.

          • model — (String)

            The data model to use to assign a value to the component property.

          • bindings — (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.

          • event — (String)

            An event that occurs in your app. Use this for workflow data binding.

          • userAttribute — (String)

            An authenticated user attribute to use to assign a value to the component property.

          • concat — (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.

            • property — (String)

              The name of the conditional property.

            • field — (String)

              The name of a field. Specify this when the property is a data model.

            • operator — (String)

              The operator to use to perform the evaluation, such as eq to represent equals.

            • operand — (String)

              The value of the property to evaluate.

            • operandType — (String)

              The type of the property to evaluate.

          • configured — (Boolean)

            Specifies whether the user configured the property in Amplify Studio after importing it.

          • type — (String)

            The component type.

          • importedValue — (String)

            The default value assigned to the property when the component is imported into an app.

          • componentName — (String)

            The name of the component that is affected by an event.

          • property — (String)

            The name of the component's property that is affected by an event.

        • children — (Array<map>)

          A list of the component's ComponentChild instances.

          • componentTyperequired — (String)

            The type of the child component.

          • 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.

            • value — (String)

              The value to assign to the component property.

            • bindingProperties — (map)

              The information to bind the component property to data at runtime.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • collectionBindingProperties — (map)

              The information to bind the component property to data at runtime. Use this for collection components.

              • propertyrequired — (String)

                The component property to bind to the data field.

              • field — (String)

                The data field to bind the property to.

            • defaultValue — (String)

              The default value to assign to the component property.

            • model — (String)

              The data model to use to assign a value to the component property.

            • bindings — (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.

            • event — (String)

              An event that occurs in your app. Use this for workflow data binding.

            • userAttribute — (String)

              An authenticated user attribute to use to assign a value to the component property.

            • concat — (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.

              • property — (String)

                The name of the conditional property.

              • field — (String)

                The name of a field. Specify this when the property is a data model.

              • operator — (String)

                The operator to use to perform the evaluation, such as eq to represent equals.

              • operand — (String)

                The value of the property to evaluate.

              • operandType — (String)

                The type of the property to evaluate.

            • configured — (Boolean)

              Specifies whether the user configured the property in Amplify Studio after importing it.

            • type — (String)

              The component type.

            • importedValue — (String)

              The default value assigned to the property when the component is imported into an app.

            • componentName — (String)

              The name of the component that is affected by an event.

            • property — (String)

              The name of the component's property that is affected by an event.

          • 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.

            • parameters — (map)

              Describes information about the action.

              • type — (map)

                The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • url — (map)

                The URL to the location to open. Specify this value for a navigation action.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • anchor — (map)

                The HTML anchor link to the location to open. Specify this value for a navigation action.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • target — (map)

                The element within the same component to modify when the action occurs.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • global — (map)

                Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • model — (String)

                The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

              • id — (map)

                The unique ID of the component that the ActionParameters apply to.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • fields — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

              • state — (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.

                  • value — (String)

                    The value to assign to the component property.

                  • bindingProperties — (map)

                    The information to bind the component property to data at runtime.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • collectionBindingProperties — (map)

                    The information to bind the component property to data at runtime. Use this for collection components.

                    • propertyrequired — (String)

                      The component property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • defaultValue — (String)

                    The default value to assign to the component property.

                  • model — (String)

                    The data model to use to assign a value to the component property.

                  • bindings — (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.

                  • event — (String)

                    An event that occurs in your app. Use this for workflow data binding.

                  • userAttribute — (String)

                    An authenticated user attribute to use to assign a value to the component property.

                  • concat — (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.

                    • property — (String)

                      The name of the conditional property.

                    • field — (String)

                      The name of a field. Specify this when the property is a data model.

                    • operator — (String)

                      The operator to use to perform the evaluation, such as eq to represent equals.

                    • operand — (String)

                      The value of the property to evaluate.

                    • operandType — (String)

                      The type of the property to evaluate.

                  • configured — (Boolean)

                    Specifies whether the user configured the property in Amplify Studio after importing it.

                  • type — (String)

                    The component type.

                  • importedValue — (String)

                    The default value assigned to the property when the component is imported into an app.

                  • componentName — (String)

                    The name of the component that is affected by an event.

                  • property — (String)

                    The name of the component's property that is affected by an event.

            • bindingEvent — (String)

              Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

          • sourceId — (String)

            The unique ID of the child component in its original source system, such as Figma.

        • variantsrequired — (Array<map>)

          A list of the component's variants. A variant is a unique style configuration of a main component.

          • variantValues — (map<String>)

            The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

          • 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.

        • 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.

        • 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.

          • type — (String)

            The property type.

          • bindingProperties — (map)

            Describes the properties to customize with data at runtime.

            • model — (String)

              An Amplify DataStore model.

            • field — (String)

              The field to bind the data to.

            • predicates — (Array<map>)

              A list of predicates for binding a component's properties to data.

              • field — (String)

                The field to query.

              • operator — (String)

                The operator to use to perform the evaluation.

              • operand — (String)

                The value to use when performing the evaluation.

              • operandType — (String)

                The type of value to use when performing the evaluation.

            • userAttribute — (String)

              An authenticated user attribute.

            • bucket — (String)

              An Amazon S3 bucket.

            • key — (String)

              The storage key for an Amazon S3 bucket.

            • defaultValue — (String)

              The default value to assign to the property.

            • slotName — (String)

              The name of a component slot.

          • defaultValue — (String)

            The default value of the property.

        • collectionProperties — (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.

          • modelrequired — (String)

            The name of the data model to use to bind data to a component.

          • sort — (Array<map>)

            Describes how to sort the component's properties.

            • fieldrequired — (String)

              The field to perform the sort on.

            • directionrequired — (String)

              The direction of the sort, either ascending or descending.

              Possible values include:
              • "ASC"
              • "DESC"
          • 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.

            • or — (Array<map>)

              A list of predicates to combine logically.

            • and — (Array<map>)

              A list of predicates to combine logically.

            • field — (String)

              The field to query.

            • operator — (String)

              The operator to use to perform the evaluation.

            • operand — (String)

              The value to use when performing the evaluation.

            • operandType — (String)

              The type of value to use when performing the evaluation.

          • 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.

        • createdAtrequired — (Date)

          The time that the component was created.

        • modifiedAt — (Date)

          The time that the component was modified.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the component.

        • 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.

          • parameters — (map)

            Describes information about the action.

            • type — (map)

              The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • url — (map)

              The URL to the location to open. Specify this value for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • anchor — (map)

              The HTML anchor link to the location to open. Specify this value for a navigation action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • target — (map)

              The element within the same component to modify when the action occurs.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • global — (map)

              Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • model — (String)

              The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

            • id — (map)

              The unique ID of the component that the ActionParameters apply to.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • fields — (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.

              • value — (String)

                The value to assign to the component property.

              • bindingProperties — (map)

                The information to bind the component property to data at runtime.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • collectionBindingProperties — (map)

                The information to bind the component property to data at runtime. Use this for collection components.

                • propertyrequired — (String)

                  The component property to bind to the data field.

                • field — (String)

                  The data field to bind the property to.

              • defaultValue — (String)

                The default value to assign to the component property.

              • model — (String)

                The data model to use to assign a value to the component property.

              • bindings — (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.

              • event — (String)

                An event that occurs in your app. Use this for workflow data binding.

              • userAttribute — (String)

                An authenticated user attribute to use to assign a value to the component property.

              • concat — (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.

                • property — (String)

                  The name of the conditional property.

                • field — (String)

                  The name of a field. Specify this when the property is a data model.

                • operator — (String)

                  The operator to use to perform the evaluation, such as eq to represent equals.

                • operand — (String)

                  The value of the property to evaluate.

                • operandType — (String)

                  The type of the property to evaluate.

              • configured — (Boolean)

                Specifies whether the user configured the property in Amplify Studio after importing it.

              • type — (String)

                The component type.

              • importedValue — (String)

                The default value assigned to the property when the component is imported into an app.

              • componentName — (String)

                The name of the component that is affected by an event.

              • property — (String)

                The name of the component's property that is affected by an event.

            • state — (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.

                • value — (String)

                  The value to assign to the component property.

                • bindingProperties — (map)

                  The information to bind the component property to data at runtime.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • collectionBindingProperties — (map)

                  The information to bind the component property to data at runtime. Use this for collection components.

                  • propertyrequired — (String)

                    The component property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • defaultValue — (String)

                  The default value to assign to the component property.

                • model — (String)

                  The data model to use to assign a value to the component property.

                • bindings — (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.

                • event — (String)

                  An event that occurs in your app. Use this for workflow data binding.

                • userAttribute — (String)

                  An authenticated user attribute to use to assign a value to the component property.

                • concat — (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.

                  • property — (String)

                    The name of the conditional property.

                  • field — (String)

                    The name of a field. Specify this when the property is a data model.

                  • operator — (String)

                    The operator to use to perform the evaluation, such as eq to represent equals.

                  • operand — (String)

                    The value of the property to evaluate.

                  • operandType — (String)

                    The type of the property to evaluate.

                • configured — (Boolean)

                  Specifies whether the user configured the property in Amplify Studio after importing it.

                • type — (String)

                  The component type.

                • importedValue — (String)

                  The default value assigned to the property when the component is imported into an app.

                • componentName — (String)

                  The name of the component that is affected by an event.

                • property — (String)

                  The name of the component's property that is affected by an event.

          • bindingEvent — (String)

            Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

        • schemaVersion — (String)

          The schema version of the component when it was imported.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateForm(params = {}, callback) ⇒ AWS.Request

Updates an existing form.

Service Reference:

Examples:

Calling the updateForm operation

var params = {
  appId: 'STRING_VALUE', /* required */
  environmentName: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  updatedForm: { /* required */
    cta: {
      cancel: {
        children: 'STRING_VALUE',
        excluded: true || false,
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        }
      },
      clear: {
        children: 'STRING_VALUE',
        excluded: true || false,
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        }
      },
      position: top | bottom | top_and_bottom,
      submit: {
        children: 'STRING_VALUE',
        excluded: true || false,
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        }
      }
    },
    dataType: {
      dataSourceType: DataStore | Custom, /* required */
      dataTypeName: 'STRING_VALUE' /* required */
    },
    fields: {
      '<String>': {
        excluded: true || false,
        inputType: {
          type: 'STRING_VALUE', /* required */
          defaultChecked: true || false,
          defaultCountryCode: 'STRING_VALUE',
          defaultValue: 'STRING_VALUE',
          descriptiveText: 'STRING_VALUE',
          fileUploaderConfig: {
            acceptedFileTypes: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            accessLevel: public | protected | private, /* required */
            isResumable: true || false,
            maxFileCount: 'NUMBER_VALUE',
            maxSize: 'NUMBER_VALUE',
            showThumbnails: true || false
          },
          isArray: true || false,
          maxValue: 'NUMBER_VALUE',
          minValue: 'NUMBER_VALUE',
          name: 'STRING_VALUE',
          placeholder: 'STRING_VALUE',
          readOnly: true || false,
          required: true || false,
          step: 'NUMBER_VALUE',
          value: 'STRING_VALUE',
          valueMappings: {
            values: [ /* required */
              {
                value: { /* FormInputValueProperty */ /* required */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  concat: [
                    /* recursive FormInputValueProperty */,
                    /* more items */
                  ],
                  value: 'STRING_VALUE'
                },
                displayValue: { /* FormInputValueProperty */
                  bindingProperties: {
                    property: 'STRING_VALUE', /* required */
                    field: 'STRING_VALUE'
                  },
                  concat: [
                    /* recursive FormInputValueProperty */,
                    /* more items */
                  ],
                  value: 'STRING_VALUE'
                }
              },
              /* more items */
            ],
            bindingProperties: {
              '<String>': {
                bindingProperties: {
                  model: 'STRING_VALUE'
                },
                type: 'STRING_VALUE'
              },
              /* '<String>': ... */
            }
          }
        },
        label: 'STRING_VALUE',
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        },
        validations: [
          {
            type: 'STRING_VALUE', /* required */
            numValues: [
              'NUMBER_VALUE',
              /* more items */
            ],
            strValues: [
              'STRING_VALUE',
              /* more items */
            ],
            validationMessage: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* '<String>': ... */
    },
    formActionType: create | update,
    labelDecorator: required | optional | none,
    name: 'STRING_VALUE',
    schemaVersion: 'STRING_VALUE',
    sectionalElements: {
      '<String>': {
        type: 'STRING_VALUE', /* required */
        excluded: true || false,
        level: 'NUMBER_VALUE',
        orientation: 'STRING_VALUE',
        position: {
          below: 'STRING_VALUE',
          fixed: first,
          rightOf: 'STRING_VALUE'
        },
        text: 'STRING_VALUE'
      },
      /* '<String>': ... */
    },
    style: {
      horizontalGap: {
        tokenReference: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      outerPadding: {
        tokenReference: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      verticalGap: {
        tokenReference: 'STRING_VALUE',
        value: 'STRING_VALUE'
      }
    }
  },
  clientToken: 'STRING_VALUE'
};
amplifyuibuilder.updateForm(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 part of the Amplify app.

    • id — (String)

      The unique ID for the form.

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • updatedForm — (map)

      The request accepts the following data in JSON format.

      • name — (String)

        The name of the form.

      • dataType — (map)

        The type of data source to use to create the form.

        • dataSourceTyperequired — (String)

          The data source type, either an Amplify DataStore model or a custom data type.

          Possible values include:
          • "DataStore"
          • "Custom"
        • dataTypeNamerequired — (String)

          The unique name of the data type you are using as the data source for the form.

      • formActionType — (String)

        Specifies whether to perform a create or update action on the form.

        Possible values include:
        • "create"
        • "update"
      • fields — (map<map>)

        The configuration information for the form's fields.

        • label — (String)

          The label for the field.

        • position — (map)

          Specifies the field position.

          • fixed — (String)

            The field position is fixed and doesn't change in relation to other fields.

            Possible values include:
            • "first"
          • rightOf — (String)

            The field position is to the right of the field specified by the string.

          • below — (String)

            The field position is below the field specified by the string.

        • excluded — (Boolean)

          Specifies whether to hide a field.

        • inputType — (map)

          Describes the configuration for the default input value to display for a field.

          • typerequired — (String)

            The input type for the field.

          • required — (Boolean)

            Specifies a field that requires input.

          • readOnly — (Boolean)

            Specifies a read only field.

          • placeholder — (String)

            The text to display as a placeholder for the field.

          • defaultValue — (String)

            The default value for the field.

          • descriptiveText — (String)

            The text to display to describe the field.

          • defaultChecked — (Boolean)

            Specifies whether a field has a default value.

          • defaultCountryCode — (String)

            The default country code for a phone number.

          • valueMappings — (map)

            The information to use to customize the input fields with data at runtime.

            • valuesrequired — (Array<map>)

              The value and display value pairs.

              • displayValue — (map)

                The value to display for the complex object.

                • value — (String)

                  The value to assign to the input field.

                • bindingProperties — (map)

                  The information to bind fields to data at runtime.

                  • propertyrequired — (String)

                    The form property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • concat — (Array<map>)

                  A list of form properties to concatenate to create the value to assign to this field property.

              • valuerequired — (map)

                The complex object.

                • value — (String)

                  The value to assign to the input field.

                • bindingProperties — (map)

                  The information to bind fields to data at runtime.

                  • propertyrequired — (String)

                    The form property to bind to the data field.

                  • field — (String)

                    The data field to bind the property to.

                • concat — (Array<map>)

                  A list of form properties to concatenate to create the value to assign to this field property.

            • bindingProperties — (map<map>)

              The information to bind fields to data at runtime.

              • type — (String)

                The property type.

              • bindingProperties — (map)

                Describes the properties to customize with data at runtime.

                • model — (String)

                  An Amplify DataStore model.

          • name — (String)

            The name of the field.

          • minValue — (Float)

            The minimum value to display for the field.

          • maxValue — (Float)

            The maximum value to display for the field.

          • step — (Float)

            The stepping increment for a numeric value in a field.

          • value — (String)

            The value for the field.

          • isArray — (Boolean)

            Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

          • fileUploaderConfig — (map)

            The configuration for the file uploader field.

            • accessLevelrequired — (String)

              The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

              Possible values include:
              • "public"
              • "protected"
              • "private"
            • acceptedFileTypesrequired — (Array<String>)

              The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

            • showThumbnails — (Boolean)

              Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

            • isResumable — (Boolean)

              Allows the file upload operation to be paused and resumed. The default value is false.

              When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

            • maxFileCount — (Integer)

              Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

            • maxSize — (Integer)

              The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

        • validations — (Array<map>)

          The validations to perform on the value in the field.

          • typerequired — (String)

            The validation to perform on an object type.

          • strValues — (Array<String>)

            The validation to perform on a string value.

          • numValues — (Array<Integer>)

            The validation to perform on a number value.

          • validationMessage — (String)

            The validation message to display.

      • style — (map)

        The configuration for the form's style.

        • horizontalGap — (map)

          The spacing for the horizontal gap.

          • tokenReference — (String)

            A reference to a design token to use to bind the form's style properties to an existing theme.

          • value — (String)

            The value of the style setting.

        • verticalGap — (map)

          The spacing for the vertical gap.

          • tokenReference — (String)

            A reference to a design token to use to bind the form's style properties to an existing theme.

          • value — (String)

            The value of the style setting.

        • outerPadding — (map)

          The size of the outer padding for the form.

          • tokenReference — (String)

            A reference to a design token to use to bind the form's style properties to an existing theme.

          • value — (String)

            The value of the style setting.

      • sectionalElements — (map<map>)

        The configuration information for the visual helper elements for the form. These elements are not associated with any data.

        • typerequired — (String)

          The type of sectional element. Valid values are Heading, Text, and Divider.

        • position — (map)

          Specifies the position of the text in a field for a Text sectional element.

          • fixed — (String)

            The field position is fixed and doesn't change in relation to other fields.

            Possible values include:
            • "first"
          • rightOf — (String)

            The field position is to the right of the field specified by the string.

          • below — (String)

            The field position is below the field specified by the string.

        • text — (String)

          The text for a Text sectional element.

        • level — (Integer)

          Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

        • orientation — (String)

          Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

        • excluded — (Boolean)

          Excludes a sectional element that was generated by default for a specified data model.

      • schemaVersion — (String)

        The schema version of the form.

      • cta — (map)

        The FormCTA object that stores the call to action configuration for the form.

        • position — (String)

          The position of the button.

          Possible values include:
          • "top"
          • "bottom"
          • "top_and_bottom"
        • clear — (map)

          Displays a clear button.

          • excluded — (Boolean)

            Specifies whether the button is visible on the form.

          • children — (String)

            Describes the button's properties.

          • position — (map)

            The position of the button.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

        • cancel — (map)

          Displays a cancel button.

          • excluded — (Boolean)

            Specifies whether the button is visible on the form.

          • children — (String)

            Describes the button's properties.

          • position — (map)

            The position of the button.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

        • submit — (map)

          Displays a submit button.

          • excluded — (Boolean)

            Specifies whether the button is visible on the form.

          • children — (String)

            Describes the button's properties.

          • position — (map)

            The position of the button.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

      • labelDecorator — (String)

        Specifies an icon or decoration to display on the form.

        Possible values include:
        • "required"
        • "optional"
        • "none"

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 form.

        • appIdrequired — (String)

          The unique ID of the Amplify app associated with the form.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • idrequired — (String)

          The unique ID of the form.

        • namerequired — (String)

          The name of the form.

        • formActionTyperequired — (String)

          The operation to perform on the specified form.

          Possible values include:
          • "create"
          • "update"
        • stylerequired — (map)

          Stores the configuration for the form's style.

          • horizontalGap — (map)

            The spacing for the horizontal gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • verticalGap — (map)

            The spacing for the vertical gap.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

          • outerPadding — (map)

            The size of the outer padding for the form.

            • tokenReference — (String)

              A reference to a design token to use to bind the form's style properties to an existing theme.

            • value — (String)

              The value of the style setting.

        • dataTyperequired — (map)

          The type of data source to use to create the form.

          • dataSourceTyperequired — (String)

            The data source type, either an Amplify DataStore model or a custom data type.

            Possible values include:
            • "DataStore"
            • "Custom"
          • dataTypeNamerequired — (String)

            The unique name of the data type you are using as the data source for the form.

        • fieldsrequired — (map<map>)

          Stores the information about the form's fields.

          • label — (String)

            The label for the field.

          • position — (map)

            Specifies the field position.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • excluded — (Boolean)

            Specifies whether to hide a field.

          • inputType — (map)

            Describes the configuration for the default input value to display for a field.

            • typerequired — (String)

              The input type for the field.

            • required — (Boolean)

              Specifies a field that requires input.

            • readOnly — (Boolean)

              Specifies a read only field.

            • placeholder — (String)

              The text to display as a placeholder for the field.

            • defaultValue — (String)

              The default value for the field.

            • descriptiveText — (String)

              The text to display to describe the field.

            • defaultChecked — (Boolean)

              Specifies whether a field has a default value.

            • defaultCountryCode — (String)

              The default country code for a phone number.

            • valueMappings — (map)

              The information to use to customize the input fields with data at runtime.

              • valuesrequired — (Array<map>)

                The value and display value pairs.

                • displayValue — (map)

                  The value to display for the complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

                    A list of form properties to concatenate to create the value to assign to this field property.

                • valuerequired — (map)

                  The complex object.

                  • value — (String)

                    The value to assign to the input field.

                  • bindingProperties — (map)

                    The information to bind fields to data at runtime.

                    • propertyrequired — (String)

                      The form property to bind to the data field.

                    • field — (String)

                      The data field to bind the property to.

                  • concat — (Array<map>)

                    A list of form properties to concatenate to create the value to assign to this field property.

              • bindingProperties — (map<map>)

                The information to bind fields to data at runtime.

                • type — (String)

                  The property type.

                • bindingProperties — (map)

                  Describes the properties to customize with data at runtime.

                  • model — (String)

                    An Amplify DataStore model.

            • name — (String)

              The name of the field.

            • minValue — (Float)

              The minimum value to display for the field.

            • maxValue — (Float)

              The maximum value to display for the field.

            • step — (Float)

              The stepping increment for a numeric value in a field.

            • value — (String)

              The value for the field.

            • isArray — (Boolean)

              Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

            • fileUploaderConfig — (map)

              The configuration for the file uploader field.

              • accessLevelrequired — (String)

                The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

                Possible values include:
                • "public"
                • "protected"
                • "private"
              • acceptedFileTypesrequired — (Array<String>)

                The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

              • showThumbnails — (Boolean)

                Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

              • isResumable — (Boolean)

                Allows the file upload operation to be paused and resumed. The default value is false.

                When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

              • maxFileCount — (Integer)

                Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

              • maxSize — (Integer)

                The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

          • validations — (Array<map>)

            The validations to perform on the value in the field.

            • typerequired — (String)

              The validation to perform on an object type.

            • strValues — (Array<String>)

              The validation to perform on a string value.

            • numValues — (Array<Integer>)

              The validation to perform on a number value.

            • validationMessage — (String)

              The validation message to display.

        • sectionalElementsrequired — (map<map>)

          Stores the visual helper elements for the form that are not associated with any data.

          • typerequired — (String)

            The type of sectional element. Valid values are Heading, Text, and Divider.

          • position — (map)

            Specifies the position of the text in a field for a Text sectional element.

            • fixed — (String)

              The field position is fixed and doesn't change in relation to other fields.

              Possible values include:
              • "first"
            • rightOf — (String)

              The field position is to the right of the field specified by the string.

            • below — (String)

              The field position is below the field specified by the string.

          • text — (String)

            The text for a Text sectional element.

          • level — (Integer)

            Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

          • orientation — (String)

            Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

          • excluded — (Boolean)

            Excludes a sectional element that was generated by default for a specified data model.

        • schemaVersionrequired — (String)

          The schema version of the form when it was imported.

        • tags — (map<String>)

          One or more key-value pairs to use when tagging the form.

        • cta — (map)

          Stores the call to action configuration for the form.

          • position — (String)

            The position of the button.

            Possible values include:
            • "top"
            • "bottom"
            • "top_and_bottom"
          • clear — (map)

            Displays a clear button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • cancel — (map)

            Displays a cancel button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

          • submit — (map)

            Displays a submit button.

            • excluded — (Boolean)

              Specifies whether the button is visible on the form.

            • children — (String)

              Describes the button's properties.

            • position — (map)

              The position of the button.

              • fixed — (String)

                The field position is fixed and doesn't change in relation to other fields.

                Possible values include:
                • "first"
              • rightOf — (String)

                The field position is to the right of the field specified by the string.

              • below — (String)

                The field position is below the field specified by the string.

        • labelDecorator — (String)

          Specifies an icon or decoration to display on the form.

          Possible values include:
          • "required"
          • "optional"
          • "none"

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.

    • environmentName — (String)

      The name of the backend environment that is part of the Amplify app.

    • id — (String)

      The unique ID for the theme.

    • clientToken — (String)

      The unique client token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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.

      • 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.

      • 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.

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.

        • environmentNamerequired — (String)

          The name of the backend environment that is a part of the Amplify app.

        • idrequired — (String)

          The ID for the theme.

        • namerequired — (String)

          The name of the theme.

        • createdAtrequired — (Date)

          The time that the theme was created.

        • modifiedAt — (Date)

          The time that the theme was modified.

        • 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.

        • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given AmplifyUIBuilder resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.