You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Batch::Types::ListJobsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Batch::Types::ListJobsRequest
- Defined in:
- (unknown)
Overview
When passing ListJobsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
job_queue: "String",
array_job_id: "String",
multi_node_job_id: "String",
job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
max_results: 1,
next_token: "String",
}
Instance Attribute Summary collapse
-
#array_job_id ⇒ String
The job ID for an array job.
-
#job_queue ⇒ String
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
-
#job_status ⇒ String
The job status with which to filter jobs in the specified queue.
-
#max_results ⇒ Integer
The maximum number of results returned by
ListJobs
in paginated output. -
#multi_node_job_id ⇒ String
The job ID for a multi-node parallel job.
-
#next_token ⇒ String
The
nextToken
value returned from a previous paginatedListJobs
request wheremaxResults
was used and the results exceeded the value of that parameter.
Instance Attribute Details
#array_job_id ⇒ String
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
#job_queue ⇒ String
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
#job_status ⇒ String
The job status with which to filter jobs in the specified queue. If you
do not specify a status, only RUNNING
jobs are returned.
Possible values:
- SUBMITTED
- PENDING
- RUNNABLE
- STARTING
- RUNNING
- SUCCEEDED
- FAILED
#max_results ⇒ Integer
The maximum number of results returned by ListJobs
in paginated
output. When this parameter is used, ListJobs
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListJobs
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter is not used, then
ListJobs
returns up to 100 results and a nextToken
value if
applicable.
#multi_node_job_id ⇒ String
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.
#next_token ⇒ String
The nextToken
value returned from a previous paginated ListJobs
request where maxResults
was used and the results exceeded the value
of that parameter. Pagination continues from the end of the previous
results that returned the nextToken
value. This value is null
when
there are no more results to return.