AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ECS::Types::DescribeCapacityProvidersRequest

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

Overview

Note:

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

{
  capacity_providers: ["String"],
  include: ["TAGS"], # accepts TAGS
  max_results: 1,
  next_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_providersArray<String>

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Returns:

  • (Array<String>)


4001
4002
4003
4004
4005
4006
4007
4008
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4001

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

#includeArray<String>

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Returns:

  • (Array<String>)


4001
4002
4003
4004
4005
4006
4007
4008
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4001

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

#max_resultsInteger

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

Returns:

  • (Integer)


4001
4002
4003
4004
4005
4006
4007
4008
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4001

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

#next_tokenString

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


4001
4002
4003
4004
4005
4006
4007
4008
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4001

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