Skip to content

Commit e35e270

Browse files
author
AWS
committed
AWS Parallel Computing Service Update: Documentation-only update to add AccountingStorageEnforce to SlurmCustomSetting.
1 parent c4d2bb1 commit e35e270

File tree

2 files changed

+27
-21
lines changed

2 files changed

+27
-21
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Parallel Computing Service",
4+
"contributor": "",
5+
"description": "Documentation-only update to add AccountingStorageEnforce to SlurmCustomSetting."
6+
}

services/pcs/src/main/resources/codegen-resources/service-2.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
{"shape":"InternalServerException"},
3232
{"shape":"AccessDeniedException"}
3333
],
34-
"documentation":"<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>",
34+
"documentation":"<p>Creates a cluster in your account. 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 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>",
3535
"idempotent":true
3636
},
3737
"CreateComputeNodeGroup":{
@@ -51,7 +51,7 @@
5151
{"shape":"InternalServerException"},
5252
{"shape":"AccessDeniedException"}
5353
],
54-
"documentation":"<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>",
54+
"documentation":"<p>Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. 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 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>",
5555
"idempotent":true
5656
},
5757
"CreateQueue":{
@@ -128,7 +128,7 @@
128128
{"shape":"InternalServerException"},
129129
{"shape":"AccessDeniedException"}
130130
],
131-
"documentation":"<p>Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.</p>",
131+
"documentation":"<p>Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, PCS terminates all the compute nodes for this queue.</p>",
132132
"idempotent":true
133133
},
134134
"GetCluster":{
@@ -250,7 +250,7 @@
250250
"errors":[
251251
{"shape":"ResourceNotFoundException"}
252252
],
253-
"documentation":"<p>Returns a list of all tags on an Amazon Web Services PCS resource.</p>"
253+
"documentation":"<p>Returns a list of all tags on an PCS resource.</p>"
254254
},
255255
"RegisterComputeNodeGroupInstance":{
256256
"name":"RegisterComputeNodeGroupInstance",
@@ -264,7 +264,7 @@
264264
{"shape":"InternalServerException"},
265265
{"shape":"AccessDeniedException"}
266266
],
267-
"documentation":"<p><important> <p>This API action isn't intended for you to use.</p> </important> <p>Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.</p></p>"
267+
"documentation":"<p><important> <p>This API action isn't intended for you to use.</p> </important> <p>PCS uses this API action to register the compute nodes it launches in your account.</p></p>"
268268
},
269269
"TagResource":{
270270
"name":"TagResource",
@@ -277,7 +277,7 @@
277277
{"shape":"ServiceQuotaExceededException"},
278278
{"shape":"ResourceNotFoundException"}
279279
],
280-
"documentation":"<p>Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.</p>",
280+
"documentation":"<p>Adds or edits tags on an PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.</p>",
281281
"idempotent":true
282282
},
283283
"UntagResource":{
@@ -290,7 +290,7 @@
290290
"errors":[
291291
{"shape":"ResourceNotFoundException"}
292292
],
293-
"documentation":"<p>Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.</p>",
293+
"documentation":"<p>Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.</p>",
294294
"idempotent":true
295295
},
296296
"UpdateComputeNodeGroup":{
@@ -631,7 +631,7 @@
631631
},
632632
"amiId":{
633633
"shape":"AmiId",
634-
"documentation":"<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>"
634+
"documentation":"<p>The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.</p>"
635635
},
636636
"subnetIds":{
637637
"shape":"SubnetIdList",
@@ -858,7 +858,7 @@
858858
},
859859
"amiId":{
860860
"shape":"AmiId",
861-
"documentation":"<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>"
861+
"documentation":"<p> The ID of the Amazon Machine Image (AMI) that PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, PCS uses the AMI ID specified in the custom launch template.</p>"
862862
},
863863
"subnetIds":{
864864
"shape":"StringList",
@@ -955,7 +955,7 @@
955955
"documentation":"<p>The version of the EC2 launch template to use to provision instances.</p>"
956956
}
957957
},
958-
"documentation":"<p>An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.</p>"
958+
"documentation":"<p>An Amazon EC2 launch template PCS uses to launch compute nodes.</p>"
959959
},
960960
"DeleteClusterRequest":{
961961
"type":"structure",
@@ -1158,10 +1158,10 @@
11581158
"members":{
11591159
"instanceType":{
11601160
"shape":"String",
1161-
"documentation":"<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>"
1161+
"documentation":"<p>The EC2 instance type that PCS can provision in the compute node group.</p> <p> Example: <code>t2.xlarge</code> </p>"
11621162
}
11631163
},
1164-
"documentation":"<p>An EC2 instance configuration Amazon Web Services PCS uses to launch compute nodes.</p>"
1164+
"documentation":"<p>An EC2 instance configuration PCS uses to launch compute nodes.</p>"
11651165
},
11661166
"InstanceList":{
11671167
"type":"list",
@@ -1181,7 +1181,7 @@
11811181
"members":{
11821182
"message":{"shape":"String"}
11831183
},
1184-
"documentation":"<p>Amazon Web Services PCS can't process your request right now. Try again later.</p>",
1184+
"documentation":"<p>PCS can't process your request right now. Try again later.</p>",
11851185
"exception":true,
11861186
"fault":true,
11871187
"retryable":{"throttling":false}
@@ -1314,7 +1314,7 @@
13141314
"members":{
13151315
"subnetIds":{
13161316
"shape":"SubnetIdList",
1317-
"documentation":"<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>"
1317+
"documentation":"<p>The ID of the subnet where PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and PCS resources. The subnet must have an available IP address, cannot reside in Outposts, Wavelength, or an Amazon Web Services Local Zone.</p> <p> Example: <code>subnet-abcd1234</code> </p>"
13181318
},
13191319
"securityGroupIds":{
13201320
"shape":"SecurityGroupIdList",
@@ -1617,11 +1617,11 @@
16171617
"members":{
16181618
"type":{
16191619
"shape":"SchedulerType",
1620-
"documentation":"<p>The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.</p>"
1620+
"documentation":"<p>The software PCS uses to manage cluster scaling and job scheduling.</p>"
16211621
},
16221622
"version":{
16231623
"shape":"String",
1624-
"documentation":"<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>"
1624+
"documentation":"<p>The version of the specified scheduling software that 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 PCS</a> in the <i>PCS User Guide</i>.</p> <p>Valid Values: <code>23.11 | 24.05 | 24.11</code> </p>"
16251625
}
16261626
},
16271627
"documentation":"<p>The cluster management and job scheduling software associated with the cluster.</p>"
@@ -1635,11 +1635,11 @@
16351635
"members":{
16361636
"type":{
16371637
"shape":"SchedulerType",
1638-
"documentation":"<p>The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.</p>"
1638+
"documentation":"<p>The software PCS uses to manage cluster scaling and job scheduling.</p>"
16391639
},
16401640
"version":{
16411641
"shape":"String",
1642-
"documentation":"<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>"
1642+
"documentation":"<p>The version of the specified scheduling software that 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 PCS</a> in the <i>PCS User Guide</i>.</p> <p>Valid Values: <code>23.11 | 24.05 | 24.11</code> </p>"
16431643
}
16441644
},
16451645
"documentation":"<p>The cluster management and job scheduling software associated with the cluster.</p>"
@@ -1723,7 +1723,7 @@
17231723
"members":{
17241724
"parameterName":{
17251725
"shape":"String",
1726-
"documentation":"<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>"
1726+
"documentation":"<p>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> <li> <p> <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_AccountingStorageEnforce\"> <code>AccountingStorageEnforce</code> </a> </p> <important> <p>PCS supports a subset of the options for <code>AccountingStorageEnforce</code>. For more information, see <a href=\"https://docs.aws.amazon.com/pcs/latest/userguide/slurm-accounting.html\">Slurm accounting in PCS</a> in the <i>PCS User Guide</i>.</p> </important> </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>"
17271727
},
17281728
"parameterValue":{
17291729
"shape":"String",
@@ -1853,7 +1853,7 @@
18531853
},
18541854
"amiId":{
18551855
"shape":"AmiId",
1856-
"documentation":"<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>"
1856+
"documentation":"<p>The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.</p>"
18571857
},
18581858
"subnetIds":{
18591859
"shape":"StringList",
@@ -1984,5 +1984,5 @@
19841984
]
19851985
}
19861986
},
1987-
"documentation":"<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>"
1987+
"documentation":"<p>Parallel Computing Service (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\">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 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 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 PCS <i>compute node</i> is an Amazon EC2 instance. You don't launch compute nodes directly. 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. PCS automatically terminates your compute nodes when you delete the PCS resources related to those compute nodes.</p>"
19881988
}

0 commit comments

Comments
 (0)