EKS / Paginator / ListClusters
ListClusters#
- class EKS.Paginator.ListClusters#
paginator = client.get_paginator('list_clusters')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
EKS.Client.list_clusters()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( include=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
include (list) –
Indicates whether external clusters are included in the returned list. Use ‘
all
’ to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html <https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html>`__connected clusters, or blank to return only Amazon EKS clusters. ‘ ``all`’ must be in lowercase otherwise an error occurs.(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'clusters': [ 'string', ], 'NextToken': 'string' }
Response Structure
(dict) –
clusters (list) –
A list of all of the clusters for your account in the specified Amazon Web Services Region.
(string) –
NextToken (string) –
A token to resume pagination.