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

***************
describe_entity
***************



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

  

  Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.

   

  The response includes all the fields which make up the entity.

  

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


  **Request Syntax**
  ::

    response = client.describe_entity(
        ConnectionName='string',
        CatalogId='string',
        EntityName='string',
        NextToken='string',
        DataStoreApiVersion='string'
    )
    
  :type ConnectionName: string
  :param ConnectionName: **[REQUIRED]** 

    The name of the connection that contains the connection type credentials.

    

  
  :type CatalogId: string
  :param CatalogId: 

    The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

    

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

    The name of the entity that you want to describe from the connection type.

    

  
  :type NextToken: string
  :param NextToken: 

    A continuation token, included if this is a continuation call.

    

  
  :type DataStoreApiVersion: string
  :param DataStoreApiVersion: 

    The version of the API used for the data store.

    

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

    
    ::

      {
          'Fields': [
              {
                  'FieldName': 'string',
                  'Label': 'string',
                  'Description': 'string',
                  'FieldType': 'INT'|'SMALLINT'|'BIGINT'|'FLOAT'|'LONG'|'DATE'|'BOOLEAN'|'MAP'|'ARRAY'|'STRING'|'TIMESTAMP'|'DECIMAL'|'BYTE'|'SHORT'|'DOUBLE'|'STRUCT'|'BINARY'|'UNION',
                  'IsPrimaryKey': True|False,
                  'IsNullable': True|False,
                  'IsRetrievable': True|False,
                  'IsFilterable': True|False,
                  'IsPartitionable': True|False,
                  'IsCreateable': True|False,
                  'IsUpdateable': True|False,
                  'IsUpsertable': True|False,
                  'IsDefaultOnCreate': True|False,
                  'SupportedValues': [
                      'string',
                  ],
                  'SupportedFilterOperators': [
                      'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'EQUAL_TO'|'NOT_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'CONTAINS'|'ORDER_BY',
                  ],
                  'ParentField': 'string',
                  'NativeDataType': 'string',
                  'CustomProperties': {
                      'string': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Fields** *(list) --* 

        Describes the fields for that connector entity. This is the list of ``Field`` objects. ``Field`` is very similar to column in a database. The ``Field`` object has information about different properties associated with fields in the connector.

        
        

        - *(dict) --* 

          The ``Field`` object has information about the different properties associated with a field in the connector.

          
          

          - **FieldName** *(string) --* 

            A unique identifier for the field.

            
          

          - **Label** *(string) --* 

            A readable label used for the field.

            
          

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

            A description of the field.

            
          

          - **FieldType** *(string) --* 

            The type of data in the field.

            
          

          - **IsPrimaryKey** *(boolean) --* 

            Indicates whether this field can used as a primary key for the given entity.

            
          

          - **IsNullable** *(boolean) --* 

            Indicates whether this field can be nullable or not.

            
          

          - **IsRetrievable** *(boolean) --* 

            Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.

            
          

          - **IsFilterable** *(boolean) --* 

            Indicates whether this field can used in a filter clause ( ``WHERE`` clause) of a SQL statement when querying data.

            
          

          - **IsPartitionable** *(boolean) --* 

            Indicates whether a given field can be used in partitioning the query made to SaaS.

            
          

          - **IsCreateable** *(boolean) --* 

            Indicates whether this field can be created as part of a destination write.

            
          

          - **IsUpdateable** *(boolean) --* 

            Indicates whether this field can be updated as part of a destination write.

            
          

          - **IsUpsertable** *(boolean) --* 

            Indicates whether this field can be upserted as part of a destination write.

            
          

          - **IsDefaultOnCreate** *(boolean) --* 

            Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

            
          

          - **SupportedValues** *(list) --* 

            A list of supported values for the field.

            
            

            - *(string) --* 
        
          

          - **SupportedFilterOperators** *(list) --* 

            Indicates the support filter operators for this field.

            
            

            - *(string) --* 
        
          

          - **ParentField** *(string) --* 

            A parent field name for a nested field.

            
          

          - **NativeDataType** *(string) --* 

            The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

            
          

          - **CustomProperties** *(dict) --* 

            Optional map of keys which may be returned.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **NextToken** *(string) --* 

        A continuation token, present if the current segment is not the last.

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

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

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

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

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

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

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

  