Class: Aws::Batch::Types::ListJobsByConsumableResourceRequest

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::ListJobsByConsumableResourceRequest

Defined in:

gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consumable_resource ⇒ String

  The name or ARN of the consumable resource.

• #filters ⇒ Array<Types::KeyValuesPair>

  The filters to apply to the job list query.

• #max_results ⇒ Integer

  The maximum number of results returned by ListJobsByConsumableResource in paginated output.

• #next_token ⇒ String

  The nextToken value returned from a previous paginated ListJobsByConsumableResource request where maxResults was used and the results exceeded the value of that parameter.

Instance Attribute Details

#consumable_resource ⇒ String

The name or ARN of the consumable resource.

Returns:

• (String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7415

class ListJobsByConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::KeyValuesPair>

The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

• name: JOB_STATUS

  values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED

• name: JOB_NAME

  The values are case-insensitive matches for the job name. If a filter value ends with an asterisk (), it matches any job name that begins with the string before the ''.

Returns:

• (Array<Types::KeyValuesPair>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7415

class ListJobsByConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results returned by ListJobsByConsumableResource in paginated output. When this parameter is used, ListJobsByConsumableResource 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 ListJobsByConsumableResource request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobsByConsumableResource returns up to 100 results and a nextToken value if applicable.

Returns:

• (Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7415

class ListJobsByConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The nextToken value returned from a previous paginated ListJobsByConsumableResource 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.

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.

Returns:

• (String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7415

class ListJobsByConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end