AmplifyUIBuilder / Client / list_forms

list_forms#

AmplifyUIBuilder.Client.list_forms(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_forms(
    appId='string',
    environmentName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • appId (string) –

    [REQUIRED]

    The unique ID for the Amplify app.

  • environmentName (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'entities': [
        {
            'appId': 'string',
            'dataType': {
                'dataSourceType': 'DataStore'|'Custom',
                'dataTypeName': 'string'
            },
            'environmentName': 'string',
            'formActionType': 'create'|'update',
            'id': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • entities (list) –

      The list of forms for the Amplify app.

      • (dict) –

        Describes the basic information about a form.

        • appId (string) –

          The unique ID for the app associated with the form summary.

        • dataType (dict) –

          The form’s data source type.

          • dataSourceType (string) –

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

          • dataTypeName (string) –

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

        • environmentName (string) –

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

        • formActionType (string) –

          The type of operation to perform on the form.

        • id (string) –

          The ID of the form.

        • name (string) –

          The name of the form.

    • nextToken (string) –

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

Exceptions