:doc:`CloudTrail <../../cloudtrail>` / Client / list_queries

************
list_queries
************



.. py:method:: CloudTrail.Client.list_queries(**kwargs)

  

  Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for ``EventDataStore``. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding ``StartTime`` and ``EndTime`` parameters, and a ``QueryStatus`` value. Valid values for ``QueryStatus`` include ``QUEUED``, ``RUNNING``, ``FINISHED``, ``FAILED``, ``TIMED_OUT``, or ``CANCELLED``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListQueries>`_  


  **Request Syntax**
  ::

    response = client.list_queries(
        EventDataStore='string',
        NextToken='string',
        MaxResults=123,
        StartTime=datetime(2015, 1, 1),
        EndTime=datetime(2015, 1, 1),
        QueryStatus='QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT'
    )
    
  :type EventDataStore: string
  :param EventDataStore: **[REQUIRED]** 

    The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

    

  
  :type NextToken: string
  :param NextToken: 

    A token you can use to get the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of queries to show on a page.

    

  
  :type StartTime: datetime
  :param StartTime: 

    Use with ``EndTime`` to bound a ``ListQueries`` request, and limit its results to only those queries run within a specified time period.

    

  
  :type EndTime: datetime
  :param EndTime: 

    Use with ``StartTime`` to bound a ``ListQueries`` request, and limit its results to only those queries run within a specified time period.

    

  
  :type QueryStatus: string
  :param QueryStatus: 

    The status of queries that you want to return in results. Valid values for ``QueryStatus`` include ``QUEUED``, ``RUNNING``, ``FINISHED``, ``FAILED``, ``TIMED_OUT``, or ``CANCELLED``.

    

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

    
    ::

      {
          'Queries': [
              {
                  'QueryId': 'string',
                  'QueryStatus': 'QUEUED'|'RUNNING'|'FINISHED'|'FAILED'|'CANCELLED'|'TIMED_OUT',
                  'CreationTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Queries** *(list) --* 

        Lists matching query results, and shows query ID, status, and creation time of each query.

        
        

        - *(dict) --* 

          A SQL string of criteria about events that you want to collect in an event data store.

          
          

          - **QueryId** *(string) --* 

            The ID of a query.

            
          

          - **QueryStatus** *(string) --* 

            The status of the query. This can be ``QUEUED``, ``RUNNING``, ``FINISHED``, ``FAILED``, ``TIMED_OUT``, or ``CANCELLED``.

            
          

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

            The creation time of a query.

            
      
    
      

      - **NextToken** *(string) --* 

        A token you can use to get the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`CloudTrail.Client.exceptions.EventDataStoreARNInvalidException`

  
  *   :py:class:`CloudTrail.Client.exceptions.EventDataStoreNotFoundException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InactiveEventDataStoreException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidDateRangeException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidMaxResultsException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidNextTokenException`

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

  
  *   :py:class:`CloudTrail.Client.exceptions.InvalidQueryStatusException`

  
  *   :py:class:`CloudTrail.Client.exceptions.OperationNotPermittedException`

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

  
  *   :py:class:`CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException`

  