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 must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
", "CreateQueue": "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.
", "UpdateComputeNodeGroup": "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 STANDARD. A value of STANDARD means Slurm accounting is enabled.
The default value for mode is STANDARD. 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 provided, 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). If you don't provide this value, PCS uses the AMI ID specified in the custom launch template.
", "UpdateComputeNodeGroupRequest$amiId": "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.
" } }, "Arn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "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.
" } }, "Cluster": { "base": "The cluster resource and configuration.
", "refs": { "CreateClusterResponse$cluster": "The cluster resource.
", "GetClusterResponse$cluster": "The cluster resource.
" } }, "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 of the queue.
", "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.
", "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.
" } }, "ComputeNodeGroupStatus": { "base": null, "refs": { "ComputeNodeGroup$status": "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.
", "refs": { "ComputeNodeGroup$customLaunchTemplate": null, "CreateComputeNodeGroupRequest$customLaunchTemplate": null, "UpdateComputeNodeGroupRequest$customLaunchTemplate": null } }, "DeleteClusterRequest": { "base": null, "refs": {} }, "DeleteClusterResponse": { "base": null, "refs": {} }, "DeleteComputeNodeGroupRequest": { "base": null, "refs": {} }, "DeleteComputeNodeGroupResponse": { "base": null, "refs": {} }, "DeleteQueueRequest": { "base": null, "refs": {} }, "DeleteQueueResponse": { "base": null, "refs": {} }, "Endpoint": { "base": "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.
" } }, "GetClusterRequest": { "base": null, "refs": {} }, "GetClusterResponse": { "base": null, "refs": {} }, "GetComputeNodeGroupRequest": { "base": null, "refs": {} }, "GetComputeNodeGroupResponse": { "base": null, "refs": {} }, "GetQueueRequest": { "base": null, "refs": {} }, "GetQueueResponse": { "base": null, "refs": {} }, "InstanceConfig": { "base": "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 Amazon Web Services PCS can provision in the compute node group.
", "CreateComputeNodeGroupRequest$instanceConfigs": "A list of EC2 instance configurations that Amazon Web Services 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": {} }, "ListClustersRequest": { "base": null, "refs": {} }, "ListClustersResponse": { "base": null, "refs": {} }, "ListComputeNodeGroupsRequest": { "base": null, "refs": {} }, "ListComputeNodeGroupsResponse": { "base": null, "refs": {} }, "ListQueuesRequest": { "base": null, "refs": {} }, "ListQueuesResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "MaxResults": { "base": null, "refs": { "ListClustersRequest$maxResults": "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.
" } }, "PurchaseOption": { "base": null, "refs": { "ComputeNodeGroup$purchaseOption": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
", "CreateComputeNodeGroupRequest$purchaseOption": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
", "UpdateComputeNodeGroupRequest$purchaseOption": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. 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.
" } }, "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 1 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 1 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 1 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 1 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 1 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 1 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 1 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 1 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.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupIdList$member": null } }, "SecurityGroupIdList": { "base": null, "refs": { "Networking$securityGroupIds": "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.
" } }, "ServiceQuotaExceededException": { "base": "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.
", "refs": { "SlurmCustomSettings$member": null } }, "SlurmCustomSettings": { "base": null, "refs": { "ClusterSlurmConfiguration$slurmCustomSettings": "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.
", "UpdateComputeNodeGroupSlurmConfigurationRequest$slurmCustomSettings": "Additional Slurm-specific configuration that directly maps to Slurm settings.
" } }, "SpotAllocationStrategy": { "base": null, "refs": { "SpotOptions$allocationStrategy": "The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services 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.
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.
Example: lt-xxxx
The version of the EC2 launch template to use to provision instances.
", "Endpoint$privateIpAddress": "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.
", "InstanceConfig$instanceType": "The EC2 instance type that PCS can provision in the compute node group.
Example: t2.xlarge
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.
", "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. For more information, see Slurm versions in PCS in the PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
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: 23.11 | 24.05 | 24.11
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 the shared Slurm key.
", "SlurmAuthKey$secretVersion": "The version of the shared Slurm key.
", "SlurmCustomSetting$parameterName": "PCS supports configuration of the following Slurm parameters:
For clusters
PCS supports a subset of the options for AccountingStorageEnforce. For more information, see Slurm accounting in PCS in the PCS User Guide.
For compute node groups
The values for the configured Slurm settings.
", "StringList$member": null, "ThrottlingException$message": null, "ValidationException$message": null, "ValidationExceptionField$name": "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 Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
Amazon Web Services 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": {} }, "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": {} }, "UpdateComputeNodeGroupRequest": { "base": null, "refs": {} }, "UpdateComputeNodeGroupResponse": { "base": null, "refs": {} }, "UpdateComputeNodeGroupSlurmConfigurationRequest": { "base": "Additional options related to the Slurm scheduler.
", "refs": { "UpdateComputeNodeGroupRequest$slurmConfiguration": "Additional options related to the Slurm scheduler.
" } }, "UpdateQueueRequest": { "base": null, "refs": {} }, "UpdateQueueResponse": { "base": null, "refs": {} }, "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.
" } } } }