AuroraDSQL / Paginator / ListClusters

ListClusters#

class AuroraDSQL.Paginator.ListClusters#

paginator = client.get_paginator('list_clusters')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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': [
        {
            'identifier': 'string',
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- clusters (list) –
  
  An array of the returned clusters.
  - (dict) –
    
    A summary of the properties of a cluster.
    - identifier (string) –
      
      The ID of the cluster.
    - arn (string) –
      
      The ARN of the cluster.
- NextToken (string) –
  
  A token to resume pagination.