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

***************
update_notebook
***************



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

  

  Updates the contents of a Spark notebook.

  

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


  **Request Syntax**
  ::

    response = client.update_notebook(
        NotebookId='string',
        Payload='string',
        Type='IPYNB',
        SessionId='string',
        ClientRequestToken='string'
    )
    
  :type NotebookId: string
  :param NotebookId: **[REQUIRED]** 

    The ID of the notebook to update.

    

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

    The updated content for the notebook.

    

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

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

    

  
  :type SessionId: string
  :param SessionId: 

    The active notebook session ID. Required if the notebook has an active session.

    

  
  :type ClientRequestToken: string
  :param ClientRequestToken: 

    A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

     

    .. warning::

       

      This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

      

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Athena.Client.exceptions.InternalServerException`

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

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

  