Searching AWS Batch jobs in a job queue
You can search and filter your jobs in AWS Batch using Job search. This feature provides an option to search within a pre-existing job queue and filter its jobs by one of five options (Created after, Created before, Job name, Job definition, and Status). For the process to use this feature, complete the Search and filter AWS Batch jobs procedure.
To search using multiple criteria simultaneously, use the Beta Job search feature. For example, you can include any or all of the following filters: Job status, Date range, and Additional criteria (such as, a job name, job definition, or job ID). For the process to use this feature, see the (Beta) Search and filter AWS Batch jobs procedure.
Search and filter AWS Batch jobs
Use this procedure to list all the jobs in a job queue in the AWS Batch console. Optionally, use the Filter type dropdown list to narrow the results based on the criteria you specify.
-
Navigate to the AWS Batch console
. -
In the Navigation pane, choose Jobs.
-
Expand the Job queue dropdown list and choose the job queue that you want to search within.
Note
You can search for jobs within only one job queue at a time.
-
(Optional) Choose the filter type you want to apply.
-
Created after: Returns jobs created after a specific date and time (in UTC). If you select this option, two filter value fields appear where you can specify the earliest date and time that the search will return.
-
Created before: Returns jobs created before a specific date and time (in UTC). If you select this option, two filter value fields appear where you can specify the latest date and time that the search will return.
-
Job definition: Returns jobs created with a specific job definition name. If you select this option, a field appears where you can specify a job’s complete or partial definition (if you add an asterisk (*) at the end, the filter matches any job definition that begins with the string before the asterisk).
-
Job name: Returns jobs that have a specific job name. If you select this option, a field appears where you can specify a job’s complete or partial name (if you add an asterisk (*) at the end, the filter matches any job name that begins with the string before the asterisk).
-
Status: Returns jobs that have the selected job status. If you select this option, a dropdown list appears for you to expand and select a specific status. For more information, see Job states.
-
-
(Optional) Choose Load all jobs to return all jobs within a job queue in the last seven days and without the previous filters. If you choose this option, the following message appears:
Note
AWS Batch now stores seven (7) days of job history. Choosing to load all jobs will increase the time it takes to access your jobs and start searching and filtering. Using a filter type instead will provide more immediate results. Are you sure you want to load all jobs.
A Choose Confirm to close the message.
-
If you choose this option, a dropdown list appears where you can choose similar filter options: Status, Job name, and Job ID. If you choose one of these options, you can further filter your search criteria where the specified filter is equal to, is not equal to, contains, or does not contain the criteria you enter.
-
-
When the options are complete, choose Search.
(Beta) Search and filter AWS Batch jobs
Use this procedure to list all the jobs in a job queue in the AWS Batch console and using the beta search features. Optionally, use the Search options section to narrow the results based on the criteria you specify. This beta search feature allows you to combine search criteria to narrow the results. However, you can define only one criteria per filter.
-
Navigate to the AWS Batch console
. -
In the Navigation pane, choose Jobs.
-
Ensure that the Search jobs - beta option is active.
-
Expand the Job queue dropdown list and choose the job queue that you want to search within.
Note
You can search for jobs within only one job queue at a time.
-
(Optional) Expand the Job status dropdown list and select one or more job states. For more information, see Job states.
-
(Optional) Choose Date range to filter the results based on a date and time range.
-
Choose Relative mode to search for jobs that ran within a time range counting backwards from the current date and time.
-
Choose Absolute mode to search for jobs that ran within a date and time range that you specify.
-
-
(Optional) In the Additional criteria field, enter keywords to include in the search results. For example, you can use this field to search by job name, job definition, or job ID. Depending on the property, there may be additional operators, such as equals (=) or starts with (^) that you must define.
-
When the options are complete, choose Search.
Tip
You can choose the settings icon to customize column that appear and their order in the Search results table.