:doc:`AppSync <../../appsync>` / Client / list_types

**********
list_types
**********



.. py:method:: AppSync.Client.list_types(**kwargs)

  

  Lists the types for a given API.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListTypes>`_  


  **Request Syntax**
  ::

    response = client.list_types(
        apiId='string',
        format='SDL'|'JSON',
        nextToken='string',
        maxResults=123
    )
    
  :type apiId: string
  :param apiId: **[REQUIRED]** 

    The API ID.

    

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

    The type format: SDL or JSON.

    

  
  :type nextToken: string
  :param nextToken: 

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that you want the request to return.

    

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

    
    ::

      {
          'types': [
              {
                  'name': 'string',
                  'description': 'string',
                  'arn': 'string',
                  'definition': 'string',
                  'format': 'SDL'|'JSON'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **types** *(list) --* 

        The ``Type`` objects.

        
        

        - *(dict) --* 

          Describes a type.

          
          

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

            The type name.

            
          

          - **description** *(string) --* 

            The type description.

            
          

          - **arn** *(string) --* 

            The type Amazon Resource Name (ARN).

            
          

          - **definition** *(string) --* 

            The type definition.

            
          

          - **format** *(string) --* 

            The type format: SDL or JSON.

            
      
    
      

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

        An identifier to pass in the next request to this operation to return the next set of items in the list.

        
  
  **Exceptions**
  
  *   :py:class:`AppSync.Client.exceptions.BadRequestException`

  
  *   :py:class:`AppSync.Client.exceptions.ConcurrentModificationException`

  
  *   :py:class:`AppSync.Client.exceptions.NotFoundException`

  
  *   :py:class:`AppSync.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`AppSync.Client.exceptions.InternalFailureException`

  