Class: Aws::Batch::Types::ListJobsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Batch::Types::ListJobsRequest
- Defined in:
- gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb
Overview
Contains the parameters for ListJobs
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#array_job_id ⇒ String
The job ID for an array job.
-
#filters ⇒ Array<Types::KeyValuesPair>
The filter to apply to the query.
-
#job_queue ⇒ String
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
-
#job_status ⇒ String
The job status used 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.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |
#filters ⇒ Array<Types::KeyValuesPair>
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 the createdAt
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.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |
#job_queue ⇒ String
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |
#job_status ⇒ String
The job status used to filter jobs in the specified queue. If the
filters
parameter is specified, the jobStatus
parameter is
ignored and jobs with any status are returned. If you don't specify
a status, only RUNNING
jobs are returned.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |
#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 and 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 isn't
used, then ListJobs
returns up to 100 results and a nextToken
value if applicable.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |
#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.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |
#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.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 5544 class ListJobsRequest < Struct.new( :job_queue, :array_job_id, :multi_node_job_id, :job_status, :max_results, :next_token, :filters) SENSITIVE = [] include Aws::Structure end |