:doc:`TimestreamInfluxDB <../../timestream-influxdb>` / Client / list_db_instances

*****************
list_db_instances
*****************



.. py:method:: TimestreamInfluxDB.Client.list_db_instances(**kwargs)

  

  Returns a list of Timestream for InfluxDB DB instances.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstances>`_  


  **Request Syntax**
  ::

    response = client.list_db_instances(
        nextToken='string',
        maxResults=123
    )
    
  :type nextToken: string
  :param nextToken: 

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    

  
  :type maxResults: integer
  :param maxResults: 

    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 argument of a subsequent API invocation.

    

  
  
  :rtype: 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'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED',
                  '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'|'db.influx.24xlarge',
                  '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 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.

            
          

          - **port** *(integer) --* 

            The port number on which InfluxDB accepts connections.

            
          

          - **networkType** *(string) --* 

            Specifies whether the networkType 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 to allocate for your DbStorageType in GiB (gibibytes).

            
          

          - **deploymentType** *(string) --* 

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

            
      
    
      

      - **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**
  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ValidationException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.InternalServerException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`TimestreamInfluxDB.Client.exceptions.ThrottlingException`

  