:doc:`Braket <../../braket>` / Client / search_quantum_tasks

********************
search_quantum_tasks
********************



.. py:method:: Braket.Client.search_quantum_tasks(**kwargs)

  

  Searches for tasks that match the specified filter values.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasks>`_  


  **Request Syntax**
  ::

    response = client.search_quantum_tasks(
        nextToken='string',
        maxResults=123,
        filters=[
            {
                'name': 'string',
                'values': [
                    'string',
                ],
                'operator': 'LT'|'LTE'|'EQUAL'|'GT'|'GTE'|'BETWEEN'
            },
        ]
    )
    
  :type nextToken: string
  :param nextToken: 

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

    

  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of results to return in the response.

    

  
  :type filters: list
  :param filters: **[REQUIRED]** 

    Array of ``SearchQuantumTasksFilter`` objects to use when searching for quantum tasks.

    

  
    - *(dict) --* 

      A filter used to search for quantum tasks.

      

    
      - **name** *(string) --* **[REQUIRED]** 

        The name of the quantum task parameter to filter based on. Filter name can be either ``quantumTaskArn``, ``deviceArn``, ``jobArn``, ``status`` or ``createdAt``.

        

      
      - **values** *(list) --* **[REQUIRED]** 

        The values used to filter quantum tasks based on the filter name and operator.

        

      
        - *(string) --* 

        
    
      - **operator** *(string) --* **[REQUIRED]** 

        An operator to use for the filter.

        

      
    

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

    
    ::

      {
          'quantumTasks': [
              {
                  'quantumTaskArn': 'string',
                  'status': 'CREATED'|'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
                  'deviceArn': 'string',
                  'shots': 123,
                  'outputS3Bucket': 'string',
                  'outputS3Directory': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'endedAt': datetime(2015, 1, 1),
                  'tags': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **quantumTasks** *(list) --* 

        An array of ``QuantumTaskSummary`` objects for quantum tasks that match the specified filters.

        
        

        - *(dict) --* 

          Includes information about a quantum task.

          
          

          - **quantumTaskArn** *(string) --* 

            The ARN of the quantum task.

            
          

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

            The status of the quantum task.

            
          

          - **deviceArn** *(string) --* 

            The ARN of the device the quantum task ran on.

            
          

          - **shots** *(integer) --* 

            The shots used for the quantum task.

            
          

          - **outputS3Bucket** *(string) --* 

            The S3 bucket where the quantum task result file is stored.

            
          

          - **outputS3Directory** *(string) --* 

            The folder in the S3 bucket where the quantum task result file is stored.

            
          

          - **createdAt** *(datetime) --* 

            The time at which the quantum task was created.

            
          

          - **endedAt** *(datetime) --* 

            The time at which the quantum task finished.

            
          

          - **tags** *(dict) --* 

            Displays the key, value pairs of tags associated with this quantum task.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **nextToken** *(string) --* 

        A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.

        
  
  **Exceptions**
  
  *   :py:class:`Braket.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Braket.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Braket.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Braket.Client.exceptions.ValidationException`

  