@aws-sdk/client-pcs 3.810.0 → 3.812.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/README.md +1 -18
  2. package/dist-cjs/models/models_0.js +5 -1
  3. package/dist-es/models/models_0.js +4 -0
  4. package/dist-types/PCS.d.ts +1 -18
  5. package/dist-types/PCSClient.d.ts +1 -18
  6. package/dist-types/commands/CreateClusterCommand.d.ts +13 -91
  7. package/dist-types/commands/CreateComputeNodeGroupCommand.d.ts +6 -93
  8. package/dist-types/commands/CreateQueueCommand.d.ts +6 -86
  9. package/dist-types/commands/DeleteClusterCommand.d.ts +5 -65
  10. package/dist-types/commands/DeleteComputeNodeGroupCommand.d.ts +5 -65
  11. package/dist-types/commands/DeleteQueueCommand.d.ts +5 -66
  12. package/dist-types/commands/GetClusterCommand.d.ts +9 -66
  13. package/dist-types/commands/GetComputeNodeGroupCommand.d.ts +5 -66
  14. package/dist-types/commands/GetQueueCommand.d.ts +5 -65
  15. package/dist-types/commands/ListClustersCommand.d.ts +4 -63
  16. package/dist-types/commands/ListComputeNodeGroupsCommand.d.ts +4 -63
  17. package/dist-types/commands/ListQueuesCommand.d.ts +4 -63
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -5
  19. package/dist-types/commands/RegisterComputeNodeGroupInstanceCommand.d.ts +2 -23
  20. package/dist-types/commands/TagResourceCommand.d.ts +3 -30
  21. package/dist-types/commands/UntagResourceCommand.d.ts +2 -7
  22. package/dist-types/commands/UpdateComputeNodeGroupCommand.d.ts +6 -87
  23. package/dist-types/commands/UpdateQueueCommand.d.ts +6 -86
  24. package/dist-types/index.d.ts +1 -18
  25. package/dist-types/models/models_0.d.ts +137 -550
  26. package/dist-types/ts3.4/models/models_0.d.ts +16 -0
  27. package/package.json +5 -5
package/README.md CHANGED
@@ -6,24 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript PCS Client for Node.js, Browser and React Native.
8
8
 
9
- <p>Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for
10
- you to run and scale your high performance computing (HPC) workloads,
11
- and build scientific and engineering models on Amazon Web Services using Slurm.
12
- For more information, see
13
- the <a href="https://docs.aws.amazon.com/pcs/latest/userguide">Amazon Web Services Parallel Computing Service
14
- User Guide</a>.</p>
15
- <p>This reference describes the actions and data types of the service management API. You can use the
16
- Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API
17
- actions manually. These API actions manage the service through an Amazon Web Services account.</p>
18
- <p>The API actions operate on Amazon Web Services PCS resources. A <i>resource</i> is
19
- an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use
20
- the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute
21
- node groups, and queues. For more information about resources in Amazon Web Services, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-resource">Resource</a> in the <i>Resource Explorer User Guide</i>. </p>
22
- <p>An Amazon Web Services PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch
23
- compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch
24
- compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes.
25
- Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources
26
- related to those compute nodes.</p>
9
+ <p>Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the <a href="https://docs.aws.amazon.com/pcs/latest/userguide">Amazon Web Services Parallel Computing Service User Guide</a>.</p> <p>This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.</p> <p>The API actions operate on Amazon Web Services PCS resources. A <i>resource</i> is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-resource">Resource</a> in the <i>Resource Explorer User Guide</i>. </p> <p>An Amazon Web Services PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.</p>
27
10
 
28
11
  ## Installing
29
12
 
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RegisterComputeNodeGroupInstanceResponseFilterSensitiveLog = exports.QueueStatus = exports.ClusterStatus = exports.EndpointType = exports.Size = exports.SchedulerType = exports.ValidationException = exports.ValidationExceptionReason = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.InternalServerException = exports.ComputeNodeGroupStatus = exports.SpotAllocationStrategy = exports.PurchaseOption = exports.ConflictException = exports.AccessDeniedException = void 0;
3
+ exports.RegisterComputeNodeGroupInstanceResponseFilterSensitiveLog = exports.QueueStatus = exports.ClusterStatus = exports.EndpointType = exports.Size = exports.SchedulerType = exports.ValidationException = exports.ValidationExceptionReason = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.InternalServerException = exports.ComputeNodeGroupStatus = exports.SpotAllocationStrategy = exports.PurchaseOption = exports.ConflictException = exports.AccountingMode = exports.AccessDeniedException = void 0;
4
4
  const smithy_client_1 = require("@smithy/smithy-client");
5
5
  const PCSServiceException_1 = require("./PCSServiceException");
6
6
  class AccessDeniedException extends PCSServiceException_1.PCSServiceException {
@@ -16,6 +16,10 @@ class AccessDeniedException extends PCSServiceException_1.PCSServiceException {
16
16
  }
17
17
  }
18
18
  exports.AccessDeniedException = AccessDeniedException;
19
+ exports.AccountingMode = {
20
+ NONE: "NONE",
21
+ STANDARD: "STANDARD",
22
+ };
19
23
  class ConflictException extends PCSServiceException_1.PCSServiceException {
20
24
  name = "ConflictException";
21
25
  $fault = "client";
@@ -12,6 +12,10 @@ export class AccessDeniedException extends __BaseException {
12
12
  Object.setPrototypeOf(this, AccessDeniedException.prototype);
13
13
  }
14
14
  }
15
+ export const AccountingMode = {
16
+ NONE: "NONE",
17
+ STANDARD: "STANDARD",
18
+ };
15
19
  export class ConflictException extends __BaseException {
16
20
  name = "ConflictException";
17
21
  $fault = "client";
@@ -130,24 +130,7 @@ export interface PCS {
130
130
  updateQueue(args: UpdateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueCommandOutput) => void): void;
131
131
  }
132
132
  /**
133
- * <p>Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for
134
- * you to run and scale your high performance computing (HPC) workloads,
135
- * and build scientific and engineering models on Amazon Web Services using Slurm.
136
- * For more information, see
137
- * the <a href="https://docs.aws.amazon.com/pcs/latest/userguide">Amazon Web Services Parallel Computing Service
138
- * User Guide</a>.</p>
139
- * <p>This reference describes the actions and data types of the service management API. You can use the
140
- * Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API
141
- * actions manually. These API actions manage the service through an Amazon Web Services account.</p>
142
- * <p>The API actions operate on Amazon Web Services PCS resources. A <i>resource</i> is
143
- * an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use
144
- * the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute
145
- * node groups, and queues. For more information about resources in Amazon Web Services, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-resource">Resource</a> in the <i>Resource Explorer User Guide</i>. </p>
146
- * <p>An Amazon Web Services PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch
147
- * compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch
148
- * compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes.
149
- * Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources
150
- * related to those compute nodes.</p>
133
+ * <p>Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the <a href="https://docs.aws.amazon.com/pcs/latest/userguide">Amazon Web Services Parallel Computing Service User Guide</a>.</p> <p>This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.</p> <p>The API actions operate on Amazon Web Services PCS resources. A <i>resource</i> is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-resource">Resource</a> in the <i>Resource Explorer User Guide</i>. </p> <p>An Amazon Web Services PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.</p>
151
134
  * @public
152
135
  */
153
136
  export declare class PCS extends PCSClient implements PCS {
@@ -187,24 +187,7 @@ export type PCSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
187
187
  export interface PCSClientResolvedConfig extends PCSClientResolvedConfigType {
188
188
  }
189
189
  /**
190
- * <p>Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for
191
- * you to run and scale your high performance computing (HPC) workloads,
192
- * and build scientific and engineering models on Amazon Web Services using Slurm.
193
- * For more information, see
194
- * the <a href="https://docs.aws.amazon.com/pcs/latest/userguide">Amazon Web Services Parallel Computing Service
195
- * User Guide</a>.</p>
196
- * <p>This reference describes the actions and data types of the service management API. You can use the
197
- * Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API
198
- * actions manually. These API actions manage the service through an Amazon Web Services account.</p>
199
- * <p>The API actions operate on Amazon Web Services PCS resources. A <i>resource</i> is
200
- * an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use
201
- * the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute
202
- * node groups, and queues. For more information about resources in Amazon Web Services, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-resource">Resource</a> in the <i>Resource Explorer User Guide</i>. </p>
203
- * <p>An Amazon Web Services PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch
204
- * compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch
205
- * compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes.
206
- * Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources
207
- * related to those compute nodes.</p>
190
+ * <p>Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the <a href="https://docs.aws.amazon.com/pcs/latest/userguide">Amazon Web Services Parallel Computing Service User Guide</a>.</p> <p>This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.</p> <p>The API actions operate on Amazon Web Services PCS resources. A <i>resource</i> is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-resource">Resource</a> in the <i>Resource Explorer User Guide</i>. </p> <p>An Amazon Web Services PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.</p>
208
191
  * @public
209
192
  */
210
193
  export declare class PCSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PCSClientResolvedConfig> {
@@ -27,18 +27,7 @@ declare const CreateClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a
31
- * service-owned account. The cluster controller communicates with the cluster resources in
32
- * your account. The subnets and security groups for the cluster must already exist before you
33
- * use this API action.</p>
34
- * <note>
35
- * <p>It takes time for Amazon Web Services PCS to create the cluster. The cluster is in
36
- * a <code>Creating</code> state until it is ready to use. There can only be 1
37
- * cluster in a <code>Creating</code> state per Amazon Web Services Region per Amazon Web Services account.
38
- * <code>CreateCluster</code>
39
- * fails with a <code>ServiceQuotaExceededException</code> if there is already
40
- * a cluster in a <code>Creating</code> state.</p>
41
- * </note>
30
+ * <p>Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.</p> <note> <p>It takes time for Amazon Web Services PCS to create the cluster. The cluster is in a <code>Creating</code> state until it is ready to use. There can only be 1 cluster in a <code>Creating</code> state per Amazon Web Services Region per Amazon Web Services account. <code>CreateCluster</code> fails with a <code>ServiceQuotaExceededException</code> if there is already a cluster in a <code>Creating</code> state.</p> </note>
42
31
  * @example
43
32
  * Use a bare-bones client and the command you need to make an API call.
44
33
  * ```javascript
@@ -68,6 +57,10 @@ declare const CreateClusterCommand_base: {
68
57
  * parameterValue: "STRING_VALUE", // required
69
58
  * },
70
59
  * ],
60
+ * accounting: { // AccountingRequest
61
+ * mode: "STANDARD" || "NONE", // required
62
+ * defaultPurgeTimeInDays: Number("int"),
63
+ * },
71
64
  * },
72
65
  * clientToken: "STRING_VALUE",
73
66
  * tags: { // RequestTagMap
@@ -101,6 +94,10 @@ declare const CreateClusterCommand_base: {
101
94
  * // secretArn: "STRING_VALUE", // required
102
95
  * // secretVersion: "STRING_VALUE", // required
103
96
  * // },
97
+ * // accounting: { // Accounting
98
+ * // mode: "STANDARD" || "NONE", // required
99
+ * // defaultPurgeTimeInDays: Number("int"),
100
+ * // },
104
101
  * // },
105
102
  * // networking: { // Networking
106
103
  * // subnetIds: [ // SubnetIdList
@@ -136,97 +133,22 @@ declare const CreateClusterCommand_base: {
136
133
  * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape.
137
134
  *
138
135
  * @throws {@link AccessDeniedException} (client fault)
139
- * <p>You don't have permission to perform the action.</p>
140
- * <p>
141
- * <u>Examples</u>
142
- * </p>
143
- * <ul>
144
- * <li>
145
- * <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
146
- * verification.</p>
147
- * </li>
148
- * <li>
149
- * <p>There is a mismatch between the account ID and cluster ID.</p>
150
- * </li>
151
- * <li>
152
- * <p>The cluster ID doesn't exist.</p>
153
- * </li>
154
- * <li>
155
- * <p>The EC2 instance isn't present.</p>
156
- * </li>
157
- * </ul>
136
+ * <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>
158
137
  *
159
138
  * @throws {@link ConflictException} (client fault)
160
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
161
- * than 1 operation on the same resource at the same time.</p>
162
- * <p>
163
- * <u>Examples</u>
164
- * </p>
165
- * <ul>
166
- * <li>
167
- * <p>A cluster with the same name already exists.</p>
168
- * </li>
169
- * <li>
170
- * <p>A cluster isn't in <code>ACTIVE</code> status.</p>
171
- * </li>
172
- * <li>
173
- * <p>A cluster to delete is in an unstable state. For example, because it still has
174
- * <code>ACTIVE</code> node groups or queues.</p>
175
- * </li>
176
- * <li>
177
- * <p>A queue already exists in a cluster.</p>
178
- * </li>
179
- * </ul>
139
+ * <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>
180
140
  *
181
141
  * @throws {@link InternalServerException} (server fault)
182
142
  * <p>Amazon Web Services PCS can't process your request right now. Try again later.</p>
183
143
  *
184
144
  * @throws {@link ServiceQuotaExceededException} (client fault)
185
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
186
- * maximum number of service resources or operations for your Amazon Web Services account. To learn how to
187
- * increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota
188
- * increase</a> in the <i>Service Quotas User Guide</i>
189
- * </p>
190
- * <p>
191
- * <u>Examples</u>
192
- * </p>
193
- * <ul>
194
- * <li>
195
- * <p>The max number of clusters or queues has been reached for the account.</p>
196
- * </li>
197
- * <li>
198
- * <p>The max number of compute node groups has been reached for the associated
199
- * cluster.</p>
200
- * </li>
201
- * <li>
202
- * <p>The total of <code>maxInstances</code> across all compute node groups has been
203
- * reached for associated cluster.</p>
204
- * </li>
205
- * </ul>
145
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota increase</a> in the <i>Service Quotas User Guide</i> </p> <p> <u>Examples</u> </p> <ul> <li> <p>The max number of clusters or queues has been reached for the account.</p> </li> <li> <p>The max number of compute node groups has been reached for the associated cluster.</p> </li> <li> <p>The total of <code>maxInstances</code> across all compute node groups has been reached for associated cluster.</p> </li> </ul>
206
146
  *
207
147
  * @throws {@link ThrottlingException} (client fault)
208
148
  * <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
209
149
  *
210
150
  * @throws {@link ValidationException} (client fault)
211
- * <p>The request isn't valid.</p>
212
- * <p>
213
- * <u>Examples</u>
214
- * </p>
215
- * <ul>
216
- * <li>
217
- * <p>Your request contains malformed JSON or unsupported characters.</p>
218
- * </li>
219
- * <li>
220
- * <p>The scheduler version isn't supported.</p>
221
- * </li>
222
- * <li>
223
- * <p>There are networking related errors, such as network validation failure.</p>
224
- * </li>
225
- * <li>
226
- * <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID,
227
- * or the AMI type is AL2 and the launch template defines the AMI.</p>
228
- * </li>
229
- * </ul>
151
+ * <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>
230
152
  *
231
153
  * @throws {@link PCSServiceException}
232
154
  * <p>Base exception class for all service exceptions from PCS service.</p>
@@ -27,15 +27,7 @@ declare const CreateComputeNodeGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a managed set of compute nodes. You associate a compute node group with a
31
- * cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node
32
- * group includes the definition of the compute properties and lifecycle management.
33
- * Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in
34
- * your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive
35
- * billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must
36
- * already have a launch template before you call this API. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launch an
37
- * instance from a launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux
38
- * Instances</i>.</p>
30
+ * <p>Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launch an instance from a launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>.</p>
39
31
  * @example
40
32
  * Use a bare-bones client and the command you need to make an API call.
41
33
  * ```javascript
@@ -139,104 +131,25 @@ declare const CreateComputeNodeGroupCommand_base: {
139
131
  * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape.
140
132
  *
141
133
  * @throws {@link AccessDeniedException} (client fault)
142
- * <p>You don't have permission to perform the action.</p>
143
- * <p>
144
- * <u>Examples</u>
145
- * </p>
146
- * <ul>
147
- * <li>
148
- * <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
149
- * verification.</p>
150
- * </li>
151
- * <li>
152
- * <p>There is a mismatch between the account ID and cluster ID.</p>
153
- * </li>
154
- * <li>
155
- * <p>The cluster ID doesn't exist.</p>
156
- * </li>
157
- * <li>
158
- * <p>The EC2 instance isn't present.</p>
159
- * </li>
160
- * </ul>
134
+ * <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>
161
135
  *
162
136
  * @throws {@link ConflictException} (client fault)
163
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
164
- * than 1 operation on the same resource at the same time.</p>
165
- * <p>
166
- * <u>Examples</u>
167
- * </p>
168
- * <ul>
169
- * <li>
170
- * <p>A cluster with the same name already exists.</p>
171
- * </li>
172
- * <li>
173
- * <p>A cluster isn't in <code>ACTIVE</code> status.</p>
174
- * </li>
175
- * <li>
176
- * <p>A cluster to delete is in an unstable state. For example, because it still has
177
- * <code>ACTIVE</code> node groups or queues.</p>
178
- * </li>
179
- * <li>
180
- * <p>A queue already exists in a cluster.</p>
181
- * </li>
182
- * </ul>
137
+ * <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>
183
138
  *
184
139
  * @throws {@link InternalServerException} (server fault)
185
140
  * <p>Amazon Web Services PCS can't process your request right now. Try again later.</p>
186
141
  *
187
142
  * @throws {@link ResourceNotFoundException} (client fault)
188
- * <p>The requested resource can't be found. The cluster, node group, or queue you're
189
- * attempting to get, update, list, or delete doesn't exist.</p>
190
- * <p>
191
- * <u>Examples</u>
192
- * </p>
143
+ * <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>
193
144
  *
194
145
  * @throws {@link ServiceQuotaExceededException} (client fault)
195
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
196
- * maximum number of service resources or operations for your Amazon Web Services account. To learn how to
197
- * increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota
198
- * increase</a> in the <i>Service Quotas User Guide</i>
199
- * </p>
200
- * <p>
201
- * <u>Examples</u>
202
- * </p>
203
- * <ul>
204
- * <li>
205
- * <p>The max number of clusters or queues has been reached for the account.</p>
206
- * </li>
207
- * <li>
208
- * <p>The max number of compute node groups has been reached for the associated
209
- * cluster.</p>
210
- * </li>
211
- * <li>
212
- * <p>The total of <code>maxInstances</code> across all compute node groups has been
213
- * reached for associated cluster.</p>
214
- * </li>
215
- * </ul>
146
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota increase</a> in the <i>Service Quotas User Guide</i> </p> <p> <u>Examples</u> </p> <ul> <li> <p>The max number of clusters or queues has been reached for the account.</p> </li> <li> <p>The max number of compute node groups has been reached for the associated cluster.</p> </li> <li> <p>The total of <code>maxInstances</code> across all compute node groups has been reached for associated cluster.</p> </li> </ul>
216
147
  *
217
148
  * @throws {@link ThrottlingException} (client fault)
218
149
  * <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
219
150
  *
220
151
  * @throws {@link ValidationException} (client fault)
221
- * <p>The request isn't valid.</p>
222
- * <p>
223
- * <u>Examples</u>
224
- * </p>
225
- * <ul>
226
- * <li>
227
- * <p>Your request contains malformed JSON or unsupported characters.</p>
228
- * </li>
229
- * <li>
230
- * <p>The scheduler version isn't supported.</p>
231
- * </li>
232
- * <li>
233
- * <p>There are networking related errors, such as network validation failure.</p>
234
- * </li>
235
- * <li>
236
- * <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID,
237
- * or the AMI type is AL2 and the launch template defines the AMI.</p>
238
- * </li>
239
- * </ul>
152
+ * <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>
240
153
  *
241
154
  * @throws {@link PCSServiceException}
242
155
  * <p>Base exception class for all service exceptions from PCS service.</p>
@@ -27,8 +27,7 @@ declare const CreateQueueCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a job queue. You must associate 1 or more compute node groups with the queue.
31
- * You can associate 1 compute node group with multiple queues.</p>
30
+ * <p>Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -82,104 +81,25 @@ declare const CreateQueueCommand_base: {
82
81
  * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape.
83
82
  *
84
83
  * @throws {@link AccessDeniedException} (client fault)
85
- * <p>You don't have permission to perform the action.</p>
86
- * <p>
87
- * <u>Examples</u>
88
- * </p>
89
- * <ul>
90
- * <li>
91
- * <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
92
- * verification.</p>
93
- * </li>
94
- * <li>
95
- * <p>There is a mismatch between the account ID and cluster ID.</p>
96
- * </li>
97
- * <li>
98
- * <p>The cluster ID doesn't exist.</p>
99
- * </li>
100
- * <li>
101
- * <p>The EC2 instance isn't present.</p>
102
- * </li>
103
- * </ul>
84
+ * <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>
104
85
  *
105
86
  * @throws {@link ConflictException} (client fault)
106
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
107
- * than 1 operation on the same resource at the same time.</p>
108
- * <p>
109
- * <u>Examples</u>
110
- * </p>
111
- * <ul>
112
- * <li>
113
- * <p>A cluster with the same name already exists.</p>
114
- * </li>
115
- * <li>
116
- * <p>A cluster isn't in <code>ACTIVE</code> status.</p>
117
- * </li>
118
- * <li>
119
- * <p>A cluster to delete is in an unstable state. For example, because it still has
120
- * <code>ACTIVE</code> node groups or queues.</p>
121
- * </li>
122
- * <li>
123
- * <p>A queue already exists in a cluster.</p>
124
- * </li>
125
- * </ul>
87
+ * <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>
126
88
  *
127
89
  * @throws {@link InternalServerException} (server fault)
128
90
  * <p>Amazon Web Services PCS can't process your request right now. Try again later.</p>
129
91
  *
130
92
  * @throws {@link ResourceNotFoundException} (client fault)
131
- * <p>The requested resource can't be found. The cluster, node group, or queue you're
132
- * attempting to get, update, list, or delete doesn't exist.</p>
133
- * <p>
134
- * <u>Examples</u>
135
- * </p>
93
+ * <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>
136
94
  *
137
95
  * @throws {@link ServiceQuotaExceededException} (client fault)
138
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
139
- * maximum number of service resources or operations for your Amazon Web Services account. To learn how to
140
- * increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota
141
- * increase</a> in the <i>Service Quotas User Guide</i>
142
- * </p>
143
- * <p>
144
- * <u>Examples</u>
145
- * </p>
146
- * <ul>
147
- * <li>
148
- * <p>The max number of clusters or queues has been reached for the account.</p>
149
- * </li>
150
- * <li>
151
- * <p>The max number of compute node groups has been reached for the associated
152
- * cluster.</p>
153
- * </li>
154
- * <li>
155
- * <p>The total of <code>maxInstances</code> across all compute node groups has been
156
- * reached for associated cluster.</p>
157
- * </li>
158
- * </ul>
96
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota increase</a> in the <i>Service Quotas User Guide</i> </p> <p> <u>Examples</u> </p> <ul> <li> <p>The max number of clusters or queues has been reached for the account.</p> </li> <li> <p>The max number of compute node groups has been reached for the associated cluster.</p> </li> <li> <p>The total of <code>maxInstances</code> across all compute node groups has been reached for associated cluster.</p> </li> </ul>
159
97
  *
160
98
  * @throws {@link ThrottlingException} (client fault)
161
99
  * <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
162
100
  *
163
101
  * @throws {@link ValidationException} (client fault)
164
- * <p>The request isn't valid.</p>
165
- * <p>
166
- * <u>Examples</u>
167
- * </p>
168
- * <ul>
169
- * <li>
170
- * <p>Your request contains malformed JSON or unsupported characters.</p>
171
- * </li>
172
- * <li>
173
- * <p>The scheduler version isn't supported.</p>
174
- * </li>
175
- * <li>
176
- * <p>There are networking related errors, such as network validation failure.</p>
177
- * </li>
178
- * <li>
179
- * <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID,
180
- * or the AMI type is AL2 and the launch template defines the AMI.</p>
181
- * </li>
182
- * </ul>
102
+ * <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>
183
103
  *
184
104
  * @throws {@link PCSServiceException}
185
105
  * <p>Base exception class for all service exceptions from PCS service.</p>
@@ -27,8 +27,7 @@ declare const DeleteClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a cluster and all its linked resources. You must delete all queues and compute
31
- * node groups associated with the cluster before you can delete the cluster.</p>
30
+ * <p>Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -52,81 +51,22 @@ declare const DeleteClusterCommand_base: {
52
51
  * @see {@link PCSClientResolvedConfig | config} for PCSClient's `config` shape.
53
52
  *
54
53
  * @throws {@link AccessDeniedException} (client fault)
55
- * <p>You don't have permission to perform the action.</p>
56
- * <p>
57
- * <u>Examples</u>
58
- * </p>
59
- * <ul>
60
- * <li>
61
- * <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
62
- * verification.</p>
63
- * </li>
64
- * <li>
65
- * <p>There is a mismatch between the account ID and cluster ID.</p>
66
- * </li>
67
- * <li>
68
- * <p>The cluster ID doesn't exist.</p>
69
- * </li>
70
- * <li>
71
- * <p>The EC2 instance isn't present.</p>
72
- * </li>
73
- * </ul>
54
+ * <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>
74
55
  *
75
56
  * @throws {@link ConflictException} (client fault)
76
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
77
- * than 1 operation on the same resource at the same time.</p>
78
- * <p>
79
- * <u>Examples</u>
80
- * </p>
81
- * <ul>
82
- * <li>
83
- * <p>A cluster with the same name already exists.</p>
84
- * </li>
85
- * <li>
86
- * <p>A cluster isn't in <code>ACTIVE</code> status.</p>
87
- * </li>
88
- * <li>
89
- * <p>A cluster to delete is in an unstable state. For example, because it still has
90
- * <code>ACTIVE</code> node groups or queues.</p>
91
- * </li>
92
- * <li>
93
- * <p>A queue already exists in a cluster.</p>
94
- * </li>
95
- * </ul>
57
+ * <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>
96
58
  *
97
59
  * @throws {@link InternalServerException} (server fault)
98
60
  * <p>Amazon Web Services PCS can't process your request right now. Try again later.</p>
99
61
  *
100
62
  * @throws {@link ResourceNotFoundException} (client fault)
101
- * <p>The requested resource can't be found. The cluster, node group, or queue you're
102
- * attempting to get, update, list, or delete doesn't exist.</p>
103
- * <p>
104
- * <u>Examples</u>
105
- * </p>
63
+ * <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>
106
64
  *
107
65
  * @throws {@link ThrottlingException} (client fault)
108
66
  * <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
109
67
  *
110
68
  * @throws {@link ValidationException} (client fault)
111
- * <p>The request isn't valid.</p>
112
- * <p>
113
- * <u>Examples</u>
114
- * </p>
115
- * <ul>
116
- * <li>
117
- * <p>Your request contains malformed JSON or unsupported characters.</p>
118
- * </li>
119
- * <li>
120
- * <p>The scheduler version isn't supported.</p>
121
- * </li>
122
- * <li>
123
- * <p>There are networking related errors, such as network validation failure.</p>
124
- * </li>
125
- * <li>
126
- * <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID,
127
- * or the AMI type is AL2 and the launch template defines the AMI.</p>
128
- * </li>
129
- * </ul>
69
+ * <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>
130
70
  *
131
71
  * @throws {@link PCSServiceException}
132
72
  * <p>Base exception class for all service exceptions from PCS service.</p>