UpdateComponent - AmplifyUIBuilder

UpdateComponent

Updates an existing component.

Request Syntax

PATCH /app/appId/environment/environmentName/components/id?clientToken=clientToken HTTP/1.1 Content-type: application/json { "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] }

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for the Amplify app.

Required: Yes

clientToken

The unique client token.

environmentName

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

Required: Yes

id

The unique ID for the component.

Required: Yes

Request Body

The request accepts the following data in JSON format.

bindingProperties

The data binding information for the component's properties.

Type: String to ComponentBindingPropertiesValue object map

Required: No

children

The components that are instances of the main component.

Type: Array of ComponentChild objects

Required: No

collectionProperties

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

Type: String to ComponentDataConfiguration object map

Required: No

componentType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

events

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

Type: String to ComponentEvent object map

Required: No

id

The unique ID of the component to update.

Type: String

Required: No

name

The name of the component to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

overrides

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

Type: String to string to string map map

Required: No

properties

Describes the component's properties.

Type: String to ComponentProperty object map

Required: No

schemaVersion

The schema version of the component when it was imported.

Type: String

Required: No

sourceId

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

Type: String

Required: No

variants

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

Type: Array of ComponentVariant objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "appId": "string", "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "createdAt": "string", "environmentName": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "modifiedAt": "string", "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

appId

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

Type: String

bindingProperties

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 to ComponentBindingPropertiesValue object map

children

A list of the component's ComponentChild instances.

Type: Array of ComponentChild objects

collectionProperties

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.

Type: String to ComponentDataConfiguration object map

componentType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

createdAt

The time that the component was created.

Type: Timestamp

environmentName

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

Type: String

events

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.

Type: String to ComponentEvent object map

id

The unique ID of the component.

Type: String

modifiedAt

The time that the component was modified.

Type: Timestamp

name

The name of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

overrides

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.

Type: String to string to string map map

properties

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

Type: String to ComponentProperty object map

schemaVersion

The schema version of the component when it was imported.

Type: String

sourceId

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

Type: String

tags

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 1. Maximum length of 256.

variants

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

Type: Array of ComponentVariant objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

InvalidParameterException

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

ResourceConflictException

The resource specified in the request conflicts with an existing resource.

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: