:doc:`IoTSiteWise <../../iotsitewise>` / Client / describe_project

****************
describe_project
****************



.. py:method:: IoTSiteWise.Client.describe_project(**kwargs)

  

  Retrieves information about a project.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeProject>`_  


  **Request Syntax**
  ::

    response = client.describe_project(
        projectId='string'
    )
    
  :type projectId: string
  :param projectId: **[REQUIRED]** 

    The ID of the project.

    

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

    
    ::

      {
          'projectId': 'string',
          'projectArn': 'string',
          'projectName': 'string',
          'portalId': 'string',
          'projectDescription': 'string',
          'projectCreationDate': datetime(2015, 1, 1),
          'projectLastUpdateDate': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **projectId** *(string) --* 

        The ID of the project.

        
      

      - **projectArn** *(string) --* 

        The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the project, which has the following format.

         

        ``arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}``

        
      

      - **projectName** *(string) --* 

        The name of the project.

        
      

      - **portalId** *(string) --* 

        The ID of the portal that the project is in.

        
      

      - **projectDescription** *(string) --* 

        The project's description.

        
      

      - **projectCreationDate** *(datetime) --* 

        The date the project was created, in Unix epoch time.

        
      

      - **projectLastUpdateDate** *(datetime) --* 

        The date the project was last updated, in Unix epoch time.

        
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

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

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

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

  