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

Class: Aws::OpsWorks::Types::DescribeEcsClustersRequest

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

Overview

Note:

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

{
  ecs_cluster_arns: ["String"],
  stack_id: "String",
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#ecs_cluster_arnsArray<String>

A list of ARNs, one for each cluster to be described.

Returns:

  • (Array<String>)


2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2847

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

  • (Integer)


2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2847

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (String)


2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2847

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#stack_idString

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Returns:

  • (String)


2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2847

class DescribeEcsClustersRequest < Struct.new(
  :ecs_cluster_arns,
  :stack_id,
  :next_token,
  :max_results)
  include Aws::Structure
end