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

Class: Aws::Batch::Types::DescribeJobQueuesRequest

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 DescribeJobQueuesRequest data as a hash:

{
  job_queues: ["String"],
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_queuesArray<String>

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Returns:

  • (Array<String>)


1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1118

class DescribeJobQueuesRequest < Struct.new(
  :job_queues,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1118

class DescribeJobQueuesRequest < Struct.new(
  :job_queues,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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


1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1118

class DescribeJobQueuesRequest < Struct.new(
  :job_queues,
  :max_results,
  :next_token)
  include Aws::Structure
end