Braket / Paginator / SearchQuantumTasks

SearchQuantumTasks

class Braket.Paginator.SearchQuantumTasks

paginator = client.get_paginator('search_quantum_tasks')

paginate(**kwargs)

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(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'operator': 'LT'|'LTE'|'EQUAL'|'GT'|'GTE'|'BETWEEN'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  [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.

• 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:

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 to resume pagination.