:doc:`AmplifyUIBuilder <../../amplifyuibuilder>` / Client / list_components

***************
list_components
***************



.. py:method:: AmplifyUIBuilder.Client.list_components(**kwargs)

  

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

  

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


  **Request Syntax**
  ::

    response = client.list_components(
        appId='string',
        environmentName='string',
        nextToken='string',
        maxResults=123
    )
    
  :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 nextToken: string
  :param nextToken: 

    The token to request the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of components to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'entities': [
              {
                  'appId': 'string',
                  'environmentName': 'string',
                  'id': 'string',
                  'name': 'string',
                  'componentType': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **entities** *(list) --* 

        The list of components for the Amplify app.

        
        

        - *(dict) --* 

          Contains a summary of a component. This is a read-only data type that is returned by ``ListComponents``.

          
          

          - **appId** *(string) --* 

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

            
          

          - **environmentName** *(string) --* 

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

            
          

          - **id** *(string) --* 

            The unique ID of the component.

            
          

          - **name** *(string) --* 

            The name of the component.

            
          

          - **componentType** *(string) --* 

            The component type.

            
      
    
      

      - **nextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`AmplifyUIBuilder.Client.exceptions.InternalServerException`

  
  *   :py:class:`AmplifyUIBuilder.Client.exceptions.InvalidParameterException`

  