TimestreamInfluxDB / Paginator / ListDbInstances


class TimestreamInfluxDB.Paginator.ListDbInstances#
paginator = client.get_paginator('list_db_instances')

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

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

    'items': [
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'endpoint': 'string',
            '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',
            'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
            'allocatedStorage': 123,
            'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • items (list) –

      A list of Timestream for InfluxDB DB instance summaries.

      • (dict) –

        Contains a summary of a DB instance.

        • id (string) –

          The service-generated unique identifier of the DB instance.

        • name (string) –

          This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.

        • arn (string) –

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

        • status (string) –

          The status of the DB instance.

        • endpoint (string) –

          The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

        • dbInstanceType (string) –

          The Timestream for InfluxDB instance type to run InfluxDB on.

        • dbStorageType (string) –

          The storage type for your DB instance.

        • allocatedStorage (integer) –

          The amount of storage to allocate for your DbStorageType in GiB (gibibytes).

        • deploymentType (string) –

          Single-Instance or with a MultiAZ Standby for High availability.

    • NextToken (string) –

      A token to resume pagination.