@aws-sdk/client-pcs 3.808.0 → 3.811.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.
- package/README.md +1 -18
- package/dist-cjs/models/models_0.js +5 -1
- package/dist-es/models/models_0.js +4 -0
- package/dist-types/PCS.d.ts +1 -18
- package/dist-types/PCSClient.d.ts +1 -18
- package/dist-types/commands/CreateClusterCommand.d.ts +13 -91
- package/dist-types/commands/CreateComputeNodeGroupCommand.d.ts +6 -93
- package/dist-types/commands/CreateQueueCommand.d.ts +6 -86
- package/dist-types/commands/DeleteClusterCommand.d.ts +5 -65
- package/dist-types/commands/DeleteComputeNodeGroupCommand.d.ts +5 -65
- package/dist-types/commands/DeleteQueueCommand.d.ts +5 -66
- package/dist-types/commands/GetClusterCommand.d.ts +9 -66
- package/dist-types/commands/GetComputeNodeGroupCommand.d.ts +5 -66
- package/dist-types/commands/GetQueueCommand.d.ts +5 -65
- package/dist-types/commands/ListClustersCommand.d.ts +4 -63
- package/dist-types/commands/ListComputeNodeGroupsCommand.d.ts +4 -63
- package/dist-types/commands/ListQueuesCommand.d.ts +4 -63
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -5
- package/dist-types/commands/RegisterComputeNodeGroupInstanceCommand.d.ts +2 -23
- package/dist-types/commands/TagResourceCommand.d.ts +3 -30
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -7
- package/dist-types/commands/UpdateComputeNodeGroupCommand.d.ts +6 -87
- package/dist-types/commands/UpdateQueueCommand.d.ts +6 -86
- package/dist-types/index.d.ts +1 -18
- package/dist-types/models/models_0.d.ts +137 -550
- package/dist-types/ts3.4/models/models_0.d.ts +16 -0
- package/package.json +12 -12
|
@@ -1,25 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { PCSServiceException as __BaseException } from "./PCSServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>You don't have permission to perform the action.</p>
|
|
5
|
-
* <p>
|
|
6
|
-
* <u>Examples</u>
|
|
7
|
-
* </p>
|
|
8
|
-
* <ul>
|
|
9
|
-
* <li>
|
|
10
|
-
* <p>The launch template instance profile doesn't pass <code>iam:PassRole</code>
|
|
11
|
-
* verification.</p>
|
|
12
|
-
* </li>
|
|
13
|
-
* <li>
|
|
14
|
-
* <p>There is a mismatch between the account ID and cluster ID.</p>
|
|
15
|
-
* </li>
|
|
16
|
-
* <li>
|
|
17
|
-
* <p>The cluster ID doesn't exist.</p>
|
|
18
|
-
* </li>
|
|
19
|
-
* <li>
|
|
20
|
-
* <p>The EC2 instance isn't present.</p>
|
|
21
|
-
* </li>
|
|
22
|
-
* </ul>
|
|
4
|
+
* <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>
|
|
23
5
|
* @public
|
|
24
6
|
*/
|
|
25
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -31,42 +13,63 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
31
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
32
14
|
}
|
|
33
15
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
*
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
16
|
+
* @public
|
|
17
|
+
* @enum
|
|
18
|
+
*/
|
|
19
|
+
export declare const AccountingMode: {
|
|
20
|
+
readonly NONE: "NONE";
|
|
21
|
+
readonly STANDARD: "STANDARD";
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export type AccountingMode = (typeof AccountingMode)[keyof typeof AccountingMode];
|
|
27
|
+
/**
|
|
28
|
+
* <p>The accounting configuration includes configurable settings for Slurm accounting. It's a property of the <b>ClusterSlurmConfiguration</b> object.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface Accounting {
|
|
32
|
+
/**
|
|
33
|
+
* <p>The default value for <code>mode</code> is <code>STANDARD</code>. A value of <code>STANDARD</code> means Slurm accounting is enabled.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
mode: AccountingMode | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>The default value for all purge settings for <code>slurmdbd.conf</code>. For more information, see the <a href="https://slurm.schedmd.com/slurmdbd.conf.html">slurmdbd.conf documentation at SchedMD</a>.</p> <p>The default value for <code>defaultPurgeTimeInDays</code> is <code>-1</code>.</p> <p>A value of <code>-1</code> means there is no purge time and records persist as long as the cluster exists.</p> <important> <p> <code>0</code> isn't a valid value.</p> </important>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
defaultPurgeTimeInDays?: number | undefined;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* <p>The accounting configuration includes configurable settings for Slurm accounting. It's a property of the <b>ClusterSlurmConfiguration</b> object.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
export interface AccountingRequest {
|
|
48
|
+
/**
|
|
49
|
+
* <p>The default value for <code>mode</code> is <code>STANDARD</code>. A value of <code>STANDARD</code> means Slurm accounting is enabled.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
mode: AccountingMode | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>The default value for all purge settings for <code>slurmdbd.conf</code>. For more information, see the <a href="https://slurm.schedmd.com/slurmdbd.conf.html">slurmdbd.conf documentation at SchedMD</a>.</p> <p>The default value for <code>defaultPurgeTimeInDays</code> is <code>-1</code>.</p> <p>A value of <code>-1</code> means there is no purge time and records persist as long as the cluster exists.</p> <important> <p> <code>0</code> isn't a valid value.</p> </important>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
defaultPurgeTimeInDays?: number | undefined;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* <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>
|
|
54
61
|
* @public
|
|
55
62
|
*/
|
|
56
63
|
export declare class ConflictException extends __BaseException {
|
|
57
64
|
readonly name: "ConflictException";
|
|
58
65
|
readonly $fault: "client";
|
|
59
66
|
/**
|
|
60
|
-
* <p>
|
|
61
|
-
* The unique identifier of the resource that caused the conflict exception.
|
|
62
|
-
* </p>
|
|
67
|
+
* <p> The unique identifier of the resource that caused the conflict exception. </p>
|
|
63
68
|
* @public
|
|
64
69
|
*/
|
|
65
70
|
resourceId: string | undefined;
|
|
66
71
|
/**
|
|
67
|
-
* <p>
|
|
68
|
-
* The type or category of the resource that caused the conflict exception."
|
|
69
|
-
* </p>
|
|
72
|
+
* <p> The type or category of the resource that caused the conflict exception." </p>
|
|
70
73
|
* @public
|
|
71
74
|
*/
|
|
72
75
|
resourceType: string | undefined;
|
|
@@ -81,9 +84,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
81
84
|
*/
|
|
82
85
|
export interface CustomLaunchTemplate {
|
|
83
86
|
/**
|
|
84
|
-
* <p>The ID of the EC2 launch template to use to provision instances.</p>
|
|
85
|
-
* <p> Example: <code>lt-xxxx</code>
|
|
86
|
-
* </p>
|
|
87
|
+
* <p>The ID of the EC2 launch template to use to provision instances.</p> <p> Example: <code>lt-xxxx</code> </p>
|
|
87
88
|
* @public
|
|
88
89
|
*/
|
|
89
90
|
id: string | undefined;
|
|
@@ -99,9 +100,7 @@ export interface CustomLaunchTemplate {
|
|
|
99
100
|
*/
|
|
100
101
|
export interface InstanceConfig {
|
|
101
102
|
/**
|
|
102
|
-
* <p>The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.</p>
|
|
103
|
-
* <p> Example: <code>t2.xlarge</code>
|
|
104
|
-
* </p>
|
|
103
|
+
* <p>The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.</p> <p> Example: <code>t2.xlarge</code> </p>
|
|
105
104
|
* @public
|
|
106
105
|
*/
|
|
107
106
|
instanceType?: string | undefined;
|
|
@@ -140,56 +139,7 @@ export interface ScalingConfigurationRequest {
|
|
|
140
139
|
*/
|
|
141
140
|
export interface SlurmCustomSetting {
|
|
142
141
|
/**
|
|
143
|
-
* <p>Amazon Web Services PCS supports configuration of the following Slurm parameters:</p>
|
|
144
|
-
* <ul>
|
|
145
|
-
* <li>
|
|
146
|
-
* <p>For <b>clusters</b>
|
|
147
|
-
* </p>
|
|
148
|
-
* <ul>
|
|
149
|
-
* <li>
|
|
150
|
-
* <p>
|
|
151
|
-
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1">
|
|
152
|
-
* <code>Prolog</code>
|
|
153
|
-
* </a>
|
|
154
|
-
* </p>
|
|
155
|
-
* </li>
|
|
156
|
-
* <li>
|
|
157
|
-
* <p>
|
|
158
|
-
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1">
|
|
159
|
-
* <code>Epilog</code>
|
|
160
|
-
* </a>
|
|
161
|
-
* </p>
|
|
162
|
-
* </li>
|
|
163
|
-
* <li>
|
|
164
|
-
* <p>
|
|
165
|
-
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters">
|
|
166
|
-
* <code>SelectTypeParameters</code>
|
|
167
|
-
* </a>
|
|
168
|
-
* </p>
|
|
169
|
-
* </li>
|
|
170
|
-
* </ul>
|
|
171
|
-
* </li>
|
|
172
|
-
* <li>
|
|
173
|
-
* <p>For <b>compute node groups</b>
|
|
174
|
-
* </p>
|
|
175
|
-
* <ul>
|
|
176
|
-
* <li>
|
|
177
|
-
* <p>
|
|
178
|
-
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight">
|
|
179
|
-
* <code>Weight</code>
|
|
180
|
-
* </a>
|
|
181
|
-
* </p>
|
|
182
|
-
* </li>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p>
|
|
185
|
-
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight">
|
|
186
|
-
* <code>RealMemory</code>
|
|
187
|
-
* </a>
|
|
188
|
-
* </p>
|
|
189
|
-
* </li>
|
|
190
|
-
* </ul>
|
|
191
|
-
* </li>
|
|
192
|
-
* </ul>
|
|
142
|
+
* <p>Amazon Web Services PCS supports configuration of the following Slurm parameters:</p> <ul> <li> <p>For <b>clusters</b> </p> <ul> <li> <p> <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1"> <code>Prolog</code> </a> </p> </li> <li> <p> <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1"> <code>Epilog</code> </a> </p> </li> <li> <p> <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters"> <code>SelectTypeParameters</code> </a> </p> </li> </ul> </li> <li> <p>For <b>compute node groups</b> </p> <ul> <li> <p> <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight"> <code>Weight</code> </a> </p> </li> <li> <p> <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight"> <code>RealMemory</code> </a> </p> </li> </ul> </li> </ul>
|
|
193
143
|
* @public
|
|
194
144
|
*/
|
|
195
145
|
parameterName: string | undefined;
|
|
@@ -224,20 +174,12 @@ export declare const SpotAllocationStrategy: {
|
|
|
224
174
|
*/
|
|
225
175
|
export type SpotAllocationStrategy = (typeof SpotAllocationStrategy)[keyof typeof SpotAllocationStrategy];
|
|
226
176
|
/**
|
|
227
|
-
* <p>Additional configuration when you specify <code>SPOT</code> as the
|
|
228
|
-
* <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
177
|
+
* <p>Additional configuration when you specify <code>SPOT</code> as the <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
229
178
|
* @public
|
|
230
179
|
*/
|
|
231
180
|
export interface SpotOptions {
|
|
232
181
|
/**
|
|
233
|
-
* <p>The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances.
|
|
234
|
-
* Amazon Web Services PCS supports <b>lowest price</b>,
|
|
235
|
-
* <b>capacity optimized</b>, and
|
|
236
|
-
* <b>price capacity optimized</b>.
|
|
237
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html">Use
|
|
238
|
-
* allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand
|
|
239
|
-
* capacity</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option,
|
|
240
|
-
* it defaults to <b>price capacity optimized</b>.</p>
|
|
182
|
+
* <p>The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports <b>lowest price</b>, <b>capacity optimized</b>, and <b>price capacity optimized</b>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html">Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to <b>price capacity optimized</b>.</p>
|
|
241
183
|
* @public
|
|
242
184
|
*/
|
|
243
185
|
allocationStrategy?: SpotAllocationStrategy | undefined;
|
|
@@ -252,29 +194,22 @@ export interface CreateComputeNodeGroupRequest {
|
|
|
252
194
|
*/
|
|
253
195
|
clusterIdentifier: string | undefined;
|
|
254
196
|
/**
|
|
255
|
-
* <p>A name to identify the cluster. Example: <code>MyCluster</code>
|
|
256
|
-
* </p>
|
|
197
|
+
* <p>A name to identify the cluster. Example: <code>MyCluster</code> </p>
|
|
257
198
|
* @public
|
|
258
199
|
*/
|
|
259
200
|
computeNodeGroupName: string | undefined;
|
|
260
201
|
/**
|
|
261
|
-
* <p> The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes
|
|
262
|
-
* (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified
|
|
263
|
-
* in the custom launch template.</p>
|
|
202
|
+
* <p> The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.</p>
|
|
264
203
|
* @public
|
|
265
204
|
*/
|
|
266
205
|
amiId?: string | undefined;
|
|
267
206
|
/**
|
|
268
|
-
* <p>The list of subnet IDs where the compute node group launches instances.
|
|
269
|
-
* Subnets must be in the same VPC as the cluster.</p>
|
|
207
|
+
* <p>The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.</p>
|
|
270
208
|
* @public
|
|
271
209
|
*/
|
|
272
210
|
subnetIds: string[] | undefined;
|
|
273
211
|
/**
|
|
274
|
-
* <p>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand
|
|
275
|
-
* and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance
|
|
276
|
-
* purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this
|
|
277
|
-
* option, it defaults to On-Demand.</p>
|
|
212
|
+
* <p>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to On-Demand.</p>
|
|
278
213
|
* @public
|
|
279
214
|
*/
|
|
280
215
|
purchaseOption?: PurchaseOption | undefined;
|
|
@@ -284,26 +219,7 @@ export interface CreateComputeNodeGroupRequest {
|
|
|
284
219
|
*/
|
|
285
220
|
customLaunchTemplate: CustomLaunchTemplate | undefined;
|
|
286
221
|
/**
|
|
287
|
-
* <p>The Amazon Resource Name (ARN) of the IAM instance
|
|
288
|
-
* profile used to pass an IAM role when launching EC2 instances. The role contained
|
|
289
|
-
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
|
|
290
|
-
* permission. The resource identifier of the ARN must start with
|
|
291
|
-
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
|
|
292
|
-
* <p class="title">
|
|
293
|
-
* <b>Examples</b>
|
|
294
|
-
* </p>
|
|
295
|
-
* <ul>
|
|
296
|
-
* <li>
|
|
297
|
-
* <p>
|
|
298
|
-
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
|
|
299
|
-
* </p>
|
|
300
|
-
* </li>
|
|
301
|
-
* <li>
|
|
302
|
-
* <p>
|
|
303
|
-
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
|
|
304
|
-
* </p>
|
|
305
|
-
* </li>
|
|
306
|
-
* </ul>
|
|
222
|
+
* <p>The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code> permission. The resource identifier of the ARN must start with <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p> <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code> </p> </li> <li> <p> <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code> </p> </li> </ul>
|
|
307
223
|
* @public
|
|
308
224
|
*/
|
|
309
225
|
iamInstanceProfileArn: string | undefined;
|
|
@@ -318,8 +234,7 @@ export interface CreateComputeNodeGroupRequest {
|
|
|
318
234
|
*/
|
|
319
235
|
instanceConfigs: InstanceConfig[] | undefined;
|
|
320
236
|
/**
|
|
321
|
-
* <p>Additional configuration when you specify <code>SPOT</code> as the
|
|
322
|
-
* <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
237
|
+
* <p>Additional configuration when you specify <code>SPOT</code> as the <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
323
238
|
* @public
|
|
324
239
|
*/
|
|
325
240
|
spotOptions?: SpotOptions | undefined;
|
|
@@ -329,20 +244,12 @@ export interface CreateComputeNodeGroupRequest {
|
|
|
329
244
|
*/
|
|
330
245
|
slurmConfiguration?: ComputeNodeGroupSlurmConfigurationRequest | undefined;
|
|
331
246
|
/**
|
|
332
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
333
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
334
|
-
* request completes only once. With an idempotent request, if the original
|
|
335
|
-
* request completes successfully, the subsequent retries with the same
|
|
336
|
-
* client token return the result from the original successful request and
|
|
337
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
338
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
247
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
339
248
|
* @public
|
|
340
249
|
*/
|
|
341
250
|
clientToken?: string | undefined;
|
|
342
251
|
/**
|
|
343
|
-
* <p>1 or more tags added to the resource. Each tag consists of a
|
|
344
|
-
* tag key and tag value. The tag value is optional and can be an empty
|
|
345
|
-
* string.</p>
|
|
252
|
+
* <p>1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.</p>
|
|
346
253
|
* @public
|
|
347
254
|
*/
|
|
348
255
|
tags?: Record<string, string> | undefined;
|
|
@@ -444,31 +351,22 @@ export interface ComputeNodeGroup {
|
|
|
444
351
|
*/
|
|
445
352
|
modifiedAt: Date | undefined;
|
|
446
353
|
/**
|
|
447
|
-
* <p>The provisioning status of the compute node group.</p>
|
|
448
|
-
* <note>
|
|
449
|
-
* <p>The provisioning status doesn't indicate the overall health of the compute node
|
|
450
|
-
* group.</p>
|
|
451
|
-
* </note>
|
|
354
|
+
* <p>The provisioning status of the compute node group.</p> <note> <p>The provisioning status doesn't indicate the overall health of the compute node group.</p> </note>
|
|
452
355
|
* @public
|
|
453
356
|
*/
|
|
454
357
|
status: ComputeNodeGroupStatus | undefined;
|
|
455
358
|
/**
|
|
456
|
-
* <p>The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.
|
|
457
|
-
* If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.</p>
|
|
359
|
+
* <p>The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.</p>
|
|
458
360
|
* @public
|
|
459
361
|
*/
|
|
460
362
|
amiId?: string | undefined;
|
|
461
363
|
/**
|
|
462
|
-
* <p>The list of subnet IDs where instances are provisioned by the compute node group.
|
|
463
|
-
* The subnets must be in the same VPC as the cluster.</p>
|
|
364
|
+
* <p>The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.</p>
|
|
464
365
|
* @public
|
|
465
366
|
*/
|
|
466
367
|
subnetIds: string[] | undefined;
|
|
467
368
|
/**
|
|
468
|
-
* <p>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand
|
|
469
|
-
* and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance
|
|
470
|
-
* purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this
|
|
471
|
-
* option, it defaults to On-Demand.</p>
|
|
369
|
+
* <p>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to On-Demand.</p>
|
|
472
370
|
* @public
|
|
473
371
|
*/
|
|
474
372
|
purchaseOption?: PurchaseOption | undefined;
|
|
@@ -478,26 +376,7 @@ export interface ComputeNodeGroup {
|
|
|
478
376
|
*/
|
|
479
377
|
customLaunchTemplate: CustomLaunchTemplate | undefined;
|
|
480
378
|
/**
|
|
481
|
-
* <p>The Amazon Resource Name (ARN) of the IAM instance
|
|
482
|
-
* profile used to pass an IAM role when launching EC2 instances. The role contained
|
|
483
|
-
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
|
|
484
|
-
* permission. The resource identifier of the ARN must start with
|
|
485
|
-
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
|
|
486
|
-
* <p class="title">
|
|
487
|
-
* <b>Examples</b>
|
|
488
|
-
* </p>
|
|
489
|
-
* <ul>
|
|
490
|
-
* <li>
|
|
491
|
-
* <p>
|
|
492
|
-
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
|
|
493
|
-
* </p>
|
|
494
|
-
* </li>
|
|
495
|
-
* <li>
|
|
496
|
-
* <p>
|
|
497
|
-
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
|
|
498
|
-
* </p>
|
|
499
|
-
* </li>
|
|
500
|
-
* </ul>
|
|
379
|
+
* <p>The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code> permission. The resource identifier of the ARN must start with <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p> <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code> </p> </li> <li> <p> <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code> </p> </li> </ul>
|
|
501
380
|
* @public
|
|
502
381
|
*/
|
|
503
382
|
iamInstanceProfileArn: string | undefined;
|
|
@@ -512,8 +391,7 @@ export interface ComputeNodeGroup {
|
|
|
512
391
|
*/
|
|
513
392
|
instanceConfigs: InstanceConfig[] | undefined;
|
|
514
393
|
/**
|
|
515
|
-
* <p>Additional configuration when you specify <code>SPOT</code> as the
|
|
516
|
-
* <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
394
|
+
* <p>Additional configuration when you specify <code>SPOT</code> as the <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
517
395
|
* @public
|
|
518
396
|
*/
|
|
519
397
|
spotOptions?: SpotOptions | undefined;
|
|
@@ -552,27 +430,19 @@ export declare class InternalServerException extends __BaseException {
|
|
|
552
430
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
553
431
|
}
|
|
554
432
|
/**
|
|
555
|
-
* <p>The requested resource can't be found. The cluster, node group, or queue you're
|
|
556
|
-
* attempting to get, update, list, or delete doesn't exist.</p>
|
|
557
|
-
* <p>
|
|
558
|
-
* <u>Examples</u>
|
|
559
|
-
* </p>
|
|
433
|
+
* <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>
|
|
560
434
|
* @public
|
|
561
435
|
*/
|
|
562
436
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
563
437
|
readonly name: "ResourceNotFoundException";
|
|
564
438
|
readonly $fault: "client";
|
|
565
439
|
/**
|
|
566
|
-
* <p>
|
|
567
|
-
* The unique identifier of the resource that was not found.
|
|
568
|
-
* </p>
|
|
440
|
+
* <p> The unique identifier of the resource that was not found. </p>
|
|
569
441
|
* @public
|
|
570
442
|
*/
|
|
571
443
|
resourceId: string | undefined;
|
|
572
444
|
/**
|
|
573
|
-
* <p>
|
|
574
|
-
* The type or category of the resource that was not found.
|
|
575
|
-
* </p>
|
|
445
|
+
* <p> The type or category of the resource that was not found. </p>
|
|
576
446
|
* @public
|
|
577
447
|
*/
|
|
578
448
|
resourceType: string | undefined;
|
|
@@ -582,57 +452,29 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
582
452
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
583
453
|
}
|
|
584
454
|
/**
|
|
585
|
-
* <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
|
|
586
|
-
* maximum number of service resources or operations for your Amazon Web Services account. To learn how to
|
|
587
|
-
* increase your service quota, see <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html">Requesting a quota
|
|
588
|
-
* increase</a> in the <i>Service Quotas User Guide</i>
|
|
589
|
-
* </p>
|
|
590
|
-
* <p>
|
|
591
|
-
* <u>Examples</u>
|
|
592
|
-
* </p>
|
|
593
|
-
* <ul>
|
|
594
|
-
* <li>
|
|
595
|
-
* <p>The max number of clusters or queues has been reached for the account.</p>
|
|
596
|
-
* </li>
|
|
597
|
-
* <li>
|
|
598
|
-
* <p>The max number of compute node groups has been reached for the associated
|
|
599
|
-
* cluster.</p>
|
|
600
|
-
* </li>
|
|
601
|
-
* <li>
|
|
602
|
-
* <p>The total of <code>maxInstances</code> across all compute node groups has been
|
|
603
|
-
* reached for associated cluster.</p>
|
|
604
|
-
* </li>
|
|
605
|
-
* </ul>
|
|
455
|
+
* <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>
|
|
606
456
|
* @public
|
|
607
457
|
*/
|
|
608
458
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
609
459
|
readonly name: "ServiceQuotaExceededException";
|
|
610
460
|
readonly $fault: "client";
|
|
611
461
|
/**
|
|
612
|
-
* <p>
|
|
613
|
-
* The service code associated with the quota that was exceeded.
|
|
614
|
-
* </p>
|
|
462
|
+
* <p> The service code associated with the quota that was exceeded. </p>
|
|
615
463
|
* @public
|
|
616
464
|
*/
|
|
617
465
|
serviceCode: string | undefined;
|
|
618
466
|
/**
|
|
619
|
-
* <p>
|
|
620
|
-
* The unique identifier of the resource that caused the quota to be exceeded.
|
|
621
|
-
* </p>
|
|
467
|
+
* <p> The unique identifier of the resource that caused the quota to be exceeded. </p>
|
|
622
468
|
* @public
|
|
623
469
|
*/
|
|
624
470
|
resourceId?: string | undefined;
|
|
625
471
|
/**
|
|
626
|
-
* <p>
|
|
627
|
-
* The type or category of the resource that caused the quota to be exceeded.
|
|
628
|
-
* </p>
|
|
472
|
+
* <p> The type or category of the resource that caused the quota to be exceeded. </p>
|
|
629
473
|
* @public
|
|
630
474
|
*/
|
|
631
475
|
resourceType?: string | undefined;
|
|
632
476
|
/**
|
|
633
|
-
* <p>
|
|
634
|
-
* The <b>quota code</b> of the service quota that was exceeded.
|
|
635
|
-
* </p>
|
|
477
|
+
* <p> The <b>quota code</b> of the service quota that was exceeded. </p>
|
|
636
478
|
* @public
|
|
637
479
|
*/
|
|
638
480
|
quotaCode?: string | undefined;
|
|
@@ -650,9 +492,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
650
492
|
readonly $fault: "client";
|
|
651
493
|
$retryable: {};
|
|
652
494
|
/**
|
|
653
|
-
* <p>
|
|
654
|
-
* The number of seconds to wait before retrying the request.
|
|
655
|
-
* </p>
|
|
495
|
+
* <p> The number of seconds to wait before retrying the request. </p>
|
|
656
496
|
* @public
|
|
657
497
|
*/
|
|
658
498
|
retryAfterSeconds?: number | undefined;
|
|
@@ -692,41 +532,19 @@ export declare const ValidationExceptionReason: {
|
|
|
692
532
|
*/
|
|
693
533
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
694
534
|
/**
|
|
695
|
-
* <p>The request isn't valid.</p>
|
|
696
|
-
* <p>
|
|
697
|
-
* <u>Examples</u>
|
|
698
|
-
* </p>
|
|
699
|
-
* <ul>
|
|
700
|
-
* <li>
|
|
701
|
-
* <p>Your request contains malformed JSON or unsupported characters.</p>
|
|
702
|
-
* </li>
|
|
703
|
-
* <li>
|
|
704
|
-
* <p>The scheduler version isn't supported.</p>
|
|
705
|
-
* </li>
|
|
706
|
-
* <li>
|
|
707
|
-
* <p>There are networking related errors, such as network validation failure.</p>
|
|
708
|
-
* </li>
|
|
709
|
-
* <li>
|
|
710
|
-
* <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID,
|
|
711
|
-
* or the AMI type is AL2 and the launch template defines the AMI.</p>
|
|
712
|
-
* </li>
|
|
713
|
-
* </ul>
|
|
535
|
+
* <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>
|
|
714
536
|
* @public
|
|
715
537
|
*/
|
|
716
538
|
export declare class ValidationException extends __BaseException {
|
|
717
539
|
readonly name: "ValidationException";
|
|
718
540
|
readonly $fault: "client";
|
|
719
541
|
/**
|
|
720
|
-
* <p>
|
|
721
|
-
* The specific reason or cause of the validation error.
|
|
722
|
-
* </p>
|
|
542
|
+
* <p> The specific reason or cause of the validation error. </p>
|
|
723
543
|
* @public
|
|
724
544
|
*/
|
|
725
545
|
reason: ValidationExceptionReason | undefined;
|
|
726
546
|
/**
|
|
727
|
-
* <p>
|
|
728
|
-
* A list of fields or properties that failed validation.
|
|
729
|
-
* </p>
|
|
547
|
+
* <p> A list of fields or properties that failed validation. </p>
|
|
730
548
|
* @public
|
|
731
549
|
*/
|
|
732
550
|
fieldList?: ValidationExceptionField[] | undefined;
|
|
@@ -750,13 +568,7 @@ export interface DeleteComputeNodeGroupRequest {
|
|
|
750
568
|
*/
|
|
751
569
|
computeNodeGroupIdentifier: string | undefined;
|
|
752
570
|
/**
|
|
753
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
754
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
755
|
-
* request completes only once. With an idempotent request, if the original
|
|
756
|
-
* request completes successfully, the subsequent retries with the same
|
|
757
|
-
* client token return the result from the original successful request and
|
|
758
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
759
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
571
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
760
572
|
* @public
|
|
761
573
|
*/
|
|
762
574
|
clientToken?: string | undefined;
|
|
@@ -801,20 +613,12 @@ export interface ListComputeNodeGroupsRequest {
|
|
|
801
613
|
*/
|
|
802
614
|
clusterIdentifier: string | undefined;
|
|
803
615
|
/**
|
|
804
|
-
* <p>The value of <code>nextToken</code> is a unique pagination token
|
|
805
|
-
* for each page of results returned. If <code>nextToken</code> is returned, there are more
|
|
806
|
-
* results available. Make the call again using the returned token to retrieve the next page.
|
|
807
|
-
* Keep all other arguments unchanged. Each pagination token expires after 24 hours.
|
|
808
|
-
* Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code>
|
|
809
|
-
* error.</p>
|
|
616
|
+
* <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
|
|
810
617
|
* @public
|
|
811
618
|
*/
|
|
812
619
|
nextToken?: string | undefined;
|
|
813
620
|
/**
|
|
814
|
-
* <p>The maximum number of results that are returned per call.
|
|
815
|
-
* You can use <code>nextToken</code> to obtain further pages of results. The default
|
|
816
|
-
* is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses
|
|
817
|
-
* the default.</p>
|
|
621
|
+
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.</p>
|
|
818
622
|
* @public
|
|
819
623
|
*/
|
|
820
624
|
maxResults?: number | undefined;
|
|
@@ -855,11 +659,7 @@ export interface ComputeNodeGroupSummary {
|
|
|
855
659
|
*/
|
|
856
660
|
modifiedAt: Date | undefined;
|
|
857
661
|
/**
|
|
858
|
-
* <p>The provisioning status of the compute node group.</p>
|
|
859
|
-
* <note>
|
|
860
|
-
* <p>The provisioning status doesn't indicate the overall health of the compute node
|
|
861
|
-
* group.</p>
|
|
862
|
-
* </note>
|
|
662
|
+
* <p>The provisioning status of the compute node group.</p> <note> <p>The provisioning status doesn't indicate the overall health of the compute node group.</p> </note>
|
|
863
663
|
* @public
|
|
864
664
|
*/
|
|
865
665
|
status: ComputeNodeGroupStatus | undefined;
|
|
@@ -874,12 +674,7 @@ export interface ListComputeNodeGroupsResponse {
|
|
|
874
674
|
*/
|
|
875
675
|
computeNodeGroups: ComputeNodeGroupSummary[] | undefined;
|
|
876
676
|
/**
|
|
877
|
-
* <p>The value of <code>nextToken</code> is a unique pagination token
|
|
878
|
-
* for each page of results returned. If <code>nextToken</code> is returned, there are more
|
|
879
|
-
* results available. Make the call again using the returned token to retrieve the next page.
|
|
880
|
-
* Keep all other arguments unchanged. Each pagination token expires after 24 hours.
|
|
881
|
-
* Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code>
|
|
882
|
-
* error.</p>
|
|
677
|
+
* <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
|
|
883
678
|
* @public
|
|
884
679
|
*/
|
|
885
680
|
nextToken?: string | undefined;
|
|
@@ -910,15 +705,12 @@ export interface UpdateComputeNodeGroupRequest {
|
|
|
910
705
|
*/
|
|
911
706
|
computeNodeGroupIdentifier: string | undefined;
|
|
912
707
|
/**
|
|
913
|
-
* <p>The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.
|
|
914
|
-
* If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch
|
|
915
|
-
* template.</p>
|
|
708
|
+
* <p>The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.</p>
|
|
916
709
|
* @public
|
|
917
710
|
*/
|
|
918
711
|
amiId?: string | undefined;
|
|
919
712
|
/**
|
|
920
|
-
* <p>The list of subnet IDs where the compute node group provisions instances.
|
|
921
|
-
* The subnets must be in the same VPC as the cluster.</p>
|
|
713
|
+
* <p>The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.</p>
|
|
922
714
|
* @public
|
|
923
715
|
*/
|
|
924
716
|
subnetIds?: string[] | undefined;
|
|
@@ -928,16 +720,12 @@ export interface UpdateComputeNodeGroupRequest {
|
|
|
928
720
|
*/
|
|
929
721
|
customLaunchTemplate?: CustomLaunchTemplate | undefined;
|
|
930
722
|
/**
|
|
931
|
-
* <p>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand
|
|
932
|
-
* and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance
|
|
933
|
-
* purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this
|
|
934
|
-
* option, it defaults to On-Demand.</p>
|
|
723
|
+
* <p>Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html">Instance purchasing options</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. If you don't provide this option, it defaults to On-Demand.</p>
|
|
935
724
|
* @public
|
|
936
725
|
*/
|
|
937
726
|
purchaseOption?: PurchaseOption | undefined;
|
|
938
727
|
/**
|
|
939
|
-
* <p>Additional configuration when you specify <code>SPOT</code> as the
|
|
940
|
-
* <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
728
|
+
* <p>Additional configuration when you specify <code>SPOT</code> as the <code>purchaseOption</code> for the <code>CreateComputeNodeGroup</code> API action.</p>
|
|
941
729
|
* @public
|
|
942
730
|
*/
|
|
943
731
|
spotOptions?: SpotOptions | undefined;
|
|
@@ -947,26 +735,7 @@ export interface UpdateComputeNodeGroupRequest {
|
|
|
947
735
|
*/
|
|
948
736
|
scalingConfiguration?: ScalingConfigurationRequest | undefined;
|
|
949
737
|
/**
|
|
950
|
-
* <p>The Amazon Resource Name (ARN) of the IAM instance
|
|
951
|
-
* profile used to pass an IAM role when launching EC2 instances. The role contained
|
|
952
|
-
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
|
|
953
|
-
* permission. The resource identifier of the ARN must start with
|
|
954
|
-
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
|
|
955
|
-
* <p class="title">
|
|
956
|
-
* <b>Examples</b>
|
|
957
|
-
* </p>
|
|
958
|
-
* <ul>
|
|
959
|
-
* <li>
|
|
960
|
-
* <p>
|
|
961
|
-
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
|
|
962
|
-
* </p>
|
|
963
|
-
* </li>
|
|
964
|
-
* <li>
|
|
965
|
-
* <p>
|
|
966
|
-
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
|
|
967
|
-
* </p>
|
|
968
|
-
* </li>
|
|
969
|
-
* </ul>
|
|
738
|
+
* <p>The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code> permission. The resource identifier of the ARN must start with <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p> <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code> </p> </li> <li> <p> <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code> </p> </li> </ul>
|
|
970
739
|
* @public
|
|
971
740
|
*/
|
|
972
741
|
iamInstanceProfileArn?: string | undefined;
|
|
@@ -976,13 +745,7 @@ export interface UpdateComputeNodeGroupRequest {
|
|
|
976
745
|
*/
|
|
977
746
|
slurmConfiguration?: UpdateComputeNodeGroupSlurmConfigurationRequest | undefined;
|
|
978
747
|
/**
|
|
979
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
980
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
981
|
-
* request completes only once. With an idempotent request, if the original
|
|
982
|
-
* request completes successfully, the subsequent retries with the same
|
|
983
|
-
* client token return the result from the original successful request and
|
|
984
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
985
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
748
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
986
749
|
* @public
|
|
987
750
|
*/
|
|
988
751
|
clientToken?: string | undefined;
|
|
@@ -1003,13 +766,7 @@ export interface UpdateComputeNodeGroupResponse {
|
|
|
1003
766
|
*/
|
|
1004
767
|
export interface NetworkingRequest {
|
|
1005
768
|
/**
|
|
1006
|
-
* <p>The list of subnet IDs where Amazon Web Services PCS creates an
|
|
1007
|
-
* Elastic Network Interface (ENI) to enable communication between managed controllers
|
|
1008
|
-
* and Amazon Web Services PCS resources. Subnet IDs have the form <code>subnet-0123456789abcdef0</code>.</p>
|
|
1009
|
-
* <p>Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.</p>
|
|
1010
|
-
* <note>
|
|
1011
|
-
* <p>Amazon Web Services PCS currently supports only 1 subnet in this list.</p>
|
|
1012
|
-
* </note>
|
|
769
|
+
* <p>The list of subnet IDs where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. Subnet IDs have the form <code>subnet-0123456789abcdef0</code>.</p> <p>Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.</p> <note> <p>Amazon Web Services PCS currently supports only 1 subnet in this list.</p> </note>
|
|
1013
770
|
* @public
|
|
1014
771
|
*/
|
|
1015
772
|
subnetIds?: string[] | undefined;
|
|
@@ -1041,11 +798,7 @@ export interface SchedulerRequest {
|
|
|
1041
798
|
*/
|
|
1042
799
|
type: SchedulerType | undefined;
|
|
1043
800
|
/**
|
|
1044
|
-
* <p>The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
|
|
1045
|
-
* For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html">Slurm versions in
|
|
1046
|
-
* Amazon Web Services PCS</a> in the <i>Amazon Web Services PCS User Guide</i>.</p>
|
|
1047
|
-
* <p>Valid Values: <code>23.11 | 24.05</code>
|
|
1048
|
-
* </p>
|
|
801
|
+
* <p>The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html">Slurm versions in Amazon Web Services PCS</a> in the <i>Amazon Web Services PCS User Guide</i>.</p> <p>Valid Values: <code>23.11 | 24.05 | 24.11</code> </p>
|
|
1049
802
|
* @public
|
|
1050
803
|
*/
|
|
1051
804
|
version: string | undefined;
|
|
@@ -1069,9 +822,7 @@ export type Size = (typeof Size)[keyof typeof Size];
|
|
|
1069
822
|
*/
|
|
1070
823
|
export interface ClusterSlurmConfigurationRequest {
|
|
1071
824
|
/**
|
|
1072
|
-
* <p>The time (in seconds) before an idle node is scaled down.</p>
|
|
1073
|
-
* <p>Default: <code>600</code>
|
|
1074
|
-
* </p>
|
|
825
|
+
* <p>The time (in seconds) before an idle node is scaled down.</p> <p>Default: <code>600</code> </p>
|
|
1075
826
|
* @public
|
|
1076
827
|
*/
|
|
1077
828
|
scaleDownIdleTimeInSeconds?: number | undefined;
|
|
@@ -1080,14 +831,18 @@ export interface ClusterSlurmConfigurationRequest {
|
|
|
1080
831
|
* @public
|
|
1081
832
|
*/
|
|
1082
833
|
slurmCustomSettings?: SlurmCustomSetting[] | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* <p>The accounting configuration includes configurable settings for Slurm accounting.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
accounting?: AccountingRequest | undefined;
|
|
1083
839
|
}
|
|
1084
840
|
/**
|
|
1085
841
|
* @public
|
|
1086
842
|
*/
|
|
1087
843
|
export interface CreateClusterRequest {
|
|
1088
844
|
/**
|
|
1089
|
-
* <p>A name to identify the cluster. Example: <code>MyCluster</code>
|
|
1090
|
-
* </p>
|
|
845
|
+
* <p>A name to identify the cluster. Example: <code>MyCluster</code> </p>
|
|
1091
846
|
* @public
|
|
1092
847
|
*/
|
|
1093
848
|
clusterName: string | undefined;
|
|
@@ -1097,22 +852,7 @@ export interface CreateClusterRequest {
|
|
|
1097
852
|
*/
|
|
1098
853
|
scheduler: SchedulerRequest | undefined;
|
|
1099
854
|
/**
|
|
1100
|
-
* <p>A value that determines the maximum number of compute nodes in the cluster and the
|
|
1101
|
-
* maximum number of jobs (active and queued).</p>
|
|
1102
|
-
* <ul>
|
|
1103
|
-
* <li>
|
|
1104
|
-
* <p>
|
|
1105
|
-
* <code>SMALL</code>: 32 compute nodes and 256 jobs</p>
|
|
1106
|
-
* </li>
|
|
1107
|
-
* <li>
|
|
1108
|
-
* <p>
|
|
1109
|
-
* <code>MEDIUM</code>: 512 compute nodes and 8192 jobs</p>
|
|
1110
|
-
* </li>
|
|
1111
|
-
* <li>
|
|
1112
|
-
* <p>
|
|
1113
|
-
* <code>LARGE</code>: 2048 compute nodes and 16,384 jobs</p>
|
|
1114
|
-
* </li>
|
|
1115
|
-
* </ul>
|
|
855
|
+
* <p>A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).</p> <ul> <li> <p> <code>SMALL</code>: 32 compute nodes and 256 jobs</p> </li> <li> <p> <code>MEDIUM</code>: 512 compute nodes and 8192 jobs</p> </li> <li> <p> <code>LARGE</code>: 2048 compute nodes and 16,384 jobs</p> </li> </ul>
|
|
1116
856
|
* @public
|
|
1117
857
|
*/
|
|
1118
858
|
size: Size | undefined;
|
|
@@ -1127,20 +867,12 @@ export interface CreateClusterRequest {
|
|
|
1127
867
|
*/
|
|
1128
868
|
slurmConfiguration?: ClusterSlurmConfigurationRequest | undefined;
|
|
1129
869
|
/**
|
|
1130
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
1131
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
1132
|
-
* request completes only once. With an idempotent request, if the original
|
|
1133
|
-
* request completes successfully, the subsequent retries with the same
|
|
1134
|
-
* client token return the result from the original successful request and
|
|
1135
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
1136
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
870
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
1137
871
|
* @public
|
|
1138
872
|
*/
|
|
1139
873
|
clientToken?: string | undefined;
|
|
1140
874
|
/**
|
|
1141
|
-
* <p>1 or more tags added to the resource. Each tag consists of a
|
|
1142
|
-
* tag key and tag value. The tag value is optional and can be an empty
|
|
1143
|
-
* string.</p>
|
|
875
|
+
* <p>1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.</p>
|
|
1144
876
|
* @public
|
|
1145
877
|
*/
|
|
1146
878
|
tags?: Record<string, string> | undefined;
|
|
@@ -1168,23 +900,17 @@ export interface Endpoint {
|
|
|
1168
900
|
*/
|
|
1169
901
|
type: EndpointType | undefined;
|
|
1170
902
|
/**
|
|
1171
|
-
* <p>The endpoint's private IP address.</p>
|
|
1172
|
-
* <p>Example: <code>2.2.2.2</code>
|
|
1173
|
-
* </p>
|
|
903
|
+
* <p>The endpoint's private IP address.</p> <p>Example: <code>2.2.2.2</code> </p>
|
|
1174
904
|
* @public
|
|
1175
905
|
*/
|
|
1176
906
|
privateIpAddress: string | undefined;
|
|
1177
907
|
/**
|
|
1178
|
-
* <p>The endpoint's public IP address.</p>
|
|
1179
|
-
* <p>Example: <code>1.1.1.1</code>
|
|
1180
|
-
* </p>
|
|
908
|
+
* <p>The endpoint's public IP address.</p> <p>Example: <code>1.1.1.1</code> </p>
|
|
1181
909
|
* @public
|
|
1182
910
|
*/
|
|
1183
911
|
publicIpAddress?: string | undefined;
|
|
1184
912
|
/**
|
|
1185
|
-
* <p>The endpoint's connection port number.</p>
|
|
1186
|
-
* <p> Example: <code>1234</code>
|
|
1187
|
-
* </p>
|
|
913
|
+
* <p>The endpoint's connection port number.</p> <p> Example: <code>1234</code> </p>
|
|
1188
914
|
* @public
|
|
1189
915
|
*/
|
|
1190
916
|
port: string | undefined;
|
|
@@ -1195,63 +921,12 @@ export interface Endpoint {
|
|
|
1195
921
|
*/
|
|
1196
922
|
export interface Networking {
|
|
1197
923
|
/**
|
|
1198
|
-
* <p>The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to
|
|
1199
|
-
* enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must
|
|
1200
|
-
* have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS
|
|
1201
|
-
* Local Zone.</p>
|
|
1202
|
-
* <p> Example: <code>subnet-abcd1234</code>
|
|
1203
|
-
* </p>
|
|
924
|
+
* <p>The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone.</p> <p> Example: <code>subnet-abcd1234</code> </p>
|
|
1204
925
|
* @public
|
|
1205
926
|
*/
|
|
1206
927
|
subnetIds?: string[] | undefined;
|
|
1207
928
|
/**
|
|
1208
|
-
* <p>The list of security group IDs associated
|
|
1209
|
-
* with the Elastic Network Interface (ENI) created in subnets.</p>
|
|
1210
|
-
* <p>The following rules are required:</p>
|
|
1211
|
-
* <ul>
|
|
1212
|
-
* <li>
|
|
1213
|
-
* <p>Inbound rule 1</p>
|
|
1214
|
-
* <ul>
|
|
1215
|
-
* <li>
|
|
1216
|
-
* <p>Protocol: All</p>
|
|
1217
|
-
* </li>
|
|
1218
|
-
* <li>
|
|
1219
|
-
* <p>Ports: All</p>
|
|
1220
|
-
* </li>
|
|
1221
|
-
* <li>
|
|
1222
|
-
* <p>Source: Self</p>
|
|
1223
|
-
* </li>
|
|
1224
|
-
* </ul>
|
|
1225
|
-
* </li>
|
|
1226
|
-
* <li>
|
|
1227
|
-
* <p>Outbound rule 1</p>
|
|
1228
|
-
* <ul>
|
|
1229
|
-
* <li>
|
|
1230
|
-
* <p>Protocol: All</p>
|
|
1231
|
-
* </li>
|
|
1232
|
-
* <li>
|
|
1233
|
-
* <p>Ports: All</p>
|
|
1234
|
-
* </li>
|
|
1235
|
-
* <li>
|
|
1236
|
-
* <p>Destination: 0.0.0.0/0 (IPv4)</p>
|
|
1237
|
-
* </li>
|
|
1238
|
-
* </ul>
|
|
1239
|
-
* </li>
|
|
1240
|
-
* <li>
|
|
1241
|
-
* <p>Outbound rule 2</p>
|
|
1242
|
-
* <ul>
|
|
1243
|
-
* <li>
|
|
1244
|
-
* <p>Protocol: All</p>
|
|
1245
|
-
* </li>
|
|
1246
|
-
* <li>
|
|
1247
|
-
* <p>Ports: All</p>
|
|
1248
|
-
* </li>
|
|
1249
|
-
* <li>
|
|
1250
|
-
* <p>Destination: Self</p>
|
|
1251
|
-
* </li>
|
|
1252
|
-
* </ul>
|
|
1253
|
-
* </li>
|
|
1254
|
-
* </ul>
|
|
929
|
+
* <p>The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.</p> <p>The following rules are required:</p> <ul> <li> <p>Inbound rule 1</p> <ul> <li> <p>Protocol: All</p> </li> <li> <p>Ports: All</p> </li> <li> <p>Source: Self</p> </li> </ul> </li> <li> <p>Outbound rule 1</p> <ul> <li> <p>Protocol: All</p> </li> <li> <p>Ports: All</p> </li> <li> <p>Destination: 0.0.0.0/0 (IPv4)</p> </li> </ul> </li> <li> <p>Outbound rule 2</p> <ul> <li> <p>Protocol: All</p> </li> <li> <p>Ports: All</p> </li> <li> <p>Destination: Self</p> </li> </ul> </li> </ul>
|
|
1255
930
|
* @public
|
|
1256
931
|
*/
|
|
1257
932
|
securityGroupIds?: string[] | undefined;
|
|
@@ -1267,11 +942,7 @@ export interface Scheduler {
|
|
|
1267
942
|
*/
|
|
1268
943
|
type: SchedulerType | undefined;
|
|
1269
944
|
/**
|
|
1270
|
-
* <p>The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
|
|
1271
|
-
* For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html">Slurm versions in
|
|
1272
|
-
* Amazon Web Services PCS</a> in the <i>Amazon Web Services PCS User Guide</i>.</p>
|
|
1273
|
-
* <p>Valid Values: <code>23.11 | 24.05</code>
|
|
1274
|
-
* </p>
|
|
945
|
+
* <p>The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see <a href="https://docs.aws.amazon.com/pcs/latest/userguide/slurm-versions.html">Slurm versions in Amazon Web Services PCS</a> in the <i>Amazon Web Services PCS User Guide</i>.</p> <p>Valid Values: <code>23.11 | 24.05 | 24.11</code> </p>
|
|
1275
946
|
* @public
|
|
1276
947
|
*/
|
|
1277
948
|
version: string | undefined;
|
|
@@ -1298,9 +969,7 @@ export interface SlurmAuthKey {
|
|
|
1298
969
|
*/
|
|
1299
970
|
export interface ClusterSlurmConfiguration {
|
|
1300
971
|
/**
|
|
1301
|
-
* <p>The time (in seconds) before an idle node is scaled down.</p>
|
|
1302
|
-
* <p>Default: <code>600</code>
|
|
1303
|
-
* </p>
|
|
972
|
+
* <p>The time (in seconds) before an idle node is scaled down.</p> <p>Default: <code>600</code> </p>
|
|
1304
973
|
* @public
|
|
1305
974
|
*/
|
|
1306
975
|
scaleDownIdleTimeInSeconds?: number | undefined;
|
|
@@ -1314,6 +983,11 @@ export interface ClusterSlurmConfiguration {
|
|
|
1314
983
|
* @public
|
|
1315
984
|
*/
|
|
1316
985
|
authKey?: SlurmAuthKey | undefined;
|
|
986
|
+
/**
|
|
987
|
+
* <p>The accounting configuration includes configurable settings for Slurm accounting.</p>
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
accounting?: Accounting | undefined;
|
|
1317
991
|
}
|
|
1318
992
|
/**
|
|
1319
993
|
* @public
|
|
@@ -1353,10 +1027,7 @@ export interface Cluster {
|
|
|
1353
1027
|
*/
|
|
1354
1028
|
arn: string | undefined;
|
|
1355
1029
|
/**
|
|
1356
|
-
* <p>The provisioning status of the cluster.</p>
|
|
1357
|
-
* <note>
|
|
1358
|
-
* <p>The provisioning status doesn't indicate the overall health of the cluster.</p>
|
|
1359
|
-
* </note>
|
|
1030
|
+
* <p>The provisioning status of the cluster.</p> <note> <p>The provisioning status doesn't indicate the overall health of the cluster.</p> </note>
|
|
1360
1031
|
* @public
|
|
1361
1032
|
*/
|
|
1362
1033
|
status: ClusterStatus | undefined;
|
|
@@ -1376,21 +1047,7 @@ export interface Cluster {
|
|
|
1376
1047
|
*/
|
|
1377
1048
|
scheduler: Scheduler | undefined;
|
|
1378
1049
|
/**
|
|
1379
|
-
* <p>The size of the cluster.</p>
|
|
1380
|
-
* <ul>
|
|
1381
|
-
* <li>
|
|
1382
|
-
* <p>
|
|
1383
|
-
* <code>SMALL</code>: 32 compute nodes and 256 jobs</p>
|
|
1384
|
-
* </li>
|
|
1385
|
-
* <li>
|
|
1386
|
-
* <p>
|
|
1387
|
-
* <code>MEDIUM</code>: 512 compute nodes and 8192 jobs</p>
|
|
1388
|
-
* </li>
|
|
1389
|
-
* <li>
|
|
1390
|
-
* <p>
|
|
1391
|
-
* <code>LARGE</code>: 2048 compute nodes and 16,384 jobs</p>
|
|
1392
|
-
* </li>
|
|
1393
|
-
* </ul>
|
|
1050
|
+
* <p>The size of the cluster.</p> <ul> <li> <p> <code>SMALL</code>: 32 compute nodes and 256 jobs</p> </li> <li> <p> <code>MEDIUM</code>: 512 compute nodes and 8192 jobs</p> </li> <li> <p> <code>LARGE</code>: 2048 compute nodes and 16,384 jobs</p> </li> </ul>
|
|
1394
1051
|
* @public
|
|
1395
1052
|
*/
|
|
1396
1053
|
size: Size | undefined;
|
|
@@ -1435,13 +1092,7 @@ export interface DeleteClusterRequest {
|
|
|
1435
1092
|
*/
|
|
1436
1093
|
clusterIdentifier: string | undefined;
|
|
1437
1094
|
/**
|
|
1438
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
1439
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
1440
|
-
* request completes only once. With an idempotent request, if the original
|
|
1441
|
-
* request completes successfully, the subsequent retries with the same
|
|
1442
|
-
* client token return the result from the original successful request and
|
|
1443
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
1444
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
1095
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
1445
1096
|
* @public
|
|
1446
1097
|
*/
|
|
1447
1098
|
clientToken?: string | undefined;
|
|
@@ -1476,20 +1127,12 @@ export interface GetClusterResponse {
|
|
|
1476
1127
|
*/
|
|
1477
1128
|
export interface ListClustersRequest {
|
|
1478
1129
|
/**
|
|
1479
|
-
* <p>The value of <code>nextToken</code> is a unique pagination token
|
|
1480
|
-
* for each page of results returned. If <code>nextToken</code> is returned, there are more
|
|
1481
|
-
* results available. Make the call again using the returned token to retrieve the next page.
|
|
1482
|
-
* Keep all other arguments unchanged. Each pagination token expires after 24 hours.
|
|
1483
|
-
* Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code>
|
|
1484
|
-
* error.</p>
|
|
1130
|
+
* <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
|
|
1485
1131
|
* @public
|
|
1486
1132
|
*/
|
|
1487
1133
|
nextToken?: string | undefined;
|
|
1488
1134
|
/**
|
|
1489
|
-
* <p>The maximum number of results that are returned per call.
|
|
1490
|
-
* You can use <code>nextToken</code> to obtain further pages of results. The default
|
|
1491
|
-
* is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses
|
|
1492
|
-
* the default.</p>
|
|
1135
|
+
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.</p>
|
|
1493
1136
|
* @public
|
|
1494
1137
|
*/
|
|
1495
1138
|
maxResults?: number | undefined;
|
|
@@ -1525,10 +1168,7 @@ export interface ClusterSummary {
|
|
|
1525
1168
|
*/
|
|
1526
1169
|
modifiedAt: Date | undefined;
|
|
1527
1170
|
/**
|
|
1528
|
-
* <p>The provisioning status of the cluster.</p>
|
|
1529
|
-
* <note>
|
|
1530
|
-
* <p>The provisioning status doesn't indicate the overall health of the cluster.</p>
|
|
1531
|
-
* </note>
|
|
1171
|
+
* <p>The provisioning status of the cluster.</p> <note> <p>The provisioning status doesn't indicate the overall health of the cluster.</p> </note>
|
|
1532
1172
|
* @public
|
|
1533
1173
|
*/
|
|
1534
1174
|
status: ClusterStatus | undefined;
|
|
@@ -1543,12 +1183,7 @@ export interface ListClustersResponse {
|
|
|
1543
1183
|
*/
|
|
1544
1184
|
clusters: ClusterSummary[] | undefined;
|
|
1545
1185
|
/**
|
|
1546
|
-
* <p>The value of <code>nextToken</code> is a unique pagination token
|
|
1547
|
-
* for each page of results returned. If <code>nextToken</code> is returned, there are more
|
|
1548
|
-
* results available. Make the call again using the returned token to retrieve the next page.
|
|
1549
|
-
* Keep all other arguments unchanged. Each pagination token expires after 24 hours.
|
|
1550
|
-
* Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code>
|
|
1551
|
-
* error.</p>
|
|
1186
|
+
* <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
|
|
1552
1187
|
* @public
|
|
1553
1188
|
*/
|
|
1554
1189
|
nextToken?: string | undefined;
|
|
@@ -1579,26 +1214,17 @@ export interface CreateQueueRequest {
|
|
|
1579
1214
|
*/
|
|
1580
1215
|
queueName: string | undefined;
|
|
1581
1216
|
/**
|
|
1582
|
-
* <p>The list of compute node group configurations to associate with the queue. Queues
|
|
1583
|
-
* assign jobs to associated compute node groups.</p>
|
|
1217
|
+
* <p>The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.</p>
|
|
1584
1218
|
* @public
|
|
1585
1219
|
*/
|
|
1586
1220
|
computeNodeGroupConfigurations?: ComputeNodeGroupConfiguration[] | undefined;
|
|
1587
1221
|
/**
|
|
1588
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
1589
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
1590
|
-
* request completes only once. With an idempotent request, if the original
|
|
1591
|
-
* request completes successfully, the subsequent retries with the same
|
|
1592
|
-
* client token return the result from the original successful request and
|
|
1593
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
1594
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
1222
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
1595
1223
|
* @public
|
|
1596
1224
|
*/
|
|
1597
1225
|
clientToken?: string | undefined;
|
|
1598
1226
|
/**
|
|
1599
|
-
* <p>1 or more tags added to the resource. Each tag consists of a
|
|
1600
|
-
* tag key and tag value. The tag value is optional and can be an empty
|
|
1601
|
-
* string.</p>
|
|
1227
|
+
* <p>1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.</p>
|
|
1602
1228
|
* @public
|
|
1603
1229
|
*/
|
|
1604
1230
|
tags?: Record<string, string> | undefined;
|
|
@@ -1656,16 +1282,12 @@ export interface Queue {
|
|
|
1656
1282
|
*/
|
|
1657
1283
|
modifiedAt: Date | undefined;
|
|
1658
1284
|
/**
|
|
1659
|
-
* <p>The provisioning status of the queue.</p>
|
|
1660
|
-
* <note>
|
|
1661
|
-
* <p>The provisioning status doesn't indicate the overall health of the queue.</p>
|
|
1662
|
-
* </note>
|
|
1285
|
+
* <p>The provisioning status of the queue.</p> <note> <p>The provisioning status doesn't indicate the overall health of the queue.</p> </note>
|
|
1663
1286
|
* @public
|
|
1664
1287
|
*/
|
|
1665
1288
|
status: QueueStatus | undefined;
|
|
1666
1289
|
/**
|
|
1667
|
-
* <p>The list of compute node group configurations associated with the queue. Queues
|
|
1668
|
-
* assign jobs to associated compute node groups.</p>
|
|
1290
|
+
* <p>The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.</p>
|
|
1669
1291
|
* @public
|
|
1670
1292
|
*/
|
|
1671
1293
|
computeNodeGroupConfigurations: ComputeNodeGroupConfiguration[] | undefined;
|
|
@@ -1700,13 +1322,7 @@ export interface DeleteQueueRequest {
|
|
|
1700
1322
|
*/
|
|
1701
1323
|
queueIdentifier: string | undefined;
|
|
1702
1324
|
/**
|
|
1703
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
1704
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
1705
|
-
* request completes only once. With an idempotent request, if the original
|
|
1706
|
-
* request completes successfully, the subsequent retries with the same
|
|
1707
|
-
* client token return the result from the original successful request and
|
|
1708
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
1709
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
1325
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
1710
1326
|
* @public
|
|
1711
1327
|
*/
|
|
1712
1328
|
clientToken?: string | undefined;
|
|
@@ -1751,20 +1367,12 @@ export interface ListQueuesRequest {
|
|
|
1751
1367
|
*/
|
|
1752
1368
|
clusterIdentifier: string | undefined;
|
|
1753
1369
|
/**
|
|
1754
|
-
* <p>The value of <code>nextToken</code> is a unique pagination token
|
|
1755
|
-
* for each page of results returned. If <code>nextToken</code> is returned, there are more
|
|
1756
|
-
* results available. Make the call again using the returned token to retrieve the next page.
|
|
1757
|
-
* Keep all other arguments unchanged. Each pagination token expires after 24 hours.
|
|
1758
|
-
* Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code>
|
|
1759
|
-
* error.</p>
|
|
1370
|
+
* <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
|
|
1760
1371
|
* @public
|
|
1761
1372
|
*/
|
|
1762
1373
|
nextToken?: string | undefined;
|
|
1763
1374
|
/**
|
|
1764
|
-
* <p>The maximum number of results that are returned per call.
|
|
1765
|
-
* You can use <code>nextToken</code> to obtain further pages of results. The default
|
|
1766
|
-
* is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses
|
|
1767
|
-
* the default.</p>
|
|
1375
|
+
* <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.</p>
|
|
1768
1376
|
* @public
|
|
1769
1377
|
*/
|
|
1770
1378
|
maxResults?: number | undefined;
|
|
@@ -1805,10 +1413,7 @@ export interface QueueSummary {
|
|
|
1805
1413
|
*/
|
|
1806
1414
|
modifiedAt: Date | undefined;
|
|
1807
1415
|
/**
|
|
1808
|
-
* <p>The provisioning status of the queue.</p>
|
|
1809
|
-
* <note>
|
|
1810
|
-
* <p> The provisioning status doesn't indicate the overall health of the queue.</p>
|
|
1811
|
-
* </note>
|
|
1416
|
+
* <p>The provisioning status of the queue.</p> <note> <p> The provisioning status doesn't indicate the overall health of the queue.</p> </note>
|
|
1812
1417
|
* @public
|
|
1813
1418
|
*/
|
|
1814
1419
|
status: QueueStatus | undefined;
|
|
@@ -1823,12 +1428,7 @@ export interface ListQueuesResponse {
|
|
|
1823
1428
|
*/
|
|
1824
1429
|
queues: QueueSummary[] | undefined;
|
|
1825
1430
|
/**
|
|
1826
|
-
* <p>The value of <code>nextToken</code> is a unique pagination token
|
|
1827
|
-
* for each page of results returned. If <code>nextToken</code> is returned, there are more
|
|
1828
|
-
* results available. Make the call again using the returned token to retrieve the next page.
|
|
1829
|
-
* Keep all other arguments unchanged. Each pagination token expires after 24 hours.
|
|
1830
|
-
* Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code>
|
|
1831
|
-
* error.</p>
|
|
1431
|
+
* <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
|
|
1832
1432
|
* @public
|
|
1833
1433
|
*/
|
|
1834
1434
|
nextToken?: string | undefined;
|
|
@@ -1848,19 +1448,12 @@ export interface UpdateQueueRequest {
|
|
|
1848
1448
|
*/
|
|
1849
1449
|
queueIdentifier: string | undefined;
|
|
1850
1450
|
/**
|
|
1851
|
-
* <p>The list of compute node group configurations to associate with the queue. Queues
|
|
1852
|
-
* assign jobs to associated compute node groups.</p>
|
|
1451
|
+
* <p>The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.</p>
|
|
1853
1452
|
* @public
|
|
1854
1453
|
*/
|
|
1855
1454
|
computeNodeGroupConfigurations?: ComputeNodeGroupConfiguration[] | undefined;
|
|
1856
1455
|
/**
|
|
1857
|
-
* <p>A unique, case-sensitive identifier that you provide to
|
|
1858
|
-
* ensure the idempotency of the request. Idempotency ensures that an API
|
|
1859
|
-
* request completes only once. With an idempotent request, if the original
|
|
1860
|
-
* request completes successfully, the subsequent retries with the same
|
|
1861
|
-
* client token return the result from the original successful request and
|
|
1862
|
-
* they have no additional effect. If you don't specify a client token, the
|
|
1863
|
-
* CLI and SDK automatically generate 1 for you.</p>
|
|
1456
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.</p>
|
|
1864
1457
|
* @public
|
|
1865
1458
|
*/
|
|
1866
1459
|
clientToken?: string | undefined;
|
|
@@ -1900,8 +1493,7 @@ export interface RegisterComputeNodeGroupInstanceResponse {
|
|
|
1900
1493
|
*/
|
|
1901
1494
|
nodeID: string | undefined;
|
|
1902
1495
|
/**
|
|
1903
|
-
* <p>For the Slurm scheduler, this is the shared Munge key the scheduler uses to
|
|
1904
|
-
* authenticate compute node group instances.</p>
|
|
1496
|
+
* <p>For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.</p>
|
|
1905
1497
|
* @public
|
|
1906
1498
|
*/
|
|
1907
1499
|
sharedSecret: string | undefined;
|
|
@@ -1926,9 +1518,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1926
1518
|
*/
|
|
1927
1519
|
export interface ListTagsForResourceResponse {
|
|
1928
1520
|
/**
|
|
1929
|
-
* <p>1 or more tags added to the resource. Each tag consists of a
|
|
1930
|
-
* tag key and tag value. The tag value is optional and can be an empty
|
|
1931
|
-
* string.</p>
|
|
1521
|
+
* <p>1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.</p>
|
|
1932
1522
|
* @public
|
|
1933
1523
|
*/
|
|
1934
1524
|
tags?: Record<string, string> | undefined;
|
|
@@ -1943,9 +1533,7 @@ export interface TagResourceRequest {
|
|
|
1943
1533
|
*/
|
|
1944
1534
|
resourceArn: string | undefined;
|
|
1945
1535
|
/**
|
|
1946
|
-
* <p>1 or more tags added to the resource. Each tag consists of a
|
|
1947
|
-
* tag key and tag value. The tag value is optional and can be an empty
|
|
1948
|
-
* string.</p>
|
|
1536
|
+
* <p>1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.</p>
|
|
1949
1537
|
* @public
|
|
1950
1538
|
*/
|
|
1951
1539
|
tags: Record<string, string> | undefined;
|
|
@@ -1960,8 +1548,7 @@ export interface UntagResourceRequest {
|
|
|
1960
1548
|
*/
|
|
1961
1549
|
resourceArn: string | undefined;
|
|
1962
1550
|
/**
|
|
1963
|
-
* <p>1 or more tag keys to remove from the resource. Specify only tag keys and not tag
|
|
1964
|
-
* values.</p>
|
|
1551
|
+
* <p>1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.</p>
|
|
1965
1552
|
* @public
|
|
1966
1553
|
*/
|
|
1967
1554
|
tagKeys: string[] | undefined;
|