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

************************
get_introspection_schema
************************



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

  

  Retrieves the introspection schema for a GraphQL API.

  

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


  **Request Syntax**
  ::

    response = client.get_introspection_schema(
        apiId='string',
        format='SDL'|'JSON',
        includeDirectives=True|False
    )
    
  :type apiId: string
  :param apiId: **[REQUIRED]** 

    The API ID.

    

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

    The schema format: SDL or JSON.

    

  
  :type includeDirectives: boolean
  :param includeDirectives: 

    A flag that specifies whether the schema introspection should contain directives.

    

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

    
    ::

      {
          'schema': StreamingBody()
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **schema** (:class:`.StreamingBody`) -- 

        The schema, in GraphQL Schema Definition Language (SDL) format.

         

        For more information, see the `GraphQL SDL documentation <http://graphql.org/learn/schema/>`__.

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

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

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

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

  