Use ListJobs with an AWS SDK or CLI

Example 1: To list running jobs

The following list-jobs example lists the running jobs in the HighPriority job queue.

aws batch list-jobs \
    --job-queue HighPriority

Output:

{
    "jobSummaryList": [
        {
            "jobName": "example",
            "jobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        }
    ]
}

For more information, see Job states in the AWS Batch User Guide.

Example 2: To list submitted jobs

The following list-jobs example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.

aws batch list-jobs \
    --job-queue HighPriority \
    --job-status SUBMITTED

Output:

{
    "jobSummaryList": [
        {
            "jobName": "example",
            "jobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
        }
    ]
}

For more information, see Job states in the AWS Batch User Guide.

    def list_jobs(self, job_queue: str, job_status: str = "SUCCEEDED") -> list:
        """
        Lists jobs in a job queue with a specific status.

        :param job_queue: The job queue name or ARN.
        :param job_status: The job status to filter by (default SUCCEEDED).
        :return: A list of job summary dictionaries.
        """
        try:
            paginator = self.batch_client.get_paginator("list_jobs")
            job_summaries = []
            for page in paginator.paginate(jobQueue=job_queue, jobStatus=job_status):
                job_summaries.extend(page.get("jobSummaryList", []))
            logger.info(
                "Listed %d %s job(s) in queue %s.",
                len(job_summaries),
                job_status,
                job_queue,
            )
            return job_summaries
        except ClientError as err:
            logger.error(
                "Error listing jobs in queue %s: %s",
                job_queue,
                err.response["Error"]["Message"],
            )
            raise