:doc:`NeptuneData <../../neptunedata>` / Client / execute_fast_reset

******************
execute_fast_reset
******************



.. py:method:: NeptuneData.Client.execute_fast_reset(**kwargs)

  

  The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.

   

  Neptune fast reset is a two-step process. First you call ``ExecuteFastReset`` with ``action`` set to ``initiateDatabaseReset``. This returns a UUID token which you then include when calling ``ExecuteFastReset`` again with ``action`` set to ``performDatabaseReset``. See `Empty an Amazon Neptune DB cluster using the fast reset API <https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html>`__.

   

  When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the `neptune-db\:ResetDatabase <https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase>`__ IAM action in that cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteFastReset>`_  


  **Request Syntax**
  ::

    response = client.execute_fast_reset(
        action='initiateDatabaseReset'|'performDatabaseReset',
        token='string'
    )
    
  :type action: string
  :param action: **[REQUIRED]** 

    The fast reset action. One of the following values:

     

    
    * ``initiateDatabaseReset``   – This action generates a unique token needed to actually perform the fast reset.
     
    * ``performDatabaseReset``   – This action uses the token generated by the ``initiateDatabaseReset`` action to actually perform the fast reset.
    

    

  
  :type token: string
  :param token: 

    The fast-reset token to initiate the reset.

    

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

    
    ::

      {
          'status': 'string',
          'payload': {
              'token': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **status** *(string) --* 

        The ``status`` is only returned for the ``performDatabaseReset`` action, and indicates whether or not the fast reset rquest is accepted.

        
      

      - **payload** *(dict) --* 

        The ``payload`` is only returned by the ``initiateDatabaseReset`` action, and contains the unique token to use with the ``performDatabaseReset`` action to make the reset occur.

        
        

        - **token** *(string) --* 

          A UUID generated by the database in the ``initiateDatabaseReset`` action, and then consumed by the ``performDatabaseReset`` to reset the database.

          
    
  
  **Exceptions**
  
  *   :py:class:`NeptuneData.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ClientTimeoutException`

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

  
  *   :py:class:`NeptuneData.Client.exceptions.IllegalArgumentException`

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

  
  *   :py:class:`NeptuneData.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`NeptuneData.Client.exceptions.PreconditionsFailedException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ServerShutdownException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ReadOnlyViolationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ConstraintViolationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`NeptuneData.Client.exceptions.MissingParameterException`

  