You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Batch::Types::ListJobsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass ListJobsRequest data as a hash:

{
  job_queue: "String",
  array_job_id: "String",
  job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#array_job_idString

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Returns:

  • (String)


1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1711

class ListJobsRequest < Struct.new(
  :job_queue,
  :array_job_id,
  :job_status,
  :max_results,
  :next_token)
  include Aws::Structure
end

#job_queueString

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Returns:

  • (String)


1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1711

class ListJobsRequest < Struct.new(
  :job_queue,
  :array_job_id,
  :job_status,
  :max_results,
  :next_token)
  include Aws::Structure
end

#job_statusString

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Returns:

  • (String)


1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1711

class ListJobsRequest < Struct.new(
  :job_queue,
  :array_job_id,
  :job_status,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1711

class ListJobsRequest < Struct.new(
  :job_queue,
  :array_job_id,
  :job_status,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

  • (String)


1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1711

class ListJobsRequest < Struct.new(
  :job_queue,
  :array_job_id,
  :job_status,
  :max_results,
  :next_token)
  include Aws::Structure
end