GetForm - AmplifyUIBuilder


Returns an existing form for an Amplify app.

Request Syntax

GET /app/appId/environment/environmentName/forms/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The unique ID of the Amplify app.

Required: Yes


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

Required: Yes


The unique ID of the form.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "form": { "appId": "string", "cta": { "cancel": { "children": "string", "excluded": boolean, "position": { "below": "string", "fixed": "string", "rightOf": "string" } }, "clear": { "children": "string", "excluded": boolean, "position": { "below": "string", "fixed": "string", "rightOf": "string" } }, "position": "string", "submit": { "children": "string", "excluded": boolean, "position": { "below": "string", "fixed": "string", "rightOf": "string" } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, "step": number, "type": "string", "value": "string", "valueMappings": { "values": [ { "displayValue": { "value": "string" }, "value": { "value": "string" } } ] } }, "label": "string", "position": { "below": "string", "fixed": "string", "rightOf": "string" }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "id": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "level": number, "orientation": "string", "position": { "below": "string", "fixed": "string", "rightOf": "string" }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { "tokenReference": "string", "value": "string" }, "outerPadding": { "tokenReference": "string", "value": "string" }, "verticalGap": { "tokenReference": "string", "value": "string" } }, "tags": { "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.


Represents the configuration settings for the form.

Type: Form object


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


An internal error has occurred. Please retry your request.

HTTP Status Code: 500


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

HTTP Status Code: 400


The requested resource does not exist, or access was denied.

HTTP Status Code: 404

See Also

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