@aws-sdk/client-finspace 3.468.0 → 3.470.0

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

@@ -0,0 +1,115 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
+import { ListKxVolumesRequest, ListKxVolumesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListKxVolumesCommand}.
+ */
+export interface ListKxVolumesCommandInput extends ListKxVolumesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListKxVolumesCommand}.
+ */
+export interface ListKxVolumesCommandOutput extends ListKxVolumesResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>
+ * Lists all the volumes in a kdb environment.
+ * </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FinspaceClient, ListKxVolumesCommand } from "@aws-sdk/client-finspace"; // ES Modules import
+ * // const { FinspaceClient, ListKxVolumesCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
+ * const client = new FinspaceClient(config);
+ * const input = { // ListKxVolumesRequest
+ *   environmentId: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ *   volumeType: "NAS_1",
+ * };
+ * const command = new ListKxVolumesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListKxVolumesResponse
+ * //   kxVolumeSummaries: [ // KxVolumes
+ * //     { // KxVolume
+ * //       volumeName: "STRING_VALUE",
+ * //       volumeType: "NAS_1",
+ * //       status: "CREATING" || "CREATE_FAILED" || "ACTIVE" || "UPDATING" || "UPDATED" || "UPDATE_FAILED" || "DELETING" || "DELETED" || "DELETE_FAILED",
+ * //       description: "STRING_VALUE",
+ * //       statusReason: "STRING_VALUE",
+ * //       azMode: "SINGLE" || "MULTI",
+ * //       availabilityZoneIds: [ // AvailabilityZoneIds
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       createdTimestamp: new Date("TIMESTAMP"),
+ * //       lastModifiedTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListKxVolumesCommandInput - {@link ListKxVolumesCommandInput}
+ * @returns {@link ListKxVolumesCommandOutput}
+ * @see {@link ListKxVolumesCommandInput} for command's `input` shape.
+ * @see {@link ListKxVolumesCommandOutput} for command's `response` shape.
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient'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>There was a conflict with this action, and it could not be completed.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>A service limit or quota is exceeded.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</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 an AWS service.</p>
+ *
+ * @throws {@link FinspaceServiceException}
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
+ *
+ */
+export declare class ListKxVolumesCommand extends $Command<ListKxVolumesCommandInput, ListKxVolumesCommandOutput, FinspaceClientResolvedConfig> {
+    readonly input: ListKxVolumesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListKxVolumesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKxVolumesCommandInput, ListKxVolumesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -44,9 +44,24 @@ export interface UpdateKxClusterDatabasesCommandOutput extends UpdateKxClusterDa
  *           dbPaths: [ // DbPaths // required
  *             "STRING_VALUE",
  *           ],
+ *           dataviewName: "STRING_VALUE",
  *         },
  *       ],
  *       changesetId: "STRING_VALUE",
+ *       dataviewName: "STRING_VALUE",
+ *       dataviewConfiguration: { // KxDataviewConfiguration
+ *         dataviewName: "STRING_VALUE",
+ *         dataviewVersionId: "STRING_VALUE",
+ *         changesetId: "STRING_VALUE",
+ *         segmentConfigurations: [ // KxDataviewSegmentConfigurationList
+ *           { // KxDataviewSegmentConfiguration
+ *             dbPaths: [ // SegmentConfigurationDbPathList // required
+ *               "STRING_VALUE",
+ *             ],
+ *             volumeName: "STRING_VALUE", // required
+ *           },
+ *         ],
+ *       },
  *     },
  *   ],
  *   deploymentConfiguration: { // KxDeploymentConfiguration

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

@@ -0,0 +1,145 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
+import { UpdateKxDataviewRequest, UpdateKxDataviewResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateKxDataviewCommand}.
+ */
+export interface UpdateKxDataviewCommandInput extends UpdateKxDataviewRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateKxDataviewCommand}.
+ */
+export interface UpdateKxDataviewCommandOutput extends UpdateKxDataviewResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>
+ * Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FinspaceClient, UpdateKxDataviewCommand } from "@aws-sdk/client-finspace"; // ES Modules import
+ * // const { FinspaceClient, UpdateKxDataviewCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
+ * const client = new FinspaceClient(config);
+ * const input = { // UpdateKxDataviewRequest
+ *   environmentId: "STRING_VALUE", // required
+ *   databaseName: "STRING_VALUE", // required
+ *   dataviewName: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   changesetId: "STRING_VALUE",
+ *   segmentConfigurations: [ // KxDataviewSegmentConfigurationList
+ *     { // KxDataviewSegmentConfiguration
+ *       dbPaths: [ // SegmentConfigurationDbPathList // required
+ *         "STRING_VALUE",
+ *       ],
+ *       volumeName: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   clientToken: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateKxDataviewCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateKxDataviewResponse
+ * //   environmentId: "STRING_VALUE",
+ * //   databaseName: "STRING_VALUE",
+ * //   dataviewName: "STRING_VALUE",
+ * //   azMode: "SINGLE" || "MULTI",
+ * //   availabilityZoneId: "STRING_VALUE",
+ * //   changesetId: "STRING_VALUE",
+ * //   segmentConfigurations: [ // KxDataviewSegmentConfigurationList
+ * //     { // KxDataviewSegmentConfiguration
+ * //       dbPaths: [ // SegmentConfigurationDbPathList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       volumeName: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   activeVersions: [ // KxDataviewActiveVersionList
+ * //     { // KxDataviewActiveVersion
+ * //       changesetId: "STRING_VALUE",
+ * //       segmentConfigurations: [
+ * //         {
+ * //           dbPaths: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           volumeName: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       attachedClusters: [ // AttachedClusterList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       createdTimestamp: new Date("TIMESTAMP"),
+ * //       versionId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   status: "CREATING" || "ACTIVE" || "UPDATING" || "FAILED" || "DELETING",
+ * //   autoUpdate: true || false,
+ * //   description: "STRING_VALUE",
+ * //   createdTimestamp: new Date("TIMESTAMP"),
+ * //   lastModifiedTimestamp: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateKxDataviewCommandInput - {@link UpdateKxDataviewCommandInput}
+ * @returns {@link UpdateKxDataviewCommandOutput}
+ * @see {@link UpdateKxDataviewCommandInput} for command's `input` shape.
+ * @see {@link UpdateKxDataviewCommandOutput} for command's `response` shape.
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient'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>There was a conflict with this action, and it could not be completed.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
+ *
+ * @throws {@link ResourceAlreadyExistsException} (client fault)
+ *  <p>The specified resource group already exists.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</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 an AWS service.</p>
+ *
+ * @throws {@link FinspaceServiceException}
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
+ *
+ */
+export declare class UpdateKxDataviewCommand extends $Command<UpdateKxDataviewCommandInput, UpdateKxDataviewCommandOutput, FinspaceClientResolvedConfig> {
+    readonly input: UpdateKxDataviewCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateKxDataviewCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKxDataviewCommandInput, UpdateKxDataviewCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,128 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
+import { UpdateKxVolumeRequest, UpdateKxVolumeResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateKxVolumeCommand}.
+ */
+export interface UpdateKxVolumeCommandInput extends UpdateKxVolumeRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateKxVolumeCommand}.
+ */
+export interface UpdateKxVolumeCommandOutput extends UpdateKxVolumeResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>
+ * Updates the throughput or capacity of a volume. During the update process, the filesystem
+ * might be unavailable for a few minutes. You can retry any operations after the update is complete.
+ * </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FinspaceClient, UpdateKxVolumeCommand } from "@aws-sdk/client-finspace"; // ES Modules import
+ * // const { FinspaceClient, UpdateKxVolumeCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
+ * const client = new FinspaceClient(config);
+ * const input = { // UpdateKxVolumeRequest
+ *   environmentId: "STRING_VALUE", // required
+ *   volumeName: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   clientToken: "STRING_VALUE",
+ *   nas1Configuration: { // KxNAS1Configuration
+ *     type: "SSD_1000" || "SSD_250" || "HDD_12",
+ *     size: Number("int"),
+ *   },
+ * };
+ * const command = new UpdateKxVolumeCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateKxVolumeResponse
+ * //   environmentId: "STRING_VALUE",
+ * //   volumeName: "STRING_VALUE",
+ * //   volumeType: "NAS_1",
+ * //   volumeArn: "STRING_VALUE",
+ * //   nas1Configuration: { // KxNAS1Configuration
+ * //     type: "SSD_1000" || "SSD_250" || "HDD_12",
+ * //     size: Number("int"),
+ * //   },
+ * //   status: "CREATING" || "CREATE_FAILED" || "ACTIVE" || "UPDATING" || "UPDATED" || "UPDATE_FAILED" || "DELETING" || "DELETED" || "DELETE_FAILED",
+ * //   description: "STRING_VALUE",
+ * //   statusReason: "STRING_VALUE",
+ * //   createdTimestamp: new Date("TIMESTAMP"),
+ * //   azMode: "SINGLE" || "MULTI",
+ * //   availabilityZoneIds: [ // AvailabilityZoneIds
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   lastModifiedTimestamp: new Date("TIMESTAMP"),
+ * //   attachedClusters: [ // KxAttachedClusters
+ * //     { // KxAttachedCluster
+ * //       clusterName: "STRING_VALUE",
+ * //       clusterType: "HDB" || "RDB" || "GATEWAY" || "GP" || "TICKERPLANT",
+ * //       clusterStatus: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateKxVolumeCommandInput - {@link UpdateKxVolumeCommandInput}
+ * @returns {@link UpdateKxVolumeCommandOutput}
+ * @see {@link UpdateKxVolumeCommandInput} for command's `input` shape.
+ * @see {@link UpdateKxVolumeCommandOutput} for command's `response` shape.
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient'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>There was a conflict with this action, and it could not be completed.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>A service limit or quota is exceeded.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</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 an AWS service.</p>
+ *
+ * @throws {@link FinspaceServiceException}
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
+ *
+ */
+export declare class UpdateKxVolumeCommand extends $Command<UpdateKxVolumeCommandInput, UpdateKxVolumeCommandOutput, FinspaceClientResolvedConfig> {
+    readonly input: UpdateKxVolumeCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateKxVolumeCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKxVolumeCommandInput, UpdateKxVolumeCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -2,27 +2,39 @@ export * from "./CreateEnvironmentCommand";
 export * from "./CreateKxChangesetCommand";
 export * from "./CreateKxClusterCommand";
 export * from "./CreateKxDatabaseCommand";
+export * from "./CreateKxDataviewCommand";
 export * from "./CreateKxEnvironmentCommand";
+export * from "./CreateKxScalingGroupCommand";
 export * from "./CreateKxUserCommand";
+export * from "./CreateKxVolumeCommand";
 export * from "./DeleteEnvironmentCommand";
 export * from "./DeleteKxClusterCommand";
 export * from "./DeleteKxDatabaseCommand";
+export * from "./DeleteKxDataviewCommand";
 export * from "./DeleteKxEnvironmentCommand";
+export * from "./DeleteKxScalingGroupCommand";
 export * from "./DeleteKxUserCommand";
+export * from "./DeleteKxVolumeCommand";
 export * from "./GetEnvironmentCommand";
 export * from "./GetKxChangesetCommand";
 export * from "./GetKxClusterCommand";
 export * from "./GetKxConnectionStringCommand";
 export * from "./GetKxDatabaseCommand";
+export * from "./GetKxDataviewCommand";
 export * from "./GetKxEnvironmentCommand";
+export * from "./GetKxScalingGroupCommand";
 export * from "./GetKxUserCommand";
+export * from "./GetKxVolumeCommand";
 export * from "./ListEnvironmentsCommand";
 export * from "./ListKxChangesetsCommand";
 export * from "./ListKxClusterNodesCommand";
 export * from "./ListKxClustersCommand";
 export * from "./ListKxDatabasesCommand";
+export * from "./ListKxDataviewsCommand";
 export * from "./ListKxEnvironmentsCommand";
+export * from "./ListKxScalingGroupsCommand";
 export * from "./ListKxUsersCommand";
+export * from "./ListKxVolumesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
@@ -30,6 +42,8 @@ export * from "./UpdateEnvironmentCommand";
 export * from "./UpdateKxClusterCodeConfigurationCommand";
 export * from "./UpdateKxClusterDatabasesCommand";
 export * from "./UpdateKxDatabaseCommand";
+export * from "./UpdateKxDataviewCommand";
 export * from "./UpdateKxEnvironmentCommand";
 export * from "./UpdateKxEnvironmentNetworkCommand";
 export * from "./UpdateKxUserCommand";
+export * from "./UpdateKxVolumeCommand";