WelcomeAPI Version 2021-08-11 AmplifyUIBuilder

(1)

AmplifyUIBuilder

Welcome

API Version 2021-08-11

(2)

AmplifyUIBuilder: Welcome

Copyright © Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

Welcome to the AWS Amplify UI Builder API documentation. This reference provides descriptions of the actions and data types for the Amplify UI Builder API.

The Amplify UI Builder API provides a programmatic interface for creating and conﬁguring 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 AWS 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 AWS, see the Amplify User Guide.

This document was last published on March 6, 2022.

(8)

Actions

The following actions are supported:

• CreateComponent (p. 3)

• CreateTheme (p. 30)

• DeleteComponent (p. 33)

• DeleteTheme (p. 35)

• ExchangeCodeForToken (p. 37)

• ExportComponents (p. 39)

• ExportThemes (p. 53)

• GetComponent (p. 56)

• GetTheme (p. 70)

• ListComponents (p. 73)

• ListThemes (p. 75)

• RefreshToken (p. 77)

• UpdateComponent (p. 79)

• UpdateTheme (p. 106)

(9)

CreateComponent

Creates a new component for an Amplify app.

Request Syntax

POST /app/appId/environment/environmentName/components?clientToken=clientToken HTTP/1.1 Content-type: application/json

{ "componentToCreate": { "bindingProperties": { "string" : {

"bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ {

"and": [ "Predicate"

],

"field": "string", "operand": "string", "operator": "string", "or": [

"Predicate"

] } ],

"userAttribute": "string"

},

"defaultValue": "string", "type": "string"

} },

"children": [ {

"children": [ "ComponentChild"

],

"componentType": "string", "events": {

"string" : {

"action": "string", "parameters": { "anchor": {

"bindingProperties": { "field": "string", "property": "string"

},

"bindings": { "string" : {

"element": "string", "property": "string"

} },

"collectionBindingProperties": { "field": "string",

"property": "string"

},

(10)

Request Syntax

"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" : {

},

} },

},

"ComponentProperty"

],

"condition": {

},

(11)

Request Syntax

},

} },

},

"ComponentProperty"

],

"condition": {

},

}, "id": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

(12)

Request Syntax

},

"model": "string", "state": {

"componentName": "string", "property": "string", "set": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"target": {

},

(13)

Request Syntax

"concat": [

"ComponentProperty"

],

"condition": {

},

"type": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

"url": {

},

"bindings": {

(14)

Request Syntax

"string" : {

} },

},

"ComponentProperty"

],

"condition": {

},

} } } },

"name": "string", "properties": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

(15)

Request Syntax

"defaultValue": "string", "event": "string",

} } } ],

"collectionProperties": { "string" : {

"identifiers": [ "string" ], "model": "string",

"predicate": { "and": [ "Predicate"

],

"Predicate"

] },

"sort": [ {

"direction": "string", "field": "string"

} ] } },

"string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

"operand": "string", "operandType": "string", "operator": "string", "property": "string",

(16)

Request Syntax

"then": "ComponentProperty"

},

"fields": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"global": {

},

(17)

Request Syntax

},

"ComponentProperty"

],

"condition": {

},

}, "id": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

"componentName": "string", "property": "string",

(18)

Request Syntax

"set": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"target": {

},

} },

},

"ComponentProperty"

(19)

Request Syntax

},

"type": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

"url": {

},

} },

},

(20)

Request Syntax

"ComponentProperty"

],

"condition": {

},

} } } },

"name": "string", "overrides": { "string" : {

"string" : "string"

} },

"properties": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

(21)

URI Request Parameters

} },

"schemaVersion": "string", "sourceId": "string", "tags": {

"string" : "string"

},

"variants": [ {

"overrides": { "string" : {

"string" : "string"

} },

"variantValues": { "string" : "string"

} } ] }}

URI Request Parameters

The request uses the following URI parameters.

appId (p. 3)

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

Required: Yes clientToken (p. 3)

The unique client token.

environmentName (p. 3)

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

componentToCreate (p. 3)

Represents the conﬁguration of the component to create.

Type: CreateComponentData (p. 129) object Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json

(22)

Response Syntax

{ "entity": {

"appId": "string", "bindingProperties": { "string" : {

"bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ {

"and": [ "Predicate"

],

"Predicate"

] } ],

"userAttribute": "string"

},

"defaultValue": "string", "type": "string"

} },

"children": [ {

"children": [ "ComponentChild"

],

"string" : {

},

"bindings": { "string" : {

} },

},

"componentName": "string",

(23)

Response Syntax

"property": "string", "then": "ComponentProperty"

},

"fields": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"global": {

},

} },

(24)

Response Syntax

},

"ComponentProperty"

],

"condition": {

},

}, "id": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

"importedValue": "string",

(25)

Response Syntax

"property": "string", "set": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"target": {

},

} },

},

"ComponentProperty"

],

"condition": {

(26)

Response Syntax

"then": "ComponentProperty"

},

"type": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

"url": {

},

(27)

Response Syntax

"concat": [

"ComponentProperty"

],

"condition": {

},

} } } },

"name": "string", "properties": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} }

(28)

Response Syntax

} ],

"collectionProperties": { "string" : {

"identifiers": [ "string" ], "model": "string",

"predicate": { "and": [ "Predicate"

],

"Predicate"

] },

"sort": [ {

"direction": "string", "field": "string"

} ] } },

"componentType": "string", "createdAt": number,

"environmentName": "string", "events": {

"string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

"operand": "string", "operandType": "string", "operator": "string",

(29)

Response Syntax

"type": "string",

},

"fields": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"global": {

},

} },

},

"ComponentProperty"

],

"condition": {

(30)

Response Syntax

},

}, "id": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

(31)

Response Syntax

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"target": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

(32)

Response Syntax

},

"type": {

},

} },

},

"ComponentProperty"

],

"condition": {

},

"url": {

},

} },

},

(33)

Response Syntax

"property": "string", "then": "ComponentProperty"

},

} } } },

"id": "string", "modifiedAt": number, "name": "string", "overrides": { "string" : {

"string" : "string"

} },

"properties": { "string" : {

},

} },

},

"ComponentProperty"

],

"condition": {

},

} },

"schemaVersion": "string", "sourceId": "string",

(34)

Response Elements

"tags": {

},

"variants": [ {

"overrides": { "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.

entity (p. 15)

Describes the conﬁguration of the new component.

Type: Component (p. 112) object

Errors

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

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 ResourceConﬂictException

The resource speciﬁed in the request conﬂicts with an existing resource.

HTTP Status Code: 409 ServiceQuotaExceededException

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number

(35)

CreateTheme

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

Request Syntax

POST /app/appId/environment/environmentName/themes?clientToken=clientToken HTTP/1.1 Content-type: application/json

{ "themeToCreate": { "name": "string", "overrides": [ {

"key": "string", "value": { "children": [ "ThemeValues"

],

"value": "string"

} } ],

"tags": {

"string" : "string"

},

"values": [ {

],

"value": "string"

} } ] }}

URI Request Parameters

appId (p. 30)

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

Required: Yes clientToken (p. 30)

(37)

Request Body

The request accepts the following data in JSON format.

themeToCreate (p. 30)

Represents the conﬁguration of the theme to create.

Type: CreateThemeData (p. 131) object Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "entity": {

"appId": "string", "createdAt": number,

"environmentName": "string", "id": "string",

"modifiedAt": number, "name": "string", "overrides": [ {

],

"value": "string"

} } ],

"tags": {

},

"values": [ {

],

"value": "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.

(38)

Errors

entity (p. 31)

Describes the conﬁguration of the new theme.

Type: Theme (p. 138) object

Errors

HTTP Status Code: 400 ResourceConﬂictException

The resource speciﬁed in the request conﬂicts with an existing resource.

HTTP Status Code: 409 ServiceQuotaExceededException

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

HTTP Status Code: 402

DeleteComponent

Deletes a component from an Amplify app.

Request Syntax

DELETE /app/appId/environment/environmentName/components/id HTTP/1.1

URI Request Parameters

appId (p. 33)

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

Required: Yes

environmentName (p. 33)

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

Required: Yes id (p. 33)

The unique ID of the component to delete.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

(40)

WelcomeAPI Version 2021-08-11 AmplifyUIBuilder

AmplifyUIBuilder

Welcome

API Version 2021-08-11

AmplifyUIBuilder: Welcome

Copyright © Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved.

Table of Contents

Welcome

Actions

CreateComponent

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

CreateTheme

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteComponent

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also