class EKS.Paginator.ListClusters
paginator = client.get_paginator('list_clusters')

Creates an iterator that will paginate through responses from EKS.Client.list_clusters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • include (list) --

    Indicates whether external clusters are included in the returned list. Use ' all ' to return 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



Response Syntax

    'clusters': [
    'NextToken': 'string'

Response Structure

  • (dict) --

    • clusters (list) --

      A list of all of the clusters for your account in the specified Region.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.