QiskitRuntimeService.jobs¶

QiskitRuntimeService.jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)[source]¶

Retrieve all runtime jobs, subject to optional filtering.

Parameters:

limit (Optional[int]) – Number of jobs to retrieve. None means no limit.
skip (int) – Starting index for the job retrieval.
backend_name (Optional[str]) – Name of the backend to retrieve jobs from.
pending (Optional[bool]) – Filter by job pending state. If True, ‘QUEUED’ and ‘RUNNING’ jobs are included. If False, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included.
program_id (Optional[str]) – Filter by Program ID.
instance (Optional[str]) – This is only supported for ibm_quantum runtime and is in the hub/group/project format.
job_tags (Optional[List[str]]) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
session_id (Optional[str]) – Job ID of the first job in a runtime session.
created_after (Optional[datetime]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time.
created_before (Optional[datetime]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time.
descending (bool) – If True, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.

Return type:

List[RuntimeJob]

Returns:

A list of runtime jobs.

Raises:

IBMInputValueError – If an input value is invalid.