:doc:`Athena <../../athena>` / Client / get_notebook_metadata

*********************
get_notebook_metadata
*********************



.. py:method:: Athena.Client.get_notebook_metadata(**kwargs)

  

  Retrieves notebook metadata for the specified notebook ID.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNotebookMetadata>`_  


  **Request Syntax**
  ::

    response = client.get_notebook_metadata(
        NotebookId='string'
    )
    
  :type NotebookId: string
  :param NotebookId: **[REQUIRED]** 

    The ID of the notebook whose metadata is to be retrieved.

    

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

    
    ::

      {
          'NotebookMetadata': {
              'NotebookId': 'string',
              'Name': 'string',
              'WorkGroup': 'string',
              'CreationTime': datetime(2015, 1, 1),
              'Type': 'IPYNB',
              'LastModifiedTime': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NotebookMetadata** *(dict) --* 

        The metadata that is returned for the specified notebook ID.

        
        

        - **NotebookId** *(string) --* 

          The notebook ID.

          
        

        - **Name** *(string) --* 

          The name of the notebook.

          
        

        - **WorkGroup** *(string) --* 

          The name of the Spark enabled workgroup to which the notebook belongs.

          
        

        - **CreationTime** *(datetime) --* 

          The time when the notebook was created.

          
        

        - **Type** *(string) --* 

          The type of notebook. Currently, the only valid type is ``IPYNB``.

          
        

        - **LastModifiedTime** *(datetime) --* 

          The time when the notebook was last modified.

          
    
  
  **Exceptions**
  
  *   :py:class:`Athena.Client.exceptions.InternalServerException`

  
  *   :py:class:`Athena.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Athena.Client.exceptions.TooManyRequestsException`

  