Skip to content

Commit 25f3950

Browse files
author
awstools
committed
docs(client-pcs): AWS PCS API documentation - Edited the description of the iamInstanceProfileArn parameter of the CreateComputeNodeGroup and UpdateComputeNodeGroup actions; edited the description of the SlurmCustomSetting data type to list the supported parameters for clusters and compute node groups.
1 parent 0e77940 commit 25f3950

File tree

2 files changed

+113
-24
lines changed

2 files changed

+113
-24
lines changed

‎clients/client-pcs/src/models/models_0.ts

+109-20
Original file line numberDiff line numberDiff line change
@@ -170,13 +170,56 @@ export interface ScalingConfigurationRequest {
170170
*/
171171
export interface SlurmCustomSetting {
172172
/**
173-
* <p>Amazon Web Services PCS supports configuration of the following Slurm parameters: <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1">
174-
* <code>Prolog</code>
175-
* </a>, <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1">
176-
* <code>Epilog</code>
177-
* </a>, and <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters">
178-
* <code>SelectTypeParameters</code>
179-
* </a>.</p>
173+
* <p>Amazon Web Services PCS supports configuration of the following Slurm parameters:</p>
174+
* <ul>
175+
* <li>
176+
* <p>For <b>clusters</b>
177+
* </p>
178+
* <ul>
179+
* <li>
180+
* <p>
181+
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1">
182+
* <code>Prolog</code>
183+
* </a>
184+
* </p>
185+
* </li>
186+
* <li>
187+
* <p>
188+
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1">
189+
* <code>Epilog</code>
190+
* </a>
191+
* </p>
192+
* </li>
193+
* <li>
194+
* <p>
195+
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters">
196+
* <code>SelectTypeParameters</code>
197+
* </a>
198+
* </p>
199+
* </li>
200+
* </ul>
201+
* </li>
202+
* <li>
203+
* <p>For <b>compute node groups</b>
204+
* </p>
205+
* <ul>
206+
* <li>
207+
* <p>
208+
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight">
209+
* <code>Weight</code>
210+
* </a>
211+
* </p>
212+
* </li>
213+
* <li>
214+
* <p>
215+
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight">
216+
* <code>RealMemory</code>
217+
* </a>
218+
* </p>
219+
* </li>
220+
* </ul>
221+
* </li>
222+
* </ul>
180223
* @public
181224
*/
182225
parameterName: string | undefined;
@@ -283,12 +326,26 @@ export interface CreateComputeNodeGroupRequest {
283326
customLaunchTemplate: CustomLaunchTemplate | undefined;
284327

285328
/**
286-
* <p>The Amazon Resource Name (ARN) of the
287-
* IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
288-
* <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached in order to
289-
* provision instances correctly. The resource identifier of the ARN must start with
290-
* <code>AWSPCS</code>. For example, <code>arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile</code>.
329+
* <p>The Amazon Resource Name (ARN) of the IAM instance
330+
* profile used to pass an IAM role when launching EC2 instances. The role contained
331+
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
332+
* permission. The resource identifier of the ARN must start with
333+
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
334+
* <p class="title">
335+
* <b>Examples</b>
291336
* </p>
337+
* <ul>
338+
* <li>
339+
* <p>
340+
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
341+
* </p>
342+
* </li>
343+
* <li>
344+
* <p>
345+
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
346+
* </p>
347+
* </li>
348+
* </ul>
292349
* @public
293350
*/
294351
iamInstanceProfileArn: string | undefined;
@@ -488,10 +545,26 @@ export interface ComputeNodeGroup {
488545
customLaunchTemplate: CustomLaunchTemplate | undefined;
489546

490547
/**
491-
* <p>The Amazon Resource Name (ARN) of the
492-
* IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
493-
* <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances
494-
* correctly.</p>
548+
* <p>The Amazon Resource Name (ARN) of the IAM instance
549+
* profile used to pass an IAM role when launching EC2 instances. The role contained
550+
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
551+
* permission. The resource identifier of the ARN must start with
552+
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
553+
* <p class="title">
554+
* <b>Examples</b>
555+
* </p>
556+
* <ul>
557+
* <li>
558+
* <p>
559+
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
560+
* </p>
561+
* </li>
562+
* <li>
563+
* <p>
564+
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
565+
* </p>
566+
* </li>
567+
* </ul>
495568
* @public
496569
*/
497570
iamInstanceProfileArn: string | undefined;
@@ -1037,10 +1110,26 @@ export interface UpdateComputeNodeGroupRequest {
10371110
scalingConfiguration?: ScalingConfigurationRequest;
10381111

10391112
/**
1040-
* <p>The Amazon Resource Name (ARN) of the
1041-
* IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
1042-
* <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances
1043-
* correctly.</p>
1113+
* <p>The Amazon Resource Name (ARN) of the IAM instance
1114+
* profile used to pass an IAM role when launching EC2 instances. The role contained
1115+
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
1116+
* permission. The resource identifier of the ARN must start with
1117+
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
1118+
* <p class="title">
1119+
* <b>Examples</b>
1120+
* </p>
1121+
* <ul>
1122+
* <li>
1123+
* <p>
1124+
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
1125+
* </p>
1126+
* </li>
1127+
* <li>
1128+
* <p>
1129+
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
1130+
* </p>
1131+
* </li>
1132+
* </ul>
10441133
* @public
10451134
*/
10461135
iamInstanceProfileArn?: string;

‎codegen/sdk-codegen/aws-models/pcs.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1154,7 +1154,7 @@
11541154
"iamInstanceProfileArn": {
11551155
"target": "com.amazonaws.pcs#InstanceProfileArn",
11561156
"traits": {
1157-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances\n correctly.</p>",
1157+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>\n permission. The resource identifier of the ARN must start with \n <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>\n <p class=\"title\">\n <b>Examples</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>\n </p>\n </li>\n </ul>",
11581158
"smithy.api#required": {}
11591159
}
11601160
},
@@ -1628,7 +1628,7 @@
16281628
"iamInstanceProfileArn": {
16291629
"target": "com.amazonaws.pcs#InstanceProfileArn",
16301630
"traits": {
1631-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached in order to\n provision instances correctly. The resource identifier of the ARN must start with \n <code>AWSPCS</code>. For example, <code>arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile</code>.\n </p>",
1631+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>\n permission. The resource identifier of the ARN must start with \n <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>\n <p class=\"title\">\n <b>Examples</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>\n </p>\n </li>\n </ul>",
16321632
"smithy.api#required": {}
16331633
}
16341634
},
@@ -3321,7 +3321,7 @@
33213321
"parameterName": {
33223322
"target": "smithy.api#String",
33233323
"traits": {
3324-
"smithy.api#documentation": "<p>Amazon Web Services PCS supports configuration of the following Slurm parameters: <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1\">\n <code>Prolog</code>\n </a>, <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1\">\n <code>Epilog</code>\n </a>, and <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters\">\n <code>SelectTypeParameters</code>\n </a>.</p>",
3324+
"smithy.api#documentation": "<p>Amazon Web Services PCS supports configuration of the following Slurm parameters:</p>\n <ul>\n <li>\n <p>For <b>clusters</b>\n </p>\n <ul>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1\">\n <code>Prolog</code>\n </a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1\">\n <code>Epilog</code>\n </a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters\">\n <code>SelectTypeParameters</code>\n </a>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>For <b>compute node groups</b>\n </p>\n <ul>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Weight\">\n <code>Weight</code>\n </a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Weight\">\n <code>RealMemory</code>\n </a>\n </p>\n </li>\n </ul>\n </li>\n </ul>",
33253325
"smithy.api#required": {}
33263326
}
33273327
},
@@ -3672,7 +3672,7 @@
36723672
"iamInstanceProfileArn": {
36733673
"target": "com.amazonaws.pcs#InstanceProfileArn",
36743674
"traits": {
3675-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances\n correctly.</p>"
3675+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>\n permission. The resource identifier of the ARN must start with \n <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>\n <p class=\"title\">\n <b>Examples</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>\n </p>\n </li>\n </ul>"
36763676
}
36773677
},
36783678
"slurmConfiguration": {

0 commit comments

Comments
 (0)