TimestreamInfluxDB / Client / list_db_instances_for_cluster

list_db_instances_for_cluster¶

TimestreamInfluxDB.Client.list_db_instances_for_cluster(**kwargs)¶

Returns a list of Timestream for InfluxDB clusters.

Request Syntax

response = client.list_db_instances_for_cluster(
    dbClusterId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

dbClusterId (string) –
[REQUIRED]

Service-generated unique identifier of the DB cluster.
nextToken (string) – The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
maxResults (integer) – The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

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) –
  
  Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.

Exceptions

TimestreamInfluxDB.Client.exceptions.ValidationException
TimestreamInfluxDB.Client.exceptions.AccessDeniedException
TimestreamInfluxDB.Client.exceptions.InternalServerException
TimestreamInfluxDB.Client.exceptions.ResourceNotFoundException
TimestreamInfluxDB.Client.exceptions.ThrottlingException