:doc:`Glue <../../glue>` / Client / get_schema

**********
get_schema
**********



.. py:method:: Glue.Client.get_schema(**kwargs)

  

  Describes the specified schema in detail.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetSchema>`_  


  **Request Syntax**
  ::

    response = client.get_schema(
        SchemaId={
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'RegistryName': 'string'
        }
    )
    
  :type SchemaId: dict
  :param SchemaId: **[REQUIRED]** 

    This is a wrapper structure to contain schema identity fields. The structure contains:

     

    
    * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either ``SchemaArn`` or ``SchemaName`` and ``RegistryName`` has to be provided.
     
    * SchemaId$SchemaName: The name of the schema. Either ``SchemaArn`` or ``SchemaName`` and ``RegistryName`` has to be provided.
    

    

  
    - **SchemaArn** *(string) --* 

      The Amazon Resource Name (ARN) of the schema. One of ``SchemaArn`` or ``SchemaName`` has to be provided.

      

    
    - **SchemaName** *(string) --* 

      The name of the schema. One of ``SchemaArn`` or ``SchemaName`` has to be provided.

      

    
    - **RegistryName** *(string) --* 

      The name of the schema registry that contains the schema.

      

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

    
    ::

      {
          'RegistryName': 'string',
          'RegistryArn': 'string',
          'SchemaName': 'string',
          'SchemaArn': 'string',
          'Description': 'string',
          'DataFormat': 'AVRO'|'JSON'|'PROTOBUF',
          'Compatibility': 'NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL',
          'SchemaCheckpoint': 123,
          'LatestSchemaVersion': 123,
          'NextSchemaVersion': 123,
          'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
          'CreatedTime': 'string',
          'UpdatedTime': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RegistryName** *(string) --* 

        The name of the registry.

        
      

      - **RegistryArn** *(string) --* 

        The Amazon Resource Name (ARN) of the registry.

        
      

      - **SchemaName** *(string) --* 

        The name of the schema.

        
      

      - **SchemaArn** *(string) --* 

        The Amazon Resource Name (ARN) of the schema.

        
      

      - **Description** *(string) --* 

        A description of schema if specified when created

        
      

      - **DataFormat** *(string) --* 

        The data format of the schema definition. Currently ``AVRO``, ``JSON`` and ``PROTOBUF`` are supported.

        
      

      - **Compatibility** *(string) --* 

        The compatibility mode of the schema.

        
      

      - **SchemaCheckpoint** *(integer) --* 

        The version number of the checkpoint (the last time the compatibility mode was changed).

        
      

      - **LatestSchemaVersion** *(integer) --* 

        The latest version of the schema associated with the returned schema definition.

        
      

      - **NextSchemaVersion** *(integer) --* 

        The next version of the schema associated with the returned schema definition.

        
      

      - **SchemaStatus** *(string) --* 

        The status of the schema.

        
      

      - **CreatedTime** *(string) --* 

        The date and time the schema was created.

        
      

      - **UpdatedTime** *(string) --* 

        The date and time the schema was updated.

        
  
  **Exceptions**
  
  *   :py:class:`Glue.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Glue.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Glue.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`Glue.Client.exceptions.InternalServiceException`

  