|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 8 | +import { UpdateClusterRequest, UpdateClusterResponse } from "../models/models_0"; |
| 9 | +import { PCSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PCSClient"; |
| 10 | +import { de_UpdateClusterCommand, se_UpdateClusterCommand } from "../protocols/Aws_json1_0"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link UpdateClusterCommand}. |
| 21 | + */ |
| 22 | +export interface UpdateClusterCommandInput extends UpdateClusterRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link UpdateClusterCommand}. |
| 27 | + */ |
| 28 | +export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Updates a cluster configuration. You can modify Slurm scheduler settings, accounting configuration, and security groups for an existing cluster. </p> <note> <p>You can only update clusters that are in <code>ACTIVE</code>, <code>UPDATE_FAILED</code>, or <code>SUSPENDED</code> state. All associated resources (queues and compute node groups) must be in <code>ACTIVE</code> state before you can update the cluster.</p> </note> |
| 32 | + * @example |
| 33 | + * Use a bare-bones client and the command you need to make an API call. |
| 34 | + * ```javascript |
| 35 | + * import { PCSClient, UpdateClusterCommand } from "@aws-sdk/client-pcs"; // ES Modules import |
| 36 | + * // const { PCSClient, UpdateClusterCommand } = require("@aws-sdk/client-pcs"); // CommonJS import |
| 37 | + * // import type { PCSClientConfig } from "@aws-sdk/client-pcs"; |
| 38 | + * const config = {}; // type is PCSClientConfig |
| 39 | + * const client = new PCSClient(config); |
| 40 | + * const input = { // UpdateClusterRequest |
| 41 | + * clusterIdentifier: "STRING_VALUE", // required |
| 42 | + * clientToken: "STRING_VALUE", |
| 43 | + * slurmConfiguration: { // UpdateClusterSlurmConfigurationRequest |
| 44 | + * scaleDownIdleTimeInSeconds: Number("int"), |
| 45 | + * slurmCustomSettings: [ // SlurmCustomSettings |
| 46 | + * { // SlurmCustomSetting |
| 47 | + * parameterName: "STRING_VALUE", // required |
| 48 | + * parameterValue: "STRING_VALUE", // required |
| 49 | + * }, |
| 50 | + * ], |
| 51 | + * accounting: { // UpdateAccountingRequest |
| 52 | + * defaultPurgeTimeInDays: Number("int"), |
| 53 | + * mode: "STANDARD" || "NONE", |
| 54 | + * }, |
| 55 | + * }, |
| 56 | + * }; |
| 57 | + * const command = new UpdateClusterCommand(input); |
| 58 | + * const response = await client.send(command); |
| 59 | + * // { // UpdateClusterResponse |
| 60 | + * // cluster: { // Cluster |
| 61 | + * // name: "STRING_VALUE", // required |
| 62 | + * // id: "STRING_VALUE", // required |
| 63 | + * // arn: "STRING_VALUE", // required |
| 64 | + * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED" || "SUSPENDING" || "SUSPENDED", // required |
| 65 | + * // createdAt: new Date("TIMESTAMP"), // required |
| 66 | + * // modifiedAt: new Date("TIMESTAMP"), // required |
| 67 | + * // scheduler: { // Scheduler |
| 68 | + * // type: "SLURM", // required |
| 69 | + * // version: "STRING_VALUE", // required |
| 70 | + * // }, |
| 71 | + * // size: "SMALL" || "MEDIUM" || "LARGE", // required |
| 72 | + * // slurmConfiguration: { // ClusterSlurmConfiguration |
| 73 | + * // scaleDownIdleTimeInSeconds: Number("int"), |
| 74 | + * // slurmCustomSettings: [ // SlurmCustomSettings |
| 75 | + * // { // SlurmCustomSetting |
| 76 | + * // parameterName: "STRING_VALUE", // required |
| 77 | + * // parameterValue: "STRING_VALUE", // required |
| 78 | + * // }, |
| 79 | + * // ], |
| 80 | + * // authKey: { // SlurmAuthKey |
| 81 | + * // secretArn: "STRING_VALUE", // required |
| 82 | + * // secretVersion: "STRING_VALUE", // required |
| 83 | + * // }, |
| 84 | + * // accounting: { // Accounting |
| 85 | + * // defaultPurgeTimeInDays: Number("int"), |
| 86 | + * // mode: "STANDARD" || "NONE", // required |
| 87 | + * // }, |
| 88 | + * // }, |
| 89 | + * // networking: { // Networking |
| 90 | + * // subnetIds: [ // SubnetIdList |
| 91 | + * // "STRING_VALUE", |
| 92 | + * // ], |
| 93 | + * // securityGroupIds: [ // SecurityGroupIdList |
| 94 | + * // "STRING_VALUE", |
| 95 | + * // ], |
| 96 | + * // networkType: "IPV4" || "IPV6", |
| 97 | + * // }, |
| 98 | + * // endpoints: [ // Endpoints |
| 99 | + * // { // Endpoint |
| 100 | + * // type: "SLURMCTLD" || "SLURMDBD", // required |
| 101 | + * // privateIpAddress: "STRING_VALUE", // required |
| 102 | + * // publicIpAddress: "STRING_VALUE", |
| 103 | + * // ipv6Address: "STRING_VALUE", |
| 104 | + * // port: "STRING_VALUE", // required |
| 105 | + * // }, |
| 106 | + * // ], |
| 107 | + * // errorInfo: [ // ErrorInfoList |
| 108 | + * // { // ErrorInfo |
| 109 | + * // code: "STRING_VALUE", |
| 110 | + * // message: "STRING_VALUE", |
| 111 | + * // }, |
| 112 | + * // ], |
| 113 | + * // }, |
| 114 | + * // }; |
| 115 | + * |
| 116 | + * ``` |
| 117 | + * |
| 118 | + * @param UpdateClusterCommandInput - {@link UpdateClusterCommandInput} |
| 119 | + * @returns {@link UpdateClusterCommandOutput} |
| 120 | + * @see {@link UpdateClusterCommandInput} for command's `input` shape. |
| 121 | + * @see {@link UpdateClusterCommandOutput} for command's `response` shape. |
| 122 | + * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape. |
| 123 | + * |
| 124 | + * @throws {@link AccessDeniedException} (client fault) |
| 125 | + * <p>You don't have permission to perform the action.</p> <p> <u>Examples</u> </p> <ul> <li> <p>The launch template instance profile doesn't pass <code>iam:PassRole</code> verification.</p> </li> <li> <p>There is a mismatch between the account ID and cluster ID.</p> </li> <li> <p>The cluster ID doesn't exist.</p> </li> <li> <p>The EC2 instance isn't present.</p> </li> </ul> |
| 126 | + * |
| 127 | + * @throws {@link ConflictException} (client fault) |
| 128 | + * <p>Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.</p> <p> <u>Examples</u> </p> <ul> <li> <p>A cluster with the same name already exists.</p> </li> <li> <p>A cluster isn't in <code>ACTIVE</code> status.</p> </li> <li> <p>A cluster to delete is in an unstable state. For example, because it still has <code>ACTIVE</code> node groups or queues.</p> </li> <li> <p>A queue already exists in a cluster.</p> </li> </ul> |
| 129 | + * |
| 130 | + * @throws {@link InternalServerException} (server fault) |
| 131 | + * <p>PCS can't process your request right now. Try again later.</p> |
| 132 | + * |
| 133 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 134 | + * <p>The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.</p> <p> <u>Examples</u> </p> |
| 135 | + * |
| 136 | + * @throws {@link ThrottlingException} (client fault) |
| 137 | + * <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p> |
| 138 | + * |
| 139 | + * @throws {@link ValidationException} (client fault) |
| 140 | + * <p>The request isn't valid.</p> <p> <u>Examples</u> </p> <ul> <li> <p>Your request contains malformed JSON or unsupported characters.</p> </li> <li> <p>The scheduler version isn't supported.</p> </li> <li> <p>There are networking related errors, such as network validation failure.</p> </li> <li> <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.</p> </li> </ul> |
| 141 | + * |
| 142 | + * @throws {@link PCSServiceException} |
| 143 | + * <p>Base exception class for all service exceptions from PCS service.</p> |
| 144 | + * |
| 145 | + * |
| 146 | + * @public |
| 147 | + */ |
| 148 | +export class UpdateClusterCommand extends $Command |
| 149 | + .classBuilder< |
| 150 | + UpdateClusterCommandInput, |
| 151 | + UpdateClusterCommandOutput, |
| 152 | + PCSClientResolvedConfig, |
| 153 | + ServiceInputTypes, |
| 154 | + ServiceOutputTypes |
| 155 | + >() |
| 156 | + .ep(commonParams) |
| 157 | + .m(function (this: any, Command: any, cs: any, config: PCSClientResolvedConfig, o: any) { |
| 158 | + return [ |
| 159 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 160 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 161 | + ]; |
| 162 | + }) |
| 163 | + .s("AWSParallelComputingService", "UpdateCluster", {}) |
| 164 | + .n("PCSClient", "UpdateClusterCommand") |
| 165 | + .f(void 0, void 0) |
| 166 | + .ser(se_UpdateClusterCommand) |
| 167 | + .de(de_UpdateClusterCommand) |
| 168 | + .build() { |
| 169 | + /** @internal type navigation helper, not in runtime. */ |
| 170 | + protected declare static __types: { |
| 171 | + api: { |
| 172 | + input: UpdateClusterRequest; |
| 173 | + output: UpdateClusterResponse; |
| 174 | + }; |
| 175 | + sdk: { |
| 176 | + input: UpdateClusterCommandInput; |
| 177 | + output: UpdateClusterCommandOutput; |
| 178 | + }; |
| 179 | + }; |
| 180 | +} |
0 commit comments