ListForms - AmplifyUIBuilder


Retrieves a list of forms for a specified Amplify app and backend environment.

Request Syntax

GET /app/appId/environment/environmentName/forms?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The unique ID for the Amplify app.

Required: Yes


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

Required: Yes


The maximum number of forms to retrieve.

Valid Range: Minimum value of 1. Maximum value of 100.


The token to request the next page of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "entities": [ { "appId": "string", "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "formActionType": "string", "id": "string", "name": "string" } ], "nextToken": "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.


The list of forms for the Amplify app.

Type: Array of FormSummary objects


The pagination token that's included if more results are available.

Type: String


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

See Also

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