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

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

Overview

Contains the parameters for DescribeComputeEnvironments.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environments ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2918
2919
2920
2921
2922
2923
2924
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2918

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

#max_results ⇒ Integer

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 isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Returns:

  • (Integer) 


2918
2919
2920
2921
2922
2923
2924
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2918

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

#next_token ⇒ String

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.

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) 


2918
2919
2920
2921
2922
2923
2924
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2918

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