TimestreamInfluxDB / Paginator / ListDbClusters

ListDbClusters

class TimestreamInfluxDB.Paginator.ListDbClusters

paginator = client.get_paginator('list_db_clusters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TimestreamInfluxDB.Client.list_db_clusters().

See also: AWS API Documentation

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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED',
            'endpoint': 'string',
            'readerEndpoint': 'string',
            'port': 123,
            'deploymentType': 'MULTI_NODE_READ_REPLICAS',
            'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
            'networkType': 'IPV4'|'DUAL',
            'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
            'allocatedStorage': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of Timestream for InfluxDB cluster summaries.

    • (dict) –

      Describes a summary of a Timestream for InfluxDB cluster.

      • id (string) –

        Service-generated unique identifier of the DB cluster to retrieve.

      • name (string) –

        Customer supplied name of the Timestream for InfluxDB cluster.

      • arn (string) –

        The Amazon Resource Name (ARN) of the DB cluster.

      • status (string) –

        The status of the DB cluster.

      • endpoint (string) –

        The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

      • readerEndpoint (string) –

        The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

      • port (integer) –

        The port number on which InfluxDB accepts connections.

      • deploymentType (string) –

        Deployment type of the DB cluster

      • dbInstanceType (string) –

        The Timestream for InfluxDB DB instance type that InfluxDB runs on.

      • networkType (string) –

        Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

      • dbStorageType (string) –

        The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

      • allocatedStorage (integer) –

        The amount of storage allocated for your DB storage type (in gibibytes).

  • NextToken (string) –

    A token to resume pagination.