DocDBElastic / Paginator / ListClusters


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

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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': [
            'clusterArn': 'string',
            'clusterName': 'string',
    'NextToken': 'string'

Response Structure

  • (dict) –

    • clusters (list) –

      A list of Amazon DocumentDB elastic clusters.

      • (dict) –

        A list of Amazon DocumentDB elastic clusters.

        • clusterArn (string) –

          The ARN identifier of the elastic cluster.

        • clusterName (string) –

          The name of the elastic cluster.

        • status (string) –

          The status of the elastic cluster.

    • NextToken (string) –

      A token to resume pagination.