TimestreamInfluxDB / Client / list_db_instances

list_db_instances#

TimestreamInfluxDB.Client.list_db_instances(**kwargs)#

Returns a list of Timestream for InfluxDB DB instances.

Request Syntax

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

Parameters:

nextToken (string) – The pagination token. To resume pagination, provide the NextToken value as 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 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,
            '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.
    - port (integer) –
      
      The port number on which InfluxDB accepts connections.
    - 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

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