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

Class: Aws::Batch::Types::DescribeComputeEnvironmentsRequest

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environmentsArray<String>

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

Returns:

  • (Array<String>)


967
968
969
970
971
972
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 967

class DescribeComputeEnvironmentsRequest < Struct.new(
  :compute_environments,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


967
968
969
970
971
972
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 967

class DescribeComputeEnvironmentsRequest < Struct.new(
  :compute_environments,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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


967
968
969
970
971
972
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 967

class DescribeComputeEnvironmentsRequest < Struct.new(
  :compute_environments,
  :max_results,
  :next_token)
  include Aws::Structure
end