:doc:`Personalize <../../personalize>` / Client / describe_schema

***************
describe_schema
***************



.. py:method:: Personalize.Client.describe_schema(**kwargs)

  

  Describes a schema. For more information on schemas, see `CreateSchema <https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema>`_  


  **Request Syntax**
  ::

    response = client.describe_schema(
        schemaArn='string'
    )
    
  :type schemaArn: string
  :param schemaArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the schema to retrieve.

    

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

    
    ::

      {
          'schema': {
              'name': 'string',
              'schemaArn': 'string',
              'schema': 'string',
              'creationDateTime': datetime(2015, 1, 1),
              'lastUpdatedDateTime': datetime(2015, 1, 1),
              'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **schema** *(dict) --* 

        The requested schema.

        
        

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

          The name of the schema.

          
        

        - **schemaArn** *(string) --* 

          The Amazon Resource Name (ARN) of the schema.

          
        

        - **schema** *(string) --* 

          The schema.

          
        

        - **creationDateTime** *(datetime) --* 

          The date and time (in Unix time) that the schema was created.

          
        

        - **lastUpdatedDateTime** *(datetime) --* 

          The date and time (in Unix time) that the schema was last updated.

          
        

        - **domain** *(string) --* 

          The domain of a schema that you created for a dataset in a Domain dataset group.

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

  
  *   :py:class:`Personalize.Client.exceptions.ResourceNotFoundException`

  