Class: Aws::EKS::Types::ListClustersRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EKS::Types::ListClustersRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-eks/types.rb
Overview
When making an API call, you may pass ListClustersRequest data as a hash:
{
max_results: 1,
next_token: "String",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of cluster results returned by `ListClusters` in paginated output.
-
#next_token ⇒ String
The `nextToken` value returned from a previous paginated `ListClusters` request where `maxResults` was used and the results exceeded the value of that parameter.
Instance Attribute Details
#max_results ⇒ Integer
The maximum number of cluster results returned by `ListClusters` in paginated output. When you use this parameter, `ListClusters` returns only `maxResults` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListClusters` request with the returned `nextToken` value. This value can be between 1 and 100. If you don't use this parameter, `ListClusters` returns up to 100 results and a `nextToken` value if applicable.
2230 2231 2232 2233 2234 2235 |
# File 'lib/aws-sdk-eks/types.rb', line 2230 class ListClustersRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
The `nextToken` value returned from a previous paginated `ListClusters` 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.
<note markdown=“1”> This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
</note>
2230 2231 2232 2233 2234 2235 |
# File 'lib/aws-sdk-eks/types.rb', line 2230 class ListClustersRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |