search_quantum_tasks

Braket.Client.search_quantum_tasks(**kwargs)

Searches for tasks that match the specified filter values.

See also: AWS API Documentation

Request Syntax

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

Parameters

• filters (list) --

  [REQUIRED]

  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) --
• maxResults (integer) -- Maximum number of results to return in the response.
• nextToken (string) -- A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • 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 results where the previous request ended.

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

Exceptions

• Braket.Client.exceptions.AccessDeniedException
• Braket.Client.exceptions.ThrottlingException
• Braket.Client.exceptions.InternalServiceException
• Braket.Client.exceptions.ValidationException