Skip to content

iter_list_jobs async

iter_list_jobs(
    *,
    config_overrides: Optional[AsyncBatchClientConfig] = None,
    job_queue: Optional[String] = None,
    array_job_id: Optional[String] = None,
    multi_node_job_id: Optional[String] = None,
    job_status: Optional[JobStatus] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
    filters: Optional[ListJobsFilterList] = None,
) -> AsyncIterator[JobSummary]
Source code in docs_src/capo_batch/_services/async_batch.py
async def iter_list_jobs(
    self,
    *,
    config_overrides: Optional[AsyncBatchClientConfig] = None,
    job_queue: Optional["capo_batch.types.string.String"] = None,
    array_job_id: Optional["capo_batch.types.string.String"] = None,
    multi_node_job_id: Optional["capo_batch.types.string.String"] = None,
    job_status: Optional["capo_batch.types.job_status.JobStatus"] = None,
    max_results: Optional["capo_batch.types.integer.Integer"] = None,
    next_token: Optional["capo_batch.types.string.String"] = None,
    filters: Optional[
        "capo_batch.types.list_jobs_filter_list.ListJobsFilterList"
    ] = None,
) -> "AsyncIterator[capo_batch.types.job_summary.JobSummary]":
    _token = next_token
    while True:
        _response = await self.list_jobs(
            config_overrides=config_overrides,
            job_queue=job_queue,
            array_job_id=array_job_id,
            multi_node_job_id=multi_node_job_id,
            job_status=job_status,
            max_results=max_results,
            next_token=_token,
            filters=filters,
        )
        _page = _resolve_path(_response, ("job_summary_list",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break