:doc:`MarketplaceCatalog <../../marketplace-catalog>` / Client / describe_entity

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



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

  

  Returns the metadata and content of the entity.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeEntity>`_  


  **Request Syntax**
  ::

    response = client.describe_entity(
        Catalog='string',
        EntityId='string'
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

    Required. The catalog related to the request. Fixed value: ``AWSMarketplace``

    

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

    Required. The unique ID of the entity to describe.

    

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

    
    ::

      {
          'EntityType': 'string',
          'EntityIdentifier': 'string',
          'EntityArn': 'string',
          'LastModifiedDate': 'string',
          'Details': 'string',
          'DetailsDocument': {...}|[...]|123|123.4|'string'|True|None
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EntityType** *(string) --* 

        The named type of the entity, in the format of ``EntityType@Version``.

        
      

      - **EntityIdentifier** *(string) --* 

        The identifier of the entity, in the format of ``EntityId@RevisionId``.

        
      

      - **EntityArn** *(string) --* 

        The ARN associated to the unique identifier for the entity referenced in this request.

        
      

      - **LastModifiedDate** *(string) --* 

        The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).

        
      

      - **Details** *(string) --* 

        This stringified JSON object includes the details of the entity.

        
      

      - **DetailsDocument** (:ref:`document<document>`) -- 

        The JSON value of the details specific to the entity.

         

        To download "DetailsDocument" shapes, see the `Python <https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python>`__ and `Java <https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main>`__ shapes on GitHub.

        
  
  **Exceptions**
  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.InternalServiceException`

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

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

  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.ResourceNotSupportedException`

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

  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.ThrottlingException`

  