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

************************
get_gremlin_query_status
************************



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

  

  Gets the status of a specified Gremlin query.

   

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

   

  Note that the `neptune-db\:QueryLanguage\:Gremlin <https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys>`__ IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see `Condition keys available in Neptune IAM data-access policy statements <https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html>`__).

  

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


  **Request Syntax**
  ::

    response = client.get_gremlin_query_status(
        queryId='string'
    )
    
  :type queryId: string
  :param queryId: **[REQUIRED]** 

    The unique identifier that identifies the Gremlin query.

    

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

    
    ::

      {
          'queryId': 'string',
          'queryString': 'string',
          'queryEvalStats': {
              'waited': 123,
              'elapsed': 123,
              'cancelled': True|False,
              'subqueries': {...}|[...]|123|123.4|'string'|True|None
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **queryId** *(string) --* 

        The ID of the query for which status is being returned.

        
      

      - **queryString** *(string) --* 

        The Gremlin query string.

        
      

      - **queryEvalStats** *(dict) --* 

        The evaluation status of the Gremlin query.

        
        

        - **waited** *(integer) --* 

          Indicates how long the query waited, in milliseconds.

          
        

        - **elapsed** *(integer) --* 

          The number of milliseconds the query has been running so far.

          
        

        - **cancelled** *(boolean) --* 

          Set to ``TRUE`` if the query was cancelled, or FALSE otherwise.

          
        

        - **subqueries** (:ref:`document<document>`) -- 

          The number of subqueries in this query.

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

  
  *   :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.FailureByQueryException`

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

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

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

  
  *   :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`

  