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

*************************
list_types_by_association
*************************



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

  

  Lists ``Type`` objects by the source API association ID.

  

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


  **Request Syntax**
  ::

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

    The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    

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

    The ID generated by the AppSync service for the source API association.

    

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

    The format type.

    

  
  :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 that was returned from the previous call to this operation, which you can use 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`

  