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 Parallel Computing Service User Guide.
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.
The API actions operate on PCS resources. A resource 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 Resource in the Resource Explorer User Guide.
An PCS compute node 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.
", "operations": { "CreateCluster": "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.
It takes time for PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.
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 can configure common instance settings, such as the AMI, security groups, and SSH key pair, directly on the compute node group, or you can provide a custom EC2 launch template. To use a launch template that PCS manages, set launchTemplateMode to MANAGED and don't provide customLaunchTemplate. In this case, you must specify amiId and securityGroupIds. For more information, see Configuring instance settings for compute node groups in PCS in the PCS User Guide.
Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.
", "DeleteCluster": "Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.
", "DeleteComputeNodeGroup": "Deletes a compute node group. You must delete all queues associated with the compute node group first.
", "DeleteQueue": "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.
", "GetCluster": "Returns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.
", "GetComputeNodeGroup": "Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.
", "GetQueue": "Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.
", "ListClusters": "Returns a list of running clusters in your account.
", "ListComputeNodeGroups": "Returns a list of all compute node groups associated with a cluster.
", "ListQueues": "Returns a list of all queues associated with a cluster.
", "ListTagsForResource": "Returns a list of all tags on an PCS resource.
", "RegisterComputeNodeGroupInstance": "This API action isn't intended for you to use.
PCS uses this API action to register the compute nodes it launches in your account.
", "TagResource": "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.
", "UntagResource": "Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.
", "UpdateCluster": "Updates a cluster configuration. You can update the scheduler version, modify scheduler settings, and update accounting configuration for an existing cluster. For more information about updating the scheduler version, see Updating the scheduler version on a cluster in the PCS User Guide.
You can only update clusters that are in ACTIVE, UPDATE_FAILED, or SUSPENDED state. All associated resources (queues and compute node groups) must be in ACTIVE state before you can update the cluster.
Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).
", "UpdateQueue": "Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have permission to perform the action.
Examples
The launch template instance profile doesn't pass iam:PassRole verification.
There is a mismatch between the account ID and cluster ID.
The cluster ID doesn't exist.
The EC2 instance isn't present.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
", "refs": { "ClusterSlurmConfiguration$accounting": "The accounting configuration includes configurable settings for Slurm accounting.
" } }, "AccountingDefaultPurgeTimeInDaysInteger": { "base": null, "refs": { "Accounting$defaultPurgeTimeInDays": "The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The default value for mode is NONE. A value of STANDARD means Slurm accounting is enabled.
The default value for mode is NONE. A value of STANDARD means Slurm accounting is enabled.
The default value for mode is NONE. A value of STANDARD means Slurm accounting is enabled.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
", "refs": { "ClusterSlurmConfigurationRequest$accounting": "The accounting configuration includes configurable settings for Slurm accounting.
" } }, "AccountingRequestDefaultPurgeTimeInDaysInteger": { "base": null, "refs": { "AccountingRequest$defaultPurgeTimeInDays": "The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not present, PCS uses the AMI ID specified in the custom launch template.
", "CreateComputeNodeGroupRequest$amiId": " The ID of the Amazon Machine Image (AMI) that PCS uses to launch compute nodes (Amazon EC2 instances). This value overrides the AMI ID in the custom launch template. If you don't provide this value, PCS uses the AMI ID specified in the custom launch template. You must provide this value if launchTemplateMode is MANAGED.
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. This value overrides the AMI ID in the custom launch template. Specify an empty string (\"\") to remove the AMI ID from the compute node group and use the AMI ID specified in the custom launch template. Omit this value to leave the current setting unchanged.
The Amazon Resource Name (ARN) of the resource for which to list tags.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "BootstrapId": { "base": null, "refs": { "RegisterComputeNodeGroupInstanceRequest$bootstrapId": "The client-generated token to allow for retries.
" } }, "CgroupCustomSetting": { "base": "Additional settings that directly map to Cgroup settings.
PCS supports a subset of Cgroup settings. For more information, see Configuring custom Cgroup settings in PCS in the PCS User Guide.
Additional Cgroup-specific configuration that directly maps to Cgroup settings.
", "ClusterSlurmConfigurationRequest$cgroupCustomSettings": "Additional Cgroup-specific configuration that directly maps to Cgroup settings.
", "UpdateClusterSlurmConfigurationRequest$cgroupCustomSettings": "Additional Cgroup-specific configuration that directly maps to Cgroup settings.
" } }, "Cluster": { "base": "The cluster resource and configuration.
", "refs": { "CreateClusterResponse$cluster": "The cluster resource.
", "GetClusterResponse$cluster": "The cluster resource.
", "UpdateClusterResponse$cluster": null } }, "ClusterIdentifier": { "base": null, "refs": { "CreateComputeNodeGroupRequest$clusterIdentifier": "The name or ID of the cluster to create a compute node group in.
", "CreateQueueRequest$clusterIdentifier": "The name or ID of the cluster for which to create a queue.
", "DeleteClusterRequest$clusterIdentifier": "The name or ID of the cluster to delete.
", "DeleteComputeNodeGroupRequest$clusterIdentifier": "The name or ID of the cluster of the compute node group.
", "DeleteQueueRequest$clusterIdentifier": "The name or ID of the cluster of the queue.
", "GetClusterRequest$clusterIdentifier": "The name or ID of the cluster.
", "GetComputeNodeGroupRequest$clusterIdentifier": "The name or ID of the cluster.
", "GetQueueRequest$clusterIdentifier": "The name or ID of the cluster of the queue.
", "ListComputeNodeGroupsRequest$clusterIdentifier": "The name or ID of the cluster to list compute node groups for.
", "ListQueuesRequest$clusterIdentifier": "The name or ID of the cluster to list queues for.
", "RegisterComputeNodeGroupInstanceRequest$clusterIdentifier": "The name or ID of the cluster to register the compute node group instance in.
", "UpdateClusterRequest$clusterIdentifier": "The name or ID of the cluster to update.
", "UpdateComputeNodeGroupRequest$clusterIdentifier": "The name or ID of the cluster of the compute node group.
", "UpdateQueueRequest$clusterIdentifier": "The name or ID of the cluster of the queue.
" } }, "ClusterList": { "base": null, "refs": { "ListClustersResponse$clusters": "The list of clusters.
" } }, "ClusterName": { "base": null, "refs": { "CreateClusterRequest$clusterName": "A name to identify the cluster. Example: MyCluster
Additional options related to the Slurm scheduler.
", "refs": { "Cluster$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "ClusterSlurmConfigurationRequest": { "base": "Additional options related to the Slurm scheduler.
", "refs": { "CreateClusterRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "ClusterSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger": { "base": null, "refs": { "ClusterSlurmConfigurationRequest$scaleDownIdleTimeInSeconds": "The time (in seconds) before an idle node is scaled down.
Default: 600
The time (in seconds) before an idle node is scaled down.
Default: 600
The provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
The provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
The object returned by the ListClusters API action.
A compute node group associated with a cluster.
", "refs": { "CreateComputeNodeGroupResponse$computeNodeGroup": null, "GetComputeNodeGroupResponse$computeNodeGroup": null, "UpdateComputeNodeGroupResponse$computeNodeGroup": null } }, "ComputeNodeGroupConfiguration": { "base": "The compute node group configuration for a queue.
", "refs": { "ComputeNodeGroupConfigurationList$member": null } }, "ComputeNodeGroupConfigurationList": { "base": null, "refs": { "CreateQueueRequest$computeNodeGroupConfigurations": "The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
", "Queue$computeNodeGroupConfigurations": "The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.
", "UpdateQueueRequest$computeNodeGroupConfigurations": "The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
" } }, "ComputeNodeGroupIdentifier": { "base": null, "refs": { "DeleteComputeNodeGroupRequest$computeNodeGroupIdentifier": "The name or ID of the compute node group to delete.
", "GetComputeNodeGroupRequest$computeNodeGroupIdentifier": "The name or ID of the compute node group.
", "UpdateComputeNodeGroupRequest$computeNodeGroupIdentifier": "The name or ID of the compute node group.
" } }, "ComputeNodeGroupList": { "base": null, "refs": { "ListComputeNodeGroupsResponse$computeNodeGroups": "The list of compute node groups for the cluster.
" } }, "ComputeNodeGroupName": { "base": null, "refs": { "ComputeNodeGroup$name": "The name that identifies the compute node group.
", "ComputeNodeGroupSummary$name": "The name that identifies the compute node group.
", "CreateComputeNodeGroupRequest$computeNodeGroupName": "A name to identify the cluster. Example: MyCluster
Additional options related to the Slurm scheduler.
", "refs": { "ComputeNodeGroup$slurmConfiguration": null } }, "ComputeNodeGroupSlurmConfigurationRequest": { "base": "Additional options related to the Slurm scheduler.
", "refs": { "CreateComputeNodeGroupRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "ComputeNodeGroupSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger": { "base": null, "refs": { "ComputeNodeGroupSlurmConfigurationRequest$scaleDownIdleTimeInSeconds": "The time (in seconds) before an idle node is scaled down. If not specified, the cluster-level setting applies. This overrides the cluster-level scaleDownIdleTimeInSeconds setting. A value of -1 removes the override and applies the cluster-level setting to this compute node group. Requires Slurm version 25.11 or later.
The time (in seconds) before an idle node is scaled down. If not specified, the cluster-level setting applies. This overrides the cluster-level scaleDownIdleTimeInSeconds setting. A value of -1 removes the override and applies the cluster-level setting to this compute node group. Requires Slurm version 25.11 or later.
The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
The object returned by the ListComputeNodeGroups API action.
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.
Examples
A cluster with the same name already exists.
A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has ACTIVE node groups or queues.
A queue already exists in a cluster.
An Amazon EC2 launch template PCS uses to launch compute nodes. The structure contains the launch template ID and version.
", "refs": { "ComputeNodeGroup$customLaunchTemplate": "The custom Amazon EC2 launch template associated with the compute node group. This value is present when launchTemplateMode is CUSTOM and isn't present when launchTemplateMode is MANAGED.
The custom Amazon EC2 launch template to associate with the compute node group. Specify the launch template id and version when launchTemplateMode is CUSTOM. Don't specify this value when launchTemplateMode is MANAGED.
The custom Amazon EC2 launch template to associate with the compute node group. To set or change the custom launch template, specify id and version. If you provide this value and omit launchTemplateMode, the compute node group must already use CUSTOM mode. To switch from MANAGED to CUSTOM, specify launchTemplateMode as CUSTOM and provide this value. If the compute node group already uses CUSTOM, omit this value while also omitting launchTemplateMode, or while specifying CUSTOM, to keep the existing custom launch template. For more information, see Migrating a compute node group from a custom launch template in the PCS User Guide.
An endpoint available for interaction with the scheduler.
", "refs": { "Endpoints$member": null } }, "EndpointType": { "base": null, "refs": { "Endpoint$type": "Indicates the type of endpoint running at the specific IP address.
" } }, "Endpoints": { "base": null, "refs": { "Cluster$endpoints": "The list of endpoints available for interaction with the scheduler.
", "RegisterComputeNodeGroupInstanceResponse$endpoints": "The list of endpoints available for interaction with the scheduler.
" } }, "ErrorInfo": { "base": "An error that occurred during resource creation.
", "refs": { "ErrorInfoList$member": null } }, "ErrorInfoList": { "base": null, "refs": { "Cluster$errorInfo": "The list of errors that occurred during cluster provisioning.
", "ComputeNodeGroup$errorInfo": "The list of errors that occurred during compute node group provisioning.
", "Queue$errorInfo": "The list of errors that occurred during queue provisioning.
" } }, "ExecutionPolicy": { "base": "The policy that determines when a node lifecycle script runs. Valid values:
FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.
EVERY_BOOT – Runs the script every time the compute node boots, including reboots.
The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY. Valid values:
FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.
EVERY_BOOT – Runs the script every time the compute node boots, including reboots.
A single Slurm gres.conf record, expressed as a map of gres.conf attribute names to their values. For example, {\"Name\": \"gpu\", \"Type\": \"a100\", \"File\": \"/dev/nvidia[0-7]\"} or {\"AutoDetect\": \"nvml\"}. PCS adds the NodeName= prefix for the compute node group.
PCS supports a subset of gres.conf settings. For more information, see Configuring custom GRES settings in PCS in the PCS User Guide.
The additional Slurm gres.conf records for the compute node group. Each item is a map of gres.conf attribute names to values that describes one gres.conf record, such as a GPU topology, MIG, MPS, or custom GRES entry. PCS adds the NodeName= prefix and merges these records with the GPU record it derives from the instance type.
The additional Slurm gres.conf records for the compute node group. Each item is a map of gres.conf attribute names to values that describes one gres.conf record, such as a GPU topology, MIG, MPS, or custom GRES entry. PCS adds the NodeName= prefix and merges these records with the GPU record it derives from the instance type.
The additional Slurm gres.conf records for the compute node group. Each item is a map of gres.conf attribute names to values that describes one gres.conf record, such as a GPU topology, MIG, MPS, or custom GRES entry. PCS adds the NodeName= prefix and merges these records with the GPU record it derives from the instance type.
An EC2 instance configuration PCS uses to launch compute nodes.
", "refs": { "InstanceList$member": null } }, "InstanceList": { "base": null, "refs": { "ComputeNodeGroup$instanceConfigs": "A list of EC2 instance configurations that PCS can provision in the compute node group.
", "CreateComputeNodeGroupRequest$instanceConfigs": "A list of EC2 instance configurations that PCS can provision in the compute node group.
" } }, "InstanceProfileArn": { "base": null, "refs": { "ComputeNodeGroup$iamInstanceProfileArn": "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 pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.
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 pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.
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 pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.
The number of seconds to wait before retrying the request.
" } }, "InternalServerException": { "base": "PCS can't process your request right now. Try again later.
", "refs": {} }, "JwtAuth": { "base": "The JWT authentication configuration for Slurm REST API access.
", "refs": { "ClusterSlurmConfiguration$jwtAuth": "The JWT authentication configuration for Slurm REST API access.
" } }, "JwtKey": { "base": "The JWT key stored in Amazon Web Services Secrets Manager for Slurm REST API authentication.
", "refs": { "JwtAuth$jwtKey": "The JWT key for Slurm REST API authentication.
" } }, "KeyPairName": { "base": null, "refs": { "ComputeNodeGroup$sshKeyName": "The name of the EC2 key pair configured directly on the compute node group. PCS uses this key pair instead of the key pair in the custom launch template. This value isn't present if a key pair isn't configured directly on the compute node group. In that case, PCS uses the key pair in the custom launch template, if one is specified.
", "CreateComputeNodeGroupRequest$sshKeyName": "The name of the EC2 key pair to configure directly on the compute node group. The key pair must exist in your account and Amazon Web Services Region. PCS uses this key pair instead of the key pair in the custom launch template. If you don't provide this value, PCS uses the key pair in the custom launch template, if one is specified. You must have permission for ec2:DescribeKeyPairs. If you delete the key pair later, future instance launches can fail. For more information, see Configuring instance settings for compute node groups in PCS in the PCS User Guide.
The name of the EC2 key pair to configure directly on the compute node group. The key pair must exist in your account and Amazon Web Services Region. PCS uses this key pair instead of the key pair in the custom launch template. Specify an empty string (\"\") to remove the key pair from the compute node group and use the key pair in the custom launch template. Omit this value to leave the current setting unchanged. You must have permission for ec2:DescribeKeyPairs to specify a key pair. If you delete the key pair later, future instance launches can fail.
Indicates whether the compute node group uses a custom launch template or a launch template that PCS manages. The default value is CUSTOM.
Valid values:
CUSTOM – The compute node group uses the launch template in customLaunchTemplate.
MANAGED – PCS creates and manages the launch template.
Specifies whether the compute node group uses a custom launch template or a launch template that PCS manages. The default value is CUSTOM.
If the value is CUSTOM, provide customLaunchTemplate. If the value is MANAGED, omit customLaunchTemplate and provide amiId and securityGroupIds.
Specifies whether the compute node group uses a custom launch template or a launch template that PCS manages. Omit this value to keep the current mode.
Valid values:
CUSTOM – Use a custom launch template. To switch from MANAGED, also provide customLaunchTemplate. If the compute node group already uses CUSTOM and you omit customLaunchTemplate, the existing launch template is unchanged.
MANAGED – Use a launch template created and managed by PCS. Omit customLaunchTemplate. Switching to this mode removes the custom launch template association but doesn't delete the launch template.
When switching to MANAGED, the compute node group must have amiId and securityGroupIds configured. You can set these values in the same request.
The maximum number of results that are returned per call. You can use nextToken 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.
The maximum number of results that are returned per call. You can use nextToken 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.
The maximum number of results that are returned per call. You can use nextToken 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.
The IP address version the cluster uses. The default is IPV4.
The IP address version the cluster uses. The default is IPV4.
The networking configuration for the cluster's control plane.
", "refs": { "Cluster$networking": null } }, "NetworkingRequest": { "base": "The networking configuration for the cluster's control plane.
", "refs": { "CreateClusterRequest$networking": "The networking configuration used to set up the cluster's control plane.
" } }, "NodeLifecycleActions": { "base": "The lifecycle actions configured on a compute node group. Lifecycle actions define scripts that PCS runs on compute nodes at specific stages of their lifecycle.
", "refs": { "ComputeNodeGroup$nodeLifecycleActions": "The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.
", "RegisterComputeNodeGroupInstanceResponse$nodeLifecycleActions": "The node lifecycle actions configured for the node group, including scripts to run when a compute node finishes bootstrapping or becomes ready to accept jobs.
" } }, "NodeLifecycleActionsRequest": { "base": "The lifecycle actions to configure on a compute node group when you create it. Lifecycle actions define scripts that PCS runs on compute nodes at specific stages of their lifecycle.
", "refs": { "CreateComputeNodeGroupRequest$nodeLifecycleActions": "The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.
" } }, "NodeLifecycleScript": { "base": "A script to run during a compute node lifecycle stage.
", "refs": { "NodeLifecycleScriptList$member": null } }, "NodeLifecycleScriptArgument": { "base": null, "refs": { "NodeLifecycleScriptArguments$member": null } }, "NodeLifecycleScriptArguments": { "base": null, "refs": { "NodeLifecycleScript$arguments": "The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long.
" } }, "NodeLifecycleScriptList": { "base": null, "refs": { "NodeLifecycleStages$nodeBootstrapped": "The scripts to run after PCS finishes setting up the compute node and before the Slurm daemon (slurmd) starts. Use this stage for tasks that must complete before the node accepts jobs, such as mounting shared storage, configuring networking, or installing software packages.
The scripts to run after the Slurm daemon (slurmd) starts and the compute node registers with the Slurm controller. Use this stage for tasks that require Slurm to be running, such as running Slurm commands.
A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (_), and hyphens (-). The first character must be a letter or a number.
The stages of a compute node's lifecycle where you can configure scripts to run.
", "refs": { "NodeLifecycleActions$stages": "The lifecycle stages where you configure scripts to run.
", "NodeLifecycleActionsRequest$stages": "The lifecycle stages where you configure scripts to run.
", "UpdateNodeLifecycleActionsRequest$stages": "The lifecycle stages where you configure scripts to run.
" } }, "OnError": { "base": "The behavior when a node lifecycle script fails. Valid values:
TERMINATE – Terminates the compute node.
STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node.
CONTINUE – Ignores the error and continues running the next script.
The behavior when the script fails. The default value is TERMINATE. Valid values:
TERMINATE – Terminates the compute node.
STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node.
CONTINUE – Ignores the error and continues running the next script.
Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.
", "CreateComputeNodeGroupRequest$purchaseOption": "Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.
", "UpdateComputeNodeGroupRequest$purchaseOption": "Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.
" } }, "Queue": { "base": "A queue resource.
", "refs": { "CreateQueueResponse$queue": null, "GetQueueResponse$queue": null, "UpdateQueueResponse$queue": null } }, "QueueIdentifier": { "base": null, "refs": { "DeleteQueueRequest$queueIdentifier": "The name or ID of the queue to delete.
", "GetQueueRequest$queueIdentifier": "The name or ID of the queue.
", "UpdateQueueRequest$queueIdentifier": "The name or ID of the queue.
" } }, "QueueList": { "base": null, "refs": { "ListQueuesResponse$queues": "The list of queues associated with the cluster.
" } }, "QueueName": { "base": null, "refs": { "CreateQueueRequest$queueName": "A name to identify the queue.
", "Queue$name": "The name that identifies the queue.
", "QueueSummary$name": "The name that identifies the queue.
" } }, "QueueSlurmConfiguration": { "base": "Additional options related to the Slurm scheduler.
", "refs": { "Queue$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "QueueSlurmConfigurationRequest": { "base": "Additional options related to the Slurm scheduler.
", "refs": { "CreateQueueRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "QueueStatus": { "base": null, "refs": { "Queue$status": "The provisioning status of the queue.
The provisioning status doesn't indicate the overall health of the queue.
The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
The provisioning status of the queue.
The provisioning status doesn't indicate the overall health of the queue.
The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
The object returned by the ListQueues API action.
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.
", "CreateComputeNodeGroupRequest$tags": "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.
", "CreateQueueRequest$tags": "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.
", "TagResourceRequest$tags": "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.
" } }, "ResourceNotFoundException": { "base": "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.
Examples
", "refs": {} }, "ResponseTagMap": { "base": null, "refs": { "ListTagsForResourceResponse$tags": "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.
" } }, "SBClientToken": { "base": null, "refs": { "CreateClusterRequest$clientToken": "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 one for you.
", "CreateComputeNodeGroupRequest$clientToken": "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 one for you.
", "CreateQueueRequest$clientToken": "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 one for you.
", "DeleteClusterRequest$clientToken": "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 one for you.
", "DeleteComputeNodeGroupRequest$clientToken": "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 one for you.
", "DeleteQueueRequest$clientToken": "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 one for you.
", "UpdateClusterRequest$clientToken": "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 one for you.
", "UpdateComputeNodeGroupRequest$clientToken": "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 one for you.
", "UpdateQueueRequest$clientToken": "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 one for you.
" } }, "ScalingConfiguration": { "base": "Specifies the boundaries of the compute node group auto scaling.
", "refs": { "ComputeNodeGroup$scalingConfiguration": null } }, "ScalingConfigurationMaxInstanceCountInteger": { "base": null, "refs": { "ScalingConfiguration$maxInstanceCount": "The upper bound of the number of instances allowed in the compute fleet.
" } }, "ScalingConfigurationMinInstanceCountInteger": { "base": null, "refs": { "ScalingConfiguration$minInstanceCount": "The lower bound of the number of instances allowed in the compute fleet.
" } }, "ScalingConfigurationRequest": { "base": "Specifies the boundaries of the compute node group auto scaling.
", "refs": { "CreateComputeNodeGroupRequest$scalingConfiguration": "Specifies the boundaries of the compute node group auto scaling.
", "UpdateComputeNodeGroupRequest$scalingConfiguration": "Specifies the boundaries of the compute node group auto scaling.
" } }, "ScalingConfigurationRequestMaxInstanceCountInteger": { "base": null, "refs": { "ScalingConfigurationRequest$maxInstanceCount": "The upper bound of the number of instances allowed in the compute fleet.
" } }, "ScalingConfigurationRequestMinInstanceCountInteger": { "base": null, "refs": { "ScalingConfigurationRequest$minInstanceCount": "The lower bound of the number of instances allowed in the compute fleet.
" } }, "Scheduler": { "base": "The cluster management and job scheduling software associated with the cluster.
", "refs": { "Cluster$scheduler": null } }, "SchedulerRequest": { "base": "The cluster management and job scheduling software associated with the cluster.
", "refs": { "CreateClusterRequest$scheduler": "The cluster management and job scheduling software associated with the cluster.
" } }, "SchedulerType": { "base": null, "refs": { "Scheduler$type": "The software PCS uses to manage cluster scaling and job scheduling.
", "SchedulerRequest$type": "The software PCS uses to manage cluster scaling and job scheduling.
" } }, "ScriptCachingPolicy": { "base": "The caching policy for a node lifecycle script. Valid values:
CACHE_ONCE – Downloads the script once and reuses it on subsequent boots.
REFRESH_ON_REBOOT – Downloads the script on every boot.
The caching policy for node lifecycle scripts. The default value is CACHE_ONCE. Valid values:
CACHE_ONCE – Downloads each script once and reuses it on subsequent boots.
REFRESH_ON_REBOOT – Downloads each script on every boot.
The caching policy for node lifecycle scripts. The default value is CACHE_ONCE. Valid values:
CACHE_ONCE – Downloads each script once and reuses it on subsequent boots.
REFRESH_ON_REBOOT – Downloads each script on every boot.
The caching policy for node lifecycle scripts. The default value is CACHE_ONCE. Valid values:
CACHE_ONCE – Downloads each script once and reuses it on subsequent boots.
REFRESH_ON_REBOOT – Downloads each script on every boot.
The source location and integrity information for a node lifecycle script.
", "refs": { "NodeLifecycleScript$scriptSource": "The source location and integrity information for the script.
" } }, "ScriptSourceChecksumString": { "base": null, "refs": { "ScriptSource$checksum": "The SHA-256 checksum of the script content, as a 64-character hexadecimal string. This value is optional. When specified, PCS uses this value to verify the integrity of the downloaded script.
" } }, "ScriptSourceS3VersionIdString": { "base": null, "refs": { "ScriptSource$s3VersionId": "The Amazon S3 version ID of the script. Use this value to pin the script to a specific version in a versioned Amazon S3 bucket. This value is only valid when scriptLocation is an Amazon S3 URI.
The location of the script. Specify either an Amazon S3 URI in the format s3://bucket-name/key or an HTTPS URL.
The IDs of the EC2 security groups configured directly on the compute node group. PCS uses these security groups instead of the security groups in the custom launch template. This value isn't present if security groups aren't configured directly on the compute node group. In that case, PCS uses the security groups in the custom launch template.
", "CreateComputeNodeGroupRequest$securityGroupIds": "The IDs of the EC2 security groups to configure directly on the compute node group. The security groups must be in the same VPC as the cluster. PCS uses these security groups instead of the security groups in the custom launch template. You can't specify this value if the custom launch template defines network interfaces. If you don't provide this value, PCS uses the security groups in the custom launch template. You must provide this value if launchTemplateMode is MANAGED. For more information, see Configuring instance settings for compute node groups in PCS in the PCS User Guide.
The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
The following rules are required:
Inbound rule 1
Protocol: All
Ports: All
Source: Self
Outbound rule 1
Protocol: All
Ports: All
Destination: 0.0.0.0/0 (IPv4) or ::/0 (IPv6)
Outbound rule 2
Protocol: All
Ports: All
Destination: Self
A list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
" } }, "SecurityGroupIdListOrEmpty": { "base": null, "refs": { "UpdateComputeNodeGroupRequest$securityGroupIds": "The IDs of the EC2 security groups to configure directly on the compute node group. The security groups must be in the same VPC as the cluster. PCS uses these security groups instead of the security groups in the custom launch template. You can't specify this value if the custom launch template defines network interfaces. Specify an empty list ([]) to remove the security groups from the compute node group and use the security groups in the custom launch template. Omit this value to leave the current setting unchanged.
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 Requesting a quota increase in the Service Quotas User Guide
Examples
The max number of clusters or queues has been reached for the account.
The max number of compute node groups has been reached for the associated cluster.
The total of maxInstances across all compute node groups has been reached for associated cluster.
For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.
" } }, "Size": { "base": null, "refs": { "Cluster$size": "The size of the cluster.
SMALL: 32 compute nodes and 256 jobs
MEDIUM: 512 compute nodes and 8192 jobs
LARGE: 2048 compute nodes and 16,384 jobs
A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).
SMALL: 32 compute nodes and 256 jobs
MEDIUM: 512 compute nodes and 8192 jobs
LARGE: 2048 compute nodes and 16,384 jobs
The shared Slurm key for authentication, also known as the cluster secret.
", "refs": { "ClusterSlurmConfiguration$authKey": "The shared Slurm key for authentication, also known as the cluster secret.
" } }, "SlurmCustomSetting": { "base": "Additional settings that directly map to Slurm settings.
PCS supports a subset of Slurm settings. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.
Additional Slurm-specific configuration that directly maps to Slurm settings.
", "ClusterSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "ComputeNodeGroupSlurmConfiguration$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "ComputeNodeGroupSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "QueueSlurmConfiguration$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "QueueSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "UpdateClusterSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "UpdateComputeNodeGroupSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
", "UpdateQueueSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" } }, "SlurmRest": { "base": "The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API. It's a property of the ClusterSlurmConfiguration object.
", "refs": { "ClusterSlurmConfiguration$slurmRest": "The Slurm REST API configuration for the cluster.
" } }, "SlurmRestMode": { "base": null, "refs": { "SlurmRest$mode": "The default value for mode is NONE. A value of STANDARD means the Slurm REST API is enabled.
The default value for mode is NONE. A value of STANDARD means the Slurm REST API is enabled.
The default value for mode is NONE. A value of STANDARD means the Slurm REST API is enabled.
The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API. It's a property of the ClusterSlurmConfiguration object.
", "refs": { "ClusterSlurmConfigurationRequest$slurmRest": "The Slurm REST API configuration for the cluster.
" } }, "SlurmdbdCustomSetting": { "base": "Additional settings that directly map to SlurmDBD settings.
PCS supports a subset of SlurmDBD settings. For more information, see Configuring custom SlurmDBD settings in PCS in the PCS User Guide.
Additional SlurmDBD-specific configuration that directly maps to SlurmDBD settings.
", "ClusterSlurmConfigurationRequest$slurmdbdCustomSettings": "Additional SlurmDBD-specific configuration that directly maps to SlurmDBD settings.
", "UpdateClusterSlurmConfigurationRequest$slurmdbdCustomSettings": "Additional SlurmDBD-specific configuration that directly maps to SlurmDBD settings.
" } }, "SpotAllocationStrategy": { "base": null, "refs": { "SpotOptions$allocationStrategy": "The Amazon EC2 allocation strategy PCS uses to provision EC2 instances. PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.
" } }, "SpotOptions": { "base": "Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
PCS supports custom Cgroup settings for clusters. For more information, see Configuring custom Cgroup settings in PCS in the PCS User Guide.
", "CgroupCustomSetting$parameterValue": "The values for the configured Cgroup settings.
", "Cluster$name": "The name that identifies the cluster.
", "Cluster$id": "The generated unique ID of the cluster.
", "Cluster$arn": "The unique Amazon Resource Name (ARN) of the cluster.
", "ClusterSummary$name": "The name that identifies the cluster.
", "ClusterSummary$id": "The generated unique ID of the cluster.
", "ClusterSummary$arn": "The unique Amazon Resource Name (ARN) of the cluster.
", "ComputeNodeGroup$id": "The generated unique ID of the compute node group.
", "ComputeNodeGroup$arn": "The unique Amazon Resource Name (ARN) of the compute node group.
", "ComputeNodeGroup$clusterId": "The ID of the cluster of the compute node group.
", "ComputeNodeGroupConfiguration$computeNodeGroupId": "The compute node group ID for the compute node group configuration.
", "ComputeNodeGroupSummary$id": "The generated unique ID of the compute node group.
", "ComputeNodeGroupSummary$arn": "The unique Amazon Resource Name (ARN) of the compute node group.
", "ComputeNodeGroupSummary$clusterId": "The ID of the cluster of the compute node group.
", "ConflictException$message": null, "ConflictException$resourceId": "The unique identifier of the resource that caused the conflict exception.
", "ConflictException$resourceType": "The type or category of the resource that caused the conflict exception.\"
", "CustomLaunchTemplate$id": "The ID of the EC2 launch template to use to provision instances. Specify this value together with version.
Example: lt-xxxx
The version of the EC2 launch template to use to provision instances. Specify this value together with id.
For clusters that use IPv4, this is the endpoint's private IP address.
Example: 10.1.2.3
For clusters configured to use IPv6, this is an empty string.
", "Endpoint$publicIpAddress": "The endpoint's public IP address.
Example: 192.0.2.1
The endpoint's IPv6 address.
Example: 2001:db8::1
The endpoint's connection port number.
Example: 1234
The short-form error code.
", "ErrorInfo$message": "The detailed error information.
", "GresCustomSettingMap$key": null, "GresCustomSettingMap$value": null, "InstanceConfig$instanceType": "The EC2 instance type that PCS can provision in the compute node group.
Example: t2.xlarge
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the JWT key.
", "JwtKey$secretVersion": "The version of the Amazon Web Services Secrets Manager secret containing the JWT key.
", "ListClustersRequest$nextToken": "The value of nextToken is a unique pagination token for each page of results returned. If nextToken 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 HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken 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 HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken 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 HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken 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 HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken 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 HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken 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 HTTP 400 InvalidToken error.
The generated unique ID of the queue.
", "Queue$arn": "The unique Amazon Resource Name (ARN) of the queue.
", "Queue$clusterId": "The ID of the cluster of the queue.
", "QueueSummary$id": "The generated unique ID of the queue.
", "QueueSummary$arn": "The unique Amazon Resource Name (ARN) of the queue.
", "QueueSummary$clusterId": "The ID of the cluster of the queue.
", "RegisterComputeNodeGroupInstanceResponse$nodeID": "The scheduler node ID for this instance.
", "RegisterComputeNodeGroupInstanceResponse$clusterName": "The name of the cluster that the compute node registered into.
", "RegisterComputeNodeGroupInstanceResponse$computeNodeGroupId": "The ID of the compute node group that the compute node registered into.
", "RegisterComputeNodeGroupInstanceResponse$computeNodeGroupName": "The name of the compute node group that the compute node registered into.
", "RegisterComputeNodeGroupInstanceResponse$schedulerVersion": "The scheduler version that the cluster is running. A compute node uses this value to run the matching scheduler version.
", "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "The unique identifier of the resource that was not found.
", "ResourceNotFoundException$resourceType": "The type or category of the resource that was not found.
", "Scheduler$version": "The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. You can update this version using the UpdateCluster API action. For more information, see Updating the scheduler version on a cluster and Slurm versions in PCS in the PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11 | 25.05 | 25.11 | 26.05
The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in PCS in the PCS User Guide.
Valid Values: 24.11 | 25.05 | 25.11 | 26.05
The service code associated with the quota that was exceeded.
", "ServiceQuotaExceededException$resourceId": "The unique identifier of the resource that caused the quota to be exceeded.
", "ServiceQuotaExceededException$resourceType": "The type or category of the resource that caused the quota to be exceeded.
", "ServiceQuotaExceededException$quotaCode": "The quota code of the service quota that was exceeded.
", "SlurmAuthKey$secretArn": "The Amazon Resource Name (ARN) of the shared Slurm key.
", "SlurmAuthKey$secretVersion": "The version of the shared Slurm key.
", "SlurmCustomSetting$parameterName": "PCS supports custom Slurm settings for clusters, compute node groups, and queues. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.
", "SlurmCustomSetting$parameterValue": "The values for the configured Slurm settings.
", "SlurmdbdCustomSetting$parameterName": "PCS supports custom SlurmDBD settings for clusters. For more information, see Configuring custom SlurmDBD settings in PCS in the PCS User Guide.
", "SlurmdbdCustomSetting$parameterValue": "The values for the configured SlurmDBD settings.
", "StringList$member": null, "ThrottlingException$message": null, "UpdateSchedulerRequest$version": "The scheduler version to update the cluster to. You can only update to a newer version. For more information about supported versions and update paths, see Updating the scheduler version on a cluster in the PCS User Guide.
Valid Values: 24.05 | 24.11 | 25.05 | 25.11 | 26.05
The name of the exception.
", "ValidationExceptionField$message": "The message body of the exception.
" } }, "StringList": { "base": null, "refs": { "CreateComputeNodeGroupRequest$subnetIds": "The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.
", "UpdateComputeNodeGroupRequest$subnetIds": "The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.
" } }, "SubnetId": { "base": null, "refs": { "SubnetIdList$member": null } }, "SubnetIdList": { "base": null, "refs": { "ComputeNodeGroup$subnetIds": "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.
", "Networking$subnetIds": "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.
Example: subnet-abcd1234
The list of subnet IDs where PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
PCS currently supports only 1 subnet in this list.
The date and time the resource was created.
", "Cluster$modifiedAt": "The date and time the resource was modified.
", "ClusterSummary$createdAt": "The date and time the resource was created.
", "ClusterSummary$modifiedAt": "The date and time the resource was modified.
", "ComputeNodeGroup$createdAt": "The date and time the resource was created.
", "ComputeNodeGroup$modifiedAt": "The date and time the resource was modified.
", "ComputeNodeGroupSummary$createdAt": "The date and time the resource was created.
", "ComputeNodeGroupSummary$modifiedAt": "The date and time the resource was modified.
", "Queue$createdAt": "The date and time the resource was created.
", "Queue$modifiedAt": "The date and time the resource was modified.
", "QueueSummary$createdAt": "The date and time the resource was created.
", "QueueSummary$modifiedAt": "The date and time the resource was modified.
" } }, "TagKey": { "base": null, "refs": { "RequestTagMap$key": null, "ResponseTagMap$key": null, "TagKeys$member": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "RequestTagMap$value": null, "ResponseTagMap$value": null } }, "ThrottlingException": { "base": "Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
", "refs": {} }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateAccountingRequest": { "base": "The accounting configuration includes configurable settings for Slurm accounting.
", "refs": { "UpdateClusterSlurmConfigurationRequest$accounting": "The accounting configuration includes configurable settings for Slurm accounting.
" } }, "UpdateAccountingRequestDefaultPurgeTimeInDaysInteger": { "base": null, "refs": { "UpdateAccountingRequest$defaultPurgeTimeInDays": "The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
Additional options related to the Slurm scheduler.
", "refs": { "UpdateClusterRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "UpdateClusterSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger": { "base": null, "refs": { "UpdateClusterSlurmConfigurationRequest$scaleDownIdleTimeInSeconds": "The time (in seconds) before an idle node is scaled down.
Default: 600
Additional options related to the Slurm scheduler.
", "refs": { "UpdateComputeNodeGroupRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "UpdateComputeNodeGroupSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger": { "base": null, "refs": { "UpdateComputeNodeGroupSlurmConfigurationRequest$scaleDownIdleTimeInSeconds": "The time (in seconds) before an idle node is scaled down. If not specified, the cluster-level setting applies. This overrides the cluster-level scaleDownIdleTimeInSeconds setting. A value of -1 removes the override and applies the cluster-level setting to this compute node group. Requires Slurm version 25.11 or later.
The lifecycle actions to configure on a compute node group when you update it. Lifecycle actions define scripts that PCS runs on compute nodes at specific stages of their lifecycle.
", "refs": { "UpdateComputeNodeGroupRequest$nodeLifecycleActions": "The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.
" } }, "UpdateQueueRequest": { "base": null, "refs": {} }, "UpdateQueueResponse": { "base": null, "refs": {} }, "UpdateQueueSlurmConfigurationRequest": { "base": "Additional options related to the Slurm scheduler.
", "refs": { "UpdateQueueRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "UpdateSchedulerRequest": { "base": "The scheduler configuration for updating a cluster. Use this to specify the scheduler version to update to.
", "refs": { "UpdateClusterRequest$scheduler": "The scheduler configuration to update for the cluster. Use this to update the scheduler version. For more information, see Updating the scheduler version on a cluster in the PCS User Guide.
" } }, "UpdateSlurmRestRequest": { "base": "The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API.
", "refs": { "UpdateClusterSlurmConfigurationRequest$slurmRest": "The Slurm REST API configuration for the cluster.
" } }, "ValidationException": { "base": "The request isn't valid.
Examples
Your request contains malformed JSON or unsupported characters.
The scheduler version isn't supported.
There are networking related errors, such as network validation failure.
AMI type is CUSTOM and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
Stores information about a field in a request that caused an exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "A list of fields or properties that failed validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The specific reason or cause of the validation error.
" } } } }