:doc:`AmplifyUIBuilder <../../amplifyuibuilder>` / Paginator / ListForms

*********
ListForms
*********



.. py:class:: AmplifyUIBuilder.Paginator.ListForms

  ::

    
    paginator = client.get_paginator('list_forms')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`AmplifyUIBuilder.Client.list_forms`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListForms>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          appId='string',
          environmentName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type appId: string
    :param appId: **[REQUIRED]** 

      The unique ID for the Amplify app.

      

    
    :type environmentName: string
    :param environmentName: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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) --* 

          A token to resume pagination.

          
    