/AWS1/CL_BTC=>LISTJOBS()
¶
About ListJobs¶
Returns a list of Batch jobs.
You must specify only one of the following items:
-
A job queue ID to return a list of jobs in that job queue
-
A multi-node parallel job ID to return a list of nodes for that job
-
An array job ID to return a list of the children for that job
You can filter the results by job status with the jobStatus
parameter. If you
don't specify a status, only RUNNING
jobs are returned.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_JOBQUEUE
TYPE /AWS1/BTCSTRING
/AWS1/BTCSTRING
¶
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
IV_ARRAYJOBID
TYPE /AWS1/BTCSTRING
/AWS1/BTCSTRING
¶
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
IV_MULTINODEJOBID
TYPE /AWS1/BTCSTRING
/AWS1/BTCSTRING
¶
The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
IV_JOBSTATUS
TYPE /AWS1/BTCJOBSTATUS
/AWS1/BTCJOBSTATUS
¶
The job status used to filter jobs in the specified queue. If the
filters
parameter is specified, thejobStatus
parameter is ignored and jobs with any status are returned. If you don't specify a status, onlyRUNNING
jobs are returned.
IV_MAXRESULTS
TYPE /AWS1/BTCINTEGER
/AWS1/BTCINTEGER
¶
The maximum number of results returned by
ListJobs
in a paginated output. When this parameter is used,ListJobs
returns up tomaxResults
results in a single page and anextToken
response element, if applicable. The remaining results of the initial request can be seen by sending anotherListJobs
request with the returnednextToken
value.The following outlines key parameters and limitations:
The minimum value is 1.
When
--job-status
is used, Batch returns up to 1000 values.When
--filters
is used, Batch returns up to 100 values.If neither parameter is used, then
ListJobs
returns up to 1000 results (jobs that are in theRUNNING
status) and anextToken
value, if applicable.
IV_NEXTTOKEN
TYPE /AWS1/BTCSTRING
/AWS1/BTCSTRING
¶
The
nextToken
value returned from a previous paginatedListJobs
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
IT_FILTERS
TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LISTJOBSFILTERLIST
TT_LISTJOBSFILTERLIST
¶
The filter to apply to the query. Only one filter can be used at a time. When the filter is used,
jobStatus
is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by thecreatedAt
field, with the most recent jobs being first.
- JOB_NAME
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (), the filter matches any job name that begins with the string before the ''. This corresponds to the
jobName
value. For example,test1
matches bothTest1
andtest1
, andtest1
matches bothtest1
andTest10
. When theJOB_NAME
filter is used, the results are grouped by the job name and version.- JOB_DEFINITION
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the
jobDefinition
value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (), the filter matches any job definition name that begins with the string before the ''. For example,jd1
matches onlyjd1
, andjd1
matches bothjd1
andjd1A
. The version of the job definition that's used doesn't affect the sort order. When theJOB_DEFINITION
filter is used and the ARN is used (which is in the formarn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.- BEFORE_CREATED_AT
The value for the filter is the time that's before the job was created. This corresponds to the
createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.- AFTER_CREATED_AT
The value for the filter is the time that's after the job was created. This corresponds to the
createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.