Braket / Paginator / SearchQuantumTasks


class Braket.Paginator.SearchQuantumTasks#
paginator = client.get_paginator('search_quantum_tasks')

Creates an iterator that will paginate through responses from Braket.Client.search_quantum_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'name': 'string',
            'operator': 'LT'|'LTE'|'EQUAL'|'GT'|'GTE'|'BETWEEN',
            'values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • filters (list) –


    Array of SearchQuantumTasksFilter objects.

    • (dict) –

      A filter to use to search for tasks.

      • name (string) – [REQUIRED]

        The name of the device used for the task.

      • operator (string) – [REQUIRED]

        An operator to use in the filter.

      • values (list) – [REQUIRED]

        The values to use for the filter.

        • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'quantumTasks': [
            'createdAt': datetime(2015, 1, 1),
            'deviceArn': 'string',
            'endedAt': datetime(2015, 1, 1),
            'outputS3Bucket': 'string',
            'outputS3Directory': 'string',
            'quantumTaskArn': 'string',
            'shots': 123,
            'tags': {
                'string': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • quantumTasks (list) –

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

      • (dict) –

        Includes information about a quantum task.

        • createdAt (datetime) –

          The time at which the task was created.

        • deviceArn (string) –

          The ARN of the device the task ran on.

        • endedAt (datetime) –

          The time at which the task finished.

        • outputS3Bucket (string) –

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

        • outputS3Directory (string) –

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

        • quantumTaskArn (string) –

          The ARN of the task.

        • shots (integer) –

          The shots used for the task.

        • status (string) –

          The status of the task.

        • tags (dict) –

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

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.