ListDbInstancesForClusterCommand

Suggest an Edit

Returns a list of Timestream for InfluxDB clusters.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TimestreamInfluxDBClient, ListDbInstancesForClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
// const { TimestreamInfluxDBClient, ListDbInstancesForClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
const client = new TimestreamInfluxDBClient(config);
const input = { // ListDbInstancesForClusterInput
  dbClusterId: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListDbInstancesForClusterCommand(input);
const response = await client.send(command);
// { // ListDbInstancesForClusterOutput
//   items: [ // DbInstanceForClusterSummaryList // required
//     { // DbInstanceForClusterSummary
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       arn: "STRING_VALUE", // required
//       status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE",
//       endpoint: "STRING_VALUE",
//       port: Number("int"),
//       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: Number("int"),
//       deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY",
//       instanceMode: "PRIMARY" || "STANDBY" || "REPLICA",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListDbInstancesForClusterCommand Input

See ListDbInstancesForClusterCommandInput for more details

Parameter
Type
Description
dbClusterId
Required
string | undefined

Service-generated unique identifier of the DB cluster.

maxResults
number | undefined

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.

nextToken
string | undefined

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

ListDbInstancesForClusterCommand Output

See ListDbInstancesForClusterCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
Required
DbInstanceForClusterSummary[] | undefined

A list of Timestream for InfluxDB instance summaries belonging to the cluster.

nextToken
string | undefined

Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The requested resource was not found or does not exist.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by Timestream for InfluxDB.

TimestreamInfluxDBServiceException
Base exception class for all service exceptions from TimestreamInfluxDB service.