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

************************
cancel_open_cypher_query
************************



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

  

  Cancels a specified openCypher query. See `Neptune openCypher status endpoint <https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html>`__ for more information.

   

  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\:CancelQuery <https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery>`__ IAM action in that cluster.

  

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


  **Request Syntax**
  ::

    response = client.cancel_open_cypher_query(
        queryId='string',
        silent=True|False
    )
    
  :type queryId: string
  :param queryId: **[REQUIRED]** 

    The unique ID of the openCypher query to cancel.

    

  
  :type silent: boolean
  :param silent: 

    If set to ``TRUE``, causes the cancelation of the openCypher query to happen silently.

    

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

    
    ::

      {
          'status': 'string',
          'payload': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The cancellation status of the openCypher query.

        
      

      - **payload** *(boolean) --* 

        The cancelation payload for the openCypher query.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  