Deletes the specified nodes from a cluster. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FinspaceClient, DeleteKxClusterNodeCommand } from "@aws-sdk/client-finspace"; // ES Modules import + * // const { FinspaceClient, DeleteKxClusterNodeCommand } = require("@aws-sdk/client-finspace"); // CommonJS import + * const client = new FinspaceClient(config); + * const input = { // DeleteKxClusterNodeRequest + * environmentId: "STRING_VALUE", // required + * clusterName: "STRING_VALUE", // required + * nodeId: "STRING_VALUE", // required + * }; + * const command = new DeleteKxClusterNodeCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteKxClusterNodeCommandInput - {@link DeleteKxClusterNodeCommandInput} + * @returns {@link DeleteKxClusterNodeCommandOutput} + * @see {@link DeleteKxClusterNodeCommandInput} for command's `input` shape. + * @see {@link DeleteKxClusterNodeCommandOutput} for command's `response` shape. + * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or + * failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link FinspaceServiceException} + *Base exception class for all service exceptions from Finspace service.
+ * + * @public + */ +export class DeleteKxClusterNodeCommand extends $Command + .classBuilder< + DeleteKxClusterNodeCommandInput, + DeleteKxClusterNodeCommandOutput, + FinspaceClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: FinspaceClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSHabaneroManagementService", "DeleteKxClusterNode", {}) + .n("FinspaceClient", "DeleteKxClusterNodeCommand") + .f(void 0, void 0) + .ser(se_DeleteKxClusterNodeCommand) + .de(de_DeleteKxClusterNodeCommand) + .build() {} diff --git a/clients/client-finspace/src/commands/ListKxClusterNodesCommand.ts b/clients/client-finspace/src/commands/ListKxClusterNodesCommand.ts index 889038517475..f0506ccee1cb 100644 --- a/clients/client-finspace/src/commands/ListKxClusterNodesCommand.ts +++ b/clients/client-finspace/src/commands/ListKxClusterNodesCommand.ts @@ -48,6 +48,7 @@ export interface ListKxClusterNodesCommandOutput extends ListKxClusterNodesRespo * // nodeId: "STRING_VALUE", * // availabilityZoneId: "STRING_VALUE", * // launchTime: new Date("TIMESTAMP"), + * // status: "RUNNING" || "PROVISIONING", * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-finspace/src/commands/index.ts b/clients/client-finspace/src/commands/index.ts index 6abf93ed0755..6bc1a6596c0e 100644 --- a/clients/client-finspace/src/commands/index.ts +++ b/clients/client-finspace/src/commands/index.ts @@ -10,6 +10,7 @@ export * from "./CreateKxUserCommand"; export * from "./CreateKxVolumeCommand"; export * from "./DeleteEnvironmentCommand"; export * from "./DeleteKxClusterCommand"; +export * from "./DeleteKxClusterNodeCommand"; export * from "./DeleteKxDatabaseCommand"; export * from "./DeleteKxDataviewCommand"; export * from "./DeleteKxEnvironmentCommand"; diff --git a/clients/client-finspace/src/models/models_0.ts b/clients/client-finspace/src/models/models_0.ts index 8a116a4e07d0..e628cd75318b 100644 --- a/clients/client-finspace/src/models/models_0.ts +++ b/clients/client-finspace/src/models/models_0.ts @@ -451,7 +451,7 @@ export interface CreateKxChangesetRequest { /** *A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath.
- * A changeType can has the following values:
PUT – Adds or updates files in a database.
@@ -2234,7 +2234,11 @@ export interface KxNAS1Configuration { /** *- * The size of the network attached storage.
+ * The size of the network attached storage. For storage type + *SSD_1000 and SSD_250 you can select the
+ * minimum size as 1200 GB or increments of 2400 GB. For storage type
+ * HDD_12 you can select the minimum size as 6000 GB or increments
+ * of 6000 GB.
* @public
*/
size?: number;
@@ -2491,6 +2495,34 @@ export interface DeleteKxClusterRequest {
*/
export interface DeleteKxClusterResponse {}
+/**
+ * @public
+ */
+export interface DeleteKxClusterNodeRequest {
+ /**
+ * A unique identifier for the kdb environment.
+ * @public + */ + environmentId: string | undefined; + + /** + *The name of the cluster, for which you want to delete the nodes.
+ * @public + */ + clusterName: string | undefined; + + /** + *A unique identifier for the node that you want to delete.
+ * @public + */ + nodeId: string | undefined; +} + +/** + * @public + */ +export interface DeleteKxClusterNodeResponse {} + /** * @public */ @@ -4253,6 +4285,20 @@ export interface ListKxClusterNodesRequest { maxResults?: number; } +/** + * @public + * @enum + */ +export const KxNodeStatus = { + PROVISIONING: "PROVISIONING", + RUNNING: "RUNNING", +} as const; + +/** + * @public + */ +export type KxNodeStatus = (typeof KxNodeStatus)[keyof typeof KxNodeStatus]; + /** *A structure that stores metadata for a kdb node.
* @public @@ -4275,6 +4321,23 @@ export interface KxNode { * @public */ launchTime?: Date; + + /** + *+ * Specifies the status of the cluster nodes.
+ *
+ * RUNNING – The node is actively serving.
+ * PROVISIONING – The node is being prepared.
A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. \n A changeType can has the following values:
PUT – Adds or updates files in a database.
\nDELETE – Deletes files in a database.
\nAll the change requests require a mandatory dbPath attribute that defines the\n path within the database directory. All database paths must start with a leading / and end\n with a trailing /. The s3Path attribute defines the s3 source file path and is\n required for a PUT change type. The s3path must end with a trailing / if it is\n a directory and must end without a trailing / if it is a file.
Here are few examples of how you can use the change request object:
\nThis request adds a single sym file at database root location.
\n\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\",\n \"dbPath\":\"/\"}\n
This request adds files in the given s3Path under the 2020.01.02\n partition of the database.
\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\",\n \"dbPath\":\"/2020.01.02/\"}\n
This request adds files in the given s3Path under the\n taq table partition of the database.
\n [ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
This request deletes the 2020.01.02 partition of the database.
\n\n [{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]\n
The DELETE request allows you to delete the existing files under the\n 2020.01.02 partition of the database, and the PUT request adds a\n new taq table under it.
\n\n [ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\",\n \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. \n A changeType can have the following values:
PUT – Adds or updates files in a database.
\nDELETE – Deletes files in a database.
\nAll the change requests require a mandatory dbPath attribute that defines the\n path within the database directory. All database paths must start with a leading / and end\n with a trailing /. The s3Path attribute defines the s3 source file path and is\n required for a PUT change type. The s3path must end with a trailing / if it is\n a directory and must end without a trailing / if it is a file.
Here are few examples of how you can use the change request object:
\nThis request adds a single sym file at database root location.
\n\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\",\n \"dbPath\":\"/\"}\n
This request adds files in the given s3Path under the 2020.01.02\n partition of the database.
\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\",\n \"dbPath\":\"/2020.01.02/\"}\n
This request adds files in the given s3Path under the\n taq table partition of the database.
\n [ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
This request deletes the 2020.01.02 partition of the database.
\n\n [{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]\n
The DELETE request allows you to delete the existing files under the\n 2020.01.02 partition of the database, and the PUT request adds a\n new taq table under it.
\n\n [ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\",\n \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
Deletes the specified nodes from a cluster.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes/{nodeId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxClusterNodeRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "The name of the cluster, for which you want to delete the nodes.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodeId": { + "target": "com.amazonaws.finspace#KxClusterNodeIdString", + "traits": { + "smithy.api#documentation": "A unique identifier for the node that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxClusterNodeResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.finspace#DeleteKxClusterRequest": { "type": "structure", "members": { @@ -6235,7 +6311,7 @@ "size": { "target": "com.amazonaws.finspace#KxNAS1Size", "traits": { - "smithy.api#documentation": "\nThe size of the network attached storage.
" + "smithy.api#documentation": "\n The size of the network attached storage. For storage type\n SSD_1000 and SSD_250 you can select the\n minimum size as 1200 GB or increments of 2400 GB. For storage type\n HDD_12 you can select the minimum size as 6000 GB or increments\n of 6000 GB.
The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" } + }, + "status": { + "target": "com.amazonaws.finspace#KxNodeStatus", + "traits": { + "smithy.api#documentation": "\n Specifies the status of the cluster nodes.
\n\n RUNNING – The node is actively serving.
\n PROVISIONING – The node is being prepared.
A structure that stores metadata for a kdb node.
" } }, + "com.amazonaws.finspace#KxNodeStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + } + } + }, "com.amazonaws.finspace#KxNodeSummaries": { "type": "list", "member": {