TimestreamInfluxDB / Paginator / ListDbInstancesForCluster

ListDbInstancesForCluster#

class TimestreamInfluxDB.Paginator.ListDbInstancesForCluster#

paginator = client.get_paginator('list_db_instances_for_cluster')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

dbClusterId (string) –
[REQUIRED]

Service-generated unique identifier of the DB cluster.
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'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
            'endpoint': 'string',
            'port': 123,
            'networkType': 'IPV4'|'DUAL',
            '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',
            'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of Timestream for InfluxDB instance summaries belonging to the cluster.
  - (dict) –
    
    Contains a summary of a DB instance belonging to a DB cluster.
    - id (string) –
      
      The service-generated unique identifier of the DB instance.
    - name (string) –
      
      A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.
    - 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.
    - port (integer) –
      
      The port number on which InfluxDB accepts connections.
    - networkType (string) –
      
      Specifies whether the network type of the Timestream for InfluxDB instance is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
    - 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 allocated for your DB storage type in GiB (gibibytes).
    - deploymentType (string) –
      
      Specifies the deployment type if applicable.
    - instanceMode (string) –
      
      Specifies the DB instance’s role in the cluster.
- NextToken (string) –
  
  A token to resume pagination.