@aws-sdk/client-timestream-influxdb 3.744.0 → 3.750.0

package/dist-types/commands/GetDbClusterCommand.d.ts

@@ -0,0 +1,113 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetDbClusterInput, GetDbClusterOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TimestreamInfluxDBClientResolvedConfig } from "../TimestreamInfluxDBClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetDbClusterCommand}.
+ */
+export interface GetDbClusterCommandInput extends GetDbClusterInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetDbClusterCommand}.
+ */
+export interface GetDbClusterCommandOutput extends GetDbClusterOutput, __MetadataBearer {
+}
+declare const GetDbClusterCommand_base: {
+    new (input: GetDbClusterCommandInput): import("@smithy/smithy-client").CommandImpl<GetDbClusterCommandInput, GetDbClusterCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetDbClusterCommandInput): import("@smithy/smithy-client").CommandImpl<GetDbClusterCommandInput, GetDbClusterCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves information about a Timestream for InfluxDB cluster.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TimestreamInfluxDBClient, GetDbClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
+ * // const { TimestreamInfluxDBClient, GetDbClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
+ * const client = new TimestreamInfluxDBClient(config);
+ * const input = { // GetDbClusterInput
+ *   dbClusterId: "STRING_VALUE", // required
+ * };
+ * const command = new GetDbClusterCommand(input);
+ * const response = await client.send(command);
+ * // { // GetDbClusterOutput
+ * //   id: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   arn: "STRING_VALUE", // required
+ * //   status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED",
+ * //   endpoint: "STRING_VALUE",
+ * //   readerEndpoint: "STRING_VALUE",
+ * //   port: Number("int"),
+ * //   deploymentType: "MULTI_NODE_READ_REPLICAS",
+ * //   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",
+ * //   networkType: "IPV4" || "DUAL",
+ * //   dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
+ * //   allocatedStorage: Number("int"),
+ * //   publiclyAccessible: true || false,
+ * //   dbParameterGroupIdentifier: "STRING_VALUE",
+ * //   logDeliveryConfiguration: { // LogDeliveryConfiguration
+ * //     s3Configuration: { // S3Configuration
+ * //       bucketName: "STRING_VALUE", // required
+ * //       enabled: true || false, // required
+ * //     },
+ * //   },
+ * //   influxAuthParametersSecretArn: "STRING_VALUE",
+ * //   vpcSubnetIds: [ // VpcSubnetIdList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   vpcSecurityGroupIds: [ // VpcSecurityGroupIdList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   failoverMode: "AUTOMATIC" || "NO_FAILOVER",
+ * // };
+ *
+ * ```
+ *
+ * @param GetDbClusterCommandInput - {@link GetDbClusterCommandInput}
+ * @returns {@link GetDbClusterCommandOutput}
+ * @see {@link GetDbClusterCommandInput} for command's `input` shape.
+ * @see {@link GetDbClusterCommandOutput} for command's `response` shape.
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource was not found or does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
+ *
+ * @throws {@link TimestreamInfluxDBServiceException}
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
+ *
+ * @public
+ */
+export declare class GetDbClusterCommand extends GetDbClusterCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetDbClusterInput;
+            output: GetDbClusterOutput;
+        };
+        sdk: {
+            input: GetDbClusterCommandInput;
+            output: GetDbClusterCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetDbInstanceCommand.d.ts

@@ -68,6 +68,8 @@ declare const GetDbInstanceCommand_base: {
  * //     },
  * //   },
  * //   influxAuthParametersSecretArn: "STRING_VALUE",
+ * //   dbClusterId: "STRING_VALUE",
+ * //   instanceMode: "PRIMARY" || "STANDBY" || "REPLICA",
  * // };
  *
  * ```

package/dist-types/commands/ListDbClustersCommand.d.ts

@@ -0,0 +1,103 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListDbClustersInput, ListDbClustersOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TimestreamInfluxDBClientResolvedConfig } from "../TimestreamInfluxDBClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDbClustersCommand}.
+ */
+export interface ListDbClustersCommandInput extends ListDbClustersInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDbClustersCommand}.
+ */
+export interface ListDbClustersCommandOutput extends ListDbClustersOutput, __MetadataBearer {
+}
+declare const ListDbClustersCommand_base: {
+    new (input: ListDbClustersCommandInput): import("@smithy/smithy-client").CommandImpl<ListDbClustersCommandInput, ListDbClustersCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListDbClustersCommandInput]): import("@smithy/smithy-client").CommandImpl<ListDbClustersCommandInput, ListDbClustersCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of Timestream for InfluxDB DB clusters.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TimestreamInfluxDBClient, ListDbClustersCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
+ * // const { TimestreamInfluxDBClient, ListDbClustersCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
+ * const client = new TimestreamInfluxDBClient(config);
+ * const input = { // ListDbClustersInput
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListDbClustersCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDbClustersOutput
+ * //   items: [ // DbClusterSummaryList // required
+ * //     { // DbClusterSummary
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       arn: "STRING_VALUE", // required
+ * //       status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED",
+ * //       endpoint: "STRING_VALUE",
+ * //       readerEndpoint: "STRING_VALUE",
+ * //       port: Number("int"),
+ * //       deploymentType: "MULTI_NODE_READ_REPLICAS",
+ * //       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",
+ * //       networkType: "IPV4" || "DUAL",
+ * //       dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
+ * //       allocatedStorage: Number("int"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDbClustersCommandInput - {@link ListDbClustersCommandInput}
+ * @returns {@link ListDbClustersCommandOutput}
+ * @see {@link ListDbClustersCommandInput} for command's `input` shape.
+ * @see {@link ListDbClustersCommandOutput} for command's `response` shape.
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource was not found or does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
+ *
+ * @throws {@link TimestreamInfluxDBServiceException}
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
+ *
+ * @public
+ */
+export declare class ListDbClustersCommand extends ListDbClustersCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDbClustersInput;
+            output: ListDbClustersOutput;
+        };
+        sdk: {
+            input: ListDbClustersCommandInput;
+            output: ListDbClustersCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListDbInstancesForClusterCommand.d.ts

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListDbInstancesForClusterInput, ListDbInstancesForClusterOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TimestreamInfluxDBClientResolvedConfig } from "../TimestreamInfluxDBClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDbInstancesForClusterCommand}.
+ */
+export interface ListDbInstancesForClusterCommandInput extends ListDbInstancesForClusterInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDbInstancesForClusterCommand}.
+ */
+export interface ListDbInstancesForClusterCommandOutput extends ListDbInstancesForClusterOutput, __MetadataBearer {
+}
+declare const ListDbInstancesForClusterCommand_base: {
+    new (input: ListDbInstancesForClusterCommandInput): import("@smithy/smithy-client").CommandImpl<ListDbInstancesForClusterCommandInput, ListDbInstancesForClusterCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListDbInstancesForClusterCommandInput): import("@smithy/smithy-client").CommandImpl<ListDbInstancesForClusterCommandInput, ListDbInstancesForClusterCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of Timestream for InfluxDB clusters.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * 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",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDbInstancesForClusterCommandInput - {@link ListDbInstancesForClusterCommandInput}
+ * @returns {@link ListDbInstancesForClusterCommandOutput}
+ * @see {@link ListDbInstancesForClusterCommandInput} for command's `input` shape.
+ * @see {@link ListDbInstancesForClusterCommandOutput} for command's `response` shape.
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource was not found or does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
+ *
+ * @throws {@link TimestreamInfluxDBServiceException}
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
+ *
+ * @public
+ */
+export declare class ListDbInstancesForClusterCommand extends ListDbInstancesForClusterCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDbInstancesForClusterInput;
+            output: ListDbInstancesForClusterOutput;
+        };
+        sdk: {
+            input: ListDbInstancesForClusterCommandInput;
+            output: ListDbInstancesForClusterCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateDbClusterCommand.d.ts

@@ -0,0 +1,99 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateDbClusterInput, UpdateDbClusterOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TimestreamInfluxDBClientResolvedConfig } from "../TimestreamInfluxDBClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateDbClusterCommand}.
+ */
+export interface UpdateDbClusterCommandInput extends UpdateDbClusterInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateDbClusterCommand}.
+ */
+export interface UpdateDbClusterCommandOutput extends UpdateDbClusterOutput, __MetadataBearer {
+}
+declare const UpdateDbClusterCommand_base: {
+    new (input: UpdateDbClusterCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDbClusterCommandInput, UpdateDbClusterCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateDbClusterCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDbClusterCommandInput, UpdateDbClusterCommandOutput, TimestreamInfluxDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a Timestream for InfluxDB cluster.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TimestreamInfluxDBClient, UpdateDbClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
+ * // const { TimestreamInfluxDBClient, UpdateDbClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
+ * const client = new TimestreamInfluxDBClient(config);
+ * const input = { // UpdateDbClusterInput
+ *   dbClusterId: "STRING_VALUE", // required
+ *   logDeliveryConfiguration: { // LogDeliveryConfiguration
+ *     s3Configuration: { // S3Configuration
+ *       bucketName: "STRING_VALUE", // required
+ *       enabled: true || false, // required
+ *     },
+ *   },
+ *   dbParameterGroupIdentifier: "STRING_VALUE",
+ *   port: Number("int"),
+ *   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",
+ *   failoverMode: "AUTOMATIC" || "NO_FAILOVER",
+ * };
+ * const command = new UpdateDbClusterCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateDbClusterOutput
+ * //   dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateDbClusterCommandInput - {@link UpdateDbClusterCommandInput}
+ * @returns {@link UpdateDbClusterCommandOutput}
+ * @see {@link UpdateDbClusterCommandInput} for command's `input` shape.
+ * @see {@link UpdateDbClusterCommandOutput} for command's `response` shape.
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource was not found or does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
+ *
+ * @throws {@link TimestreamInfluxDBServiceException}
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
+ *
+ * @public
+ */
+export declare class UpdateDbClusterCommand extends UpdateDbClusterCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateDbClusterInput;
+            output: UpdateDbClusterOutput;
+        };
+        sdk: {
+            input: UpdateDbClusterCommandInput;
+            output: UpdateDbClusterCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateDbInstanceCommand.d.ts

@@ -80,6 +80,8 @@ declare const UpdateDbInstanceCommand_base: {
  * //     },
  * //   },
  * //   influxAuthParametersSecretArn: "STRING_VALUE",
+ * //   dbClusterId: "STRING_VALUE",
+ * //   instanceMode: "PRIMARY" || "STANDBY" || "REPLICA",
  * // };
  *
  * ```

package/dist-types/commands/index.d.ts

@@ -1,11 +1,17 @@
+export * from "./CreateDbClusterCommand";
 export * from "./CreateDbInstanceCommand";
 export * from "./CreateDbParameterGroupCommand";
+export * from "./DeleteDbClusterCommand";
 export * from "./DeleteDbInstanceCommand";
+export * from "./GetDbClusterCommand";
 export * from "./GetDbInstanceCommand";
 export * from "./GetDbParameterGroupCommand";
+export * from "./ListDbClustersCommand";
 export * from "./ListDbInstancesCommand";
+export * from "./ListDbInstancesForClusterCommand";
 export * from "./ListDbParameterGroupsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateDbClusterCommand";
 export * from "./UpdateDbInstanceCommand";